Currencies

Retrieve a list of the client's currencies

Retrieve a list of the client's currencies, optionally filtered by trade_type. When show_all is true, every available currency is returned with minimal detail instead of the client's trading currencies.

get/currencies

Request

  • Base URL: https://api.ebury.io
  • URL: https://api.ebury.io/currencies
  • Auth: API key in header x-api-key

Query parameters

client_idstring required

The ID of the client

trade_type'spot' | 'forward'

The trade types to be retrieved. Ignored when show_all is true.

currencystring

A comma-separated list of currency codes compliant to ISO 4217

show_allboolean

When true, returns every available currency with minimal detail (Currency). When false or omitted, returns the client's trading currencies with full detail (CurrencyInfo).

Headers

Authorizationstring required

The access token

Response

A list with the client's currencies. Items are CurrencyInfo objects, or Currency objects when show_all is true.

Example response

[
  {
    "currency": "USD",
    "decimals": 2
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.