Skip to main content
GET
Get Balance

Headers

PX-Key-Id
string
required

The key id issued for your signing keypair.

PX-Timestamp
string
required

Unix seconds at signing, valid within 30 seconds of the server clock.

PX-Signature
string
required

Ed25519 signature of the request

PX-Content-Sha256
string
required

Hex SHA-256 of the request body, or the SHA-256 of the empty string when there is no body.

Response

Balance assembled

available
number
required

Collateral available to place orders, in USD. Excludes collateral committed to your resting buy orders.

Required range: x >= 0
unconverted
number
required

Funds that must be converted before they can be used for orders, in USD.

Required range: x >= 0
claimable
number
required

Value from resolved markets that becomes cash once claimed, in USD.

Required range: x >= 0
total
number
required

Total value held at the venue, in USD: collateral (including collateral committed to resting orders) plus unconverted and claimable value. Unaffected by placing or cancelling an order.

Required range: x >= 0