Assets, Addresses, & Balance Fetching APIs

Multiple Assets and Balances

In some cases, you may want to display a list of assets & balances in a particular wallet.

API Reference

This first endpoint returns cached balances which may be out of date, but can be used on initial load.

Get all assets that exist in a certain wallet, by specifying a wallet ID

get

Authorizations

Path parameters

walletIdstringRequired

Wallet ID

Query parameters

sortBystring · enumOptional

Sort by

Default: createdAtAvailable options:

sortOrderstring · enumOptional

Sort order

Default: DESCAvailable options:

searchstringOptional

Search

fromDatestringOptional

toDatestringOptional

chainNamestring · enumOptionalAvailable options:

symbolstringOptionalExample: ETH

isVisiblebooleanOptional

Asset visibility status

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /api/v1/wallets/{walletId}/assets HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Accept: */*

200

Returns all assets belonging in a certain wallet ID

{
  "pagination": {},
  "assets": [
    {
      "userId": "text",
      "merchantId": "text",
      "chainId": "text",
      "userAssetAddress": "text",
      "walletId": "text",
      "configId": "text",
      "assetName": "text",
      "assetSymbol": "text",
      "balance": "text",
      "balanceUpdatedAt": {},
      "defaultAddress": "text",
      "isVisible": true,
      "source": "merchant",
      "addresses": [
        "text"
      ],
      "ownershipType": "text",
      "config": {
        "chainId": "text",
        "merchantId": "text",
        "chainName": "text",
        "name": "ALGORAND",
        "symbol": "ALGO",
        "verified": true,
        "isOffChain": true,
        "type": "COIN",
        "tokenStandard": "ERC_20",
        "assetIndex": 1,
        "description": "text",
        "ownershipType": "text",
        "multisigVersion": 1,
        "multisigSignerThreshold": 1,
        "status": "active",
        "createdByUserId": "text",
        "createdByMerchantId": "text",
        "chain": {
          "id": "6e464058-67c1-4273-a6a4-8aae522e34be",
          "name": "ALGORAND",
          "derivationPath": "m/84'/0'/0'/0/0",
          "addressRegex": "/^0x[a-fA-F0-9]{40}$/",
          "slip44": 1,
          "status": "UP",
          "indexUrl": "text",
          "chainId": 1
        },
        "createdByMerchant": {
          "name": "Republic",
          "nameSlugify": "republic",
          "verified": true,
          "contactEmail": "[email protected]",
          "contactPhoneNumber": "text",
          "usersCount": 1,
          "assetsCount": 1,
          "tokensCount": 1,
          "coinsCount": 1,
          "walletsCount": 1,
          "status": "active",
          "createdAt": "2025-04-24T06:48:05.350Z",
          "updatedAt": "2025-04-24T06:48:05.350Z",
          "createdAssets": [
            []
          ]
        },
        "createdByUser": {
          "id": "text",
          "externalUserId": "6e464058-67c1-4273-a6a4-8aae522e34be",
          "merchantId": "6e464058-67c1-4273-a6a4-8aae522e34be",
          "role": "republic_admin",
          "firstName": "Bryan",
          "walletsCount": 2,
          "latestWallabyAuthPubKey": "4ecb720b1392468c75803d6252ac987c113206955070b96df1208c1c480338168e1407cec4b5af2f91d12af9b725cbd85af994b29c6364971a7ef8d955be83dc",
          "latestWallabyAuthPubKeyVersion": "1",
          "hasFullPermissions": true
        }
      }
    }
  ]
}

This second endpoint returns real time balance which will also refresh the cache, however, it is less performant so should not be used on initial load.

Fetch assets' balance by providing an array of asset addresses and symbols

post

Authorizations

Body

assetsobject[]Required

Array of balance query

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /api/v1/query/assets/bulk-balance HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "assets": [
    {
      "address": "0x9bf4001d307dfd62b26a2f1307ee0c0307632d59",
      "assetSymbol": "ETH",
      "tokenStandard": "ERC_20",
      "tokenType": "ERC_20"
    }
  ]
}

200

Balance fetched successfully

{
  "balances": [
    {
      "address": "0x9bf4001d307dfd62b26a2f1307ee0c0307632d59",
      "assetSymbol": "ETH",
      "tokenStandard": "ERC_20",
      "tokenType": "ERC_20",
      "balance": "181.2939",
      "lockedTokenBalance": "181.2939",
      "stakedBalance": "399.2",
      "claimableBalance": "1.3",
      "assetConfigId": "text",
      "balanceUpdatedAt": {}
    }
  ]
}

Single Asset and Balance

API Reference

This first endpoint returns cached balances which may be out of date, but can be used on initial load.

Get one asset from a user's wallet

get

Authorizations

Query parameters

assetSymbolstringRequired

Asset symbol, for instance: USDT, ETH, ALGO, etc, ...

Example: USDT

blockchainNamestringRequired

Blockchain name

Example: ETHEREUM

Body

assetSymbolstringRequired

Asset symbol

Example: ETH

blockchainNamestring · enumRequired

Asset symbol

Example: ETHEREUMAvailable options:

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /api/v1/wallets/asset?assetSymbol=text&blockchainName=text HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "assetSymbol": "ETH",
  "blockchainName": "ETHEREUM"
}

{
  "userId": "text",
  "merchantId": "text",
  "chainId": "text",
  "userAssetAddress": "text",
  "walletId": "text",
  "configId": "text",
  "assetName": "text",
  "assetSymbol": "text",
  "balance": "text",
  "balanceUpdatedAt": {},
  "defaultAddress": "text",
  "isVisible": true,
  "source": "merchant",
  "addresses": [
    "text"
  ],
  "ownershipType": "text",
  "config": {
    "chainId": "text",
    "merchantId": "text",
    "chainName": "text",
    "name": "ALGORAND",
    "symbol": "ALGO",
    "verified": true,
    "isOffChain": true,
    "type": "COIN",
    "tokenStandard": "ERC_20",
    "assetIndex": 1,
    "description": "text",
    "ownershipType": "text",
    "multisigVersion": 1,
    "multisigSignerThreshold": 1,
    "status": "active",
    "createdByUserId": "text",
    "createdByMerchantId": "text",
    "chain": {
      "id": "6e464058-67c1-4273-a6a4-8aae522e34be",
      "name": "ALGORAND",
      "derivationPath": "m/84'/0'/0'/0/0",
      "addressRegex": "/^0x[a-fA-F0-9]{40}$/",
      "slip44": 1,
      "status": "UP",
      "indexUrl": "text",
      "chainId": 1
    },
    "createdByMerchant": {
      "name": "Republic",
      "nameSlugify": "republic",
      "verified": true,
      "contactEmail": "[email protected]",
      "contactPhoneNumber": "text",
      "usersCount": 1,
      "assetsCount": 1,
      "tokensCount": 1,
      "coinsCount": 1,
      "walletsCount": 1,
      "status": "active",
      "createdAt": "2025-04-24T06:48:05.350Z",
      "updatedAt": "2025-04-24T06:48:05.350Z",
      "createdAssets": [
        []
      ]
    },
    "createdByUser": {
      "id": "text",
      "externalUserId": "6e464058-67c1-4273-a6a4-8aae522e34be",
      "merchantId": "6e464058-67c1-4273-a6a4-8aae522e34be",
      "role": "republic_admin",
      "firstName": "Bryan",
      "walletsCount": 2,
      "latestWallabyAuthPubKey": "4ecb720b1392468c75803d6252ac987c113206955070b96df1208c1c480338168e1407cec4b5af2f91d12af9b725cbd85af994b29c6364971a7ef8d955be83dc",
      "latestWallabyAuthPubKeyVersion": "1",
      "hasFullPermissions": true
    }
  }
}

This second endpoint returns real time balance which will also refresh the cache, however, it is less performant so should not be used on initial load.

Fetch asset balance by specifying the asset address and the asset symbol

get

Authorizations

Query parameters

addressstringRequired

Asset valid address

Example: 0x9bf4001d307dfd62b26a2f1307ee0c0307632d59

assetSymbolstringRequired

Asset symbol, for instance: USDT, ETH, ALGO, etc, ...

Example: USDT

tokenStandardstring · enumOptional

Optional value only used when dealing with non native assets (aka tokens), it can be ERC_20, BEP_20, ALGO_STANDARD, ALGO_APP. If native asset, keep the field empty

Example: ERC_20Available options:

tokenTypestringRequired

Optional value only used when querying non native assets(tokens), it can be ERC_20, BEP_20, ALGO_STANDARD. If native asset, keep the field empty

Example: ERC_20

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /api/v1/query/assets/balance?address=text&assetSymbol=text&tokenType=text HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "address": "0x9bf4001d307dfd62b26a2f1307ee0c0307632d59",
  "assetSymbol": "ETH",
  "tokenStandard": "ERC_20",
  "tokenType": "ERC_20",
  "balance": "181.2939",
  "lockedTokenBalance": "181.2939",
  "stakedBalance": "399.2",
  "claimableBalance": "1.3",
  "assetConfigId": "text",
  "balanceUpdatedAt": {}
}

Address Book

API Reference

Using this API, you will need to filter down to get an asset from each chain and then pull the associated address.

Returns user assets by specifying user id

get

Authorizations

Path parameters

userIdstringRequired

User ID

Query parameters

sortBystring · enumOptional

Sort by

Default: createdAtAvailable options:

sortOrderstring · enumOptional

Sort order

Default: DESCAvailable options:

searchstringOptional

Search

fromDatestringOptional

toDatestringOptional

chainNamestring · enumOptionalAvailable options:

symbolstringOptionalExample: ETH

isVisiblebooleanOptional

Asset visibility status

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /api/v1/users/{userId}/assets HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Accept: */*

200

Returns user assets

{
  "pagination": {},
  "assets": [
    {
      "userId": "text",
      "merchantId": "text",
      "chainId": "text",
      "userAssetAddress": "text",
      "walletId": "text",
      "configId": "text",
      "assetName": "text",
      "assetSymbol": "text",
      "balance": "text",
      "balanceUpdatedAt": {},
      "defaultAddress": "text",
      "isVisible": true,
      "source": "merchant",
      "addresses": [
        "text"
      ],
      "ownershipType": "text"
    }
  ]
}