UNLOCK API
getBalance

getBalance

Returns the account balance in US dollars.
POSThttps://unlock-api.com/getBalance

Request parameters

clientKey
StringRequired
Your API key, 32 characters, from the account page.

Request

POST /getBalance
{
  "clientKey": "YOUR_API_KEY"
}

Response

Success
{
  "errorId": 0,
  "balance": 42.5
}

Response fields

errorId
Integer
0 when the request worked, 1 when it did not.
balance
Number
Balance in US dollars.

Code samples

curl -s https://unlock-api.com/getBalance \
  -H "Content-Type: application/json" \
  -d '{"clientKey":"YOUR_API_KEY"}'

Errors this method can return