v50

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-07-112650216.3 KB
Accounts

Get account overview

Returns the authenticated account profile, usage, pricing, billing estimate, and API keys.

get/v1/account/overview

Response

Account overview loaded.

Example response

{
  "profile": {
    "accountId": "acct_123",
    "email": "user@example.com",
    "provider": "google",
    "plan": "pro",
    "displayName": null
  },
  "usage": {
    "meters": {
      "hour": {},
      "day": {},
      "week": {},
      "twoWeeks": {},
      "month": {
        "scraper.tiktok.result_records": 1000,
        "scraper.tiktok.cost_usd_micros": 1700000
      },
      "quarter": {}
    }
  },
  "pricing": {
    "subscriptionUsdCentsPerMonth": 2000,
    "planBalanceUsdCentsPerMonth": 2000,
    "bonusBalanceUsdCentsPerMonth": 0,
    "includedBalanceUsdCentsPerMonth": 2000,
    "paidOveragesEnabled": false
  },
  "planCatalog": [
    {
      "plan": "plus",
      "limits": {
        "apiTokens": 100,
        "supportTicketsPerDay": 20
      },
      "pricing": {
        "subscriptionUsdCentsPerMonth": 2000,
        "planBalanceUsdCentsPerMonth": 2000,
        "bonusBalanceUsdCentsPerMonth": 0,
        "includedBalanceUsdCentsPerMonth": 2000,
        "paidOveragesEnabled": false
      }
    }
  ],
  "billingEstimate": {
    "currency": "USD",
    "plan": "plus",
    "paidOveragesEnabled": false,
    "subscriptionUsdMicrosPerMonth": 20000000,
    "planBalanceUsdCentsPerMonth": 2000,
    "bonusBalanceUsdCentsPerMonth": 0,
    "includedBalanceUsdCentsPerMonth": 2000,
    "topUpBalanceUsdMicros": 0,
    "topUpMinimumUsdCents": 2000,
    "topUpMaximumUsdCents": 100000,
    "topUpExpiresAfterInactiveDays": 365,
    "autoTopUpEnabled": false,
    "autoTopUpThresholdUsdCents": 500,
    "autoTopUpAmountUsdCents": 2000,
    "autoTopUpMonthlyLimitUsdCents": 100000,
    "currentMonthBonusBalanceUsedUsdMicros": 0,
    "currentMonthPlanBalanceUsedUsdMicros": 1700000,
    "currentMonthTopUpBalanceUsedUsdMicros": 0,
    "currentMonthOverageUsdMicros": 0,
    "estimatedMonthlyTotalUsdMicros": 20000000,
    "lineItems": [
      {
        "product": "tiktok",
        "meter": "scraper_result_records",
        "currentMonthUsed": 1000,
        "includedPerMonth": null,
        "billableAmount": 1000,
        "usageUnit": "result",
        "billingUnit": "result",
        "billingUnitSize": 1,
        "priceUsdMicrosPerBillingUnit": null,
        "estimatedUsdMicros": 1700000,
        "estimateBasis": "stored_scrape_requests",
        "rounding": "actual_scraper_cost"
      }
    ],
    "nextActions": [
      "plus scraper usage is within monthly balance. Bonus balance is spent before paid plan balance.",
      "Fetch saved results or create another public-data scraper request when you need fresh data."
    ]
  },
  "apiKeys": [
    {
      "id": "key_123",
      "name": "analytics agent",
      "tokenPrefix": "tovuk_key_1234",
      "createdAt": "2026-06-23T12:00:00Z",
      "lastUsedAt": null,
      "revokedAt": null,
      "currentDayRequestCount": 0,
      "currentMonthRequestCount": 0
    }
  ]
}