Embedded Wallets

Retrieve asset balance

Get balance for specific asset, under a specific account

get/ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balance

Request

Base URL
https://api.fireblocks.io/v1
Auth
none declared
TypeScript
https://skmtc.dev/fireblocks/apis/fireblocks-api/docs/ncw/wallets/:walletId/accounts/:accountId/assets/:assetId/balance/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

walletIdstring required

Wallet Id

accountIdstring required

The ID of the account

assetIdstring required

The ID of the asset

Response

Successful response

idstring required

Unique identifier of the asset balance entry

totalstring required

Total balance amount for the asset in the account (including pending, locked, and available)

availablestring required

The balance available for use or withdrawal

pendingstring required

Amount pending confirmation from blockchain (e.g., unconfirmed deposits)

frozenstring required

Balance that is frozen due to policy or regulatory lock

lockedAmountstring required

Funds locked for operations such as staking or delegation

blockHeightstring

Latest known blockchain height when balance was fetched

blockHashstring

Hash of the blockchain block associated with the current balance state

Example response

{
  "id": "BTC-mainnet-acc-01",
  "total": "0.87500000",
  "available": "0.84500000",
  "pending": "0.01500000",
  "frozen": "0.00500000",
  "lockedAmount": "0.01000000",
  "blockHeight": "8459341",
  "blockHash": "0000000000000000000769e73a0b8f32a6c5d55e0d64f9ec20c6c3d4e5a9a3f1",
  "rewardInfo": {
    "pendingRewards": "5"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.