Listing exchange currency pairs

GET /api/public/v1/exchange/currency_pairs

This endpoint returns a list of currency pairs available for exchange.

Headers

Name	Value
Content-Type	application/vnd.api+json
Authorization	Bearer <api_key>

Response Body

Name	Type	Description
data[].id	string	Currency pair ID.
data[].type	string	Entity type returned. Always currencyPairs.
data[].attributes	object	Set of currency pair attributes.
data[].attributes.direction	string	Quote direction. Either buy or sell.
data[].attributes.enabled	boolean	If true, the currency pair is available for exchange.
data[].attributes.minAmount	string	Minimum exchange amount, quoted in minAmountCurrency.
data[].attributes.minAmountCurrency	string	Currency in which minAmount is quoted.
data[].attributes.maxAmount	string	Maximum exchange amount, quoted in maxAmountCurrency.
data[].attributes.maxAmountCurrency	string	Currency in which maxAmount is quoted.
data[].relationships.baseCurrency.id	string	Base currency of the pair. Refer to supported currencies.
data[].relationships.quoteCurrency.id	string	Quote currency of the pair.
included[].type(currencies).attributes	object	Currency details, including code, symbol, crypto, and subunitToUnit.
included[].type(network).attributes	object	Network details, including code, name, and currencyCode.

Response

HTTP 200

{
  "data": [
    {
      "id": "4018ce40-4af8-42bf-9c72-88c285e9e952",
      "type": "currencyPairs",
      "attributes": {
        "direction": "buy",
        "enabled": true,
        "minAmount": "1.000000",
        "maxAmount": "5000000.000000",
        "minAmountCurrency": "USDT",
        "maxAmountCurrency": "USDT"
      },
      "relationships": {
        "baseCurrency": {
          "data": {
            "type": "currencies",
            "id": "USDT"
          }
        },
        "quoteCurrency": {
          "data": {
            "type": "currencies",
            "id": "EUR"
          }
        }
      }
    },
    {
      "id": "9df10d72-ca21-4d3b-a58f-c538ec9e52e8",
      "type": "currencyPairs",
      "attributes": {
        "direction": "sell",
        "enabled": true,
        "minAmount": "1.000000",
        "maxAmount": "5000000.000000",
        "minAmountCurrency": "USDT",
        "maxAmountCurrency": "USDT"
      },
      "relationships": {
        "baseCurrency": {
          "data": {
            "type": "currencies",
            "id": "USDT"
          }
        },
        "quoteCurrency": {
          "data": {
            "type": "currencies",
            "id": "EUR"
          }
        }
      }
    }
  ],
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}