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 in the request body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Convert-and-withdraw quote parameters. Select the variant that matches whether the request is expressed as a quantity of the underlying or a total in the quoted currency.

Request for quote with specific quantity of underlying asset. Use this when you know the exact amount of crypto to convert and withdraw.

string

The identifier of the participant making the quote request

string
enum
required

the quoted asset

Allowed:
string
enum
required

the underlying asset

string
enum
required

The participant side of the quote - buy or sell

Allowed:
string

The account_label that's used to fund the trade. This parameter is case sensitive.

string
required

The on-chain address for the withdrawal.

boolean

Only applicable for orders by total. If true, the total_notional equals the total value specified, fees included.

string

The spread to apply to the quote in basis points

string

Destination tag / memo ID. Required for some assets (e.g., EOS, XLM, XRP) depending on no_destination_tag.

boolean

Whether the destination requires a tag/memo. For EOS, this must be false per zerohash requirements.

string

Identifier of the participant benefiting from the quote request

string

First name of the individual beneficiary. Not with business_beneficiary_name. Redundant if beneficiary_participant_code is provided.

string

Last name of the individual beneficiary. Not with business_beneficiary_name. Redundant if beneficiary_participant_code is provided.

string

Business name of the beneficiary. Not with first/last beneficiary name. Redundant if beneficiary_participant_code is provided.

string
required

Amount of the underlying currency requested. Exactly one of quantity or total must be supplied.

fees
array of objects

Optional custom fees applied to the quote. Up to 5 entries are accepted.

fees
payment_processor
object

Optional payment processor metadata associating this quote with an external PSP.

contract_execution
object

Optional EVM smart-contract execution metadata. Only available on supported EVM networks.

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