Get quote

get

https://api.cert.zerohash.com/convert_withdraw/rfq

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

side

string

enum

required

Allows platforms to specify the side of the quote

Allowed:

underlying

string

enum

required

Allows platforms to specify the underlying asset

quoted_currency

string

enum

required

Allows platforms to specify the quoted asset

Allowed:

quantity

string

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

total

string

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

participant_code

string

The participant requesting a quote to buy or sell an asset

account_label

string

The account_label that's used to fund the trade

withdrawal_address

string

required

The on-chain address where the withdrawal should be sent

fee_inclusive

boolean

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

spread

string

Allows the platform to define the quote spread in basis points

destination_tag

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

no_destination_tag

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

beneficiary_participant_code

string

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

beneficiary_first_name

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

beneficiary_last_name

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

beneficiary_business_name

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

X-SCX-SIGNED

string

required

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

X-SCX-TIMESTAMP

string

required

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

Responses

200Successfully generated convert-and-withdraw quote. Returns the quote envelope ({ message: {...} }) with pricing, network fees, and an ephemeral quote_id.

400Bad Request

403Forbidden

404Not Found

500Internal Server Error

503Service Unavailable