Account Notification
Subscribe to this topic to receive notifications about user balance update.
Rules
Topic name:
account
ApiKey requred: Yes
Parameters
This topic has an optional flag: v3
, which indicates the response is for v3 which has also include NFT info. if the flag is false or absent, the response is just like before.
accountId
(Optional) not required as apiKey also link to an account
v3
(Optional) If it's a v3 sub which contains NFT info, default is false for compatible with previous sub topic
Notification example
Data Model
Notification
If v3 is true
:
topic
JSON
Topic and parameters
ts
integer
Notification timestamp (milliseconds)
Otherwise:
topic
JSON
Topic and parameters
ts
integer
Notification timestamp (milliseconds)
BalanceV3
accountId
integer
Account ID
tokenId
integer
Token ID
total
string
Total token balance
locked
string
Token balance locked by orders
nftId
string
(Optional)NFT ID if it's NFT token
nftData
string
(Optional)NFT hash data if it's NFT token
tokenAddress
string
(Optional)NFT token address if it's NFT token
Balance
accountId
integer
Account ID
tokenId
integer
Token ID
totalAmount
string
Total token balance
amountLocked
string
Token balance locked by orders
Last updated