GET All Stages

Returns all stages available within your subscription

https://api.sportmonks.com/v3/football/stages


  "data": [
    {
      "id": 1086,
      "sport_id": 1,
      "league_id": 271,
      "season_id": 1273,
      "type_id": 223,
      "name": "Regular Season",
      "sort_order": 1,
      "finished": true,
      "is_current": false,
      "starting_at": "2005-07-19",
      "ending_at": "2006-05-14",
      "games_in_current_week": false
    },
    {
      "id": 1087,
      "sport_id": 1,
      "league_id": 271,
      "season_id": 1274,
      "type_id": 223,
      "name": "Regular Season",
      "sort_order": 1,
      "finished": true,
      "is_current": false,
      "starting_at": "2006-07-19",
      "ending_at": "2007-05-27",
      "games_in_current_week": false
    },

Field

Description

Type

Refers to the unique id of the stage

integer

sport_id

Refers to the sport of the stage

integer

league_id

Refers to the league related to the stage

integer

season_id

Refers to the season related to the stage

integer

type_id

Indicates what the stage type is

integer

name

Returns the name of the stage

string

sort_order

Returns the order of the stage

integer

finished

Indicates if the stage is finished or not

boolean

is_current

Indicates if the stage is the current stage or not

boolean

starting_at

The starting date of the stage

string

ending_at

The end date of the stage

string

Name

Required?

Description

api_token

YES

Another option is to provide the API token in the header.

Your unique API token. Ex. ?api_token=YOUR_TOKEN

include

Enrich the API response with more data by using includes. Ex. &include=participants;events

select

Select specific fields on the base entity. Read how to select fields in our tutorial.

filters

Filter the API response on multiple related entities. There are static filters and dynamic filters. Please find the possibilities in the Static and Dynamic Filter tab.

locale

Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page.

Static filters are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our Filters page.

Static Filters

Available on Entity

Description

Example

IdAfter

GET All Stages

Filter all stages starting from a certain stage ID. Handy if you're doing an import for all stages and want to continue from a certain ID.

&filters=IdAfter:stageID &filters=IdAfter:1100

The dynamic filters are based on entities and includes. Each dynamic filter uses an entity to filter on and one entity to apply the filter on. Below are examples with explanations of how filters are set up. For more information, please look at our Filters page.

Using an include? Check their respective filters on their entity page. For example if you use &include=fixtures, you can apply fixture-related filters.

Dynamic Filters

Available on Entity

Description

Examples

Types

Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.

Filter the stages on a selection of type IDs separated by a comma.

&include=type&filters=stageTypes:typeIDS &include=type&filters=stageTypes:223

leagues

Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.

Filter stages and more based on leagues.

&filters=stageLeagues:leagueIDS

&filters=stageLeagues:501

seasons

Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.

Filter stages based on seasons.

&filters=stageSeasons:seasonIDS

&filters=stageSeasons:19735

ParticipantSearch

Using the fixtures include? Check the fixture endpoint for all possible filters.

Filter the fixtures of certain participants

&include=fixtures&filters=ParticipantSearch:search_query

&include=fixtures&filters=ParticipantSearch:Celtic

fixtureStages

Check this endpoint for all possibilities.

Include the fixtures and only filter the fixtures based on stage IDs

&include=fixtures&filters=fixtureStages:stageIDS

&include=fixtures&filters=fixtureStages:1100

Filters

More information on how to use filters can be found on our tutorials on how to filter. If you want more information on which filters to use you can check out the following endpoint:

https://api.sportmonks.com/v3/my/filters/entity?api_token=YOUR_TOKEN

Pagination

YES

Parameters

Parameter

Required

Description

Example

order

Returns stages ordered by id (asc or desc). Defaults to asc

&order=desc

per_page

The amount of results to return per page (max 50.). Defaults to 25.

&per_page=30

page

You can paginate using the has_more parameter to determine if you can still propagate through the results.

&page=2

Include depth

You can use a total of 4 nested includes on this endpoint

Include options

league season type sport rounds currentRound groups fixtures aggregates topscorers statistics

Get an overview and explanation of all the fields returned in the API response. The related entities for the stages endpoints are:

Stage

Postman

We also offer detailed postman documentation with examples and a complete up-to-date version of all our endpoints. Below is a button that lets your fork the collection or import it.

Code Example

require "uri"
require "net/http"

url = URI("https://api.sportmonks.com/v3/football/stages?api_token=YOUR_TOKEN")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.sportmonks.com")
payload = ''
headers = {}
conn.request("GET", "/v3/football/stages?api_token=YOUR_TOKEN", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.sportmonks.com/v3/football/stages?api_token=YOUR_TOKEN',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $respons

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://api.sportmonks.com/v3/football/stages?api_token=YOUR_TOKEN")
  .method("GET", null)
  .build();
Response response = client.newCall(request).execute();

var unirest = require('unirest');
var req = unirest('GET', 'https://api.sportmonks.com/v3/football/stages?api_token=YOUR_TOKEN')
  .end(function (res) { 
    if (res.error) throw new Error(res.error); 
    console.log(res.raw_body);
  });

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.sportmonks.com/v3/football/stages?api_token=YOUR_TOKEN"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

PreviousStages NextGET Stage by ID

Last updated 2 months ago

Was this helpful?

Filters

Pagination

Parameters

Include depth

Include options

Related Entities:

Postman

Code Example