HEhevn-inc
catalog

Retrieve a market reference rate

Changed on

Convert one currency or token into another at the current market rate, before any transfer exists. Use it to show a price; the rate a transfer settles at comes from its own quote.

get/rates

Request

Query parameters

fromstring required

ISO 4217 currency code or a token symbol.

Example:EUR
tostring required

ISO 4217 currency code or a token symbol.

Example:USDC

Response

Successful Response

fromCurrencystring required

Currency or token the rate converts from.

toCurrencystring required

Currency or token the rate converts to.

ratestring required

How many units of toCurrency one unit of fromCurrency buys.

indicativeboolean

Always true: this is a market reference rate. A payout or incoming transfer is priced by its own quote.

Example response

{
  "rate": "500.00"
}

Changes

  • 299a3aa6f521Revision changes
    • warning

      added the new verification_not_applicable enum value to the / response property for the response status

    • info

      removed the phone_required enum value from the / response property for the response status

    • info

      removed the rail_requirements_unmet enum value from the / response property for the response status

  • a02795de2d2bRevision changes
    • warning

      deleted the header request parameter x-api-key

    • warning

      added the new client_already_linked enum value to the / response property for the response status

    • warning

      added the new kyb_documents_processing enum value to the / response property for the response status

    • warning

      added the new link_code_expired enum value to the / response property for the response status

    • warning

      added the new link_code_invalid enum value to the / response property for the response status

    • warning

      added the new payout_not_awaiting_signature enum value to the / response property for the response status

    • warning

      added the new redirect_uri_not_allowed enum value to the / response property for the response status

    • warning

      added the new sandbox_amount_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new sandbox_faucet_balance_too_high enum value to the / response property for the response status

    • info

      removed the client_policy_not_enabled enum value from the / response property for the response status

    • info

      removed the client_request_conflict enum value from the / response property for the response status

    • info

      removed the email_in_use enum value from the / response property for the response status

    • info

      removed the integrator_inactive enum value from the / response property for the response status

    • info

      removed the name_in_use enum value from the / response property for the response status