GET/v1/account
Which account your key belongs to, your credit balance, and where to top it up.
Request
GET /v1/account. Needs x-api-key. No parameters.
curl "$API/v1/account" -H "x-api-key: $KEY"Response
| Field | Meaning |
|---|---|
accountId | Which account this key belongs to; quote it in support requests |
displayName | The account's name, as the app shows it |
apiKeyCreatedAt | When the key sent with this request was minted, unix seconds; null if unknown |
balance | Credits available; fractional, since a top-up buys TAO ÷ taoPerCredit |
pending | Credits held by pending exchanges |
depositAddress | Top-up address, or null |
reservationCost | Credits per exchange |
creditAsset | Asset accepted for credits |
taoPerCredit | TAO that buys one credit right now; null while the price is unknown |
minTopUpTao | Smallest deposit that is credited, in TAO |
{
"accountId": "9f1c2e4a-7b3d-4c58-9e21-0a1b2c3d4e5f",
"displayName": "swift-otter-4821",
"apiKeyCreatedAt": 1756900000,
"balance": 3,
"pending": 1,
"depositAddress": "5HGjWAeFDfFCWPsjFQdVV2Msvz2XtMktvgocEZcCj68kUMaw",
"reservationCost": 1,
"creditAsset": "alpha token",
"taoPerCredit": "0.0066",
"minTopUpTao": "0.03"
}Errors
| HTTP | Code | Extra fields | When |
|---|---|---|---|
| 401 | unauthorized | — | Missing or invalid x-api-key |
| 403 | geo_blocked | — | Request from a blocked region |
| 429 | rate_limited | retryAfter | Over the limit; see Rate limits |
Notes
- Call this first when a key is handed to you:
displayNameandaccountIdsay whose account you are spending from, and several keys on several accounts are easy to mix up. - Regenerating a key invalidates the old one, so a key that still authenticates is the current one and
apiKeyCreatedAtsays when it was minted. A401means the key was replaced or revoked. - To top up, send TAO to
depositAddress; one credit coststaoPerCredit, and deposits underminTopUpTaoare not credited. No API write is needed. See Credits. - Each exchange costs
reservationCostcredits.