Balance

GET /v1/balance returns the ledger, the reserve, and the amount a new request can spend. Amounts are ngonka.

On this page

Fields

GET https://api.openbroker.gonka.gg/v1/balance

Same obk- key as inference. No dashboard session required, so a backend job can poll it.

bash

curl "https://api.openbroker.gonka.gg/v1/balance" \
  -H "Authorization: Bearer obk-YOUR_API_KEY"

json

{
  "status": "active",
  "balance_ngonka": 96730000000,
  "reserved_ngonka": 0,
  "min_reserve_ngonka": 10000000000,
  "available_ngonka": 86730000000
}

Fields

Field	Meaning
`status`	`active` or a pre-activation status.
`balance_ngonka`	Ledger total, in ngonka.
`reserved_ngonka`	Amount held and not spendable.
`min_reserve_ngonka`	Floor that new requests cannot consume.
`available_ngonka`	`balance - reserved - min_reserve`, floored at 0. Inference stops when this is 0.

1 GNK = 1,000,000,000 ngonka. The sample above is 96.73 GNK on the ledger and 86.73 GNK available.

The dashboard balance is the same ledger. The deposit address is how you add to it. See Deposits.

A chat call with available at 0 returns 402 broker GNK reserve exhausted and is not forwarded.

Balance

Fields

Related