Get balance

What is left to spend. reserved is held against tasks still running and is released or charged when each one finishes.

GET/balance

AuthAPI keyorOAuth tokenHow to send it

Response

200Account balance

dataobjectrequired

balancestringrequired: Current account balance in USD.
reservedstringrequired: Amount reserved by in-flight tasks.
availablestringrequired: Spendable balance: balance minus reserved.
currency"usd"required

Errors

A failed call names what went wrong in code, with a sentence in message. The codes, which of them are worth retrying, and how to read a validation failure are on Errors.

Request

curl https://api.mynth.io/balance \
  -H "Authorization: Bearer $MYNTH_API_KEY"

Response

{
  "data": {
    "balance": "string",
    "reserved": "string",
    "available": "string",
    "currency": "usd"
  }
}