List exchange accounts

GET

https://your-protect-instance.example.com/api/rest/v1/exchangeaccounts

GET

/api/rest/v1/exchangeaccounts

curl https://your-protect-instance.example.com/api/rest/v1/exchangeaccounts \
     -H "Authorization: Bearer <token>"

{
  "result": [
    {
      "id": "string",
      "exchange": "string",
      "account": "string",
      "currency": "string",
      "type": "string",
      "totalBalance": "string",
      "status": "string",
      "container": "string",
      "label": "string",
      "creationDate": "2024-01-15T09:30:00Z",
      "updateDate": "2024-01-15T09:30:00Z",
      "currencyInfo": {
        "name": "string",
        "symbol": "string",
        "coinTypeIndex": "string",
        "blockchain": "string",
        "isToken": true,
        "isERC20": true,
        "decimals": "string",
        "contractAddress": "string",
        "hasStaking": true,
        "isUTXOBased": true,
        "isAccountBased": true,
        "isFiat": true,
        "isFA12": true,
        "isFA20": true,
        "isNFT": true,
        "enabled": true,
        "id": "string",
        "displayName": "string",
        "type": "string",
        "wlcaId": "string",
        "network": "string",
        "tokenID": "string",
        "logo": "string"
      },
      "hasWLA": true,
      "displayLabel": "string",
      "baseCurrencyValuation": "string"
    }
  ],
  "cursor": {
    "currentPage": "string",
    "hasPrevious": true,
    "hasNext": true
  }
}

This endpoint returns a list of exchange accounts

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

currencyIDstringOptional

Filter on currency ID

includeBaseCurrencyValuationbooleanOptional

exchangeLabelstringOptional

sortOrderstringOptional

Set this parameter to ASC to get the id sorted in ASC order or DESC to get them in descending order. By default, the order is DESC.

cursor.currentPagestringOptional

Base64-encoded string representing the current window of data

cursor.pageRequeststringOptional

The page to request, w.r.t the current page. Can be one of FIRST, PREVIOUS, NEXT, LAST

cursor.pageSizestringOptionalformat: "uint64"

The size of the page requested. The handling service should impose a hard limit on this

statusstringOptional

Returns only exchange accounts that have this status. Leave empty to select all statuses.

onlyPositiveBalancebooleanOptional

Whether or not to exclude an exchangeAccount with a zero balance. Defaults to false (exchangeAccounts with 0 balance included).

Response

A successful response.

resultlist of objectsOptional

cursorobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error