API reference · Account
This account's referral code, link and results
GET/api/account/referralSigned in session
A link `/?ref=<code>` on any page is remembered by the browser and attached at the sign in that creates an account, never later and never to the same wallet. When that account's first qualifying deposit is claimed, the referee gets ANTIMATTER_REFERRAL_REWARD_MICROS and the referrer ANTIMATTER_REFERRAL_REFERRER_MICROS as credit, once. Off unless either is set, and then the answer is `{ enabled: false }` alone and no code is drawn.
Answer 200
The program and this account's place in it.
| Field | Type | What it is |
|---|---|---|
| enabledrequired | boolean | False unless the deployment set a referral reward. |
| code | string | Eight symbols, random, stable for the account. |
| link | string | The link on this deployment's public origin. |
| refereeRewardMicros | integer | Credit the referred account gets; 0 for none. |
| referrerRewardMicros | integer | Credit this account gets per referral; 0 for none. |
| minDepositMicros | integer | The smallest claim that qualifies; 0 for any. |
| maxRewardedReferrals | integer or null | How many referrals may pay one wallet, ever. |
| signedUp | integer | Accounts created through this account's link. |
| qualified | integer | Of those, how many made a qualifying deposit. |
| rewardedReferrals | integer | Referrals that paid this wallet, across its accounts. |
| capReached | boolean | |
| earnedMicros | integer | Every referral credit on this account's ledger. |
| welcomePending | boolean | This account came through a link and its reward waits on a qualifying deposit. |
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.