Developers · API Reference
API v1

Data API · Competitions

List competitions

GET/api/v1/datas/competitions

Returns competitions available to the authenticated account.

Bearer authentication required · service: data_api

Reference only — this page never sends API requests or exposes token controls.

Response formats

When format is listed below, use json for the response documented here, or csv and xml for downloads. JSON uses camelCase by default; set case=snake_case when supported for legacy key names. Nested response fields use dot notation; [] denotes an array item and {key} a dynamic object key.

Query parameters

ParameterTypeRequiredDescription
format string Required Response format. Allowed: json, csv, xml.
page integer Optional Page number. Default: 1. Minimum 1.
perPage integer Optional Items per page. Default: 20. Minimum 1; maximum 100.

Response attributes

AttributeTypeDescription
itemsarrayCompetition records.
items[].idintegerCompetition ID.
items[].namestring|nullCompetition name.
items[].shortNamestring|nullCompetition short name.
items[].dateStartstring|nullCompetition start date.
items[].dateEndstring|nullCompetition end date.
items[].competitionFormatIdinteger|nullCompetition format ID.
items[].countryIdinteger|nullCountry ID.
items[].countryNamestring|nullCountry name.
items[].logostring|nullCompetition logo URL.
items[].providerIdstring|integer|nullProvider identifier.
items[].seasonsarrayCompetition seasons.
items[].seasons[].idintegerSeason ID.
items[].seasons[].titlestring|nullSeason title.
items[].seasons[].shortTitlestring|nullSeason short title.
items[].seasons[].dateStartstring|nullSeason start date.
items[].seasons[].dateEndstring|nullSeason end date.
items[].seasons[].yearSeasonIdinteger|nullYear-season ID.
metaobjectPagination metadata.
meta.currentPageintegerCurrent page number.
meta.perPageintegerRequested page size.
meta.totalintegerTotal number of matching records.
meta.lastPageintegerLast available page number.
meta.frominteger|nullPosition of the first item on this page.
meta.tointeger|nullPosition of the last item on this page.
linksobjectPagination URLs.
links.firststringURL of the first page.
links.laststringURL of the last page.
links.previousstring|nullURL of the previous page, when available.
links.nextstring|nullURL of the next page, when available.