Get trading pairs

Retrieve the base/quote trading pairs supported by the tenant’s trading providers. All filters are optional and combined with AND.

A provider can return several rows for one pair, one per side and per connected account, each with its own tradeClass. Rows may use the wildcard * asset ID or the BOTH side and are returned unexpanded (see the baseAsset, side and baseChain filters for how they match).

Examples

Which providers support ETH/USDC: ?baseAsset=ETH&quoteAsset=USDC. Add providerId to check one provider; an empty data array means it does not support the pair.
All pairs of one account: ?providerId=ACME&accountId=<ACCOUNT_ID>. Page through large results with pageSize and pageCursor.
Everything you can buy with euro: ?baseAsset=EUR&tradeClass=ON_RAMP.

Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

For detailed information about error codes and troubleshooting, please refer to our API Error Codes documentation.

GET

trading

pairs

TypeScript

const response: Promise<FireblocksResponse<TradingPairsListPage>> = fireblocks.trading.getTradingPairs(tradingApiGetTradingPairsRequest);

CompletableFuture<ApiResponse<TradingPairsListPage>> response = fireblocks.trading().getTradingPairs(baseAsset, quoteAsset, baseChain, quoteChain, baseRail, quoteRail, side, tradeClass, providerId, accountId, prefunded, min, max, pageSize, pageCursor);

response = fireblocks.trading.get_trading_pairs(base_asset, quote_asset, base_chain, quote_chain, base_rail, quote_rail, side, trade_class, provider_id, account_id, prefunded, min, max, page_size, page_cursor);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/trading/pairs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/trading/pairs"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/trading/pairs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "providerId": "ACME",
      "accountId": "7f1a2b3c-9d4e-4a5b-8c6d-1e2f3a4b5c6d",
      "baseAssetId": "EUR",
      "quoteAssetId": "BTC",
      "quoteChain": "BTC",
      "side": "SELL",
      "tradeClass": "ON_RAMP",
      "baseAssetRail": "SEPA",
      "quoteAssetRail": "BLOCKCHAIN",
      "prefunded": false,
      "min": "10",
      "max": "100000"
    },
    {
      "providerId": "ACME",
      "baseAssetId": "*",
      "quoteAssetId": "*",
      "baseChain": "ETH",
      "quoteChain": "ETH",
      "side": "BOTH",
      "tradeClass": "SWAP_DEFI",
      "baseAssetRail": "BLOCKCHAIN",
      "quoteAssetRail": "BLOCKCHAIN"
    }
  ],
  "total": 2,
  "next": "cursor_abc123def456"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "message": "<string>",
  "code": 123
}

Query Parameters

baseAsset

string

Filter by base asset ID. Also matches * rows on the chain of this asset.

Minimum string length: 1

quoteAsset

string

Filter by quote asset ID. Also matches * rows on the chain of this asset.

Minimum string length: 1

baseChain

string

Filter by base asset blockchain legacyId (e.g. ETH, BASECHAIN_ETH, SOL). Matches both concrete-asset rows and * rows on that chain.

Minimum string length: 1

quoteChain

string

Filter by quote asset blockchain legacyId (e.g. ETH, BASECHAIN_ETH, SOL). Matches both concrete-asset rows and * rows on that chain.

Minimum string length: 1

baseRail

enum<string>

Filter by base asset transfer rail. Transfer rail:

BLOCKCHAIN - Transfer over the public blockchain
INTERNAL - Internal transfer within the same account (e.g. sub-accounts or same api key)
SWIFT - International wire transfer
IBAN - International Bank Account Number transfer
US_WIRE - Domestic wire transfer within the United States (e.g. FedWire)
ACH - Automated Clearing House transfer, typically takes longer but not as expensive as wire transfers
SEPA - Euro transfers within the SEPA zone
SPEI - Mexican interbank electronic payment system
PIX - Brazilian instant payment system
LBT - Local bank transfers
MOMO - Mobile money transfers (e.g. M-Pesa)
CHAPS - The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for transactions in the United Kingdom
PAYID - PayID payment identifier system (Australia)
INTERAC - Interac electronic funds transfer (Canada)
INTERNAL_TRANSFER - Internal transfer between accounts
CIPS - Cross-Border Interbank Payment System (China)
NEQUI - Nequi mobile payment (Colombia)
FPS_UK - UK Faster Payments (GBP)
FPS_HK - Hong Kong Faster Payment System (HKD)
INSTA_PAY - InstaPay instant payment (Philippines)
PESONET - PesoNet batch payment (Philippines)

Available options:

BLOCKCHAIN,

INTERNAL,

SWIFT,

IBAN,

US_WIRE,

ACH,

SEPA,

SPEI,

PIX,

LBT,

MOMO,

CHAPS,

PAYID,

INTERAC,

INTERNAL_TRANSFER,

CIPS,

NEQUI,

FPS_UK,

FPS_HK,

INSTA_PAY,

PESONET

Example:

"BLOCKCHAIN"

quoteRail

enum<string>

Filter by quote asset transfer rail. Transfer rail:

BLOCKCHAIN - Transfer over the public blockchain
INTERNAL - Internal transfer within the same account (e.g. sub-accounts or same api key)
SWIFT - International wire transfer
IBAN - International Bank Account Number transfer
US_WIRE - Domestic wire transfer within the United States (e.g. FedWire)
ACH - Automated Clearing House transfer, typically takes longer but not as expensive as wire transfers
SEPA - Euro transfers within the SEPA zone
SPEI - Mexican interbank electronic payment system
PIX - Brazilian instant payment system
LBT - Local bank transfers
MOMO - Mobile money transfers (e.g. M-Pesa)
CHAPS - The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for transactions in the United Kingdom
PAYID - PayID payment identifier system (Australia)
INTERAC - Interac electronic funds transfer (Canada)
INTERNAL_TRANSFER - Internal transfer between accounts
CIPS - Cross-Border Interbank Payment System (China)
NEQUI - Nequi mobile payment (Colombia)
FPS_UK - UK Faster Payments (GBP)
FPS_HK - Hong Kong Faster Payment System (HKD)
INSTA_PAY - InstaPay instant payment (Philippines)
PESONET - PesoNet batch payment (Philippines)

Available options:

BLOCKCHAIN,

INTERNAL,

SWIFT,

IBAN,

US_WIRE,

ACH,

SEPA,

SPEI,

PIX,

LBT,

MOMO,

CHAPS,

PAYID,

INTERAC,

INTERNAL_TRANSFER,

CIPS,

NEQUI,

FPS_UK,

FPS_HK,

INSTA_PAY,

PESONET

Example:

"BLOCKCHAIN"

side

enum<string>

Filter by trading side. BUY or SELL also matches rows whose side is BOTH; BOTH matches rows of any side. Side of a trading pair. Same as Side, plus BOTH, meaning the pair applies to both BUY and SELL.

Available options:

BUY,

SELL,

BOTH

Example:

"BUY"

tradeClass

enum<string>

Filter by trade class. The class of trade a pair represents, derived from the asset class of each leg, the chains those assets settle on, where the trade executes, and the trading side:

SWAP_DEFI - Exchange between two crypto assets on the same chain, executed on-chain
SWAP_CEFI - Exchange between two crypto assets on the same chain, executed through a provider account
BRIDGE_DEFI - Exchange between two crypto assets on different chains, executed on-chain
BRIDGE_CEFI - Exchange between two crypto assets on different chains, executed through a provider account
INTERNAL_LEDGER - Exchange between two crypto assets settled on a provider's internal ledger, within a single provider account. Not split by chain, because neither leg settles on-chain while the trade executes
ON_RAMP - Buying a crypto asset with a fiat asset
OFF_RAMP - Selling a crypto asset for a fiat asset
FX - Exchange between two fiat assets
OTC - A pair quoted by an OTC desk: firm, short-lived RFQ commitments against a dealer, executed on credit rather than against an order book. Takes precedence over the asset-class values, so an OTC desk selling USDC for USD is OTC, not OFF_RAMP
UNKNOWN - The class could not be resolved, e.g. when the chain of an asset could not be determined. Callers should not route on a pair with this class

Available options:

SWAP_DEFI,

SWAP_CEFI,

BRIDGE_DEFI,

BRIDGE_CEFI,

INTERNAL_LEDGER,

ON_RAMP,

OFF_RAMP,

FX,

OTC,

UNKNOWN

Example:

"SWAP_DEFI"

providerId

string[]

Filter by provider ID. Repeat the parameter to match any of several providers, up to 50.

Maximum array length: 50

Minimum string length: 1

accountId

string[]

Filter by connected account ID. Repeat the parameter to match any of several accounts, up to 50.

Maximum array length: 50

Minimum string length: 1

prefunded

boolean

Filter by whether the pair requires prefunding.

min

string

An order-size filter, not a bound on the result. Only returns pairs whose own min field (the smallest base-asset amount the pair accepts) is at most this value, i.e. pairs that can serve an order of this size. For example, min=10 returns pairs with a min of 10 or less.

Pattern: ^\d+(\.\d+)?$

max

string

An order-size filter, not a bound on the result. Only returns pairs whose own max field (the largest base-asset amount the pair accepts) is at least this value. For example, max=1000 returns pairs with a max of 1000 or more.

Pattern: ^\d+(\.\d+)?$

pageSize

integer<int32>

default:100

Page size for pagination.

Required range: 1 <= x <= 1000

pageCursor

string

Page cursor for pagination.

Response

Trading pairs response

data

object[]

required

List of trading pairs.

Show child attributes

Example:

[
  {
    "providerId": "ACME",
    "accountId": "7f1a2b3c-9d4e-4a5b-8c6d-1e2f3a4b5c6d",
    "baseAssetId": "EUR",
    "quoteAssetId": "BTC",
    "quoteChain": "BTC",
    "side": "SELL",
    "tradeClass": "ON_RAMP",
    "baseAssetRail": "SEPA",
    "quoteAssetRail": "BLOCKCHAIN",
    "prefunded": false,
    "min": "10",
    "max": "100000"
  },
  {
    "providerId": "ACME",
    "baseAssetId": "*",
    "quoteAssetId": "*",
    "baseChain": "ETH",
    "quoteChain": "ETH",
    "side": "BOTH",
    "tradeClass": "SWAP_DEFI",
    "baseAssetRail": "BLOCKCHAIN",
    "quoteAssetRail": "BLOCKCHAIN"
  }
]

total

integer<int32>

Total number of trading pairs matching the query. Best-effort count; may be absent when results are aggregated across multiple providers.

Example:

2

string | null

A cursor for the next page of results, if available.

Example:

"cursor_abc123def456"

⌘I

TypeScript

const response: Promise<FireblocksResponse<TradingPairsListPage>> = fireblocks.trading.getTradingPairs(tradingApiGetTradingPairsRequest);

CompletableFuture<ApiResponse<TradingPairsListPage>> response = fireblocks.trading().getTradingPairs(baseAsset, quoteAsset, baseChain, quoteChain, baseRail, quoteRail, side, tradeClass, providerId, accountId, prefunded, min, max, pageSize, pageCursor);

response = fireblocks.trading.get_trading_pairs(base_asset, quote_asset, base_chain, quote_chain, base_rail, quote_rail, side, trade_class, provider_id, account_id, prefunded, min, max, page_size, page_cursor);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/trading/pairs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/trading/pairs"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/trading/pairs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "providerId": "ACME",
      "accountId": "7f1a2b3c-9d4e-4a5b-8c6d-1e2f3a4b5c6d",
      "baseAssetId": "EUR",
      "quoteAssetId": "BTC",
      "quoteChain": "BTC",
      "side": "SELL",
      "tradeClass": "ON_RAMP",
      "baseAssetRail": "SEPA",
      "quoteAssetRail": "BLOCKCHAIN",
      "prefunded": false,
      "min": "10",
      "max": "100000"
    },
    {
      "providerId": "ACME",
      "baseAssetId": "*",
      "quoteAssetId": "*",
      "baseChain": "ETH",
      "quoteChain": "ETH",
      "side": "BOTH",
      "tradeClass": "SWAP_DEFI",
      "baseAssetRail": "BLOCKCHAIN",
      "quoteAssetRail": "BLOCKCHAIN"
    }
  ],
  "total": 2,
  "next": "cursor_abc123def456"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "code": 900,
  "message": "Invalid base amount: must be greater than 0"
}

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

API Endpoints

Data Objects

Get trading pairs

Query Parameters

Response