Account

Check API usage

Free — 0 credits deducted. Everything you need to decide about your plan BEFORE the API refuses you: spend by endpoint, burn rate, the date you are projected to run out, and the tier that would clear it (with a headless checkout you can POST).

Two windows, and every field says which one it is in its name:

ALL TIME — usage_by_endpoint, recent_activity, all_time, all_time_by_endpoint. Every call this key has ever made. This is the original meaning of usage_by_endpoint and recent_activity and it has not changed. Because it spans every billing period the key has lived through, it will normally be LARGER than credits_used — that is not a discrepancy, the two are measuring different things.
CURRENT BILLING PERIOD — usage_by_endpoint_period, recent_activity_period, plus credits_used / credits_remaining / period_start / next_reset_at. The credits in usage_by_endpoint_period sum to credits_used. Use these to reconcile a bill.

all_time_by_endpoint is an exact alias of usage_by_endpoint, kept because it shipped. Nothing in the all-time pair changed on 2026-08-18; if you saw those two numbers step down earlier that day, this restored them.

get/v1/usage

Request

Base URL: https://api.puntersedge.online
URL: https://api.puntersedge.online/v1/usage
Auth: API key in header X-API-Key

Query parameters

formatstring

csv returns the per-endpoint breakdown as a spreadsheet instead of the JSON document. Same rows, same numbers, no row cap. Free, like the JSON.

Headers

X-API-Keystring

X-RapidAPI-Proxy-Secretstring

Response

Successful Response

planstring required

account_email_maskedstring nullable

password_setboolean nullable

billing_attachedboolean nullable

credits_usedinteger required

credits_limitinteger required

credits_remaininginteger required

reset_atstring nullable required

When this key's credit counter was LAST set to zero, in UTC, written without an offset (read it as ending in Z). Despite the name this is the start of the current period, not the next reset; it equals period_start, which is the clearer field to use.

period_startstring nullable

Start of the current credit period, in UTC, written without an offset (read it as ending in Z). For a key created part-way through a month this is the moment the key was created; after that it is the monthly reset.

next_reset_atstring nullable

00:00 UTC on the 1st of next month, written without an offset (read it as ending in Z). Calculated, not stored: the reset job starts at that time and finishes a few seconds later, so a request in the first seconds of a month can still count against the old period.

burn_rate_per_daynumber

projected_month_end_creditsinteger

projected_exhaustion_datestring nullable

warningstring nullable

upgradeobject nullable

all_timeobject

all_time_by_endpointobject[]

usage_by_endpointobject[]

recent_activityobject[]

usage_by_endpoint_periodobject[]

recent_activity_periodobject[]

poolobject nullable

overageobject

credits_remaining_with_overageinteger

plansobject

Example response

{
  "all_time": {
    "calls": 310,
    "credits": 402,
    "endpoints": 1
  },
  "all_time_by_endpoint": [
    {
      "calls": 310,
      "credits": 402,
      "endpoint": "/v1/sports"
    }
  ],
  "burn_rate_per_day": 6,
  "credits_limit": 1000,
  "credits_remaining": 958,
  "credits_used": 42,
  "next_reset_at": "2026-08-01T00:00:00",
  "period_start": "2026-07-01T00:00:00",
  "plan": "free",
  "plans": {
    "free": {
      "credits_per_month": 500,
      "price_aud": 0
    }
  },
  "projected_month_end_credits": 186,
  "recent_activity": [
    {
      "credits": 1,
      "endpoint": "/v1/sports",
      "ts": "2026-06-07T02:20:00"
    }
  ],
  "recent_activity_period": [
    {
      "credits": 1,
      "endpoint": "/v1/sports",
      "ts": "2026-06-07T02:20:00"
    }
  ],
  "reset_at": "2026-07-01T00:00:00",
  "upgrade": {
    "checkout": {
      "body": {
        "email": "you@example.com",
        "plan": "hobby"
      },
      "endpoint": "https://api.puntersedge.online/v1/signup",
      "method": "POST"
    },
    "covers_projected_need": true,
    "credits_per_month": 7500,
    "price_aud": 9,
    "recommended_plan": "hobby",
    "sized_for_credits_per_month": 186,
    "url": "https://puntersedge.online/api/pricing?plan=hobby&utm_source=api_usage"
  },
  "usage_by_endpoint": [
    {
      "calls": 310,
      "credits": 402,
      "endpoint": "/v1/sports"
    }
  ],
  "usage_by_endpoint_period": [
    {
      "calls": 42,
      "credits": 42,
      "endpoint": "/v1/sports"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.