API Reference
  1. HERALD EXCHANGE
  2. Quote

Generate OTC Quote

post
https://herald-otc-api-sandbox.heraldex.com:3292/api/v1/otc/quote

This API generates a real-time OTC trade quote for a currency exchange between a source and target asset. It calculates the expected conversion amount based on the requested trade side (buy/sell), applies the current exchange rate, and includes any applicable commissions or fees. The response is time-sensitive and includes an expiry window, after which the quote becomes invalid and must be regenerated before placing an order.

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

The currency you are converting from

string
required

The currency you want to receive

integer
required

The numeric value used for conversion

string
required

Specifies whether the amount is based on “from” or “to” currency

string
enum
required

Defines the trade direction (buy or sell)

Allowed:
Headers
string
required

The unique API key assigned to the client for authenticating API requests.

string
required

The cryptographic signature generated to verify the integrity and authenticity of the request.

string
required

The timestamp of the API request used to prevent replay attacks.

string
required

Bearer token used to authenticate and authorize access to the API.

Response

Updated about 2 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?