Appearance
Balance updated
SEND Server to Client on wss://api.valr.com/ws/account
Sent when any currency balance changes on your account. Includes available, reserved, and total balances along with lending and borrowing amounts.
Authentication
This operation requires API key authentication (HMAC-SHA512 via query parameters or in-band AUTHENTICATE message).
Message
Event type: BALANCE_UPDATE
Payload Schema
| Property | Type | Required | Description |
|---|---|---|---|
| currency | object | Yes | - |
| available | string | Yes | - |
| reserved | string | Yes | - |
| total | string | Yes | - |
| updatedAt | string | Yes | - |
| lendReserved | string | Yes | - |
| borrowCollateralReserved | string | Yes | - |
| borrowedAmount | string | Yes | - |
| totalInReference | string | Yes | - |
| totalInReferenceWeighted | string | Yes | - |
| referenceCurrency | string | Yes | - |
Example
json
"{\n \"type\": \"BALANCE_UPDATE\",\n \"data\": {\n \"currency\": {\n \"id\": 1,\n \"shortName\": \"BTC\",\n \"longName\": \"Bitcoin\",\n \"decimalPlaces\": 8\n },\n \"available\": \"0.50000000\",\n \"reserved\": \"0.10000000\",\n \"total\": \"0.60000000\",\n \"updatedAt\": \"2024-09-27T12:30:00.000Z\",\n \"lendReserved\": \"0\",\n \"borrowCollateralReserved\": \"0\",\n \"borrowedAmount\": \"0\",\n \"totalInReference\": \"342000.00\",\n \"totalInReferenceWeighted\": \"342000.00\",\n \"referenceCurrency\": \"ZAR\"\n }\n}"Channel
Channel: account Address: wss://api.valr.com/ws/account