Account

Account

Get your API account details including balance, overage settings, and per-product subscription info with usage counters.

Endpoint

This endpoint returns account details for the authenticated API key, including your remaining balance, overage configuration, and per-product subscription status with cycle-to-date usage.

GET   /v2/account

Authentication

Include your API key as the x-api-key request header.

x-api-key: YourSecretAPIKey

Response fields

FieldTypeDescription
balancenumberRemaining prepaid balance on the account, in credits.
overageEnabledbooleanWhether overage billing is enabled for this account.
overageSpendingLimitnumberMaximum overage the account may accrue this cycle, in credits. 0 means no limit set.
subscriptionsobjectMap of product key to subscription object. See fields below.

Per-subscription fields (each value under subscriptions):

FieldTypeDescription
planIdstringPlan identifier (for example steam-full, endpoint-2.5m, thirdparty-none).
startDatestring (ISO 8601)When the current plan started.
endDatestring (ISO 8601)When the current plan term ends.
statusstringSubscription status (for example active).
autoRenewbooleanWhether the subscription auto-renews at nextRenewalDate.
pendingPlanIdstring | nullPlan the subscription will switch to at the next cycle, if any.
pendingChangeTypestring | nullType of pending change (upgrade, downgrade), or null.
cycleStartDatestring (ISO 8601)Start of the current billing cycle.
nextRenewalDatestring (ISO 8601)Next scheduled renewal date.
usageobjectMap of endpoint path or usage category to request count consumed this cycle.
billedOveragenumberOverage amount already billed this cycle, in credits.

Subscription products and plans

The subscriptions object is keyed by product category. Each product has its own set of plans; planId values are scoped to their product category.

STEAM_DATA

Core Steam data quota (profiles, inventories, apps, items).

Plan IDPriceInterval
steam-noneFreemonth
steam-30days€4.99month
steam-180days€19.99month
steam-full€29.99month

EXTRA_REQUESTS

Additional request quota on top of the base plan. Priced per month, with per-request overage.

Plan IDMax requestsPriceInterval
endpoint-none500Freeper request
endpoint-100k100,000€9.99month
endpoint-250k250,000€24.99month
endpoint-500k500,000€44.99month
endpoint-1m1,000,000€89.99month
endpoint-2.5m2,500,000€189.99month
endpoint-10m10,000,000€599.99month
endpoint-40m40,000,000€1,799.99month

THIRD_PARTY_MARKET_DATA

Third-party marketplace data access.

Plan IDPriceInterval
thirdparty-noneFreemonth
thirdparty-data€49.99month
thirdparty-data-history-15€54.99month
thirdparty-data-history-30€69.99month
thirdparty-data-history-180€99.99month

THIRD_PARTY_ADDON_SALES

Third-party sales data add-on.

Plan IDPriceInterval
addons-sales€49.99month

THIRD_PARTY_ADDON_WSS

Third-party WebSocket stream add-on.

Plan IDPriceInterval
addons-wss€39.99month

Plan IDs and prices may change over time. Treat the planId as an opaque identifier scoped to its product category.

Response example

response.json
{
  "success": true,
  "result": {
    "balance": 493177.0881900459,
    "overageEnabled": true,
    "overageSpendingLimit": 0,
    "subscriptions": {
      "STEAM_DATA": {
        "planId": "steam-full",
        "startDate": "2026-01-19T03:35:35.815Z",
        "endDate": "2026-05-19T03:35:35.815Z",
        "status": "active",
        "autoRenew": true,
        "pendingPlanId": null,
        "pendingChangeType": null,
        "cycleStartDate": "2026-01-19T03:35:35.815Z",
        "nextRenewalDate": "2026-05-19T03:35:35.815Z",
        "usage": {
          "steam/inventory": 122935,
          "steam/profile": 83223,
          "market/items": 276,
          "market/item": 20928,
          "/v2/steam/users/:steamid": 5,
          "/v2/steam/apps/:appId": 5
        },
        "billedOverage": 0
      },
      "EXTRA_REQUESTS": {
        "planId": "endpoint-2.5m",
        "startDate": "2026-01-19T03:35:36.067Z",
        "endDate": "2026-05-19T03:35:35.815Z",
        "status": "active",
        "autoRenew": true,
        "pendingPlanId": null,
        "pendingChangeType": null,
        "cycleStartDate": "2026-01-19T03:35:35.815Z",
        "nextRenewalDate": "2026-05-19T03:35:35.815Z",
        "usage": {
          "steam/profile": 83223,
          "steam/inventory": 122476,
          "market/item": 20928,
          "/v2/steam/apps": 1,
          "/v2/steam/users/:steamid/friends": 1
        },
        "billedOverage": 0
      },
      "THIRD_PARTY_MARKET_DATA": {
        "planId": "thirdparty-none",
        "startDate": "2026-01-19T03:38:43.170Z",
        "endDate": "2026-05-19T03:35:35.815Z",
        "status": "active",
        "autoRenew": true,
        "pendingPlanId": null,
        "pendingChangeType": null,
        "cycleStartDate": "2026-01-19T03:35:35.815Z",
        "nextRenewalDate": "2026-05-19T03:35:35.815Z",
        "usage": {
          "market/items": 276,
          "market/item": 20928
        },
        "billedOverage": 0
      }
    }
  }
}