Skip to main content
cURL
curl --request POST \
  --url https://api.grainfinance.co/v1/spots/quote \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'X-Customer-IP: <x-customer-ip>' \
  --data '
{
  "fromCurrency": "MXN",
  "toCurrency": "USD",
  "toCurrencyAmount": 1560,
  "fromCurrencyAmount": 123,
  "externalMarkupPct": 1
}
'
{
  "id": "8173b9a7-ee61-413e-b9e3-7c04b2a067c5",
  "fromCurrency": "MXN",
  "toCurrency": "USD",
  "quote": 20.6165,
  "validUntilTs": 1659625098,
  "toCurrencyAmount": 1560,
  "fromCurrencyAmount": 32161.8
}

Documentation Index

Fetch the complete documentation index at: https://docs.grainfinance.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Basic authentication using the partner API keys from https://console.grainfinance.co/api-keys

Headers

​
X-Customer-IP
string<IPv4>
required

The IPv4 address of the browser from which the customer contacts your platform.
example: 192.158.1.38

Pattern: ((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}

Body

application/json

The payload required in order to ask for a spot quote

The payload required in order to ask for a spot quote

​
fromCurrency
string
required

The currency in which the transaction should be paid at by your customer.

Example:

"MXN"

​
toCurrency
string
required

The currency in which the inventory item is listed at on your platform.

Example:

"USD"

​
toCurrencyAmount
number<double>

Specifies the amount to hedge in the toCurrency. When provided, this sets fixedSide to toCurrencyAmount, and the fromCurrencyAmount is derived as: fromCurrencyAmount = toCurrencyAmount × quote. Exactly one of toCurrencyAmount or fromCurrencyAmount may be provided. Alternatively, neither may be provided to defer amount specification to the Accept call.

Example:

1560

​
fromCurrencyAmount
number<double>

Specifies the amount to hedge in the fromCurrency. When provided, this sets fixedSide to fromCurrencyAmount, and the toCurrencyAmount is derived as: toCurrencyAmount = fromCurrencyAmount / quote. Exactly one of toCurrencyAmount or fromCurrencyAmount may be provided. Alternatively, neither may be provided to defer amount specification to the Accept call.

​
externalMarkupPct
number<double>

The external markup percentage that should be added to this quote on top of Grain’s internal pricing. For example, a value of 1.0 represents a 1.0% additional markup.

Example:

1

Response

Spot Proposal Created

​
id
string<uuid>
required

The id of the spot proposal within the Grain platform.

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}
Example:

"8173b9a7-ee61-413e-b9e3-7c04b2a067c5"

​
fromCurrency
string
required

The original currency that will be converted into a different currency. This is the currency the user wants to exchange or convert in the transaction.

Example:

"MXN"

​
toCurrency
string
required

The target currency that the original currency (fromCurrency) will be converted into. This is the desired currency after the conversion process is complete.

Example:

"USD"

​
quote
number<double>
required

The rate locked by this spot.

Example:

20.6165

​
validUntilTs
number<double>
required

The unix timestamp until which the spot offer is valid.

Example:

1659625098

​
toCurrencyAmount
number<double>

The amount to transfer in the toCurrency

Example:

1560

​
fromCurrencyAmount
number<double>

The amount to transfer in the fromCurrency

Example:

32161.8