API v2 Documentation

Endpoints Code Lookup

← All endpoints

venues

game All data services

A query to this endpoint without an id parameter will return a list of all venues for the competition level. Passing an id parameter will return metadata for a single venue, and a listing of all games played there in the course of a season. If no season parameter is passed, the current season is the default.

Please note that this endpoint can be used synonymously as venue.

All venues for EuroBB
https://api.natstat.com/v1/venues/EuroBB/?key=XXXX-XXXXXX&format=xml 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
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
max optional number The number of results per page to return. The default value is 100, and the maximum allowed parameter value is 1000. This value is echoed back as Max_Results in the meta block
page optional number The pagination page number. This value is echoed back as Page in the meta block. The meta block also contains the Total_Results of the query. If there are further results, a fully-formed Next_Page URI containing a pre-filled &page=X value will be returned
id optional number A valid venue ID code, which returns details for that venue (A list of available venues can be retrieved from this endpoint by not passing an ID code.)
season optional number A valid season ID code, formatted as the year that a season completes, in YYYY format. A list of available seasons can be retrieved from the seasons endpoint

Response

NameRequiredTypeDescription
ID number The unique identifier for the record
Name string The full name of the venue