For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get FX Rates

Endpoint: GET /v2/gc/fx/rates

Description: Retrieve reference (informational) FX rates for one or more currency pairs without locking a rate or generating a commitment token.

Request

Request Params Field Descriptions

Field Name
Type
Required
Description

sourceCurrency

string

No

ISO 4217 currency code of the source currency to filter results (e.g. USD).

targetCurrency

string

No

ISO 4217 currency code of the target currency to filter results (e.g. CNH).

Response

Response Field Descriptions

Field Name
Type
Description

code

number

Response code.

state

number

State of the response.

data

object

Container for the list of FX rate entries.

message

string

Response message.

neoResponseId

string

Unique NeoX response identifier.

data object fields:

Field Name
Type
Description

docs

array

Array of FX rate objects for currency pairs.

docs object item fields:

Field Name
Type
Description

sourceCurrency

string

ISO 4217 currency code of the source (selling) currency.

targetCurrency

string

ISO 4217 currency code of the target (buying) currency.

offer

number

Ask (offer) rate — the rate at which the platform sells the target currency.

bid

number

Bid rate — the rate at which the platform buys the target currency.

fxRateDt

date string

Timestamp when this FX rate was last updated (ISO 8601).

Response sample

Example cURL

Notes

  • Requires Bearer token in the Authorization header.

  • The Accept-Language header can be used to specify the response language (Support: "vi", "en").

  • The returned rates are informational only and do not lock a rate for trading. Use the FX Inquiry API (POST /v2/gc/fx/inquiry) to obtain a locked rate and a commitment token.

  • Omit both sourceCurrency and targetCurrency to retrieve the full list of available FX rate pairs.

  • offer and bid rates may change frequently; do not cache them for transactional decisions.

Last updated

Was this helpful?