Accounts

Get usage

Changed on Jul 2, 2026

Returns account profile, usage totals, current scraper pricing, and current-month cost estimates.

get/v1/usage

Request

Base URL
https://api.tovuk.com
Auth
HTTP bearer

Response

Account usage 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
  },
  "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."
    ]
  }
}

Changes

Jul 2, 2026c7b37eaf7c38 Revision changes
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property from the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Jun 5, 20263985c6090c91 Revision changes
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property's maxLength was unset from 1000 for the response status
- breaking
  the response property's maxLength was unset from 1000 for the response status
- breaking
  the response property's maxLength was unset from 1000 for the response status
- breaking
  the response property's maxLength was unset from 1000 for the response status
- breaking
  the /// response property's maxLength was unset from 128 for the response status
- breaking
  the response property's maxLength was unset from 240 for the response status
- breaking
  the response property's maxLength was unset from 240 for the response status
- breaking
  the response property's maxLength was unset from 240 for the response status
- breaking
  the response property's maxLength was unset from 240 for the response status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property /// from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  the optional response header Retry-After removed for the status 200
- warning
  the optional response header Retry-After removed for the status 400
- warning
  the optional response header Retry-After removed for the status 401
- warning
  the optional response header Retry-After removed for the status 500
- info
  removed the USD enum value from the / response property for the response status
- info
  removed the database_unavailable enum value from the response property for the response status
- info
  removed the database_unavailable enum value from the response property for the response status
- info
  removed the database_unavailable enum value from the response property for the response status
- info
  removed the database_unavailable enum value from the response property for the response status
- info
  removed the invalid_cpu_limit enum value from the response property for the response status
- info
  removed the invalid_cpu_limit enum value from the response property for the response status
- info
  removed the invalid_cpu_limit enum value from the response property for the response status
- info
  removed the invalid_cpu_limit enum value from the response property for the response status
- info
  removed the invalid_health_endpoint enum value from the response property for the response status
- info
  removed the invalid_health_endpoint enum value from the response property for the response status
- info
  removed the invalid_health_endpoint enum value from the response property for the response status
- info
  removed the invalid_health_endpoint enum value from the response property for the response status
- info
  removed the invalid_memory_limit enum value from the response property for the response status
- info
  removed the invalid_memory_limit enum value from the response property for the response status
- info
  removed the invalid_memory_limit enum value from the response property for the response status
- info
  removed the invalid_memory_limit enum value from the response property for the response status
- info
  removed the invalid_port enum value from the response property for the response status
- info
  removed the invalid_port enum value from the response property for the response status
- info
  removed the invalid_port enum value from the response property for the response status
- info
  removed the invalid_port enum value from the response property for the response status
- info
  removed the invalid_service_name enum value from the response property for the response status
- info
  removed the invalid_service_name enum value from the response property for the response status
- info
  removed the invalid_service_name enum value from the response property for the response status
- info
  removed the invalid_service_name enum value from the response property for the response status
- info
  removed the invalid_toml enum value from the response property for the response status
- info
  removed the invalid_toml enum value from the response property for the response status
- info
  removed the invalid_toml enum value from the response property for the response status
- info
  removed the invalid_toml enum value from the response property for the response status
- info
  removed the missing_command enum value from the response property for the response status
- info
  removed the missing_command enum value from the response property for the response status
- info
  removed the missing_command enum value from the response property for the response status
- info
  removed the missing_command enum value from the response property for the response status
- info
  removed the missing_config enum value from the response property for the response status
- info
  removed the missing_config enum value from the response property for the response status
- info
  removed the missing_config enum value from the response property for the response status
- info
  removed the missing_config enum value from the response property for the response status
- info
  removed the missing_source_archive enum value from the response property for the response status
- info
  removed the missing_source_archive enum value from the response property for the response status
- info
  removed the missing_source_archive enum value from the response property for the response status
- info
  removed the missing_source_archive enum value from the response property for the response status
- info
  removed the payment_required enum value from the response property for the response status
- info
  removed the payment_required enum value from the response property for the response status
- info
  removed the payment_required enum value from the response property for the response status
- info
  removed the payment_required enum value from the response property for the response status
- info
  removed the policy_rejected enum value from the response property for the response status
- info
  removed the policy_rejected enum value from the response property for the response status
- info
  removed the policy_rejected enum value from the response property for the response status
- info
  removed the policy_rejected enum value from the response property for the response status
- info
  removed the rate_limited enum value from the response property for the response status
- info
  removed the rate_limited enum value from the response property for the response status
- info
  removed the rate_limited enum value from the response property for the response status
- info
  removed the rate_limited enum value from the response property for the response status
- info
  response property checkout_url list-of-types was narrowed by removing types null from media type application/json of response 400
- info
  response property checkout_url list-of-types was narrowed by removing types null from media type application/json of response 401
- info
  response property checkout_url list-of-types was narrowed by removing types null from media type application/json of response 429
- info
  response property checkout_url list-of-types was narrowed by removing types null from media type application/json of response 500
- info
  response property docs_url list-of-types was narrowed by removing types null from media type application/json of response 400
- info
  response property docs_url list-of-types was narrowed by removing types null from media type application/json of response 401
- info
  response property docs_url list-of-types was narrowed by removing types null from media type application/json of response 429
- info
  response property docs_url list-of-types was narrowed by removing types null from media type application/json of response 500
- info
  the / response's property pattern ^[\s\S]{0,8192}$ was added for the status
- info
  the response's property pattern ^[\s\S]{0,8192}$ was added for the status
- info
  the response's property pattern ^[\s\S]{0,8192}$ was added for the status
- info
  the response's property pattern ^[\s\S]{0,8192}$ was added for the status
- info
  the response's property pattern ^[\s\S]{0,8192}$ was added for the status
- info
  the response's property pattern was changed from ^[\s\S]{1,1000}$ to ^[\s\S]{0,8192}$ for the status
- info
  the response's property pattern was changed from ^[\s\S]{1,1000}$ to ^[\s\S]{0,8192}$ for the status
- info
  the response's property pattern was changed from ^[\s\S]{1,1000}$ to ^[\s\S]{0,8192}$ for the status
- info
  the response's property pattern was changed from ^[\s\S]{1,1000}$ to ^[\s\S]{0,8192}$ for the status
- info
  the /// response's property pattern was changed from ^[\s\S]{0,128}$ to ^[\s\S]{0,8192}$ for the status
- info
  the response's property pattern was changed from ^[\s\S]{1,240}$ to ^[\s\S]{0,8192}$ for the status
- info
  the response's property pattern was changed from ^[\s\S]{1,240}$ to ^[\s\S]{0,8192}$ for the status
- info
  the response's property pattern was changed from ^[\s\S]{1,240}$ to ^[\s\S]{0,8192}$ for the status
- info
  the response's property pattern was changed from ^[\s\S]{1,240}$ to ^[\s\S]{0,8192}$ for the status
- info
  added the required property to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property to the response with the status

Operation history (13 revisions)

Get usage

Request

Response 200OK

Example response

Changes

Response