API reference · Credits
Balance and ledger
GET/api/creditsSigned in session
An account with no deposit is never gated. Once funded, a balance at or below zero answers 402 insufficient_credits on keyed requests.
Answer 200
Balance, recent ledger, and deposit configuration.
| Field | Type | What it is |
|---|---|---|
| funded | boolean | True once any deposit has landed. Only funded accounts are gated. |
| balanceMicros | integer or null | |
| ledger | array of object | |
| ledger[] | integer | |
| ledger[] | integer | Positive for money in (deposit, plan_credit, referral, reward), negative for money out (spend, hold, plan). |
| ledger[] | string | deposit: a claimed transfer or an operator credit. spend: a settled request. hold: the worst case reserved before a request, released as it settles. plan: a plan charge. plan_credit: credit a plan includes. referral and reward: referral and season rewards, credit that is not a deposit. price_lock_fund: credit moved into a price lock (negative) and price_lock_return: its remainder back at expiry (positive); price_lock_premium: a lock's premium. One of "deposit", "spend", "hold", "plan", "plan_credit", "referral", "reward", "price_lock_fund", "price_lock_premium", "price_lock_return", "storage", "studio_credit". |
| ledger[] | string or null | |
| ledger[] | integer | |
| holder | object | |
| holder. | boolean | False unless the token's address and a valid set of tiers are both set. |
| holder. | string or null | The ERC-20 contract the perk reads, lower case, or null before it exists. |
| holder. | integer | The chain the contract is on: 4663, Robinhood Chain. |
| holder. | integer | Whole tokens the lowest tier needs. |
| holder. | integer | The lowest tier's allowance bonus, micro USD. |
| holder. | array of object | Every tier, lowest bar first; empty while off. |
| holder. | string | |
| holder. | integer | Whole tokens the wallet must hold. |
| holder. | integer | Micro USD added to the lifetime free allowance. |
| holder. | number | The per key API rate limit is multiplied by this; 1 is no change. |
| holder. | integer | The per key API rate limit under this tier. |
| holder. | integer | Basis points off the operator's markup on what the holder's keys settle, never off the upstream's price; 0 where no markup is configured. |
| holder. | integer or null | Whole tokens in the signed in wallet at the last reading, or null before one. |
| holder. | object or null | The highest tier the last reading meets, or null. |
| holder. | object or null | The next tier up, or null at the top. |
| holder. | boolean | Holds any tier. |
| holder. | integer or null | Unix ms of the last reading. |
| deposits | object | |
| deposits. | boolean | False when the operator has set no deposit address. |
| deposits. | string or null | Where to send the deposit. Null until it is set. |
| deposits. | string or null | The network a claim uses when it names none. |
| deposits. | array of object | |
| deposits. | string | |
| deposits. | string | |
| deposits. | integer | |
| deposits. | integer | Blocks a transfer must be buried under. |
| deposits. | array of object | |
| deposits. | string | USDC or USDT; ANTI while $ANTI is the one way in. |
| deposits. | string | The one contract accepted for this symbol here. |
| deposits. | integer | Read from configuration, never assumed. |
| deposits. | boolean | True for $ANTI, which is not a dollar: credited at the credit price. |
| deposits. | string | The accepted networks, ready for a sentence. |
| deposits. | string | The accepted tokens, ready for a sentence. |
| deposits. | integer | The default network's depth. |
| deposits. | object | |
| deposits. | string | ANTI. |
| deposits. | integer | |
| deposits. | string | The token contract. |
| deposits. | integer | |
| deposits. | string or null | Where to buy it, or null. |
| deposits. | string or null | The credit price now, pico dollars per whole token, decimal text; null while there is none. |
| deposits. | integer or null | When the newest usable price sample was taken. |
| deposits. | integer or null | The most one claim is credited, micro USD. |
| deposits. | integer | Taken off the credit price; 0 unless set. |
| deposits. | string or null | Why there is no price, when there is none. |