Get the balance, at wallet level, for a specific asset

POST

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

POST

/api/rest/v1/asset/wallets

curl -X POST https://your-protect-instance.example.com/api/rest/v1/asset/wallets \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "asset": {
    "currency": "string"
  }
}'

{
  "wallets": [
    {
      "id": "string",
      "balance": {
        "totalConfirmed": "string",
        "totalUnconfirmed": "string",
        "availableConfirmed": "string",
        "availableUnconfirmed": "string",
        "reservedConfirmed": "string",
        "reservedUnconfirmed": "string"
      },
      "currency": "string",
      "coin": "string",
      "name": "string",
      "container": "string",
      "seed": "string",
      "accountPath": "string",
      "isOmnibus": true,
      "creationDate": "2024-01-15T09:30:00Z",
      "updateDate": "2024-01-15T09:30:00Z",
      "customerId": "string",
      "comment": "string",
      "disabled": true,
      "blockchain": "string",
      "addressesCount": "string",
      "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"
      },
      "attributes": [
        {
          "key": "string",
          "value": "string",
          "id": "string",
          "contentType": "string",
          "owner": "string",
          "type": "string",
          "subtype": "string",
          "isfile": true
        }
      ],
      "network": "string",
      "visibilityGroupID": "string",
      "externalWalletId": "string"
    }
  ],
  "totalItems": "string",
  "next": "string",
  "cursor": {
    "currentPage": "string",
    "hasPrevious": true,
    "hasNext": true
  }
}

Retrieve the wallet level balance for a specific asset. An asset is identified by the currency parameter. Optionally, set kind to “NFT” or “Unknown” for additional filtering. If kind is “Unknown”, the “unknown” object can further filter balances by blockchain, arg1, and arg2 (e.g., blockchain, contract number, and token ID).

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

assetobjectRequired

limitstringOptionalformat: "uint64"

cursorstringOptionalformat: "byte"

walletIdstringOptionalformat: "uint64"

Filters for asset positions of a specific wallet

walletNamestringOptional

requestCursorobjectOptional

Response

A successful response.

walletslist of objectsOptional

totalItemsstringOptionalformat: "uint64"

nextstringOptionalformat: "byte"

cursorobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error