NAV Navbar
shell php
  • Introduction
  • Authentication
  • Continents
  • Countries
  • Leagues
  • Seasons
  • Fixtures
  • Livescores
  • Teams
  • Players
  • Officials
  • Venues
  • Positions
  • Stages
  • Relationships
  • Errors
  • Introduction

    Welcome to the SportMonks Cricket API v1.0 documentation. In this section of our website we hope to give you more insights in how our cricket API works so you can start implementing it in no time into your application.

    Base URL

    https://cricket.sportmonks.com/api/v1
    

    Authentication

    SportMonks Cricket uses API keys to allow access to the API. You can register a new SportMonks Cricket API key at our here.

    Got to https://www.sportmonks.com/settings#/api to create an API token

    SportMonks Cricket expects the API key that can be included in all API requests to the server as part of the request

    Continents

    As the name of this endpoint already reveals, continents represent the part of the world to which countries belong to. Retrieving information about continents can be a very usefull feature to your app.

    Make sure to replace d4ksomxFumF6veb..... with your API key.

    Get All Continents

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/continents?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/continents?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": [
        {
          "type": "continents",
          "id": "1",
          "attributes": {
            "name": "Europe",
            "slug": "europe",
            "updated_at": "2017-05-04T19:31:29+00:00"
          },
          "relationships": {
            "countries": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/continents/1"
          }
        },
        {
          "type": "continents",
          "id": "2",
          "attributes": {
            "name": "Asia",
            "slug": "asia",
            "updated_at": "2017-05-04T19:31:40+00:00"
          },
          "relationships": {
            "countries": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/continents/2"
          }
        }
      ]
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/continents?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    sort false This is the sorting attribute. If not provided, results will be sorted by id in ascending order. Options include id, name and updated_at
    include false This is the relationship that can be included. eg countries

    Response Attributes

    Name Type Description
    type string The value will be continents because thats the expected response type
    id integer The id of the continent in the database
    name string The name of the continent
    slug string The slug used to represent the continent
    updated_at string A timestamp representing when the continent was last updated in the database
    relationships object If you specify includes=countries, this will return an array of countries in that continent
    links object Expect the key self which will be a link to the continent

    Get Continent By ID

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/continents/1?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/continents/1?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": {
        "type": "continents",
        "id": "1",
        "attributes": {
          "name": "Europe",
          "slug": "europe",
          "updated_at": "2017-05-04T19:31:29+00:00"
        },
        "relationships": {
          "countries": [ ]
        },
        "links": {
          "self": "https://cricket.sportmonks.com/api/v1/continents/1"
        }
      }
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/continents/{id}?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    include false This is the relationship that can be included. eg countries

    Response Attributes

    Name Type Description
    type string The value will be continents because thats the expected response type
    id integer The id of the continent in the database
    name string The name of the continent
    slug string The slug used to represent the continent
    updated_at string A timestamp representing when the continent was last updated in the database
    relationships object If you specify includes=countries, this will return an array of countries in that continent
    links object Expect the key self which will be a link to the continent

    Countries

    Retrieving information about countries can be a very usefull feature to your app. Using the leagues include can be an easy way to list all leagues that are covered in your plan, that belong to the requested country.

    Make sure to replace d4ksomxFumF6veb..... with your API key.

    Get All Countries

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/countries?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/countries?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": [
        {
          "type": "countries",
          "id": "1",
          "attributes": {
            "name": "Poland",
            "slug": "poland",
            "code": "PL"
          },
          "relationships": {
            "continent": [ ],
            "leagues": [ ],
            "players": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/countries/1"
          }
        },
        {
          "type": "countries",
          "id": "2",
          "attributes": {
            "name": "Brazil",
            "slug": "brazil",
            "code": "BR"
          },
          "relationships": {
            "continent": [ ],
            "leagues": [ ],
            "players": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/countries/2"
          }
        }
      ]
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/countries?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    sort false This is the sorting attribute. If not provided, results will be sorted by id in ascending order. Options include id, name, code, updated_at, continent_id or active
    include false This is the relationship that can be included. eg continent, leagues or players

    Response Attributes

    Name Type Description
    type string The value will be countries because thats the expected response type
    id integer The id of the country in the database
    name string The name of the country
    slug string The slug used to represent the country
    code string The code used to represent the country
    relationships object These are other endpoints related to country. They include continent, leagues and players
    links object Expect the key self which will be a link to the continent

    Get Country By ID

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/countries/1?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/countries/1?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": {
        "type": "countries",
        "id": "1",
        "attributes": {
          "name": "Poland",
          "slug": "poland",
          "code": "PL"
        },
        "relationships": {
          "continent": [ ],
          "leagues": [ ],
          "players": [ ]
        },
        "links": {
          "self": "https://cricket.sportmonks.com/api/v1/countries/1"
        }
      }
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/countries/{id}?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    include false This is the relationship that can be included. eg continent, leagues or players

    Response Attributes

    Name Type Description
    type string The value will be countries because thats the expected response type
    id integer The id of the country in the database
    name string The name of the country
    slug string The slug used to represent the country
    code string The code used to represent the country
    relationships object These are other endpoints related to country. They include continent, leagues and players
    links object Expect the key self which will be a link to the continent

    Leagues

    The response of this endpoint is limited to the leagues that are assigned to your subscription. So, if you request the /leagues endpoint this will return all the leagues you have access to. For most applications leagues is the starting point. You can retrieve all seasons we cover via seasons include or just the active season via season include.

    Make sure to replace d4ksomxFumF6veb..... with your API key.

    Get All Leagues

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/leagues?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/leagues?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": [
        {
          "type": "leagues",
          "id": "1",
          "attributes": {
            "name": "Indian Premier League",
            "code": "IPL",
            "updated_at": "2018-11-13T19:33:52+00:00"
          },
          "relationships": {
            "country": [ ],
            "season": [ ],
            "seasons": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/leagues/1"
          }
        },
        {
          "type": "leagues",
          "id": "2",
          "attributes": {
            "name": "One Day International",
            "code": "ODI",
            "updated_at": "2018-11-13T21:00:26+00:00"
          },
          "relationships": {
            "country": [ ],
            "season": [ ],
            "seasons": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/leagues/2"
          }
        }
      ]
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/leagues?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    sort false This is the sorting attribute. If not provided, results will be sorted by id in ascending order. Options include id, name, code, updated_at, country_id or type
    include false This is the relationship that can be included. eg country, season (current season) or seasons

    Response Attributes

    Name Type Description
    type string The value will be leagues because thats the expected response type
    id integer The id of the league in the database
    name string The name of the league
    code string The code used to represent the league
    updated_at string A timestamp representing when the league was last updated in the database
    relationships object These are other endpoints related to a league. They include country, season and seasons
    links object Expect the key self which will be a link to the league

    Get League By ID

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/leagues/1?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/leagues/1?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": {
        "type": "leagues",
        "id": "1",
        "attributes": {
          "name": "Indian Premier League",
          "code": "IPL",
          "updated_at": "2018-11-13T19:33:52+00:00"
        },
        "relationships": {
          "country": [ ],
          "season": [ ],
          "seasons": [ ]
        },
        "links": {
          "self": "https://cricket.sportmonks.com/api/v1/leagues/1"
        }
      }
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/leagues/{id}?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    include false This is the relationship that can be included. eg country, season or seasons

    Response Attributes

    Name Type Description
    type string The value will be leagues because thats the expected response type
    id integer The id of the league in the database
    name string The name of the league
    code string The code used to represent the league
    updated_at string A timestamp representing when the league was last updated in the database
    relationships object These are other endpoints related to a league. They include country, season and seasons
    links object Expect the key self which will be a link to the league

    Seasons

    The response of this endpoint is limited to the leaguess that are assigned to your subscription. Via this endpoint you can retrieve details about a particular season. For example you can find out if a season is still active. Another great feature, when using the proper includes, is the ability to load full season games, or just only results or upcoming fixtures.

    Make sure to replace d4ksomxFumF6veb..... with your API key.

    Get All Seasons

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/seasons?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/seasons?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": [
        {
          "type": "seasons",
          "id": "1",
          "attributes": {
            "name": "2019",
            "code": "2019",
            "league_id": 1,
            "updated_at": "2018-11-13T19:33:52+00:00"
          },
          "relationships": {
            "league": [ ],
            "stages": [ ],
            "standings": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/seasons/1"
          }
        },
        {
          "type": "seasons",
          "id": "2",
          "attributes": {
            "name": "2018",
            "code": "2018",
            "league_id": 2,
            "updated_at": "2018-11-13T21:00:26+00:00"
          },
          "relationships": {
            "league": [ ],
            "stages": [ ],
            "standings": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/seasons/2"
          }
        }
      ]
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/seasons?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    sort false This is the sorting attribute. If not provided, results will be sorted by id in ascending order. Options include name, or updated_at
    include false This is the relationship that can be included. eg leagues, stages, teams or standings

    Response Attributes

    Name Type Description
    type string The value will be seasons because thats the expected response type
    id integer The id of the season in the database
    name string The name of the season
    code string The code used to represent the season
    league_id integer The id of the league associated with this season
    updated_at string A timestamp representing when the season was last updated in the database
    relationships object These are other endpoints related to a season. They include leagues, stages, teams and standings
    links object Expect the key self which will be a link to the season

    Get Season By ID

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/seasons/1?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/seasons/1?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": {
        "type": "seasons",
        "id": "1",
        "attributes": {
          "name": "2019",
          "code": "2019",
          "league_id": 1,
          "updated_at": "2018-11-13T19:33:52+00:00"
        },
        "relationships": {
          "league": [ ],
          "stages": [ ],
          "standings": [ ]
        },
        "links": {
          "self": "https://cricket.sportmonks.com/api/v1/seasons/1"
        }
      }
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/seasons/{id}?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    include false This is the relationship that can be included. eg leagues, stages, teams or standings

    Response Attributes

    Name Type Description
    type string The value will be seasons because thats the expected response type
    id integer The id of the season in the database
    name string The name of the season
    code string The code used to represent the season
    league_id integer The id of the league associated with this season
    updated_at string A timestamp representing when the season was last updated in the database
    relationships object These are other endpoints related to a season. They include leagues, stages, teams and standings
    links object Expect the key self which will be a link to the season

    Fixtures

    The response of this endpoint is limited to the leagues that are assigned to your subscription. Fixtures represent a game played in a particular league. A Fixture is played between 2 teams. Without using includes this will return information about the current status of 1 or more games. You can enrich the the game by adding the proper includes.

    Make sure to replace d4ksomxFumF6veb..... with your API key.

    Get All Fixtures

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/fixtures?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/fixtures?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": [
        {
          "type": "fixtures",
          "id": "1",
          "attributes": {
            "league_id": 2,
            "season_id": 4,
            "stage_id": 1,
            "round": "2nd ODI",
            "localteam_id": 39,
            "visitorteam_id": 38,
            "starting_at": "2018-10-13T04:30:00+00:00",
            "game_type": "ODI",
            "live": false,
            "status": "Finished",
            "last_period": null,
            "note": "",
            "venue_id": 108,
            "toss_won_team_id": null,
            "winner_team_id": null,
            "draw_noresult": null,
            "first_umpire_id": 14,
            "second_umpire_id": 26,
            "tv_umpire_id": 2,
            "referee_id": 152,
            "man_of_match_id": 146,
            "man_of_series_id": null,
            "total_overs_played": null,
            "elected": "bowling",
            "super_over": false,
            "follow_on": false,
            "localteam_dl_data": {
              "score": null,
              "overs": null,
              "wickets_out": null
            },
            "visitorteam_dl_data": {
              "score": null,
              "overs": null,
              "wickets_out": null
            },
            "rpc_overs": null,
            "rpc_target": null,
            "weather_report": [ ],
            "created_at": "2018-10-12T09:25:13+00:00",
            "updated_at": "2018-10-15T20:35:25+00:00"
          },
          "relationships": {
            "localteam": [ ],
            "visitorteam": [ ],
            "league": [ ],
            "season": [ ],
            "stage": [ ],
            "venue": [ ],
            "runs": [ ],
            "batting": [ ],
            "bowling": [ ],
            "comments": [ ],
            "lineup": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/fixtures/1"
          }
        }
      ]
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/fixtures?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    sort false This is the sorting attribute. If not provided, results will be sorted by id in ascending order. Options include status, started_at or game_type
    page[from] false This is the date when you want the results to start from eg &page[from]=2018-01-01 in the format YYYY-MM-DD
    page[to] false This is the date when you want the results to end eg &page[to]=2018-11-15 in the format YYYY-MM-DD
    include false This is the relationship that can be included. eg localteam, visitorteam, league, season, stage, venue, batting, bowling, runs, comments

    Response Attributes

    Name Type Description
    type string The value will be fixtures supported by the subscription of the user.
    id integer The id of the fixture in the database
    league_id integer The id of the league associated with this fixture
    season_id integer The id of the season associated with this fixture
    stage_id integer The id of the stage associated with this fixture
    round string round of the fixture
    localteam_id integer Id of the team playing at home
    visitorteam_id integer Id of the team played away
    starting_at string UTC date of the starting date/time of the game
    game_type string possible values 'T20','T10','ODI','T20I','4day','Test/5day','Test'
    live boolean will the game be hosting livescores or only final result
    status string can be one of NS,Aban,Cancl,Postp,Finished, Delayed, Dinner, Lunch,Innings Break,1st Innings,2nd Innings,3rd Innings,4th Innings,Stump Day 1,Stump Day 2,Stump Day 3,Stump Day 4,Tea Break,Int
    last_period string can be null of one of '1st Innings','2nd Innings','3rd Innings','4th Innings'
    note string important information, for example Wellington Firebirds won by 32 runs
    venue_id integer the id of the venue the game is played in
    toss_won_team_id integer the team who won the toss, also include=tosswon
    winner_team_id integer id of the winning team, also via include=winnerteam
    draw_noresult boolean if the game ended in draw or no-result this will be entered here
    first_umpire_id integer id of the first official, also via include=firstumpire
    second_umpire_id integer id of the secobnd official, also via include=secondumpire
    tv_umpire_id integer id of the tv official, also via include=tvumpire
    referee_id integer id of the referee, also via include=referee
    man_of_match_id integer id of the player who won this this, also via include=manofmatch
    man_of_series_id integer id of the player who won this this, also via include=manofseries
    total_overs_played integer the total number of overs played
    elected string can be batting or bowling
    super_over boolean (If a T20 & T20I and T10 league Matches goes tie then 1 over extra inngs will be player that's called Super Over )
    follow_on boolean (This happen in 4 day or 5 day Test matches if a team A Played first and score handsome and Team B all out on manimum Score (Half score of team A or less) Then Follow on in force mean Team B play again its 2nd Inngs. )
    localteam_dl_data object (Filled if a Team played their all over and Rain distrube the match So D/L method applied Score and over revised by D/L Method)
    visitorteam_dl_data object (Filled if a Team played their all over and Rain distrube the match So D/L method applied Score and over revised by D/L Method)
    rpc_overs string Revised Overs
    rpc_target string Revised Score
    weather_report array report of the weather
    created_at string A timestamp representing when the fixture was created in the database
    updated_at string A timestamp representing when the fixture was last updated in the database
    relationships object These are other endpoints related to a fixture. They include league, season, stage, localteam, visitorteam, venue , runs, batting, bowling , comments or lineup
    links object Expect the key self which will be a link to the fixture

    Get Fixture By ID

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": {
        "type": "fixtures",
          "id": "1",
          "attributes": {
            "league_id": 2,
            "season_id": 4,
            "stage_id": 1,
            "round": "2nd ODI",
            "localteam_id": 39,
            "visitorteam_id": 38,
            "starting_at": "2018-10-13T04:30:00+00:00",
            "game_type": "ODI",
            "live": false,
            "status": "Finished",
            "last_period": null,
            "note": "",
            "venue_id": 108,
            "toss_won_team_id": null,
            "winner_team_id": null,
            "draw_noresult": null,
            "first_umpire_id": 14,
            "second_umpire_id": 26,
            "tv_umpire_id": 2,
            "referee_id": 152,
            "man_of_match_id": 146,
            "man_of_series_id": null,
            "total_overs_played": null,
            "elected": "bowling",
            "super_over": false,
            "follow_on": false,
            "localteam_dl_data": {
              "score": null,
              "overs": null,
              "wickets_out": null
            },
            "visitorteam_dl_data": {
              "score": null,
              "overs": null,
              "wickets_out": null
            },
            "rpc_overs": null,
            "rpc_target": null,
            "weather_report": [ ],
            "created_at": "2018-10-12T09:25:13+00:00",
            "updated_at": "2018-10-15T20:35:25+00:00"
          },
          "relationships": {
            "localteam": [ ],
            "visitorteam": [ ],
            "league": [ ],
            "season": [ ],
            "stage": [ ],
            "venue": [ ],
            "runs": [ ],
            "batting": [ ],
            "bowling": [ ],
            "comments": [ ],
            "lineup": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/fixtures/1"
          }
      }
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/fixtures/{id}?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    include false This is the relationship that can be included. eg localteam, visitorteam, league, season, stage, venue, batting, bowling, runs, comments

    Response Attributes

    Name Type Description
    type string The value will be fixtures supported by the subscription of the user.
    id integer The id of the fixture in the database
    league_id integer The id of the league associated with this fixture
    season_id integer The id of the season associated with this fixture
    stage_id integer The id of the stage associated with this fixture
    round string round of the fixture
    localteam_id integer Id of the team playing at home
    visitorteam_id integer Id of the team played away
    starting_at string UTC date of the starting date/time of the game
    game_type string possible values 'T20','T10','ODI','T20I','4day','Test/5day','Test'
    live boolean will the game be hosting livescores or only final result
    status string can be one of NS,Aban,Cancl,Postp,Finished, Delayed, Dinner, Lunch,Innings Break,1st Innings,2nd Innings,3rd Innings,4th Innings,Stump Day 1,Stump Day 2,Stump Day 3,Stump Day 4,Tea Break,Int
    last_period string can be null of one of '1st Innings','2nd Innings','3rd Innings','4th Innings'
    note string important information, for example Wellington Firebirds won by 32 runs
    venue_id integer the id of the venue the game is played in
    toss_won_team_id integer the team who won the toss, also include=tosswon
    winner_team_id integer id of the winning team, also via include=winnerteam
    draw_noresult boolean if the game ended in draw or no-result this will be entered here
    first_umpire_id integer id of the first official, also via include=firstumpire
    second_umpire_id integer id of the secobnd official, also via include=secondumpire
    tv_umpire_id integer id of the tv official, also via include=tvumpire
    referee_id integer id of the referee, also via include=referee
    man_of_match_id integer id of the player who won this this, also via include=manofmatch
    man_of_series_id integer id of the player who won this this, also via include=manofseries
    total_overs_played integer the total number of overs played
    elected string can be batting or bowling
    super_over boolean (If a T20 & T20I and T10 league Matches goes tie then 1 over extra inngs will be player that's called Super Over )
    follow_on boolean (This happen in 4 day or 5 day Test matches if a team A Played first and score handsome and Team B all out on manimum Score (Half score of team A or less) Then Follow on in force mean Team B play again its 2nd Inngs. )
    localteam_dl_data object (If happen if a Team played their all over and Rain distrube the match So D/L method applied Score and over revised by D/L Method
    rpc_overs string Revised Overs
    rpc_target string Revised Score
    weather_report array report of the weather
    created_at string A timestamp representing when the fixture was created in the database
    updated_at string A timestamp representing when the fixture was last updated in the database
    relationships object These are other endpoints related to a fixture. They include league, season, stage, localteam, visitorteam, venue , runs, batting, bowling , comments or lineup
    links object Expect the key self which will be a link to the fixture

    Livescores

    This endpoint returns all live fixtures covered by the subscription of the user. Via these endpoints you are able to obtain live information for games of the current day. Information provided by these endpoints are never cached and are real-time.

    Make sure to replace d4ksomxFumF6veb..... with your API key.

    Get All Livescores

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/livescores?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/livescores?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": [
        {
          "type": "livescores",
          "id": "1",
          "attributes": {
            "league_id": 2,
            "season_id": 4,
            "stage_id": 1,
            "round": "2nd ODI",
            "localteam_id": 39,
            "visitorteam_id": 38,
            "starting_at": "2018-10-13T04:30:00+00:00",
            "game_type": "ODI",
            "live": false,
            "status": "Finished",
            "last_period": null,
            "note": "",
            "venue_id": 108,
            "toss_won_team_id": null,
            "winner_team_id": null,
            "draw_noresult": null,
            "first_umpire_id": 14,
            "second_umpire_id": 26,
            "tv_umpire_id": 2,
            "referee_id": 152,
            "man_of_match_id": 146,
            "man_of_series_id": null,
            "total_overs_played": null,
            "elected": "bowling",
            "super_over": false,
            "follow_on": false,
            "localteam_dl_data": {
              "score": null,
              "overs": null,
              "wickets_out": null
            },
            "visitorteam_dl_data": {
              "score": null,
              "overs": null,
              "wickets_out": null
            },
            "rpc_overs": null,
            "rpc_target": null,
            "weather_report": [ ],
            "created_at": "2018-10-12T09:25:13+00:00",
            "updated_at": "2018-10-15T20:35:25+00:00"
          },
          "relationships": {
            "localteam": [ ],
            "visitorteam": [ ],
            "league": [ ],
            "season": [ ],
            "stage": [ ],
            "venue": [ ],
            "runs": [ ],
            "batting": [ ],
            "bowling": [ ],
            "comments": [ ],
            "lineup": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/livescores/1"
          }
        }
      ]
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/livescores?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    sort false This is the sorting attribute. If not provided, results will be sorted by id in ascending order. Options include status, started_at or game_type
    include false This is the relationship that can be included. eg localteam, visitorteam, league, season, stage, venue, batting, bowling, runs, comments

    Response Attributes

    Name Type Description
    type string The value will be livescores supported by the subscription of the user.
    id integer The id of the livescore in the database
    league_id integer The id of the league associated with this livescore
    season_id integer The id of the season associated with this livescore
    stage_id integer The id of the stage associated with this livescore
    round string round of the livescore
    localteam_id integer Id of the team playing at home
    visitorteam_id integer Id of the team played away
    starting_at string UTC date of the starting date/time of the game
    game_type string possible values 'T20','T10','ODI','T20I','4day','Test/5day','Test'
    live boolean will the game be hosting livescores or only final result
    status string can be one of NS,Aban,Cancl,Postp,Finished, Delayed, Dinner, Lunch,Innings Break,1st Innings,2nd Innings,3rd Innings,4th Innings,Stump Day 1,Stump Day 2,Stump Day 3,Stump Day 4,Tea Break,Int
    last_period string can be null of one of '1st Innings','2nd Innings','3rd Innings','4th Innings'
    note string important information, for example Wellington Firebirds won by 32 runs
    venue_id integer the id of the venue the game is played in
    toss_won_team_id integer the team who won the toss, also include=tosswon
    winner_team_id integer id of the winning team, also via include=winnerteam
    draw_noresult boolean if the game ended in draw or no-result this will be entered here
    first_umpire_id integer id of the first official, also via include=firstumpire
    second_umpire_id integer id of the secobnd official, also via include=secondumpire
    tv_umpire_id integer id of the tv official, also via include=tvumpire
    referee_id integer id of the referee, also via include=referee
    man_of_match_id integer id of the player who won this this, also via include=manofmatch
    man_of_series_id integer id of the player who won this this, also via include=manofseries
    total_overs_played integer the total number of overs played
    elected string can be batting or bowling
    super_over boolean (If a T20 & T20I and T10 league Matches goes tie then 1 over extra inngs will be player that's called Super Over )
    follow_on boolean (This happen in 4 day or 5 day Test matches if a team A Played first and score handsome and Team B all out on manimum Score (Half score of team A or less) Then Follow on in force mean Team B play again its 2nd Inngs. )
    localteam_dl_data object (If happen if a Team played their all over and Rain distrube the match So D/L method applied Score and over revised by D/L Method
    rpc_overs string Revised Overs
    rpc_target string Revised Score
    weather_report array report of the weather
    created_at string A timestamp representing when the livescore was created in the database
    updated_at string A timestamp representing when the livescore was last updated in the database
    relationships object These are other endpoints related to a livescore. They include league, season, stage, localteam, visitorteam, venue , runs, batting, bowling , comments or lineup
    links object Expect the key self which will be a link to the livescore

    Get livescore By ID

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/livescores/1?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/livescores/1?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": {
        "type": "livescores",
          "id": "1",
          "attributes": {
            "league_id": 2,
            "season_id": 4,
            "stage_id": 1,
            "round": "2nd ODI",
            "localteam_id": 39,
            "visitorteam_id": 38,
            "starting_at": "2018-10-13T04:30:00+00:00",
            "game_type": "ODI",
            "live": false,
            "status": "Finished",
            "last_period": null,
            "note": "",
            "venue_id": 108,
            "toss_won_team_id": null,
            "winner_team_id": null,
            "draw_noresult": null,
            "first_umpire_id": 14,
            "second_umpire_id": 26,
            "tv_umpire_id": 2,
            "referee_id": 152,
            "man_of_match_id": 146,
            "man_of_series_id": null,
            "total_overs_played": null,
            "elected": "bowling",
            "super_over": false,
            "follow_on": false,
            "localteam_dl_data": {
              "score": null,
              "overs": null,
              "wickets_out": null
            },
            "visitorteam_dl_data": {
              "score": null,
              "overs": null,
              "wickets_out": null
            },
            "rpc_overs": null,
            "rpc_target": null,
            "weather_report": [ ],
            "created_at": "2018-10-12T09:25:13+00:00",
            "updated_at": "2018-10-15T20:35:25+00:00"
          },
          "relationships": {
            "localteam": [ ],
            "visitorteam": [ ],
            "league": [ ],
            "season": [ ],
            "stage": [ ],
            "venue": [ ],
            "runs": [ ],
            "batting": [ ],
            "bowling": [ ],
            "comments": [ ],
            "lineup": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/livescores/1"
          }
      }
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/livescores/{id}?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    include false This is the relationship that can be included. eg localteam, visitorteam, league, season, stage, venue, batting, bowling, runs, comments

    Response Attributes

    Name Type Description
    type string The value will be livescores supported by the subscription of the user.
    id integer The id of the livescore in the database
    league_id integer The id of the league associated with this livescore
    season_id integer The id of the season associated with this livescore
    stage_id integer The id of the stage associated with this livescore
    round string round of the livescore
    localteam_id integer Id of the team playing at home
    visitorteam_id integer Id of the team played away
    starting_at string UTC date of the starting date/time of the game
    game_type string possible values 'T20','T10','ODI','T20I','4day','Test/5day','Test'
    live boolean will the game be hosting livescores or only final result
    status string can be one of NS,Aban,Cancl,Postp,Finished, Delayed, Dinner, Lunch,Innings Break,1st Innings,2nd Innings,3rd Innings,4th Innings,Stump Day 1,Stump Day 2,Stump Day 3,Stump Day 4,Tea Break,Int
    last_period string can be null of one of '1st Innings','2nd Innings','3rd Innings','4th Innings'
    note string important information, for example Wellington Firebirds won by 32 runs
    venue_id integer the id of the venue the game is played in
    toss_won_team_id integer the team who won the toss, also include=tosswon
    winner_team_id integer id of the winning team, also via include=winnerteam
    draw_noresult boolean if the game ended in draw or no-result this will be entered here
    first_umpire_id integer id of the first official, also via include=firstumpire
    second_umpire_id integer id of the secobnd official, also via include=secondumpire
    tv_umpire_id integer id of the tv official, also via include=tvumpire
    referee_id integer id of the referee, also via include=referee
    man_of_match_id integer id of the player who won this this, also via include=manofmatch
    man_of_series_id integer id of the player who won this this, also via include=manofseries
    total_overs_played integer the total number of overs played
    elected string can be batting or bowling
    super_over boolean (If a T20 & T20I and T10 league Matches goes tie then 1 over extra inngs will be player that's called Super Over )
    follow_on boolean (This happen in 4 day or 5 day Test matches if a team A Played first and score handsome and Team B all out on manimum Score (Half score of team A or less) Then Follow on in force mean Team B play again its 2nd Inngs. )
    localteam_dl_data object (If happen if a Team played their all over and Rain distrube the match So D/L method applied Score and over revised by D/L Method
    rpc_overs string Revised Overs
    rpc_target string Revised Score
    weather_report array report of the weather
    created_at string A timestamp representing when the livescore was created in the database
    updated_at string A timestamp representing when the livescore was last updated in the database
    relationships object These are other endpoints related to a livescore. They include league, season, stage, localteam, visitorteam, venue , runs, batting, bowling , comments or lineup
    links object Expect the key self which will be a link to the livescore

    Teams

    If you need details about a team then this is the endpoint to use. In it's pure form it will get you information about when the team started, what the address of their stadium is etc.

    Make sure to replace d4ksomxFumF6veb..... with your API key.

    Get All Teams

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/teams?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/teams?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": [
        {
          "type": "teams",
          "id": "1",
          "attributes": {
            "name": "Chennai Super Kings",
            "code": "CSK",
            "image_path": "https://cdn.sportmonks.com/images/path/to/team1.png",
            "national_team": false,
            "updated_at": "2018-11-13T19:33:52+00:00"
          },
          "relationships": {
            "country": [ ],
            "results": [ ],
            "fixtures": [ ],
            "players": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/teams/1"
          }
        },
        {
          "type": "teams",
          "id": "2",
          "attributes": {
            "name": "Delhi Daredevils",
            "code": "DD",
            "image_path": "https://cdn.sportmonks.com/images/path/to/team2.png",
            "national_team": false,
            "updated_at": "2018-11-13T19:33:52+00:00"
          },
          "relationships": {
            "country": [ ],
            "results": [ ],
            "fixtures": [ ],
            "players": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/teams/1"
          }
        }
      ]
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/teams?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    sort false This is the sorting attribute. If not provided, results will be sorted by id in ascending order. Options include name, or updated_at
    include false This is the relationship that can be included. eg country, results or fixtures

    Response Attributes

    Name Type Description
    type string The value will be teams because thats the expected response type
    id integer The id of the team in the database
    name string The name of the team
    code string The code used to represent the team
    image_path integer Path to the team's image
    national_team boolean This ia a boolean to show whether the team is a national team or not
    updated_at string A timestamp representing when the team was last updated in the database
    relationships object These are other endpoints related to a team. They include country, results, fixtures and players
    links object Expect the key self which will be a link to the team

    Get Team By ID

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/teams/1?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/teams/1?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": {
        "type": "teams",
        "id": "1",
        "attributes": {
          "name": "Chennai Super Kings",
          "code": "CSK",
          "image_path": "https://cdn.sportmonks.com/images/path/to/team1.png",
          "national_team": false,
          "updated_at": "2018-11-13T19:33:52+00:00"
        },
        "relationships": {
          "country": [ ],
          "results": [ ],
          "fixtures": [ ],
          "players": [ ]
        },
        "links": {
          "self": "https://cricket.sportmonks.com/api/v1/teams/1"
        }
      }
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/teams/{id}?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    include false This is the relationship that can be included. eg country, results or fixtures

    Response Attributes

    Name Type Description
    type string The value will be teams because thats the expected response type
    id integer The id of the team in the database
    name string The name of the team
    code string The code used to represent the team
    image_path integer Path to the team's image
    national_team boolean This ia a boolean to show whether the team is a national team or not
    updated_at string A timestamp representing when the team was last updated in the database
    relationships object These are other endpoints related to a team. They include country, results, fixtures and players
    links object Expect the key self which will be a link to the team

    Players

    By default this endpoint returns all players that have played at least 1 game under the leagues covered by the subscription of the user.

    Make sure to replace d4ksomxFumF6veb..... with your API key.

    Get All Players

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/players?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/players?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": [
        {
          "type": "players",
          "id": "1",
          "attributes": {
            "firstname": "Ahmed",
            "lastname": "Shehzad",
            "fullname": "Ahmed Shehzad",
            "image_path": "https://cdn.sportmonks.com/images/path/to/player1.png",
            "dateofbirth": 1991-11-23,
            "gender": "m",
            "position_id": 1,
            "country_id": 52126,
            "updated_at": "2018-11-15T19:33:52+00:00"
          },
          "relationships": {
            "country": [ ],
            "position": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/players/1"
          }
        },
        {
          "type": "players",
          "id": "2",
          "attributes": {
            "firstname": "Anwar",
            "lastname": "Ali",
            "fullname": "Anwar Ali",
            "image_path": "https://cdn.sportmonks.com/images/path/to/player2.png",
            "dateofbirth": "1987-11-25",
            "gender": "m",
            "position_id": 1,
            "country_id": 52126,
            "updated_at": "2018-11-15T19:33:52+00:00"
          },
          "relationships": {
            "country": [ ],
            "position": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/players/2"
          }
        }
      ]
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/players?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    sort false This is the sorting attribute. If not provided, results will be sorted by id in ascending order. Options include firstname, lastname, fullname, gender, dateofbirth, country_id or updated_at
    include false This is the relationship that can be included. eg position or country

    Response Attributes

    Name Type Description
    type string The value will be players because thats the expected response type
    id integer The id of the player in the database
    firstname string The first name of the player
    lastname string The last name of the player
    fullname string The full name of the player
    gender string The gender of the player
    image_path integer Path to the image of the player
    dateofbirth integer The date of birth of the player
    position_id integer The position id of the player
    country_id integer The country id of the player
    updated_at string A timestamp representing when the player was last updated in the database
    relationships object These are other endpoints related to a player. They include country and position
    links object Expect the key self which will be a link to the player

    Get Player By ID

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/players/1?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/players/1?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": {
        "type": "players",
        "id": "1",
        "attributes": {
          "firstname": "Ahmed",
          "lastname": "Shehzad",
          "fullname": "Ahmed Shehzad",
          "image_path": "https://cdn.sportmonks.com/images/path/to/player1.png",
          "dateofbirth": "1991-11-23",
          "gender": "m",
          "position_id": 1,
          "country_id": 52126,
          "updated_at": "2018-11-15T19:33:52+00:00"
        },
        "relationships": {
          "country": [ ],
          "position": [ ]
        },
        "links": {
          "self": "https://cricket.sportmonks.com/api/v1/players/1"
        }
      }
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/players/{id}?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    include false This is the relationship that can be included. eg position or country

    Response Attributes

    Name Type Description
    type string The value will be players because thats the expected response type
    id integer The id of the player in the database
    firstname string The first name of the player
    lastname string The last name of the player
    fullname string The full name of the player
    gender string The gender of the player
    image_path integer Path to the image of the player
    dateofbirth integer The date of birth of the player
    position_id integer The position id of the player
    country_id integer The country id of the player
    updated_at string A timestamp representing when the player was last updated in the database
    relationships object These are other endpoints related to a player. They include country and position
    links object Expect the key self which will be a link to the player

    Officials

    By default this endpoint returns all official/umpires that have hosted at least 1 game under the leagues covered by the subscription of the user.

    Make sure to replace d4ksomxFumF6veb..... with your API key.

    Get All Officials/Umpires

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/officials?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/officials?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": [
        {
          "type": "officials",
          "id": "1",
          "attributes": {
            "firstname": "Maraise",
            "lastname": "Erasmus",
            "fullname": "Maraise Erasmus",
            "image_path": "https://cdn.sportmonks.com/images/path/to/official1.png",
            "dateofbirth": "1964-02-27",
            "gender": "m",
            "country_id": 146,
            "updated_at": "2018-11-15T19:33:52+00:00"
          },
          "relationships": {
            "country": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/officials/1"
          }
        },
        {
          "type": "officials",
          "id": "2",
          "attributes": {
            "firstname": "Aleem",
            "lastname": "Dar",
            "fullname": "Aleem Dar",
            "image_path": "https://cdn.sportmonks.com/images/path/to/official2.png",
            "dateofbirth": "1968-06-06",
            "gender": "m",
            "country_id": 52126,
            "updated_at": "2018-11-15T19:33:52+00:00"
          },
          "relationships": {
            "country": [ ]
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/officials/2"
          }
        }
      ]
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/officials?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    sort false This is the sorting attribute. If not provided, results will be sorted by id in ascending order. Options include firstname, lastname, fullname, gender, dateofbirth, country_id or updated_at
    include false This is the relationship that can be included. eg country

    Response Attributes

    Name Type Description
    type string The value will be officials because thats the expected response type
    id integer The id of the official/umpire in the database
    firstname string The first name of the official/umpire
    lastname string The last name of the official/umpire
    fullname string The full name of the official/umpire
    gender string The gender of the official/umpire
    image_path integer Path to the image of the official/umpire
    dateofbirth integer The date of birth of the official/umpire
    country_id integer The country id of the official/umpire
    updated_at string A timestamp representing when the official/umpire was last updated in the database
    relationships object These are other endpoints related to a official/umpire. They include country
    links object Expect the key self which will be a link to the official/umpire

    Get Official/Umpire By ID

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/officials/1?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/officials/1?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": {
        "type": "officials",
        "id": "1",
        "attributes": {
          "firstname": "Maraise",
          "lastname": "Erasmus",
          "fullname": "Maraise Erasmus",
          "image_path": "https://cdn.sportmonks.com/images/path/to/official1.png",
          "dateofbirth": "1964-02-27",
          "gender": "m",
          "country_id": 146,
          "updated_at": "2018-11-15T19:33:52+00:00"
        },
        "relationships": {
          "country": [ ]
        },
        "links": {
          "self": "https://cricket.sportmonks.com/api/v1/officials/1"
        }
      }
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/officials/{id}?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    include false This is the relationship that can be included. eg country

    Response Attributes

    Name Type Description
    type string The value will be officials because thats the expected response type
    id integer The id of the official/umpire in the database
    firstname string The first name of the official/umpire
    lastname string The last name of the official/umpire
    fullname string The full name of the official/umpire
    gender string The gender of the official/umpire
    image_path integer Path to the image of the official/umpire
    dateofbirth integer The date of birth of the official/umpire
    country_id integer The country id of the official/umpire
    updated_at string A timestamp representing when the official/umpire was last updated in the database
    relationships object These are other endpoints related to a official/umpire. They include country
    links object Expect the key self which will be a link to the official/umpire

    Venues

    By default this endpoint returns all venues that have hosted at least 1 game under the leagues covered by the subscription of the user.

    With this endpoint you have the ability to retrieve details like, pitch type, address, capacity of a given venue.

    Make sure to replace d4ksomxFumF6veb..... with your API key.

    Get All Venues

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/venues?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/venues?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": [
        {
          "type": "venues",
          "id": "1",
          "attributes": {
            "name": "Adelaide Oval",
            "city": "Adelaide",
            "capacity": 53583,
            "floodlight": true,
            "country_id": 98,
            "updated_at": "2018-11-15T19:33:52+00:00"
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/venues/1"
          }
        },
        {
          "type": "venues",
          "id": "2",
          "attributes": {
            "name": "Bangabandhu National Stadium",
            "city": "Dhaka",
            "capacity": 36000,
            "floodlight": true,
            "country_id": 155043,
            "updated_at": "2018-11-15T19:33:52+00:00"
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/venues/2"
          }
        }
      ]
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/venues?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    sort false This is the sorting attribute. If not provided, results will be sorted by id in ascending order. Options include name , floodlight , capacity or updated_at
    include false This is the relationship that can be included. eg fixtures

    Response Attributes

    Name Type Description
    type string The value will be venues because thats the expected response type
    id integer The id of the venue in the database
    name string The name of the venue
    city string The city where the venue is located
    capacity string The capacity which the venue can hold
    floodlight boolean Does the venue have a floodlight or not
    country_id integer The country id of the venue
    updated_at string A timestamp representing when the venue was last updated in the database
    links object Expect the key self which will be a link to the venue

    Get Venue By ID

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/venues/1?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/venues/1?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": {
        "type": "venues",
        "id": "1",
        "attributes": {
          "name": "Adelaide Oval",
          "city": "Adelaide",
          "capacity": 53583,
          "floodlight": true,
          "country_id": 98,
          "updated_at": "2018-11-15T19:33:52+00:00"
        },
        "links": {
          "self": "https://cricket.sportmonks.com/api/v1/venues/1"
        }
      }
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/venues/{id}?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    include false This is the relationship that can be included. eg fixtures

    Response Attributes

    Name Type Description
    type string The value will be venues because thats the expected response type
    id integer The id of the venue in the database
    name string The name of the venue
    city string The city where the venue is located
    capacity string The capacity which the venue can hold
    floodlight boolean Does the venue have a floodlight or not
    country_id integer The country id of the venue
    updated_at string A timestamp representing when the venue was last updated in the database
    links object Expect the key self which will be a link to the venue

    Positions

    By default this endpoint returns all positions.

    Make sure to replace d4ksomxFumF6veb..... with your API key.

    Get All Positions

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/positions?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/positions?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": [
        {
          "type": "positions",
          "id": "1",
          "attributes": {
            "name": "Bowler",
            "updated_at": "2018-11-15T19:33:52+00:00"
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/positions/1"
          }
        },
        {
          "type": "positions",
          "id": "2",
          "attributes": {
            "name": "Wicketkeeper",
            "updated_at": "2018-11-15T19:33:52+00:00"
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/positions/2"
          }
        }
      ]
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/positions?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    sort false This is the sorting attribute. If not provided, results will be sorted by id in ascending order. Options include name or updated_at

    Response Attributes

    Name Type Description
    type string The value will be positions because thats the expected response type
    id integer The id of the position in the database
    name string The name of the position
    updated_at string A timestamp representing when the position was last updated in the database
    links object Expect the key self which will be a link to the position

    Get Position By ID

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/positions/1?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/positions/1?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": {
        "type": "positions",
        "id": "1",
        "attributes": {
          "name": "Bowler",
          "updated_at": "2018-11-15T19:33:52+00:00"
        },
        "links": {
          "self": "https://cricket.sportmonks.com/api/v1/positions/1"
        }
      }
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/positions/{id}?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API

    Response Attributes

    Name Type Description
    type string The value will be positions because thats the expected response type
    id integer The id of the position in the database
    name string The name of the position
    updated_at string A timestamp representing when the position was last updated in the database
    links object Expect the key self which will be a link to the position

    Stages

    This endpoint represents the stages of a season under the leagues hosted by the API.

    Leagues can be split up in stages representing a period a game is played in. With this endpoint we give you a ability to request data for a single stages as well as all stages of a season.

    Make sure to replace d4ksomxFumF6veb..... with your API key.

    Get All Stages

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/stages?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/stages?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": [
        {
          "type": "stages",
          "id": "1",
          "attributes": {
            "name": "Group A",
            "code": "GA",
            "league_id": 16,
            "season_id": 19,
            "stage_type": true,
            "standings": true,
            "updated_at": "2018-11-15T19:33:52+00:00"
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/stages/1"
          }
        },
        {
          "type": "stages",
          "id": "2",
          "attributes": {
            "name": "Group B",
            "code": "GB",
            "league_id": 16,
            "season_id": 19,
            "stage_type": true,
            "standings": true,
            "updated_at": "2018-11-15T19:33:52+00:00"
          },
          "links": {
            "self": "https://cricket.sportmonks.com/api/v1/stages/2"
          }
        }
      ]
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/stages?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    sort false This is the sorting attribute. If not provided, results will be sorted by id in ascending order. Options include name , code , stage_type or updated_at
    include false This is the relationship that can be included. eg fixtures, league or season

    Response Attributes

    Name Type Description
    type string The value will be stages because thats the expected response type
    id integer The id of the stage in the database
    name string The name of the stage
    code string The code of the stage
    league_id integer The id of the league hosting this stage
    season_id integer The id of the season hosting this stage
    stage_type boolean Is the type stage?
    standings boolean Standings represent the progression teams are making during a season
    updated_at string A timestamp representing when the stage was last updated in the database
    links object Expect the key self which will be a link to the stage

    Get Stage By ID

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/stages/1?api_token=d4ksomxFumF6..."
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/stages/1?api_token=d4ksomxFumF6...', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
      "data": {
        "type": "stages",
        "id": "1",
        "attributes": {
          "name": "Group A",
          "code": "GA",
          "league_id": 16,
          "season_id": 19,
          "stage_type": true,
          "standings": true,
          "updated_at": "2018-11-15T19:33:52+00:00"
        },
        "links": {
          "self": "https://cricket.sportmonks.com/api/v1/stages/1"
        }
      }
    }
    

    HTTP Request

    GET https://cricket.sportmonks.com/api/v1/stages/{id}?api_token=d4ksomxFumF6...

    Query Parameters

    Parameter Required Description
    api_token true This is the token that will allow you to access the API
    include false This is the relationship that can be included. eg fixtures, league or season

    Response Attributes

    Name Type Description
    type string The value will be stages because thats the expected response type
    id integer The id of the stage in the database
    name string The name of the stage
    code string The code of the stage
    league_id integer The id of the league hosting this stage
    season_id integer The id of the season hosting this stage
    stage_type boolean Is the type stage?
    standings boolean Standings represent the progression teams are making during a season
    updated_at string A timestamp representing when the stage was last updated in the database
    links object Expect the key self which will be a link to the stage

    Relationships

    Here is a list of relationships and a brief description about them

    Batting Scoreboards

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6...&include=batting"
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6...&include=batting', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    "included": [
        {
            "type": "battings",
            "id": "306",
            "attributes": {
                "sort": 7,
                "fixture_id": 21,
                "team_id": 39,
                "active": false,
                "scoreboard": "S1",
                "player_id": 171,
                "score": 19,
                "ball": 15,
                "four_x": 1,
                "six_x": 1,
                "catch_stump_player_id": null,
                "batsmanout_id": null,
                "bowling_player_id": null,
                "fow_score": 0,
                "fow_balls": 0,
                "rate": 0,
                "updated_at": "2018-10-23T18:41:55+00:00"
            },
            "relationships": {
                "player": [],
                "score": []
            }
        }
    ],
    
    Name Type Description
    type string The value will be battings because thats the expected response type
    id integer The id of the the batting scoreboard of this fixture
    sort integer Increasing number, equal as the amount of player currently batted
    fixture_id integer The id of the fixture associated with the batting scoreboard
    team_id integer The id of the team associated with the batting scoreboard of this fixture
    active bool True if the player is currently batting, false if not.
    scoreboard string Can have a value of S1, S2, S3 or S4
    player_id integer The id of the player associated with the batting scoreboard of this fixture
    score integer The id of the runs associated with the batting scoreboard of this fixture
    ball integer The score for the player associated with the batting scoreboard
    four_x integer Number of fours
    six_x integer Number of sixes
    catch_stump_player_id integer The id of the runs associated with the batting scoreboard of this fixture
    batsmanout_id integer The id of the batsman
    bowling_player_id integer The id of the player bowling
    fow_score integer Fall of wicket score
    fow_balls integer Fall of wicket balls
    rate integer The rate of the player
    updated_at string A timestamp representing when the batting scoreboard was last updated in the database

    Bowling Scoreboards

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6...&include=bowling"
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6...&include=bowling', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    "included": [
        {
            "type": "bowlings",
            "id": "195",
            "attributes": {
                "sort": 1,
                "fixture_id": 21,
                "team_id": 38,
                "active": false,
                "scoreboard": "S1",
                "player_id": 160,
                "overs": 8,
                "medians": 0,
                "runs": 55,
                "wickets": 0,
                "rate": 7,
                "wide": 5,
                "noball": 0,
                "updated_at": "2018-10-23T18:41:55+00:00"
            },
            "relationships": {
                "player": [],
                "score": []
            }
        }
    ]
    
    Name Type Description
    type string The value will be bowlings because thats the expected response type
    id integer The id of the the bowling scoreboard of this fixture
    sort integer Increasing number, equal as the amount of player currently bowled
    fixture_id integer The id of the fixture associated with the bowling scoreboard
    team_id integer The id of the team associated with the bowling scoreboard of this fixture
    active bool True if the player is currently bowling, false if not.
    scoreboard string Can have a value of S1, S2, S3 or S4
    player_id integer The id of the player associated with the bowling scoreboard of this fixture
    overs integer Number of overs
    medians integer Number of medians
    runs integer Number of runs
    wickets integer Number of wickets
    rate integer The rate of the player
    wide integer Number of wides
    noball integer Number of noballs
    updated_at string A timestamp representing when the bowling scoreboard was last updated in the database

    Runs

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6...&include=runs"
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6...&include=runs', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    "included": [
        {
            "type": "runs",
            "id": "49",
            "attributes": {
                "fixture_id": 21,
                "team_id": 39,
                "inning": 1,
                "score": 366,
                "wickets": 6,
                "overs": 50,
                "pp1": null,
                "pp2": null,
                "pp3": null,
                "updated_at": "2018-10-23T18:51:52+00:00"
            }
        }
    ]
    
    Name Type Description
    type string The value will be runs because thats the expected response type
    id integer The id of the runs associated with the bruns of this fixture
    fixture_id integer The id of the fixture associated with the runs
    team_id integer The id of the team associated with the runs of this fixture
    inning integer Can be a value of 1, 2, 3, or 4
    score integer The score in the inning for the tea
    wickets integer The amount of wickets in the inning for the team
    overs integer The amount of overs in the inning for the team
    pp1 integer
    pp2 integer
    pp3 integer
    updated_at string A timestamp representing when the run was last updated in the database

    Comments

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6...&include=comments"
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6...&include=comments', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    "included": [
        {
            "type": "comments",
            "id": "208",
            "attributes": {
                "fixture_id": 208,
                "team_id": 41,
                "scoreboard": "S1",
                "batsman_id": 83,
                "bowler_id": 231,
                "batsmanout_id": null,
                "catchstump_id": null,
                "score_id": 82,
                "updated_at": "2018-10-26T16:03:05+00:00"
            },
            "relationships": {
                "batsman": [],
                "bowler": [],
                "batsmanout": [],
                "catchstump": [],
                "score": []
            }
        }
    ]
    
    Name Type Description
    type string The value will be comments because thats the expected response type
    id integer The id of the comment associated with the bruns of this fixture
    fixture_id integer The id of the fixture associated with the comment
    scoreboard string Can have a value of S1, S2, S3 or S4
    batsman_id integer The id of the player batting
    bowler_id integer The id of the player bowling
    catchstump_id integer The id of the catch/stump player
    score_id integer The id of the score which can be included via a sub-include
    updated_at string A timestamp representing when the comment was last updated in the database

    Score

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6...&include=comments.score"
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6...&include=comments.score', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    "included": [
        {
            "type": "scores",
            "id": "82",
            "attributes": {
                "name": "No Run",
                "updated_at": "2018-11-06T19:11:43+00:00"
            }
        }
    ]
    
    Name Type Description
    type string The value will be scores because thats the expected response type
    id integer The id of the score record in the database
    name string The type of score represented for the comment.
    updated_at string A timestamp representing when the score was last updated in the database

    Squad

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/teams/1?api_token=d4ksomxFumF6...&include=squad"
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/teams/1?api_token=d4ksomxFumF6...&include=squad', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    "included": [
        {
            "type": "players",
            "id": "43",
            "attributes": {
                "firstname": "Andrew",
                "lastname": "Tye",
                "fullname": "Andrew Tye",
                "image_path": null,
                "dateofbirth": "1986-12-12",
                "gender": "m",
                "position_id": 2,
                "country_id": 98,
                "updated_at": "2018-11-15T10:03:44+00:00"
            },
            "relationships": {
                "country": [],
                "position": []
            }
        }
    ]
    
    Name Type Description
    type string The value will be officials because thats the expected response type
    id integer The id of the official/umpire in the database
    firstname string The first name of the official/umpire
    lastname string The last name of the official/umpire
    fullname string The full name of the official/umpire
    gender string The gender of the official/umpire
    image_path integer Path to the image of the official/umpire
    dateofbirth integer The date of birth of the official/umpire
    country_id integer The country id of the official/umpire
    updated_at string A timestamp representing when the official/umpire was last updated in the database
    relationships object These are other endpoints related to a player. They include country and position

    Lineup

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6...&include=lineup"
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6...&include=lineup', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    "included": [
        {
            "type": "players",
            "id": "169",
            "attributes": {
                "firstname": "Upul",
                "lastname": "Tharanga",
                "fullname": "Upul Tharanga",
                "image_path": null,
                "dateofbirth": "1985-02-02",
                "gender": "m",
                "position_id": 2,
                "country_id": 38404,
                "updated_at": "2018-11-16T16:32:10+00:00",
                "lineup": {
                    "team_id": 39,
                    "wicketkeeper": false,
                    "captain": false
                }
            },
            "relationships": {
                "country": [],
                "position": []
            }
        }
    ]
    

    Response Attributes

    Name Type Description
    type string The value will be players because thats the expected response type
    id integer The id of the player playing for the team
    firstname string The first name of the official/umpire
    lastname string The last name of the official/umpire
    fullname string The full name of the official/umpire
    gender string The gender of the official/umpire
    image_path integer Path to the image of the official/umpire
    dateofbirth integer The date of birth of the official/umpire
    country_id integer The country id of the official/umpire
    updated_at string A timestamp representing when the official/umpire was last updated in the database
    lineup object An object containing lineup information like captain, wicketkeeper and team_id

    Odds

    Example Request:

    curl "https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6...&include=odds"
    -H "Accept: application/vnd.api+json"
    
    <?
    
    $client = new GuzzleHttp\Client();
    $res = $client->request('GET', 'https://cricket.sportmonks.com/api/v1/fixtures/1?api_token=d4ksomxFumF6...&include=odds', []);
    
    $data = $res->getBody();
    
    ?>
    

    Example Response:

    {
        "type": "odds",
        "id": "3",
        "attributes": {
            "fixture_id": 18,
            "bookmaker_id": 3,
            "market_id": 10,
            "value": [
                {
                    "label": "Home",
                    "value": "1.82",
                    "american": -122,
                    "handicap": null
                },
                {
                    "label": "Away",
                    "value": "1.94",
                    "american": -106,
                    "handicap": null
                }
            ],
            "created_at": "2018-11-30T10:46:49+00:00",
            "updated_at": "2018-11-30T10:46:49+00:00"
        },
    ]
    

    Response Attributes

    Name Type Description
    id integer The id of the pre-match odd in the database
    type string The value will be odds because thats the expected response type
    bookmaker object The details of the bookmaker. It includes the id of the bookmarker, the name and the odds for it
    fixture_id integer The id of the related fixture
    bookmaker_id integer The id of the bookmaker providing the odd
    market_id integer The id of the market of the odd.
    value array Containing out of a label, value, american and handicap
    created_at string Date and time the odds was created in our system
    updated_at string Date and time the odds was last updated in our system

    Errors

    SportMonks uses conventional HTTP response codes to indicate the success or failure of an API request.

    In general:

    HTTP status code summary

    200 - OK - Everything worked successfully.
    
    
    400 - Bad Request   - The request was unacceptable, often due to missing a required parameter.
    
    
    401 - Unauthorized  - No valid API key provided.
    
    
    402 - Request Failed - The parameters were valid but the request failed.
    
    
    404 - Not Found - The requested resource doesnt exist
    
    
    409 - Conflict  - The request has conflicts (perhaps due to using the same idempotent key).
    
    
    429 - Too Many Requests - Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
    
    
    500, 502, 503, 504 - Server Errors