List connected exchange accounts - Fireblocks Developer Docs

GET

exchange_accounts

paged

TypeScript

const response: Promise<FireblocksResponse<GetPagedExchangeAccountsResponse>> = fireblocks.exchangeAccounts.getPagedExchangeAccounts(exchangeAccountsApiGetPagedExchangeAccountsRequest);

{
  "exchanges": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "assets": [
        {
          "id": "<string>",
          "balance": "<string>",
          "lockedAmount": "<string>",
          "total": "<string>",
          "available": "<string>",
          "credit": "<string>",
          "assetId": "2306088f-97ed-4293-8d28-8ab627f272d7",
          "providerSymbol": "BTC",
          "assetSymbol": "BTC",
          "assetLegacyId": "BTC"
        }
      ],
      "success": true,
      "tradingAccounts": [
        {
          "type": "<string>",
          "name": "<string>",
          "assets": [
            {
              "id": "<string>",
              "balance": "<string>",
              "lockedAmount": "<string>",
              "total": "<string>",
              "available": "<string>",
              "credit": "<string>",
              "assetId": "2306088f-97ed-4293-8d28-8ab627f272d7",
              "providerSymbol": "BTC",
              "assetSymbol": "BTC",
              "assetLegacyId": "BTC"
            }
          ]
        }
      ],
      "isSubaccount": true,
      "mainAccountId": "<string>"
    }
  ],
  "paging": {
    "after": "<string>",
    "before": "<string>"
  },
  "prevUrl": "<string>",
  "nextUrl": "<string>"
}

Query Parameters

before

string

after

string

limit

number

default:3

required

number of exchanges per page

Required range: 1 <= x <= 5

Response

An ExchangeAccount object

exchanges

object[]

required

Show child attributes

paging

object

Show child attributes

prevUrl

string

nextUrl

string

Get a specific exchange accountReturns an exchange account by ID. Endpoint Permission: Admin, Non-Signing Admin.

⌘I

TypeScript

const response: Promise<FireblocksResponse<GetPagedExchangeAccountsResponse>> = fireblocks.exchangeAccounts.getPagedExchangeAccounts(exchangeAccountsApiGetPagedExchangeAccountsRequest);

{
  "exchanges": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "assets": [
        {
          "id": "<string>",
          "balance": "<string>",
          "lockedAmount": "<string>",
          "total": "<string>",
          "available": "<string>",
          "credit": "<string>",
          "assetId": "2306088f-97ed-4293-8d28-8ab627f272d7",
          "providerSymbol": "BTC",
          "assetSymbol": "BTC",
          "assetLegacyId": "BTC"
        }
      ],
      "success": true,
      "tradingAccounts": [
        {
          "type": "<string>",
          "name": "<string>",
          "assets": [
            {
              "id": "<string>",
              "balance": "<string>",
              "lockedAmount": "<string>",
              "total": "<string>",
              "available": "<string>",
              "credit": "<string>",
              "assetId": "2306088f-97ed-4293-8d28-8ab627f272d7",
              "providerSymbol": "BTC",
              "assetSymbol": "BTC",
              "assetLegacyId": "BTC"
            }
          ]
        }
      ],
      "isSubaccount": true,
      "mainAccountId": "<string>"
    }
  ],
  "paging": {
    "after": "<string>",
    "before": "<string>"
  },
  "prevUrl": "<string>",
  "nextUrl": "<string>"
}