Subscription Request
In order to subscribe to the balance feed, a message of type subscribe must be sent.
| Parameter | Description | Type |
|---|---|---|
| body{} | An object used to restrict what is returned in the subscription. This must be included but can be empty. | object |
| messageType | Subscription message type -subscribe | string |
| topic | Topic to subscribe to -balances for the balance feed. Can be omitted. | string |
| useMultiChainAssetFormat | Include chain in asset names, e.g.AAVE.ETH vs. AAVE for the balance feed. Can be omitted. Default is false | boolean |
| key | Your public key | string |
| passphrase | Your passphrase | string |
| timestamp | Time in seconds since Unix Epoch | string |
| signature | Your hmac signature | string |
Subscription Response
Upon successfully subscribing, you will receive an initial-balance message, which includes a snapshot of all current account balances that meet your subscription criteria.
| Parameter | Description | Type |
|---|---|---|
| account_id | Unique ID of the specific account | string |
| participant_code | The code of the participant that owns the account | string |
| account_group | The group that the account is a part of | string |
| account_label | The account label to filter the response by | string |
| account_type | The type of account - available, collateral, payable, receivable, or collateral_deficiency | string |
| asset | The asset code for the specific account, e.g., USD | string |
| balance | The balance in the account | string |
| run_id | A unique ID for the particular run | int |
| run_type | The type of run | string |