FX spot rates
GET{BASE_URL}/fx-rates
Note: This endpoint is not yet live in production; it will be deployed soon. This documentation is provided for reference only.
Returns FX spot rates for supported currency pairs.
All bid, ask, and avg values are quoted as source currency per 1 unit of target currency (for example, HKD per USD). Use bid when the client sells target currency, ask when the client buys target currency, and avg as the mid/reference rate.
source_currency and target_currency are optional. If neither is
provided, all supported pairs are returned. If only one is provided, results
are filtered by that field. Filters are exact, case-sensitive matches
(use HKD, not hkd). If no rows match, the response is an empty
array ([]).
Request
Responses
- 200
- 400
- 401
FX rates for matching currency pairs. Returns all pairs when no query parameters are provided.
The request could not be accepted, for example because the account or
symbol is unavailable, a required paired account is missing, buying power
or position is insufficient, required market pricing is unavailable, an
identifier is duplicated, or an order field or requested lifecycle action
is invalid. A missing account_number, or one not linked to the API key,
also returns 400 BasicInput_Error.
Missing or invalid X-API-KEY.