API reference

API reference · Account

The signed in wallet's $ANTI, read live

GET/api/account/anti-balanceSigned in session

While paying in $ANTI is the one way in (ANTIMATTER_PAY_WITH=anti), the deposit flows' read of the wallet that signed in: balanceOf and the contract's decimals on Robinhood Chain, through the holder perk's RPC. Only the session's own wallet, a few times a minute at most, never stored and never cached. A 404 while paying in $ANTI is off; a 503 `balance_unreadable` when the chain does not answer.

Answer 200

The wallet's $ANTI now.

Fields of the 200 answer
FieldTypeWhat it is
walletrequiredstringThe wallet read, lower case.
rawrequiredstringBase units, decimal text.
decimalsrequiredintegerThe contract's own decimals.
readAtrequiredintegerWhen it was read, unix milliseconds.

Errors

  • 401OpenAI shaped error.
  • 404OpenAI shaped error.
  • 429OpenAI shaped error.
  • 503OpenAI 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.

Antimatter