Get quote

Retrieves a quote for the purchase of an asset and the network fees associated with an imminent and automatic withdrawal of the asset. Exactly one of quantity or total must be supplied.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

Allows platforms to specify the side of the quote

Allowed:
string
enum
required

Allows platforms to specify the underlying asset

string
enum
required

Allows platforms to specify the quoted asset

Allowed:
string

The quantity of the underlying asset requested in the quote. Exactly one of quantity or total must be supplied.

string

The total of the quoted_currency asset requested in the quote. Exactly one of quantity or total must be supplied.

string

The participant requesting a quote to buy or sell an asset

string

The account_label that's used to fund the trade

string
required

The on-chain address where the withdrawal should be sent

boolean

Allows platforms to specify if fees are inclusive
This parameter is only applicable for requests made by total

string

Allows the platform to define the quote spread in basis points

string

The destination tag or memo ID associated with the transaction. If the asset is EOS, XLM or XRP and no_destination_tag is false, then this is required

string

Whether or not the specific withdrawal and destination address requires a destination tag. If the asset is EOS, XLM or XRP, this field is required. Note: zerohash requires that no_destination_tag be false for EOS

string

The participant benefiting from the quote to buy or sell an asset

string

The first name of the participant benefiting from the quote request
Only applies to individual beneficiaries. Cannot be used along with business_beneficiary_name.
Note: Redundant if beneficiary_participant_code is provided in request

string

The last name of the participant benefiting from the quote request
Only applies to individual beneficiaries. Cannot be used along with business_beneficiary_name.
Note: Redundant if beneficiary_participant_code is provided in request

string

The name of the the business participant benefiting from the quote request
Only applies to business beneficiaries. Cannot be used along with first/last_beneficiary_name.
Note: Redundant if beneficiary_participant_code is provided in request

Headers
string
required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

string
required

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json