Path Parameters
- principalstringREQUIRED
Stacks account or contract principal.
Query Parameters
- limitinteger
Number of results per page
- cursorstring
(Optional) Cursor for paginating principal balance changes across multiple transactions. Format:
<block_height>:<microblock_sequence>:<tx_index>:<asset_type>:<asset_identifier>.
- tx_idarrayREQUIRED
Transaction IDs to query balance changes for. Provide as repeated querystring values (
?tx_id=A&tx_id=B) or as a single comma-separated value (?tx_id=A,B).
Returns
- totalinteger
Total number of matching records.
- limitinteger
Number of results per page
- cursorobject
Cursor metadata for this page of results.
- nextstring | null
Cursor for the next page, or null when there is no next page.
- previousstring | null
Cursor for the previous page, or null when there is no previous page.
- currentstring
Cursor identifying the current page.
- resultsarray
Items returned for the current page.
- tx_idstring
Transaction ID
- assetobject
Asset associated with the balance change.
Response variant.
- typestring
Discriminator identifying the record or transaction variant.
Response variant.
- typestring
The asset type that was affected by the balance change.
- identifierstring
The identifier of the asset that was affected by the balance change.
- typestring
Discriminator identifying the record or transaction variant.
- balance_changeobject
Change in the asset balance.
- sentstring
Amount sent by the principal
- receivedstring
Amount received by the principal
- netstring
Net balance change for the principal
1{2"total": 1,3"limit": 1,4"cursor": {5"next": null,6"previous": null,7"current": "8702017:2147483647:5:1:stx"8},9"results": [10{11"tx_id": "0x7793237893fe95cd64e8ba44c798ae7e42a51d90515f16d7bf4810a1f512c0a8",12"asset": {13"type": "stx"14},15"balance_change": {16"sent": "579",17"received": "0",18"net": "-579"19}20}21]22}
1{2"total": 1,3"limit": 1,4"cursor": {5"next": null,6"previous": null,7"current": "8702017:2147483647:5:1:stx"8},9"results": [10{11"tx_id": "0x7793237893fe95cd64e8ba44c798ae7e42a51d90515f16d7bf4810a1f512c0a8",12"asset": {13"type": "stx"14},15"balance_change": {16"sent": "579",17"received": "0",18"net": "-579"19}20}21]22}