Balance details

Get your balance details.

Retrieve details of a specific user’s balance. Please note that this is a Private πŸ”’ route which means it needs to be authorized by the account initiating this request.

Note: You will need to include the JWT Auth token to request headers to access this endpoint. To get the JWT Auth Token, refer the login section of the documentation.

Endpoint

GET /sapi/v1/user/balance/

Request Headers

{
  "Authorization": "JWT ***"
}

Query Params

FieldTypeMandatoryDescription

currency

STRING

NO

If the currency parameter is not specified, the whole list of balances will be returned.

Example

{baseurl}/sapi/v1/user/balance/?currency=eth

Response

{
  "status": "success",
  "message": "Retrieved Successfully",
  "payload": {
    "currency": "eth",
    "balance": "0.1959644",
    "locked": "0.0",
    "deposit_address": null
  }
}

Last updated