LogoLogo
CSPR.build Portal
1.0.x
1.0.x
  • Documentation
    • Introduction
    • Overview
      • Authorization
      • Rate limits and quotas
      • Pagination
      • Sorting
      • Filtering
      • Optional properties
      • Errors
    • Getting started
    • Highlights
      • Including related entities
      • Including CSPR rates
      • Including account info
      • Accessing auction data
      • Accessing token data
      • Accessing NFT data
      • De-anonymizing account hashes
      • De-anonymizing account purses
      • Receiving contract-level events
    • Changelog
  • REST API
    • Reference
    • Account
      • Get account
      • Get accounts
    • Account Info
      • Get account info
      • Get account infos
    • Auction metrics
      • Get auction metrics
    • Awaiting deploy
      • Create Awaiting Deploy
      • Add Awaiting Deploy signatures
      • Get Awaiting Deploy
    • Block
      • Get block
      • Get blocks
      • Get validator blocks
    • Bidder
      • Get bidder
      • Get bidders
    • Contract
      • Get contract
      • Get contracts
      • Get contracts by contract package
      • Get contract types
    • Contract entry point
      • Get contract entry points
      • Get contract entry point costs
    • Contract package
      • Get contract package
      • Get contract packages
      • Get account contract packages
    • Delegation
      • Get account delegations
      • Get validator delegations
    • Delegator reward
      • Get account delegator rewards
      • Get delegator total rewards
    • Deploy
      • Get deploy
      • Get deploys
      • Get account deploys
      • Get block deploys
      • Get deploy execution types
    • Fungible token action
      • Get fungible token actions
      • Get fungible token action types
      • Get account fungible token actions
      • Get contract package fungible token actions
    • Fungible token ownership
      • Get account fungible token ownership
      • Get contract package fungible token ownership
    • Non-fungible token (NFT)
      • Get NFT
      • Get account NFTs
      • Get contract package NFTs
      • Get NFT standards
      • Get off-chain NFT metadata statuses
    • Non-fungible token (NFT) action
      • Get contract package NFT actions for a token
      • Get account NFT actions
      • Get contract package NFT actions
      • Get NFT action types
    • Non-fungible token (NFT) ownership
      • Get contract package NFT ownership
      • Get account NFT ownership
    • CSPR rate
      • Get the current currency rate
      • Get historical currency rates
      • Get currencies
    • CSPR supply
      • Get supply
    • Transfer
      • Get account transfers
      • Get deploy transfers
    • Validator
      • Get validator
      • Get validators
    • Validator performance
      • Get historical validator performance
      • Get historical average validator performance
      • Get historical average validators performance
    • Validator reward
      • Get validator rewards
      • Get validator total rewards
  • Streaming API
    • Reference
    • Account balance
    • Block
    • Contract
    • Contract package
    • Contract-level events
    • Deploy
    • Fungible token action
    • Non-fungible token (NFT)
    • Non-fungible token (NFT) action
    • Transfer
  • Casper Node API
    • Connecting with an SDK
Powered by GitBook
On this page
  • Properties
  • Optional properties
  • Endpoint
  • Query params
  • Events
  • Response
  • Example
  1. Streaming API

Account balance

The account balance events stream provides updates about account balance changes

Properties

The AccountBalance entity has the following properties:

Property
Type
Description

account_hash

string(64)

Account hash

liquid_balance

uint64

Account liquid balance

staked_balance

uint64

Account staked balance

undelegating_balance

uint64

Account undelegating balance

Optional properties

None

Endpoint

GET /account-balances

Query params

Property
Type
Description

account_hash

string

Comma-separated account hashes

public_key

string

Comma-separated account public keys

Events

Event
Description

updated

Notifies about account balance updates

Response

Example

wscat -c 'wss://streaming.testnet.cspr.cloud/account-balances?account_hashes=d38f71a113bb46e2cb7d46cd1c14427a3e077f67d8dad15e9c0bb91b7b8a82d9' \
  -H 'authorization: 55f79117-fc4d-4d60-9956-65423f39a06a'
{
  "data": {
    "account_hash": "d38f71a113bb46e2cb7d46cd1c14427a3e077f67d8dad15e9c0bb91b7b8a82d9",
    "liquid_balance": 18761763338560,
    "staked_balance": 0,
    "undelegated_balance": 0
  },
  "action": "updated",
  "extra": {
    "deploy_hash": "71d954db5263876d74d8553f92ba12d5dd2f0df8ad030b0f5aa5687d87da696e"
  },
  "timestamp": "2024-02-26T17:13:09.285952786Z"
}
PreviousReferenceNextBlock

Last updated 1 year ago

<AccountBalance>
WebSocketMessage