Search by name, SuiNS, address, digest, object ID, coin type or checkpoint.

API
account.get

Method

account.get

Your plan, credits used and left this month, and limits.

Details

Endpoint
GET /v0/account
Credits
Free
Rate class
Light. Counts against your light requests per second.

Returns the plan of the signed-in account, the credits used and left this month (Free stops at zero; paid plans keep working and report `overage`), and every limit of the plan: requests per second per class, streams, webhooks, keys and replay depth. Credits reset on the 1st (UTC).

Parameters

This method takes no parameters.

Request

Send your key in the x-api-key header, or leave it out to use the keyless tier.

curl
curl "https://api.tide.ad/v0/account" \
  -H "x-api-key: YOUR_API_KEY"
TypeScript
const res = await fetch("https://api.tide.ad/v0/account", {
  headers: {
    "x-api-key": process.env.TIDE_API_KEY!,
  },
});
const data = await res.json();

Response

JSON
{
  "address": "0x7d20dcdb2bca4f508ea9613994683eb4e76e9c4ed371169677c1be02aaf0b58e",
  "plan": "free",
  "month": "2026-11",
  "credits": {
    "used": 1200,
    "limit": 5000000,
    "remaining": 4998800,
    "overage": 0,
    "resetsAt": "2026-12-01T00:00:00.000Z"
  },
  "limits": {
    "plan": "free",
    "priceUsdMonth": 0,
    "creditsMonth": 5000000,
    "creditsDay": 0,
    "hardStop": true,
    "lightRps": 15,
    "heavyRps": 5,
    "streamRps": 2,
    "streams": 2,
    "webhooks": 5,
    "addressesPerWebhook": 10000,
    "keys": 3,
    "replayDays": 7,
    "overagePerMillionUsd": null
  },
  "keys": 1
}