accountStatus
Reads an account's tier, its period, the units used and left, and its limits.
Cost: Free. Signed by the owner over method
GET, path/account/v1/<address lowercased>/statusand no body (the hash of no bytes), or sent with the account's key inARCGATE-KEY.Inputs:
address(path), any letter case.Returns:
tier,scheduledTier(the tier the next renewal runs at, null when none is scheduled),periodStart,periodEndandgraceEnd,state(running,graceorlapsed),units(period,usedandleft),credit(the overagebalancein USDC base units andper1000Units, what 1,000 units cost from it at the tier now),limits, which are the tier's as the config holds them now,linkedBoxes(each box's address, when it was linked and the id of the key that linked it, null for the owner's signature) andnotices, what happened to the account in this period that its owner is told of, newest first. Abox_linkednotice names the box and the key. Aunits_warningorunits_used_upnotice gives theperiod's units, how many wereusedand thecreditthen. Aperiod_ending_firstorperiod_ending_lastnotice gives theperiodEndand thegraceEnd. Alapsednotice gives them too, thecreditand each linked box with the allowance it runs on now.Errors:
404
account_not_found: the address has no account. Create one withaccountCreate.403
key_wrong_account: the key belongs to another account than the address in the path.
Next:
tradeSearch: spend the units with the key.boxLink: link a box to the account.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | The account owner's address, any letter case. One account per address, and a signed request must be signed by it. | |
| agentSignature | No | The owner's EIP-712 signature over this request, as the AGENT-SIGNATURE, AGENT-NONCE and AGENT-EXPIRY headers carry it over HTTP. Sign the typed data `AccountRequest` (not `AgentRequest`) with fields `origin` (the API's base URL with no trailing slash: the URL this request is sent to less its path, for example `https://api.arcgate.dev`; over MCP the same, not the /mcp URL), `address` (the owner), `method`, `path`, `bodyHash`, `nonce` and `expiry`, in that order. A signature made for another deployment's origin is a 401 invalid_signature, under the domain {name: "arcgate", version: "1"} with no chainId (a wallet that can only sign with one may add the chainId of the chain this deployment serves). The `path` is the request path with the address lowercased. The `bodyHash` is the keccak256 of the canonical JSON of the body you send (sorted keys, no whitespace), or of no bytes when there is none. Each nonce is accepted once per owner. Omitting it is a 401 signature_required, never a charge. |