API reference · Account
What the signed in wallet holds, and its holder tier
GET/api/account/holderSigned in session
The balance of the token in the wallet that signed in, read with balanceOf over the contract's decimals on Robinhood Chain, the tier it earns and what the next tier needs. A reading missing or older than an hour is taken first, a few times a minute at most; past that, and when the chain does not answer, the last reading stands. A tier can widen the lifetime free allowance and multiply the per key API rate limit; nothing is priced differently. Off unless the deployment set ANTIMATTER_TOKEN_ADDRESS and either ANTIMATTER_HOLDER_TIERS or ANTIMATTER_HOLDER_PERK_MIN with ANTIMATTER_HOLDER_PERK_BONUS_MICROS.
Answer 200
The perk and the wallet's last reading.
| Field | Type | What it is |
|---|---|---|
| enabled | boolean | False unless the token's address and a valid set of tiers are both set. |
| token | string or null | The ERC-20 contract the perk reads, lower case, or null before it exists. |
| chainId | integer | The chain the contract is on: 4663, Robinhood Chain. |
| minWhole | integer | Whole tokens the lowest tier needs. |
| bonusMicros | integer | The lowest tier's allowance bonus, micro USD. |
| tiers | array of object | Every tier, lowest bar first; empty while off. |
| tiers[] | string | |
| tiers[] | integer | Whole tokens the wallet must hold. |
| tiers[] | integer | Micro USD added to the lifetime free allowance. |
| tiers[] | number | The per key API rate limit is multiplied by this; 1 is no change. |
| tiers[] | integer | The per key API rate limit under this tier. |
| tiers[] | 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. |
| heldWhole | integer or null | Whole tokens in the signed in wallet at the last reading, or null before one. |
| tier | object or null | The highest tier the last reading meets, or null. |
| nextTier | object or null | The next tier up, or null at the top. |
| qualifies | boolean | Holds any tier. |
| checkedAt | integer or null | Unix ms of the last reading. |
Errors
- 401OpenAI shaped error.
Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.