Documentation / Account and coverage

Your usage

GET /v1/usage

Free key and upMCP tool: my_usageNever counted

Your plan, calls used today and this period, limits, reset times and the data your plan covers.

GEThttps://api.icehockeyapi.com/v1/usage

Your key

https://api.icehockeyapi.com/v1/usage

curl "https://api.icehockeyapi.com/v1/usage" \
  -H "X-API-Key: YOUR_KEY"

200 OKExample answer from the data, 12 Oct

{
    "data": {
        "plan": "Complete",
        "key_prefix": "docs",
        "calls_today": 0,
        "calls_this_period": 0,
        "allowance": 500000,
        "allowance_period": "month",
        "allowance_remaining": 500000,
        "allowance_resets_at": null,
        "requests_per_minute": 120,
        "covers": {
            "yesterday_today_and_ahead": true,
            "current_seasons": true,
            "past_seasons": true,
            "odds": true,
            "all_endpoints": true
        }
    },
    "meta": {
        "plan": "Complete"
    }
}

Parameters

None.

Returns

Field	Type
`plan`	string
`key_prefix`	string
`calls_today`	int
`calls_this_period`	int
`allowance`	int
`allowance_period`	string
`allowance_remaining`	int
`allowance_resets_at`	null
`requests_per_minute`	int
`covers`	object
`covers.yesterday_today_and_ahead`	bool
`covers.current_seasons`	bool
`covers.past_seasons`	bool
`covers.odds`	bool
`covers.all_endpoints`	bool

Errors

unauthorizedrate_limitedquota_exceeded

PreviousChangelog NextCoverage