Home›API›Methods

getBalance

Check the balance

#Description

This method returns the funds available on the account.

Method URL

POSThttps://api.tokenwave.org/getBalance

Request format: JSON POST

#Request parameters

clientKeystringrequired

Your API key.

#Request example

curl -X POST https://api.tokenwave.org/getBalance \
  -H "Content-Type: application/json" \
  -d '{"clientKey": "YOUR_API_KEY"}'

import requests

res = requests.post("https://api.tokenwave.org/getBalance", json={"clientKey": "YOUR_API_KEY"}).json()
print(res["balance"])

const res = await fetch("https://api.tokenwave.org/getBalance", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ clientKey: "YOUR_API_KEY" }),
}).then((r) => r.json());
console.log(res.balance);

#Response structure

errorIdinteger

The error flag. 0 — no error, the balance is in balance. 1 — an error, its code is in errorCode.

errorCodestring

The error code, for example ERROR_KEY_DOES_NOT_EXIST. Present only when errorId is 1. All codes are listed in the Error codes section.

balancedecimal

The available funds in dollars, a floating-point number. The price of tasks in progress is already deducted.
Example: 345.678

#Response example

json

{ "errorId": 0, "balance": 345.678 }