Get Account Balance

The GET /balance/ method enables you to retrieve information related to your account balances for all Bitso-supported currencies.

HTTP Request

GET https://stage.bitso.com/api/v3/balance

Header Parameters

You must specify the following authorization parameters in your request:

Parameter	Description	Required
`key`	See the section, Authorization	Yes
`signature`	See the section, Authorization	Yes
`nonce`	See the section, Authorization	Yes

JSON Response Payload

The endpoint returns a JSON array, and every element in the array is a JSON object that includes the following fields:

Field Name	Description	Type	Units
`available`	The balance available for use in the given currency, resulting from the computation `available` = `total` - `locked`. The service does not store it, and it always calculates it when needed as opposed to the rest of the balances shown in this table that are stored.	String	Currency
`currency`	The currency in which the balances are specified.	String
`locked`	The balance locked away in open orders for the given `currency`. It is a subset of the `total` balance.	String	Currency
`total`	The total balance for the given currency. The service updates this figure when it completes a deposit or creates a withdrawal.	String	Currency

The following response object exemplifies the JSON object returned, showing only a few of its elements:

{
    "success": true,
    "payload": {
        "balances": [{
            "currency": "mxn",
            "total": "300.00",
            "locked": "25.1234",
            "available": "274.8766"
        }, {
            "currency": "btc",
            "total": "100.12345678",
            "locked": "25.00000000",
            "available": "75.12345678"
        }, {
            "currency": "eth",
            "total": "50.1234",
            "locked": "40.1234",
            "available": "10.0000"
        }]
    }
}