GET All States

Returns all states available within your subscription.

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

"data": [
        {
            "id": 1,
            "state": "NS",
            "name": "Not Started",
            "short_name": "NS",
            "developer_name": "NS"
        },
        {
            "id": 2,
            "state": "INPLAY_1ST_HALF",
            "name": "1st Half",
            "short_name": "1st",
            "developer_name": "INPLAY_1ST_HALF"
        },
        {
            "id": 3,
            "state": "HT",
            "name": "Half Time",
            "short_name": "HT",
            "developer_name": "HT"
        },
        {
            "id": 4,
            "state": "BREAK",
            "name": "Break",
            "short_name": "BRK",
            "developer_name": "BREAK"
        },
        {
            "id": 5,
            "state": "FT",
            "name": "Full Time",
            "short_name": "FT",
            "developer_name": "FT"
        },
        {
            "id": 6,
            "state": "INPLAY_ET",
            "name": "Extra Time",
            "short_name": "et",
            "developer_name": "INPLAY_ET"
        },
        {
            "id": 7,
            "state": "AET",
            "name": "After Extra Time",
            "short_name": "AET",
            "developer_name": "AET"
        },
        {
            "id": 8,
            "state": "FT_PEN",
            "name": "After Penalties",
            "short_name": "FTP",
            "developer_name": "FT_PEN"
        },
        {
            "id": 9,
            "state": "INPLAY_PENALTIES",
            "name": "Penalties",
            "short_name": "PEN",
            "developer_name": "INPLAY_PENALTIES"
        },
        {
            "id": 10,
            "state": "POSTPONED",
            "name": "Postponed",
            "short_name": "POST",
            "developer_name": "POSTPONED"
        },

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.

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 states 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 0 nested includes on this endpoint

Include options

none

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

State

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/states?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/states?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/states?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/states?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/states?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/states?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))
}

PreviousStates NextGET State by ID

Last updated 1 year ago

Was this helpful?

hashtagFilters

hashtagPagination

hashtagParameters

hashtagInclude depth

hashtagInclude options

hashtagRelated Entities:

hashtagPostman

hashtagCode Example