API v2 Documentation

Endpoints Code Lookup

← All endpoints

glossary

reference All data services

A query to this endpoint will return a list of ID codes, explanations for various metadata in the API; for example: explanations of statistical abbreviations, a level's sublevels (leagues or conferences), . Currently available types values are levels, sublevels, stats and nations. Queries to this endpoint return all data records and are not paginated.

All competition levels
https://api.natstat.com/v2/forecasts/NBA/?key=XXXX-XXXXXX&format=json&season=2020&max=100 Download sample

Parameters

Path

NameRequiredTypeDescription
level required string The competition level to retrieve information for. A full glossary can be found in the Path Parameters section

Query

NameRequiredTypeDescription
type optional string The data dictionary to retrieve. Acceptable values are levels, stats, nations and sublevels
key required string A valid API key in XXXX-XXXXXX format
format optional string The preferred data format: xml, json or php (presented as a SimpleXML object). The default is json

Response

NameRequiredTypeDescription
items object Contains metadata for the item
ID number The unique identifier for the record
Name string The full name of the glossary item
CurrentSeason number The current seasons ID for this league, in YYYY format
StatsBackTo string The first seasons ID that the API contains stats for.
Color string The color in six-character binhex format
Twitter string The relevant Twitter account name