# Table of Contents - [Welcome | API 3.0](#welcome-api-3-0) - [Endpoints | BETA Documentation | API 3.0](#endpoints-beta-documentation-api-3-0) - [Welcome | BETA Documentation | API 3.0](#welcome-beta-documentation-api-3-0) - [GET Expected by Team | BETA Documentation | API 3.0](#get-expected-by-team-beta-documentation-api-3-0) - [Includes | BETA Documentation | API 3.0](#includes-beta-documentation-api-3-0) - [GET Expected by Player | BETA Documentation | API 3.0](#get-expected-by-player-beta-documentation-api-3-0) - [Entity | BETA Documentation | API 3.0](#entity-beta-documentation-api-3-0) - [Types | BETA Documentation | API 3.0](#types-beta-documentation-api-3-0) - [FAQ | BETA Documentation | API 3.0](#faq-beta-documentation-api-3-0) - [Welcome | Football Widgets | API 3.0](#welcome-football-widgets-api-3-0) - [Livescore widgets | Football Widgets | API 3.0](#livescore-widgets-football-widgets-api-3-0) - [Livescores | Football Widgets | API 3.0](#livescores-football-widgets-api-3-0) - [Topscorers | Football Widgets | API 3.0](#topscorers-football-widgets-api-3-0) - [Schedule | Football Widgets | API 3.0](#schedule-football-widgets-api-3-0) - [Configurations | Football Widgets | API 3.0](#configurations-football-widgets-api-3-0) - [League widgets | Football Widgets | API 3.0](#league-widgets-football-widgets-api-3-0) - [Team widgets | Football Widgets | API 3.0](#team-widgets-football-widgets-api-3-0) - [Match centre | Football Widgets | API 3.0](#match-centre-football-widgets-api-3-0) - [Configurations | Football Widgets | API 3.0](#configurations-football-widgets-api-3-0) - [Team statistics | Football Widgets | API 3.0](#team-statistics-football-widgets-api-3-0) - [Standings | Football Widgets | API 3.0](#standings-football-widgets-api-3-0) - [Squads | Football Widgets | API 3.0](#squads-football-widgets-api-3-0) - [Latest matches | Football Widgets | API 3.0](#latest-matches-football-widgets-api-3-0) - [Configurations | Football Widgets | API 3.0](#configurations-football-widgets-api-3-0) - [Current round | Football Widgets | API 3.0](#current-round-football-widgets-api-3-0) - [Core | Core API 3.0 | API 3.0](#core-core-api-3-0-api-3-0) - [Configurations | Football Widgets | API 3.0](#configurations-football-widgets-api-3-0) - [Schedule | Football Widgets | API 3.0](#schedule-football-widgets-api-3-0) - [Authentication | Odds API 3.0 | API 3.0](#authentication-odds-api-3-0-api-3-0) - [Standings | Football Widgets | API 3.0](#standings-football-widgets-api-3-0) - [How-to create your widget in three steps | Football Widgets | API 3.0](#how-to-create-your-widget-in-three-steps-football-widgets-api-3-0) - [Query complexity | Odds API 3.0 | API 3.0](#query-complexity-odds-api-3-0-api-3-0) - [Next fixture | Football Widgets | API 3.0](#next-fixture-football-widgets-api-3-0) - [Response Codes | Odds API 3.0 | API 3.0](#response-codes-odds-api-3-0-api-3-0) - [Welcome | Odds API 3.0 | API 3.0](#welcome-odds-api-3-0-api-3-0) - [Continents | Core API 3.0 | API 3.0](#continents-core-api-3-0-api-3-0) - [Countries | Core API 3.0 | API 3.0](#countries-core-api-3-0-api-3-0) - [Regions | Core API 3.0 | API 3.0](#regions-core-api-3-0-api-3-0) - [Endpoints | Odds API 3.0 | API 3.0](#endpoints-odds-api-3-0-api-3-0) - [Cities | Core API 3.0 | API 3.0](#cities-core-api-3-0-api-3-0) - [Timezones | Core API 3.0 | API 3.0](#timezones-core-api-3-0-api-3-0) - [Filters | Core API 3.0 | API 3.0](#filters-core-api-3-0-api-3-0) - [My Sportmonks | Core API 3.0 | API 3.0](#my-sportmonks-core-api-3-0-api-3-0) - [Types | Core API 3.0 | API 3.0](#types-core-api-3-0-api-3-0) - [Pre-match Odds | Odds API 3.0 | API 3.0](#pre-match-odds-odds-api-3-0-api-3-0) - [Inplay Odds | Odds API 3.0 | API 3.0](#inplay-odds-odds-api-3-0-api-3-0) - [Bookmakers | Odds API 3.0 | API 3.0](#bookmakers-odds-api-3-0-api-3-0) - [Entities | Odds API 3.0 | API 3.0](#entities-odds-api-3-0-api-3-0) - [GET My Resources | Core API 3.0 | API 3.0](#get-my-resources-core-api-3-0-api-3-0) - [GET Continent by ID | Core API 3.0 | API 3.0](#get-continent-by-id-core-api-3-0-api-3-0) - [Markets | Odds API 3.0 | API 3.0](#markets-odds-api-3-0-api-3-0) - [GET My Leagues | Core API 3.0 | API 3.0](#get-my-leagues-core-api-3-0-api-3-0) - [Market | Odds API 3.0 | API 3.0](#market-odds-api-3-0-api-3-0) - [GET Type by ID | Core API 3.0 | API 3.0](#get-type-by-id-core-api-3-0-api-3-0) - [Bookmaker | Odds API 3.0 | API 3.0](#bookmaker-odds-api-3-0-api-3-0) - [GET My Usage | Core API 3.0 | API 3.0](#get-my-usage-core-api-3-0-api-3-0) - [GET Regions by Search | Core API 3.0 | API 3.0](#get-regions-by-search-core-api-3-0-api-3-0) - [GET My Enrichments | Core API 3.0 | API 3.0](#get-my-enrichments-core-api-3-0-api-3-0) - [GET Region by ID | Core API 3.0 | API 3.0](#get-region-by-id-core-api-3-0-api-3-0) - [GET All Continents | Core API 3.0 | API 3.0](#get-all-continents-core-api-3-0-api-3-0) - [GET All Entity Filters | Core API 3.0 | API 3.0](#get-all-entity-filters-core-api-3-0-api-3-0) - [GET City by ID | Core API 3.0 | API 3.0](#get-city-by-id-core-api-3-0-api-3-0) - [GET All Types | Core API 3.0 | API 3.0](#get-all-types-core-api-3-0-api-3-0) - [GET Odds by Fixture ID and Market ID | Odds API 3.0 | API 3.0](#get-odds-by-fixture-id-and-market-id-odds-api-3-0-api-3-0) - [GET Last Updated Odds | Odds API 3.0 | API 3.0](#get-last-updated-odds-odds-api-3-0-api-3-0) - [GET Odds by Fixture ID and Bookmaker ID | Odds API 3.0 | API 3.0](#get-odds-by-fixture-id-and-bookmaker-id-odds-api-3-0-api-3-0) - [GET All Cities | Core API 3.0 | API 3.0](#get-all-cities-core-api-3-0-api-3-0) - [GET Country by ID | Core API 3.0 | API 3.0](#get-country-by-id-core-api-3-0-api-3-0) - [Odd | Odds API 3.0 | API 3.0](#odd-odds-api-3-0-api-3-0) - [InplayOdd | Odds API 3.0 | API 3.0](#inplayodd-odds-api-3-0-api-3-0) - [Request options | Odds API 3.0 | API 3.0](#request-options-odds-api-3-0-api-3-0) - [GET Bookmaker Event ID's by Fixture Id | Odds API 3.0 | API 3.0](#get-bookmaker-event-id-s-by-fixture-id-odds-api-3-0-api-3-0) - [GET All Regions | Core API 3.0 | API 3.0](#get-all-regions-core-api-3-0-api-3-0) - [GET All Supported Time Zones | Core API 3.0 | API 3.0](#get-all-supported-time-zones-core-api-3-0-api-3-0) - [GET Cities by Search | Core API 3.0 | API 3.0](#get-cities-by-search-core-api-3-0-api-3-0) - [GET Type by Entity | Core API 3.0 | API 3.0](#get-type-by-entity-core-api-3-0-api-3-0) - [GET Countries by Search | Core API 3.0 | API 3.0](#get-countries-by-search-core-api-3-0-api-3-0) - [GET All Odds | Odds API 3.0 | API 3.0](#get-all-odds-odds-api-3-0-api-3-0) - [GET Odds by Fixture ID and Bookmaker ID | Odds API 3.0 | API 3.0](#get-odds-by-fixture-id-and-bookmaker-id-odds-api-3-0-api-3-0) - [GET Bookmaker by ID | Odds API 3.0 | API 3.0](#get-bookmaker-by-id-odds-api-3-0-api-3-0) - [GET Bookmakers Search by Name | Odds API 3.0 | API 3.0](#get-bookmakers-search-by-name-odds-api-3-0-api-3-0) - [GET Market by ID | Odds API 3.0 | API 3.0](#get-market-by-id-odds-api-3-0-api-3-0) - [GET Last Updated Odds | Odds API 3.0 | API 3.0](#get-last-updated-odds-odds-api-3-0-api-3-0) - [Core | Core API 3.0 | API 3.0](#core-core-api-3-0-api-3-0) - [GET All Countries | Core API 3.0 | API 3.0](#get-all-countries-core-api-3-0-api-3-0) - [GET Odds by Fixture ID and Market ID | Odds API 3.0 | API 3.0](#get-odds-by-fixture-id-and-market-id-odds-api-3-0-api-3-0) - [GET Odds by Fixture ID | Odds API 3.0 | API 3.0](#get-odds-by-fixture-id-odds-api-3-0-api-3-0) - [GET Markets by Search by Name | Odds API 3.0 | API 3.0](#get-markets-by-search-by-name-odds-api-3-0-api-3-0) - [GET All Odds | Odds API 3.0 | API 3.0](#get-all-odds-odds-api-3-0-api-3-0) - [Query complexity | Motorsport 3.0 (beta) | API 3.0](#query-complexity-motorsport-3-0-beta-api-3-0) - [Welcome | Motorsport 3.0 (beta) | API 3.0](#welcome-motorsport-3-0-beta-api-3-0) - [Getting Started | Motorsport 3.0 (beta) | API 3.0](#getting-started-motorsport-3-0-beta-api-3-0) - [Changelog | Motorsport 3.0 (beta) | API 3.0](#changelog-motorsport-3-0-beta-api-3-0) - [GET Odds by Fixture ID | Odds API 3.0 | API 3.0](#get-odds-by-fixture-id-odds-api-3-0-api-3-0) - [GET Bookmakers by Fixture ID | Odds API 3.0 | API 3.0](#get-bookmakers-by-fixture-id-odds-api-3-0-api-3-0) - [Authentication | Motorsport 3.0 (beta) | API 3.0](#authentication-motorsport-3-0-beta-api-3-0) - [GET All Bookmakers | Odds API 3.0 | API 3.0](#get-all-bookmakers-odds-api-3-0-api-3-0) - [Response Codes | Motorsport 3.0 (beta) | API 3.0](#response-codes-motorsport-3-0-beta-api-3-0) - [GET All Markets | Odds API 3.0 | API 3.0](#get-all-markets-odds-api-3-0-api-3-0) - [Quick Start Guide | API 3.0](#quick-start-guide-api-3-0) - [Guides | Motorsport 3.0 (beta) | API 3.0](#guides-motorsport-3-0-beta-api-3-0) - [Tutorials | Motorsport 3.0 (beta) | API 3.0](#tutorials-motorsport-3-0-beta-api-3-0) - [Endpoints | Motorsport 3.0 (beta) | API 3.0](#endpoints-motorsport-3-0-beta-api-3-0) - [Metadata & Per-Season Data Type Reference | Motorsport 3.0 (beta) | API 3.0](#metadata-per-season-data-type-reference-motorsport-3-0-beta-api-3-0) - [Differences between API 2 and API 3 | API 3.0](#differences-between-api-2-and-api-3-api-3-0) - [Status / State | Motorsport 3.0 (beta) | API 3.0](#status-state-motorsport-3-0-beta-api-3-0) - [Teams | Motorsport 3.0 (beta) | API 3.0](#teams-motorsport-3-0-beta-api-3-0) - [Seasons | Motorsport 3.0 (beta) | API 3.0](#seasons-motorsport-3-0-beta-api-3-0) - [Code libraries | API 3.0](#code-libraries-api-3-0) - [Request options | API 3.0](#request-options-api-3-0) - [Getting Started | API 3.0](#getting-started-api-3-0) - [Most important docs pages | API 3.0](#most-important-docs-pages-api-3-0) - [Other Exceptions | API 3.0](#other-exceptions-api-3-0) - [Results & Live Data Type Reference | Motorsport 3.0 (beta) | API 3.0](#results-live-data-type-reference-motorsport-3-0-beta-api-3-0) - [Include Exceptions | API 3.0](#include-exceptions-api-3-0) - [Error codes | API 3.0](#error-codes-api-3-0) - [Rate limit | API 3.0](#rate-limit-api-3-0) - [Data corrections | API 3.0](#data-corrections-api-3-0) - [Filtering | API 3.0](#filtering-api-3-0) - [Syntax | API 3.0](#syntax-api-3-0) - [Meta description | API 3.0](#meta-description-api-3-0) - [API Coach | API 3.0](#api-coach-api-3-0) - [Entities | Motorsport 3.0 (beta) | API 3.0](#entities-motorsport-3-0-beta-api-3-0) - [Authentication | API 3.0](#authentication-api-3-0) - [Request options | Motorsport 3.0 (beta) | API 3.0](#request-options-motorsport-3-0-beta-api-3-0) - [Includes | API 3.0](#includes-api-3-0) - [Live | Motorsport 3.0 (beta) | API 3.0](#live-motorsport-3-0-beta-api-3-0) - [Filtering and Complexity Exceptions | API 3.0](#filtering-and-complexity-exceptions-api-3-0) - [State | Motorsport 3.0 (beta) | API 3.0](#state-motorsport-3-0-beta-api-3-0) - [Pitstops | Motorsport 3.0 (beta) | API 3.0](#pitstops-motorsport-3-0-beta-api-3-0) - [Venues | Motorsport 3.0 (beta) | API 3.0](#venues-motorsport-3-0-beta-api-3-0) - [Race Results | Motorsport 3.0 (beta) | API 3.0](#race-results-motorsport-3-0-beta-api-3-0) - [Pitstop | Motorsport 3.0 (beta) | API 3.0](#pitstop-motorsport-3-0-beta-api-3-0) - [Lap | Motorsport 3.0 (beta) | API 3.0](#lap-motorsport-3-0-beta-api-3-0) - [Stint | Motorsport 3.0 (beta) | API 3.0](#stint-motorsport-3-0-beta-api-3-0) --- # Welcome | API 3.0 ![Page cover](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3469464275-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F9zsNGu3HAzSnl5DWBD3Y%252Fuploads%252Fbr9kOGhz3YRebz46JMaI%252FGitbook%2520Banner%282%29.png%3Falt%3Dmedia%26token%3D402c5c45-dfee-493e-8f2a-263b0ebf2a62&width=1248&dpr=3&quality=100&sign=2b8de26c&sv=2) [](https://docs.sportmonks.com/v3/welcome/getting-started) ![Cover](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3469464275-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F9zsNGu3HAzSnl5DWBD3Y%252Fuploads%252FvV4uNZMBHhfuSDtkFU46%252FYoutube%2520Getting%2520Started.png%3Falt%3Dmedia%26token%3D02977999-de00-42b8-8166-b710fa23457f&width=490&dpr=3&quality=100&sign=147b8b70&sv=2) **Getting started** Watch a detailed tutorial video of how you can get started using our API. [](https://docs.sportmonks.com/v3/api/request-options) ![Cover](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3469464275-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F9zsNGu3HAzSnl5DWBD3Y%252Fuploads%252FlIyQmqJFr6A1Bz20m174%252FRequest%2520Options.png%3Falt%3Dmedia%26token%3D5235048b-7f8f-45cc-99ec-3dfb2346d314&width=490&dpr=3&quality=100&sign=ddb55c27&sv=2) **Request options** Learn how to optimise your API requests with filters, includes, and field selection [](https://docs.sportmonks.com/v3/endpoints-and-entities/endpoints) ![Cover](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3469464275-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F9zsNGu3HAzSnl5DWBD3Y%252Fuploads%252FucyES8y46wjIQ5J3M1G1%252FEndpointsGitbook.png%3Falt%3Dmedia%26token%3Dffcb7462-a7a2-4289-b7ff-3d45d311cd17&width=490&dpr=3&quality=100&sign=5001e747&sv=2) **Endpoints** View all the Endpoints we have available in our API. [](https://docs.sportmonks.com/v3/welcome/best-practices) ![Cover](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3469464275-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F9zsNGu3HAzSnl5DWBD3Y%252Fuploads%252FFk243yRu8MT9WJHZ2SqA%252FBest%2520Practices.png%3Falt%3Dmedia%26token%3Dcca06eab-f3e2-42d0-bbfb-6a81494e94c6&width=490&dpr=3&quality=100&sign=98cca614&sv=2) **Best Practices** Learn how to use our API in the best way possible. [](https://docs.sportmonks.com/v3/odds-api/) ![Cover](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3469464275-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F9zsNGu3HAzSnl5DWBD3Y%252Fuploads%252FpUFsblGB7OuNbx0Ws3iM%252FOdds.png%3Falt%3Dmedia%26token%3D1e5a9da1-6378-412f-b2c3-43c98a48f3c8&width=490&dpr=3&quality=100&sign=7445423b&sv=2) **Odds documentation** Take a look at our documentation dedicated to our odds features. [](https://docs.sportmonks.com/v3/core-api/) ![Cover](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3469464275-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F9zsNGu3HAzSnl5DWBD3Y%252Fuploads%252FNRLVqsmIWMTLBa0iyARh%252FCore%2520Docs.png%3Falt%3Dmedia%26token%3Df12e9ea3-8cc9-449b-a6d7-b1acfdf9b523&width=490&dpr=3&quality=100&sign=517c7737&sv=2) **Core documentation** Dive into our core documentation. [](https://docs.sportmonks.com/v3/tutorials-and-guides/tutorials) ![Cover](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3469464275-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F9zsNGu3HAzSnl5DWBD3Y%252Fuploads%252FbAO1ivy2aQq63XRoyBLQ%252FTutorials%2520Docs.png%3Falt%3Dmedia%26token%3D4ce080be-3558-489a-a8c8-c7b9d4bb4e45&width=490&dpr=3&quality=100&sign=6dda90ae&sv=2) **Tutorials** Learn more about specific features of our API by reading out tutorials. [](https://docs.sportmonks.com/v3/tutorials-and-guides/guides) ![Cover](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3469464275-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F9zsNGu3HAzSnl5DWBD3Y%252Fuploads%252FgeIoZGxjYkd9lWFDBWvG%252FGuide%2520docs.png%3Falt%3Dmedia%26token%3D77ed8d26-205c-48ef-b686-b5d6fa649740&width=490&dpr=3&quality=100&sign=d33d77ff&sv=2) **Guides** Read how to build the application of your dreams with our guides. [](https://docs.sportmonks.com/v3/changelog/changelog) ![Cover](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3469464275-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F9zsNGu3HAzSnl5DWBD3Y%252Fuploads%252FJ1z1DoihGZ30CKGmvZex%252FChangelog.png%3Falt%3Dmedia%26token%3D2752989a-4443-4860-92f3-96cc364c4374&width=490&dpr=3&quality=100&sign=5d06ceae&sv=2) **Changelog** Keep in touch with the latest changes we have pushed in our API. circle-check If you need help locating specific topics, simply use the **search bar** at the top right corner of the page. The search bar, located at the top-right corner of the documentation, makes finding relevant content quick and intuitive. Type any keyword—whether it’s a complete word or a partial match—and you’ll see immediate, filtered results. You can refine your search by using more specific terms or phrases to narrow down the options. This is particularly useful if you’re unsure which category your topic might appear in. Give it a try and discover guides and other resources tailored to your interests. We hope you find the information you need to build your dream football application! If you have any questions, feedback, or need assistance, don't hesitate to reach out to our dedicated support team at [support@sportmonks.com.envelope](mailto:support@sportmonks.com) [NextGetting Startedchevron-right](https://docs.sportmonks.com/v3/welcome/getting-started) Last updated 2 months ago Was this helpful? This site uses cookies to deliver its service and to analyze traffic. By browsing this site, you accept the [privacy policy](https://www.sportmonks.com/privacy-policy/) . close AcceptReject --- # Endpoints | BETA Documentation | API 3.0 Gather an overview of all the xG values available within your subscription via the Expected endpoints. Retrieve basic information or enrich your response. Use one of our 2 expected endpoints. Per endpoint, you can find the details, including base URL, parameters, includes and more. * **GET Expected by Team:** returns all the expected data that are available within your subscription on team level. * **GET Expected by Player:** returns all the expected data that are available within your subscription on player level. #### [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/endpoints#include-options) Include options `type` `fixture` **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the expected endpoints are: * [Expected](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/entity) Last updated 1 year ago Was this helpful? --- # Welcome | BETA Documentation | API 3.0 Welcome to our documentation for all our BETA projects! We are excited to have you on board as we take our API to the next level. This beta release is a sneak peek into the upcoming features and improvements we have in store for you. circle-exclamation This documentation will contain features that are still in beta. If you're not an invited beta tester, you won't have access to the features mentioned in this documentation. ### [hashtag](https://docs.sportmonks.com/v3/beta-documentation#your-feedback-matters) Your Feedback Matters As a beta user, your feedback is crucial in fine-tuning the API and making it the best it can be. Whether you find a bug, have a suggestion, or need clarification, let us know! We appreciate your input and will work closely with you to address any issues. ### [hashtag](https://docs.sportmonks.com/v3/beta-documentation#get-started) Get Started Ready to explore the beta documentation? Dive in and discover the exciting possibilities that Sportmonks API has to offer. If you have any questions or feedback, don't hesitate to reach out to our support team. Want to get all the answers to your questions? Take a look at our FAQ page: [❓FAQchevron-right](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq) Last updated 1 year ago Was this helpful? --- # GET Expected by Team | BETA Documentation | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/football/expected/fixtures Copy { "data": [\ {\ "id": 26898369,\ "fixture_id": 18898173,\ "type_id": 5304,\ "participant_id": 10010,\ "data": {\ "value": 1.0674\ },\ "location": "home"\ },\ {\ "id": 26898370,\ "fixture_id": 18898173,\ "type_id": 5304,\ "participant_id": 7011,\ "data": {\ "value": 1.0657\ },\ "location": "away"\ },\ \ Field\ \ Description\ \ Type\ \ id\ \ Refers to the unique id of the expected value.\ \ integer\ \ fixture\_id\ \ Refers to the fixture related to the value.\ \ integer\ \ type\_id\ \ Refers to the type of the Expected value.\ \ integer\ \ participant\_id\ \ Refers to the participant related to the Expected value.\ \ integer\ \ value\ \ Displayes the value.\ \ integer\ \ location\ \ Refers to the location of the home or away team.\ \ string\ \ Query Parameters\ \ Static Filters\ \ Dynamic Filters\ \ Query Parameters\ \ Required?\ \ Description\ \ `api_token`\ \ YES\ \ Your unique API token\ \ `include`\ \ NO\ \ Enrich the API with more data by using includes\ \ `select`\ \ NO\ \ Select specific fields on the base entity.\ \ `filters`\ \ NO\ \ 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.\ \ Not applicable for this endpoint.\ \ Not applicable for this endpoint.\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/endpoints/get-expected-by-team#pagination)\ \ Pagination\ \ Yes\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/endpoints/get-expected-by-team#include-depth)\ \ Include depth\ \ You can use a total of `3` nested includes on this endpoint\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/endpoints/get-expected-by-team#include-options)\ \ Include options\ \ `type` `fixture`\ \ **Related Entities:**\ \ Get an overview and explanation of all the fields returned in the API response. The related entities for the expected endpoints are:\ \ * [Expected](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/entity)\ \ \ Last updated 1 year ago\ \ Was this helpful?\ \ Was this helpful?\ \ sun-brightdesktopmoon\ \ sun-brightdesktopmoon --- # Includes | BETA Documentation | API 3.0 The "Includes" parameter allows you to specify additional information to be included in the API response. For xG values, we offer two primary includes:`xGFixture` and the nested include `lineups.xGLineup`. ### [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/includes#expected-by-team) Expected by Team To retrieve the xG values by team for a fixture, we've introduced an include to use. You can use `xGFixture` on the Fixture entities, to retrieve the xG values for teams participating in a match. You can use this include as follows: Request Response Copy https://api.sportmonks.com/v3/football/fixtures/date/2024-03-03??include=xGFixture Copy "expected": [\ {\ "id": 27141258,\ "fixture_id": 18842545,\ "type_id": 5304,\ "participant_id": 9,\ "data": {\ "value": 3.6439\ },\ "location": "home"\ },\ {\ "id": 27141259,\ "fixture_id": 18842545,\ "type_id": 5304,\ "participant_id": 14,\ "data": {\ "value": 0.3841\ },\ "location": "away"\ },\ {\ "id": 27141260,\ "fixture_id": 18842545,\ "type_id": 5305,\ "participant_id": 9,\ "data": {\ "value": 4.4602\ },\ "location": "home"\ },\ {\ "id": 27141261,\ "fixture_id": 18842545,\ "type_id": 5305,\ "participant_id": 14,\ "data": {\ "value": 0.2255\ },\ "location": "away"\ }\ ] } ### [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/includes#expected-by-player) Expected by player To retrieve the xG values by player for a fixture, we've introduced an include to use. You can use `lineups.xGLineup` on the Fixture entities, to retrieve the xG values for players participating in a match. You can use this include as follows: Request Response Copy https://api.sportmonks.com/v3/football/fixtures/date/2024-03-03?include=lineups.xGLineup Copy { "id": 8193384466, "sport_id": 1, "fixture_id": 18842545, "player_id": 154421, "team_id": 9, "position_id": 27, "formation_field": "5:1", "type_id": 11, "formation_position": 11, "player_name": "Erling Haaland", "jersey_number": 9, "expected": [\ {\ "id": 1068406356,\ "fixture_id": 18842545,\ "player_id": 154421,\ "team_id": 9,\ "lineup_id": 8193384466,\ "type_id": 5304,\ "data": {\ "value": 1.1634\ }\ },\ {\ "id": 1068406358,\ "fixture_id": 18842545,\ "player_id": 154421,\ "team_id": 9,\ "lineup_id": 8193384466,\ "type_id": 5305,\ "data": {\ "value": 1.1634\ }\ }\ ] circle-info If you've got any questions or comments about using this include, feel free to reach out to us at [\[email protected\]envelope](https://docs.sportmonks.com/cdn-cgi/l/email-protection#94e7e1e4e4fbe6e0d4e7e4fbe6e0f9fbfaffe7baf7fbf9) . Last updated 1 year ago Was this helpful? * [Expected by Team](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/includes#expected-by-team) * [Expected by player](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/includes#expected-by-player) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # GET Expected by Player | BETA Documentation | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/football/expected/lineups Copy "data": [\ {\ "id": 1064853093,\ "fixture_id": 19076535,\ "player_id": 77908,\ "team_id": 238626,\ "lineup_id": 8076889919,\ "type_id": 5304,\ "data": {\ "value": 0.0295\ }\ },\ {\ "id": 1064853094,\ "fixture_id": 19076535,\ "player_id": 37389571,\ "team_id": 238626,\ "lineup_id": 8076889917,\ "type_id": 5304,\ "data": {\ "value": 0.0496\ }\ },\ \ Field\ \ Description\ \ Type\ \ id\ \ Refers to the unique id of the expected value.\ \ integer\ \ fixture\_id\ \ Refers to the fixture related to the value.\ \ integer\ \ player\_id\ \ Refers to the player related to the value.\ \ integer\ \ lineup\_id\ \ Refers to the lineup record the player is related to.\ \ integer\ \ type\_id\ \ Refers to the type of the Expected value.\ \ integer\ \ value\ \ Displayes the value.\ \ integer\ \ Query Parameters\ \ Static Filters\ \ Dynamic Filters\ \ Query Parameters\ \ Required?\ \ Description\ \ `api_token`\ \ YES\ \ Your unique API token\ \ `include`\ \ NO\ \ Enrich the API with more data by using includes\ \ `select`\ \ NO\ \ Select specific fields on the base entity.\ \ `filters`\ \ NO\ \ 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.\ \ Not applicable for this endpoint.\ \ Not applicable for this endpoint.\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/endpoints/get-expected-by-player#pagination)\ \ Pagination\ \ Yes\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/endpoints/get-expected-by-player#include-depth)\ \ Include depth\ \ You can use a total of `3` nested includes on this endpoint\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/endpoints/get-expected-by-player#include-options)\ \ Include options\ \ `type` `fixture`\ \ **Related Entities:**\ \ Get an overview and explanation of all the fields returned in the API response. The related entities for the expected endpoints are:\ \ * [Expected](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/entity)\ \ \ Last updated 1 year ago\ \ Was this helpful?\ \ Was this helpful?\ \ sun-brightdesktopmoon\ \ sun-brightdesktopmoon --- # Entity | BETA Documentation | API 3.0 ### [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/entity#expected) Expected Field Description Type id Refers to the unique id of the expected value. integer fixture\_id Refers to the fixture related to the value. integer type\_id Refers to the type of the Expected value. integer value Displayes the value. integer **Include options** `type` `fixture` Last updated 1 year ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Types | BETA Documentation | API 3.0 ### [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/types#expected-types) Expected Types We calculate several different expected values. Find below the types with the description or their meaning. ID Name Description 5304 `EXPECTED_GOALS` Quantifies the quality of scoring chances based on various factors. 5305 `EXPECTED_GOALS_ON_TARGET` The probability of a shot on target resulting in a goal in football based on the post-shot model. 7939 `EXPECTED_POINTS` Assesses team performance based on the quality of chances created and conceded, predicting the expected points earned from fixtures. 7940 `EXPECTED_GOALS_PENALTIES` The expected value of of scoring goals from penalties. 7941 `EXPECTED_GOALS_FREE_KICKS` The expected value of scoring goals from direct free-kick situations. 7942 `EXPECTED_GOALS_CORNERS` The expected value of scoring goals from corner kicks. 7943 `EXPECTED_NON_PENALTY_GOALS` The expected value of goals from open play and set-piece scenarios excluding penalties in football. 7944 `EXPECTED_GOALS_SET_PLAY` The expected value of scoring from set-piece situations like free kicks and corners in football. 7945 `EXPECTED_GOALS_OPEN_PLAY` The expected value of scoring from open play situations, excluding set pieces and penalties, in football. 9684 `EXPECTED_GOALS_DIFFERENCE` Calculates the difference between a team's xG for and against. 9685 `SHOOTING_PERFORMANCE` Measures how well a team or player shoots. It compares the xGOT to the expected goals (xG). When a team/player's xGOT surpasses its xG, it signifies its proficiency in taking higher-quality shots relative to the quality of the team's or player's chances. With this type, you can decide if a player is a player or the team is overperforming or underperforming, or performing as expected based on the quality of the chances they created. 9686 `EXPECTED_GOALS_PREVENTED` The difference between the actual goals conceded by a team and the expected goals conceded based on the quality of shots faced. 9687 `EXPECTED_GOALS_AGAINST` Calculates the expected number of goals a team is expected to concede based on the quality of scoring opportunities their opponents create. _\*xG is also available at the season, player and team levels. xPTS is also available as standings detail._ You can find a full explanation of each value in our dedicated [blogarrow-up-right](https://www.sportmonks.com/blogs/xg-explained/) . Last updated 1 year ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # FAQ | BETA Documentation | API 3.0 [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#what-are-the-numeric-values-associated-with-xg-and-how-reliable-are-they) What are the numeric values associated with xG, and how reliable are they? ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- xG statistics generate numeric values that show the chance of scoring based on the quality of chances created or conceded. These values for one specific player usually range between 0 and 1.5 for a specific fixture. For example, Erling Haaland had an xG value of 1.1634 in the Manchester Derby (18842545). In that fixture, he scored 1 goal in total. Pretty accurate, right? For that same fixture, the xG for both teams was as follows: **Manchester City: 3.6439 - Manchester United: 0.3841.** The xG values are pretty accurate to the actual outcome, which was 3-1, as you can see. The wonder strike from Marcus Rashford, however, shows that xG doesn't always tell the full story. He had an xG of 0.3553 for that match but did manage to score 1 goal. [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#how-does-the-reliability-of-xg-values-depend-on-the-context-of-the-match) How does the reliability of xG values depend on the context of the match? --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The reliability of xG values is contingent on various factors, including the context of the match. A nuanced understanding of the game's flow, tempo, and dynamics enhances the interpretation of xG values, providing valuable insights into the scoring probabilities. [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#how-does-speed-impact-the-availability-of-xg-values) How does speed impact the availability of xG values? --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The availability of xG values is influenced by the speed of data processing. Since xG calculations require match statistics like shots, there may be a delay before xG values become available. Patience is key as relevant match data is processed to generate accurate xG insights. [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#what-is-the-update-frequency-for-xg-values) What is the update frequency for xG values? --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- xG values are continuously calculated and processed throughout the match, with updates occurring every couple of minutes. The maximum time between these updates should not exceed 5 minutes. Stay informed with real-time insights into evolving goal-scoring probabilities. [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#what-leagues-do-we-cover-for-xg-values) What leagues do we cover for xG values? ------------------------------------------------------------------------------------------------------------------------------------------------------------------- league name id Champions League 2 Europa League 5 Premier League 8 Championship 9 League One 12 League Two 14 FA Cup 24 Carabao Cup 27 EFL Trophy 39 Eredivisie 72 Eerste Divisie 74 Bundesliga 82 2\. Bundesliga 85 DFB Pokal 109 Bundesliga Play-offs 163 2\. Bundesliga Play-offs 166 Admiral Bundesliga 181 Pro League 208 Superliga 271 Ligue 1 301 Coupe de France 307 Serie A 384 Coppa Italia 390 Eliteserien 444 Liga Portugal 462 Premiership 501 La Liga 564 Copa Del Rey 570 Allsvenskan 573 Super League 591 Super Lig 600 Superliga 636 Serie A 648 Liga MX 743 Major League Soccer 779 Pro League 944 J-League 968 Indian Super League 1007 Africa Cup of Nations 1117 Copa Libertadores 1122 Euro Qualification 1325 A-League Men 1356 UEFA Nations League 1538 Copa de la Superliga 1658 Europa Conference League 2286 Primeira Liga - Play-offs 2295 circle-info Please keep in mind that not every league is available yet for our Expected Values. This is due to the data not being available yet for leagues that aren't active. Leagues like the European Championship will be added later on. [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#how-are-xg-values-calculated) How are xG values calculated? ----------------------------------------------------------------------------------------------------------------------------------------------- xG values are calculated by combining shot data with all types of other data provided by Sportmonks. These data points, along with additional information, are used to create the different xG metrics offered, providing a comprehensive understanding of goal-scoring probabilities. [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#what-is-the-difference-between-xg-and-xgot) What is the difference between xG and xGOT? --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- We have a complete [blogarrow-up-right](https://www.sportmonks.com/blogs/xg-explained/) dedicated to explaining what the different Expected Values entail. We will explain it here briefly as a reminder. **Expected goals (xG)** In football, xG is a statistical metric quantifying the quality of goal-scoring chances created or conceded during a match. It measures the probability that a particular goal-scoring opportunity will result in a goal based on various factors such as the location of the shot, the angle, the distance from the goal, the type of pass that led to the chance, and other situational variables. **xG On Target (xGOT)** xG On Target measures the expected goals that were actually on target. This is mainly used to focus on shots that were actually testing the goalkeeper. This metric can be used to calculate the expected goals saved, which is an essential figure in finding out how a specific goalkeeper performs. **What is the difference between xG and xGOT, and why is xGOT lower than xG?** xGOT is xG minus the xG from shots that were not on target. That is why xG is higher. It is the combination of xG of all shots that are and aren’t on target. [hashtag](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#are-these-values-available-on-season-level) Are these values available on season level? --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Unfortunately, these are not yet available as we don't have the data for the beginning of this season. Once the new season commences we'll be able to add these values on a season level. Last updated 1 year ago Was this helpful? * [What are the numeric values associated with xG, and how reliable are they?](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#what-are-the-numeric-values-associated-with-xg-and-how-reliable-are-they) * [How does the reliability of xG values depend on the context of the match?](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#how-does-the-reliability-of-xg-values-depend-on-the-context-of-the-match) * [How does speed impact the availability of xG values?](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#how-does-speed-impact-the-availability-of-xg-values) * [What is the update frequency for xG values?](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#what-is-the-update-frequency-for-xg-values) * [What leagues do we cover for xG values?](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#what-leagues-do-we-cover-for-xg-values) * [How are xG values calculated?](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#how-are-xg-values-calculated) * [What is the difference between xG and xGOT?](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#what-is-the-difference-between-xg-and-xgot) * [Are these values available on season level?](https://docs.sportmonks.com/v3/beta-documentation/expected-goals/faq#are-these-values-available-on-season-level) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Welcome | Football Widgets | API 3.0 The easiest way to show all important football data is by copying and pasting a short line of code into your web application. Easy-to-use football widgets are available for everyone! ### [hashtag](https://docs.sportmonks.com/v3/football-widgets#optimise-your-workflow-and-save-resources) OPTIMISE YOUR WORKFLOW AND SAVE RESOURCES With Sportmonks Football Widgets, you will save time and resources. * The Football Widgets are easy to implement and even easier to use. Because from the moment you implement the football widgets, you don´t have to do anything anymore. * Maintenance is done by our developers, and the widgets will request our API every time it is needed. * Our Football widgets were created by developers who are passionate about football and dedicated to providing you with the best experience possible. We constantly seek to improve and expand our documentation. If you think something is missing, have an idea for a great tutorial or how-to guide, or have any other questions, don't hesitate to contact us! We value your input. Contact us at [\[email protected\]](https://docs.sportmonks.com/cdn-cgi/l/email-protection) . Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Livescore widgets | Football Widgets | API 3.0 This section will guide you through all the screens and functionalities you and your customers can expect to see when using the livescore widgets. There are currently two livescore widgets: * [Livescore widget](https://docs.sportmonks.com/v3/football-widgets/our-widgets/livescore-widgets/livescores) * [Match Centre](https://docs.sportmonks.com/v3/football-widgets/our-widgets/livescore-widgets/match-centre) Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Livescores | Football Widgets | API 3.0 The Livescores Widget is a widget which shows a complete schedule of the day. All leagues included in your widget subscription are provided for that particular day. You can switch to any day in the past or future as well. By clicking on the game's score, you can see information about the events of any particular match. Last but not least, the advanced version of this widget allows you to include the Match Centre within this widget as well. Let's dive into what the Livescore widget can do. ### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/livescore-widgets/livescores#functionalities) Functionalities When people visit your widget, the first thing they will see is an overview of all fixtures that are played that day. The fixtures shown depend on your widget subscription and the configuration of your widget. Per fixture, a match tile is displayed with both team names and live scores. Also, the game's status is shown (e.g. FT, NS) or if a fixture is LIVE, the current minute of the game. The most important events of a match (cards and goals) can be viewed by clicking on a match tile. If you have the widget's advanced variant, you can show a ‘details’ link leading to the [Match Centre](https://docs.sportmonks.com/v3/football-widgets/our-widgets/livescore-widgets/match-centre) . ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FgEI0LqnRsvD6U4IQkPAq%252Fmatch_tile_livescore_widget.png%3Falt%3Dmedia%26token%3D2706e121-cbe1-4cb3-8301-8890566698f4&width=768&dpr=3&quality=100&sign=6ef2f605&sv=2) Livescore Widget overview Besides viewing the list of today's matches, the livescore overview page also has a couple of handy functionalities. You can filter on a specific league with the league select function and search on teams with the search bar. You can also view only inplay fixtures by clicking the LIVE button. And lastly, you can view schedules/results of other days using the calendar or the date buttons. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FtNJDhlfptG71XbZzkf7N%252Fdate_option_livescore_widget.png%3Falt%3Dmedia%26token%3D2d01f88a-945e-4cfc-9574-f9daed506787&width=768&dpr=3&quality=100&sign=c6d64849&sv=2) Use the calender Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Topscorers | Football Widgets | API 3.0 The Topscorers Widget shows the topscorers all the way back to 2005 per season. You will see the player, the team, the nationality and the amount of goals. Also, the most assist, yellow cards and red cards top scorers are included in this Widget. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252F3n7a2HEFQSmSp2foqh2L%252FTop%2520scorers%2520La%2520liga.png%3Falt%3Dmedia%26token%3D3daaa7de-6a54-4402-87e3-2d13c585a9ce&width=768&dpr=3&quality=100&sign=b2335cb1&sv=2) **Basic versus advanced** When using the advanced option, you will receive the following additions: 1. Colours customisation 2. Custom brand Colours customisation You can adapt the complete table of top scorers into your own corporate identity. Designing tables ensures a professional and consistent look and differentiates your company from your competitors. Custom brand Looking at the bottom of the basic Topscorer Widget, you can see the Sportmonks logo. With the advanced option you can change the this to your own brand logo. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252F1l08wtg89Oxijte1PaJI%252FDifference%2520basic%2520advanced.png%3Falt%3Dmedia%26token%3D13e66275-122a-4733-9f7e-6311f5987bb0&width=768&dpr=3&quality=100&sign=60b87c84&sv=2) **Also, is it possible to configure a couple of things on your hand** * Choose your competition/team * Custom the number of rows * Make the team/league logo visible or not * Highlight one individual team * Decide on whether to have our header or not * Dark mode * Customise colours circle-info Please note that we have the most detailed statistics from the 2005 season. Before that season, there were mostly basic stats available. Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Schedule | Football Widgets | API 3.0 The Schedule Widget shows the complete schedule of the league you have selected. You will see the status of the game, the time it starts, or the score once the game is live. Furthermore, you can see dates and all match events. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FN0l6aMLIjUfQZwfhXpVQ%252Fimage.png%3Falt%3Dmedia%26token%3D84159b94-af5d-4a61-bb15-1df8ffcd0d36&width=768&dpr=3&quality=100&sign=62ee8ec3&sv=2) ### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/league-widgets/schedule#basic-versus-advanced) Basic versus advanced The advanced Schedule Widget offers the option to showcase a complete Match Centre. This provides a lot of extra information about the scheduled and finished matches. For example, when a game is finished, it offers all kinds of stats, lineup details and more. When the game is Not Started, you can find H2H results, total results and form of both parties. You can find everything the Match Centre widget offers in the [Match Centre section.](https://docs.sportmonks.com/v3/football-widgets/our-widgets/livescore-widgets/match-centre) Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Configurations | Football Widgets | API 3.0 The configuration options are essential to fit the widgets into your application or website. In the Match Centre widget, you can select the country, league, season, stage and fixture. In the livescore widget, you can select a customised list of (max 25) leagues you want to showcase or show all leagues in your widget subscription. You can show or hide the following: 1. Header 2. Team logos 3. Player images 4. Match Center (advanced) 5. Theme switch (light or dark mode) You can change the font, title and, last but not least, the primary, sub-primary, secondary and tertiary colours. For more information about the configuration options you can check out our [configuration page.](https://docs.sportmonks.com/v3/football-widgets/our-widgets/configurations) ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FCjdAknthjzIX3ayDUAu1%252FBasic%2520vs%2520Advanced%2520%28Livescore%29.png%3Falt%3Dmedia%26token%3D58fff7bc-b767-45a6-b1a8-8d61e0de62f2&width=768&dpr=3&quality=100&sign=a2fb3034&sv=2) Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # League widgets | Football Widgets | API 3.0 This section will guide you through all the screens and functionalities you and your customers can expect to see when using the League widgets. There are currently three league widgets: * [Standings widget](https://docs.sportmonks.com/v3/football-widgets/our-widgets/league-widgets/standings) * [Schedule widget](https://docs.sportmonks.com/v3/football-widgets/our-widgets/league-widgets/schedule) * [Team statistics widgets](https://docs.sportmonks.com/v3/football-widgets/our-widgets/league-widgets/team-statistics) * [Topscorers widgets](https://docs.sportmonks.com/v3/football-widgets/our-widgets/league-widgets/topscorers) Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Team widgets | Football Widgets | API 3.0 This section will guide you through all the screens and data functionalities you and your customers can expect to see when using the Team widgets. There are currently two Team widgets, * [Squad widget](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/squads) * [Latest widget](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/latest-matches) * [Current round widget](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/current-round) * [Next figure widget](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/next-fixture) * [Standings widget](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/standings) * [Schedule widget](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/schedule) Let's start with the squad widget and dive right in. Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Match centre | Football Widgets | API 3.0 The Match Centre Widget shows various statistics, a match preview, lineups, events, H2H, and more. There is much information about the location and the total result of the two teams facing each other. You can show the team logos, player images and the theme switch. You can also decide to hide all of these. This way, the theme you choose will be shown on your website. There is a light and a dark theme for the widget. You can change the colours and fonts. You can also delete the Sportmonks logo and replace it with your logo. ### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/livescore-widgets/match-centre#functionalities) Functionalities The Match Center page displays extensive information about a match. The data shown depends on the coverage of the league of the game. A live scoreboard is always displayed, with both teams, livescore and goal scorers. Other relevant information, such as league info, referee, date and temperature, is also shown on the scoreboard. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FNo17nJOnIHp2N5WsNjca%252Ffull_page_events_match_centewidgets.png%3Falt%3Dmedia%26token%3Ddb65b45f-bbee-4a62-8175-25bc05646bb9&width=768&dpr=3&quality=100&sign=5df8a260&sv=2) As you can see above, there are several tabs beneath the scoreboard. Each tab shows different data about a match. #### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/livescore-widgets/match-centre#match-preview) Match preview Here you can view data that is relevant before a match. The following data is displayed: * Sidelined players * H2H Results * Venue information * Weather information ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FyNLvrgE9Mo9U5kYbands%252Fmatch_preview_match_centre_widget.png%3Falt%3Dmedia%26token%3D0fd1157b-5edc-4e2d-92cd-9af3211c9fc9&width=768&dpr=3&quality=100&sign=bd66903d&sv=2) #### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/livescore-widgets/match-centre#statistics) **Statistics** On this tab, you can view team statistics and trends about the match. Each statistic is compared between teams. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252Ffilm49jWTHKvOl0MqzaD%252Ffixture_stats_match_centre_widget.png%3Falt%3Dmedia%26token%3D814c6b74-1c5e-4ed0-ac5e-396633a0b65b&width=768&dpr=3&quality=100&sign=47812439&sv=2) #### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/livescore-widgets/match-centre#lineup) Lineup The lineups and benches of both teams are visible on the Lineup tab. The lineups are visible in a list and a visual formation field. The coaches and formations of both teams are also displayed. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FzUydGdzpslGCsv6Gqkup%252Ffixture_lineups_match_centre_widget.png%3Falt%3Dmedia%26token%3Ddb511fd4-3a19-4842-9f5b-de3e7e45d0ad&width=768&dpr=3&quality=100&sign=eab82f40&sv=2) #### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/livescore-widgets/match-centre#events) **Events** All events are displayed in the events tab. Per event, it is clear what event it is about when it happened and which player(s) are related to it. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FY0Hw8RPxgBTcSXGCr3SG%252Ffixture_events_match_centre_widget.png%3Falt%3Dmedia%26token%3D8845f954-8c77-4520-ac38-3d5d5531a47b&width=768&dpr=3&quality=100&sign=f821e50c&sv=2) Besides all match events, commentaries are also shown in Events. Commentaries are pieces of text about an event. Commentaries are displayed on a vertical timeline, and important events (goals and cards) are highlighted. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FD8cGcUCWQxaQnCC8EFxr%252Ffixture_commentaries_match_centre_widget.png%3Falt%3Dmedia%26token%3Db2efe399-c3e3-4d90-bc69-b3f8660c90ae&width=768&dpr=3&quality=100&sign=6dd40b63&sv=2) **Head2Head** The last tab shows historical data from matches between the two teams. The following information is displayed: * Previous 5 (5 or fewer) direct confrontations and their scores * Total results between the two teams * Recent form (5 matches) of both teams * Statistics of past confrontations ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FPI1Snc2wdM4G6CzJwosx%252Ffixture_h2h_match_centre_widget.png%3Falt%3Dmedia%26token%3Dd6fc40ce-15fb-480f-bc26-2ff64429fde4&width=768&dpr=3&quality=100&sign=293696fe&sv=2) circle-exclamation Remember that the widget data displayed depends on the leagues you have at your disposal. Also, not all leagues have full coverage on all resources. Check our [coverage pagearrow-up-right](https://www.sportmonks.com/football-api/coverage/) for more information about resources and coverage. Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Configurations | Football Widgets | API 3.0 The configuration options are essential to fit the schedule widget into your application or website. You select the country and league you want to showcase. After that, you can choose if you will show the schedule of a specific round or not. When ‘by round’ is on, the schedule is shown per the current round or stage of a season. When turned off, the latest seven and upcoming three fixtures are shown by default. You can show or hide the following: 1. Header 2. Team logos 3. League logos 4. Match Center (advanced) 5. Theme switch (light or dark mode) You can change the font, and last but not least, you can change the Primary, sub-primary, secondary and tertiary colours. There are multiple configuration options, but the most important options are to choose the country and league. After that, you can select the group of statistics you want to showcase. You don’t have to choose, though. However, you can filter on a group of statistics. For example, if you only want to show everything about goals, you can select this group, and your users can see only the goals scored and those conceded statistics. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FV9kXDhSN4xU7ELIau3OM%252Fimage.png%3Falt%3Dmedia%26token%3D0d8fd08f-2ea7-422b-a6d7-3476e82d0887&width=768&dpr=3&quality=100&sign=4dd36ca6&sv=2) Another thing you can do with these filters is to create a filter of all statistics you want to showcase. For example, you want to combine cards and tackles, goals and possession %, or goals and cards. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FBcWVLfM5bMK6eL3jnBo8%252Fimage.png%3Falt%3Dmedia%26token%3Df4b1ecf5-b9fd-46fe-9d3a-189f3b1ac77e&width=768&dpr=3&quality=100&sign=35eb3b7a&sv=2) You can show a season filter if you have the advanced version of the Widget. Show or hide the header and team logos. We also suggest changing the title to customise it in your app and website. circle-info Keep in mind this title will only be visible with a certain width. If the Widget is too small, the title will disappear. Besides, there are options to set the Widget to light- or dark mode and show or hide the theme switch. Finally, you can change the primary, sub-primary, secondary, and tertiary colours. For more information about the configuration options you can check out our [configuration page.](https://docs.sportmonks.com/v3/football-widgets/our-widgets/configurations) ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FUPj1CDwYqKn5hum4JntP%252FBasic%2520vs%2520Advanced%2520%28League%29.png%3Falt%3Dmedia%26token%3D8b8fa820-6d75-4813-bf1e-f3caf5566b06&width=768&dpr=3&quality=100&sign=787d7012&sv=2) Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Team statistics | Football Widgets | API 3.0 The Team Statistics Widget shows all teams and their statistics in the league. All teams will be ranked based on the statistic you have selected. When you choose the statistic goals, you will see how all the teams rank based on the goals they scored. Do you want to see which team has the most possession on average? Select the Ball Possession % statistic and determine which teams have much possession and which don’t. All statistics available are: 1. Goals 2. Ball Possession % 3. Corners 4. Attacks 5. Dangerous Attacks 6. Offsides 7. Fouls 8. Tackles 9. Yellow Cards 10. Red Cards 11. Yellowred Cards 12. Goals Conceded 13. Clean sheets 14. Team Wins 15. Team Draws 16. Team Lost ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FWoNak8JQu9PIFHNBgENw%252Fimage.png%3Falt%3Dmedia%26token%3D3441ac6c-4bd4-45fa-a8c3-852306cddeef&width=768&dpr=3&quality=100&sign=2efd6dcb&sv=2) ### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/league-widgets/team-statistics#basic-versus-advanced) Basic versus advanced In the advanced version of the Widget, you can show a season filter. This filter lets you and your users select the season you want to see. Show the statistics of teams all the way back to 2005. circle-info Please note that we have the most detailed statistics from the 2017 season. Before that season, there were mostly basic stats available. Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Standings | Football Widgets | API 3.0 The Standings Widget shows the complete table of the league you have selected. And by complete, we mean everything you expect to see in any league table is available. You will see the position a team is in and what this ranking means at the end of the season. For example, will a team in the number 3 spot play in play-offs for a particular tournament (for example, the Champions League), and will the number 20 be relegated? These standing rules can be found by watching for the colour in front of the ranking a particular team is in and checking this colour at the bottom of the league. Besides that, the logo of the team and the team name are included in the standings table. Next to the basic information about the teams, we will find the number of games a specific team has played (P) and the matches that a team has won (W), drawn (D) or lost (L). After that, goals for (GF), goals against (GA), goal difference (GD) and points (Pts) are shown. You can even decide to show the form of every team behind the points. This way, you can show their last five matches' results (win, draw, lose). ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FAe2hUfSibpAtbKgjgqpT%252Fimage.png%3Falt%3Dmedia%26token%3Da6b7361f-71bc-47d0-b77e-6aee91871021&width=768&dpr=3&quality=100&sign=616938fc&sv=2) ### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/league-widgets/standings#basic-versus-advanced) Basic versus advanced The extras you will receive when using the advanced version of the Standings widgets are as followed: 1. Live standings 2. Season filter #### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/league-widgets/standings#live-standings) Live standings You can include live standings using the advanced standings widget. But what does that mean? When a fixture is live, there is a score for that particular game. For example, Arsenal has 41 points before the match starts. At the start of the match, the score is 0-0. Because of the live standings, Arsenal will now be on 42 points. When Arsenal is in the lead (let's say 1-0), the team will have 41+3 points in the live standings. In short, the virtual result of a live match will be included in the standings if you decide to use live standings. #### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/league-widgets/standings#season-filter) Season filter: You will have access to all seasons Sportmonks provides of the leagues you have included in your widget subscription. This means you can select any season you want to use the standings. Are you interested in that season your favourite team won the league? Show your pride and put it on your website by selecting the specific season. More interested in finding out which team became champion in a particular season? Easily select that season to find out about the standings. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FehlhRsdfqlCGEKb4EkdP%252Fimage.png%3Falt%3Dmedia%26token%3D45356d32-a634-4cb5-af16-2ce7f38d6b3d&width=768&dpr=3&quality=100&sign=d57b78a7&sv=2) Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Squads | Football Widgets | API 3.0 The Squad Widgets shows all players of the team you are interested in. You can choose to show all players that have been part of the squad during the whole season or only to show the players currently in the team. Think about players that have made a transfer or went out on loan. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252F21SzyX9WEywYyg4LTcF3%252Fsquad_psg.png%3Falt%3Dmedia%26token%3Dea529102-9814-4970-89d4-ab5cd4346229&width=768&dpr=3&quality=100&sign=13a3d013&sv=2) ### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/squads#player-information) Player information So, what will you find in the squad widget besides the players? Well, you can find all kinds of player information. First up, we have the jersey number every player wears. After that, we have an image of the face of the players, the name, positions and ages of the players. You can sort on the players' number, position, name and age. Furthermore, you will be able to see all nationalities in the squad. Each player is shown with their nationality. ### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/squads#player-statistics) Player statistics After the player information, all kinds of player statistics are shown. The stats are as follows: 1. Games played 2. Starting 11 3. Subbed in 4. Subbed out 5. Goals scored 6. Assists 7. Yellow cards 8. Red cards 9. Yellowred cards 10. Minutes played 11. Rating You can order all players based on all of their stats. For example, if you want to see who is the highest or lowest-rated player, you can click on the arrows to show a descending or ascending order of the ratings of players. The same goes for any of the other statistics. You can choose any country, any league and any team that is included in your widget subscription. ### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/squads#basic-versus-advanced) Basic versus advanced Make your users relive older seasons by making use of the advanced version. This enables you to make use of a season filter. More information about this can be found on our [configurations page.](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/configurations) For example, the 2010 squad of Barcelona: ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FBXxjD0CCfSQq2BXI8Fmy%252Fimage%2520%282%29.png%3Falt%3Dmedia%26token%3D9fc46277-9c92-4173-8d77-49f63b19a28f&width=768&dpr=3&quality=100&sign=bfbcf57a&sv=2) Last updated 2 years ago Was this helpful? * [Player information](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/squads#player-information) * [Player statistics](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/squads#player-statistics) * [Basic versus advanced](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/squads#basic-versus-advanced) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Latest matches | Football Widgets | API 3.0 A much-requested widget is the Latest Matches Widget. This is precisely what you think it is. This widget shows the latest five matches of the team you selected. What is the form of your favourite team? You can deliver exactly that with this widget. You can even show the events and goal scorers in every five latest matches. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252F1753jwW8KSqXv4tEHVal%252Fimage.png%3Falt%3Dmedia%26token%3D770d1f1f-4cea-45ef-bf73-a9df2b018681&width=768&dpr=3&quality=100&sign=b2214e4f&sv=2) ### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/latest-matches#configuration-options) Configuration options The [configuration options](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/configurations) of the latest widget are the same as those mentioned for the team squad widget. ### [hashtag](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/latest-matches#basic-versus-advanced) Basic versus advanced You can utilise the Match Centre functionality in this widget when you've opted for the advanced features. All information about the Match Centre functionalities can be found in the [Match Centre section](https://docs.sportmonks.com/v3/football-widgets/our-widgets/livescore-widgets/match-centre) . ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FrWkRrkz7QBVv8E4fxcgG%252Ffixture_stats_match_centre_widget.png%3Falt%3Dmedia%26token%3D67226413-13f5-44e3-a855-d0c7f7d4e873&width=768&dpr=3&quality=100&sign=5d79796a&sv=2) Last updated 2 years ago Was this helpful? * [Configuration options](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/latest-matches#configuration-options) * [Basic versus advanced](https://docs.sportmonks.com/v3/football-widgets/our-widgets/team-widgets/latest-matches#basic-versus-advanced) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Configurations | Football Widgets | API 3.0 It is possible to customise our widgets with several configurations. Some configurations are only available for Advanced Widget users. There are general configurations which can be used for every widget. Furthermore, each widget has some extra configuration options. Each widget has its own custom configuration. Everything you need to know can be found below. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252Fxx3xcrPWp6BELBSgf6i3%252FBasic%2520vs%2520Advanced.png%3Falt%3Dmedia%26token%3Dfb24b39d-b3b4-4715-8d0c-4dfffc99d1be&width=768&dpr=3&quality=100&sign=a84913a1&sv=2) Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Current round | Football Widgets | API 3.0 The Current Round Widget shows everything about your favourite competitions and your team's current round. The Current Round Widget has the following information: * The date of the match * The time of the match * The score of the played matches * All the teams playing * Shows the current round It is possible to configure a couple of things to your hand: * The competition/team * Team/league logo * Highlighted teams (See picture down below) * Set on dark mode ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FMGmEfXTkCdibgmvaURd0%252FBarcelona%2520current%2520round.png%3Falt%3Dmedia%26token%3Dcabdc2c7-91b3-4211-88ed-2ea41d1fc0e7&width=768&dpr=3&quality=100&sign=f8c6d989&sv=2) **Basic versus advanced** When using the advanced option, you will receive the following additions: 1. Colours customisation 2. Custom brand Colours customisation You can design the table of top scorers to fit it right into your own corporate identity. Designing tables ensures a professional and consistent look and differentiates your company from your competitors. Custom brand Looking at the bottom of the basic Topscorer Widget, you can see the Sportmonks logo. With the advanced option, changing this to your brand logo is possible. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FXJYxrtdzZjtCDdjJMkO7%252FDifference%2520basic%2520advanced.png%3Falt%3Dmedia%26token%3D5a041075-3afc-4566-8779-765ae6f297c4&width=768&dpr=3&quality=100&sign=3e0014a4&sv=2) **Also, is it possible to configure a couple of things on your hand** * Choose your competition/team * Make the team/league logo visible or hide it * Highlight one individual team * Decide on whether to use the header or not * Set on dark mode Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Core | Core API 3.0 | API 3.0 Core contains all endpoints that are used in all sports and are referenced with their respective ID. Continents, Countries, Regions, and Cities are included in all subscriptions. Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Configurations | Football Widgets | API 3.0 The configuration options are essential to fit the widgets into your application or website. You select the country, league and team you want to showcase. You can show or hide the following: 1. Header 2. Team logos 3. Player images 4. Match Center (advanced) 5. Theme switch (light or dark mode) 6. Season filter You can change the font, title and last but not least, you can change the Primary, sub-primary, secondary and tertiary colours. For more information about the configuration options, you can check out our [configuration page.](https://docs.sportmonks.com/v3/football-widgets/our-widgets/configurations) ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FGktfdr9wcoXQA36WlQRU%252FBasic%2520vs%2520Advanced%2520%28Team%29.png%3Falt%3Dmedia%26token%3D13dfe4c7-429e-447e-95ac-e9b0fb256429&width=768&dpr=3&quality=100&sign=bc11904b&sv=2) Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Schedule | Football Widgets | API 3.0 The Schedule Widget shows an overview of your favourite team's matches. With this, you can take a look at all the former matches and all the upcoming matches. You can see the date of the match, the competition, the score and future time. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FHn7lR1lGvMXfrhBAitYP%252FTeam%2520schedule%2520Brest.png%3Falt%3Dmedia%26token%3D41d2bf5b-0cef-415e-90f2-cf4ff1be113a&width=768&dpr=3&quality=100&sign=7b4852f6&sv=2) **Basic versus advanced** When using the advanced option, you will receive the following additions: 1. Colours customisation 2. Custom brand logo Colours customisation You can adapt the schedule totally into your own corporate identity. Designing tables ensures a professional and consistent look and differentiates your company from your competitors. Custom brand logo Looking at the bottom of the basic Schedule Widget, you can see the Sportmonks logo. With the advanced option, changing this to your brand logo is possible. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FXJYxrtdzZjtCDdjJMkO7%252FDifference%2520basic%2520advanced.png%3Falt%3Dmedia%26token%3D5a041075-3afc-4566-8779-765ae6f297c4&width=768&dpr=3&quality=100&sign=3e0014a4&sv=2) Also, is it possible to configure a couple of things on your hand: * Choose your competition/team * Make the team/league logo visible or not * Set on dark mode Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Authentication | Odds API 3.0 | API 3.0 To make our first request, we’ll need to get authenticated first. We offer two different options for passing your API token. You are free to choose between the authentication methods. You can also use both of them at the same time. Please note that both methods count towards the same rate-limiting. * **Authenticate using a query parameter** You can pass your API token by passing 'api\_token' in your request parameters, like so: https://api3.sportmonks.com/api/v3/football/livescores?api\_token_\=your\_token\_here_ * **Authenticate using a request header** You can also pass your token via an 'Authorization' header, like so: Header Value Authorization _your\_token\_here_ You can obtain and manage your API token in [**Mysportmonks.**arrow-up-right](https://my.sportmonks.com/) The API token is only meant for your eyes and, as such, should be stored away safely. Our tokens have no expiration date and will remain valid until you manually delete them yourself. When making a request, a code response will always be returned. The following are all possible HTTP response codes for any request made to the API: Code Description **200: OK** Request succeeded **400: Bad Request** It seems that some part of the request is malformed. The exact reason is returned in the response. **401: Unauthorized** The request is not authenticated. **403: Forbidden** Not authorized. Indicates you're attempting to access a feed that is not accessible from your plan. **429: Too Many Requests** Too many requests. In order to make the API as responsive as possible, you have an hourly request limit. The limit for your current subscription can be found in any successful response. Check the "meta" section to find out your limit. **500: Internal Server Error** An internal error has occurred and has been logged for further inspection. Please email support if you are receiving this error. [PreviousWelcomechevron-left](https://docs.sportmonks.com/v3/odds-api) [NextRequest optionschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/request-options) Last updated 3 years ago --- # Standings | Football Widgets | API 3.0 The Standings widget shows an overview of the current table. With this, you can see the progress of your team and its standings in the current competition. This could be changed per competition the team is competing in. It shows the following: Points, games played, wins, draws, losses and goal balance. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FK4JD7g0NZmVb3TjgHiUr%252FStandings%2520widget.png%3Falt%3Dmedia%26token%3Dfdc709db-cddf-43f0-badf-ab9eb203a528&width=768&dpr=3&quality=100&sign=cecbbb10&sv=2) **Also, it is possible to configure a couple of features** * Choose your competition/team * Show or hide the team/league logo * Set on dark mode **Basic versus advanced** When using the advanced option, you will receive the following additions: 1. Colours customisation 2. Custom brand Colours customisation You can adapt the tables of your team completely into your own corporate identity. Designing tables ensures a professional and consistent look and differentiates your company from your competitors. Custom brand Looking at the bottom of the basic Topscorer Widget, you can see the Sportmonks logo. With the advanced option, changing this to your brand logo is possible. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252F1l08wtg89Oxijte1PaJI%252FDifference%2520basic%2520advanced.png%3Falt%3Dmedia%26token%3D13e66275-122a-4733-9f7e-6311f5987bb0&width=768&dpr=3&quality=100&sign=60b87c84&sv=2) Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # How-to create your widget in three steps | Football Widgets | API 3.0 Hey there, and welcome to this handy guide on how to gain access to Sportmonks’ widgets and use them in your web application. Throughout this guide, we'll go over the necessary steps to make use of our widgets, which are: 1. Requesting your widget subscription 2. Configuring your widget(s) 3. Embedding your widget(s) So, let's dive in and get started! ### [hashtag](https://docs.sportmonks.com/v3/football-widgets/guides/how-to-create-your-widget-in-three-steps#step-1-requesting-widgets) Step 1: Requesting Widgets To get started, if you're interested in any of our widgets, you can easily request them by heading to [My.Sportmonksarrow-up-right](https://my.sportmonks.com/dashboard) . If you haven't created an account yet, you'll need to do so first. Once you're signed up, navigate to the [My Widgetsarrow-up-right](https://my.sportmonks.com/widgets) page under Football Widgets in mySportmonks. This page provides an overview of all available widgets; you can manage them from here. Here, you can easily request the widgets you're interested in. When selecting widgets, you'll also have the option to choose between the Basic or the Advanced version of each widget. In a nutshell, the advanced widgets come with more data features and offer more customisation options. Advanced widget users have the option to configure the colours used in the widget and even use their own brand logo at the footer of the widget. It's worth noting that all widgets are based on the leagues that you have included in your widget product. For instance, the Livescore Widget will only show fixtures from the leagues you've added to your widget product. So, you'll be taken to the league selection page before you can complete your request. This way, you can choose which leagues you want to include and ensure that the widget fits your specific needs. On the league selection page, you'll be able to search for leagues based on country and/or name and select or deselect the ones you want to include in your widgets. Once you're finished, simply click the Next button to go to the overview page. Here, you'll see an overview of all the selected widgets and leagues, giving you the opportunity to double-check your request before submitting it. Once you've submitted your request, our sales team will reach out to you within 24 hours with a price proposal. Once you've come to an agreement on the pricing, you can easily subscribe to your new widget product on the [My Widgetsarrow-up-right](https://my.sportmonks.com/widgets) page. circle-info You don't need an API subscription to request widgets. However, a widget-only subscription doesn't give you access to the Football API. ### [hashtag](https://docs.sportmonks.com/v3/football-widgets/guides/how-to-create-your-widget-in-three-steps#step-2-configure-your-widget) Step 2: Configure your widget Once you've created your Widget product, you'll need to set your domain in either the [Widgets Settingsarrow-up-right](https://my.sportmonks.com/widgets) page or the My Widgets page. It's important to note that the domain you enter here will be the only one from which you'll be authorized to host our widgets. So, for instance, if you enter `sportmonks-widgets.com` as your domain, the widgets will only be authorized for use on that domain. This ensures that the widgets are used only on authorized domains and prevents unauthorized usage. Once you've set up your domain, you can visit the Widgets Configurator page. Here, you'll be able to view a live preview of your widgets and configure them to your specific needs. It's worth noting that the customisation options available to you will depend on the type of widget you've selected, as well as whether you have the basic or advanced variant of the widget. As you configure your widget, you'll be able to see a live preview of each update in real time. This allows you to see how your customisations will look before you embed the widget on your website. Additionally, you can view the live preview in various screen sizes, including mobile, tablet, desktop, and responsive. When customizing your widgets, you'll have access to a range of options, including the ability to: * **Choose a theme:** You can select a default theme for your widget, choosing between light and dark modes. * **Show or hide theme switch:** You can choose whether to include a theme switch option in your widget, allowing users to toggle between dark and light modes. * **Choose a font:** You can select the font used in your widgets, helping to ensure that your widget matches the overall style of your website. * **Customise colours (advanced only):** If you have access to the advanced version of a widget, you can choose the colours used in the widget to match your branding. #### [hashtag](https://docs.sportmonks.com/v3/football-widgets/guides/how-to-create-your-widget-in-three-steps#general-settings) General settings The Widget Settings page also allows you to save some general configurations that will be applied to all of your widgets: * Domain: Here, you can set the domain from which your widgets will be hosted. * Timezone: You can select your timezone to ensure your widgets display the correct time information. * Colours (advanced only): If you have the advanced version of a widget, you can set the colours that will be used across all of your widgets from this page. * Brand (advanced only): additionally, you can set your brand information, such as your logo, to be displayed in the footer of your widgets (advanced version only). ### [hashtag](https://docs.sportmonks.com/v3/football-widgets/guides/how-to-create-your-widget-in-three-steps#step-3-embedding-your-widget) Step 3: Embedding your widget After configuring your widget to your desired settings, you can obtain the generated embed code by clicking on the "Get embed code" button located on the Configurator page. This will display an overlay containing the code that you can simply copy and paste into your web application. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FT8CwbscUWkBb8A9RkZyZ%252Fembed_code.png%3Falt%3Dmedia%26token%3D46091fb4-6118-4410-b3c7-44ada8768b64&width=768&dpr=3&quality=100&sign=2294c10b&sv=2) To properly embed the widget into your web application, you need to copy three code fragments. The first fragment is the link to the widget's CSS, which should be placed in the head section of your web application page. The second fragment is the container that will hold the widget and should be placed in the body section of your page where you want the widget to be displayed. Lastly, the third fragment is the JavaScript code for the widget, which should be placed at the end of the body section of your page, right before the closing `` tag. triangle-exclamation Ensure you paste your widget into an application that runs on the domain you have set in the settings. And that is it! You have successfully added a widget into your web application. Last updated 2 years ago Was this helpful? * [Step 1: Requesting Widgets](https://docs.sportmonks.com/v3/football-widgets/guides/how-to-create-your-widget-in-three-steps#step-1-requesting-widgets) * [Step 2: Configure your widget](https://docs.sportmonks.com/v3/football-widgets/guides/how-to-create-your-widget-in-three-steps#step-2-configure-your-widget) * [Step 3: Embedding your widget](https://docs.sportmonks.com/v3/football-widgets/guides/how-to-create-your-widget-in-three-steps#step-3-embedding-your-widget) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Query complexity | Odds API 3.0 | API 3.0 Our APIs provide a lot of flexibility regarding includes, sorting and filtering. This flexibility makes us unique and one of the reasons thousands of customers trust Sportmonks as their sports data provider. To be able to keep providing this high flexibility. We introduce a new mechanic to ensure our services do not get overloaded with requests that take too much processing power. In API 2.0, each endpoint had a limited amount of nested includes, to prevent our databases from being overloaded. However, depending on the combination of includes, it was still possible to make a request which would become too big to process appropriately. We have now introduced the so-called 'query complexity' to prevent this from happening. The 'query complexity' is a mechanic where each include has a specific score, where the user can combine as many includes as he wants as long as the threshold is not exceeded. This mechanic allows us to monitor our systems better and keep them up and running. You can expect a higher response success rate and build even more trustworthy applications as a customer. You can find the query complexity score for each include on the docs page of the include. [PreviousRequest optionschevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/request-options) [NextResponse Codeschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/response-codes) Last updated 3 years ago --- # Next fixture | Football Widgets | API 3.0 Our Fixture Widget shows a snapshot of your team's next fixture. This is ideal for fans who seek information about the upcoming match. The Widget shows the opponent's time, the match, the date, the round and the competition. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FNHTrS607pyMav4itSdwM%252FNext%2520match%2520fixture.png%3Falt%3Dmedia%26token%3Dd01ebdac-bcc9-4725-bf60-5134669a51ef&width=768&dpr=3&quality=100&sign=a3e3bce3&sv=2) **Basic versus advanced** When using the advanced option, you will receive the following additions: 1. Colours customisation 2. Custom brand Colours customisation You can adapt the table of top scorers to fit it straight into your own corporate identity. Designing tables ensures a professional and consistent look and differentiates your company from your competitors. Custom brand Looking at the bottom of the basic Topscorer Widget, you can see the Sportmonks logo. With the advanced option, changing this to your brand logo is possible. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3244704705-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FWspgZhERqy7nYPTldGhL%252Fuploads%252FXJYxrtdzZjtCDdjJMkO7%252FDifference%2520basic%2520advanced.png%3Falt%3Dmedia%26token%3D5a041075-3afc-4566-8779-765ae6f297c4&width=768&dpr=3&quality=100&sign=3e0014a4&sv=2) **Also, is it possible to configure a couple of things to your hand** * Choose your competition/team * Make the team/league logo visible or hidden * Set on dark mode Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Response Codes | Odds API 3.0 | API 3.0 Whenever you receive an unexpected response, or are experiencing unexpected behaviour, you should check the request's HTTP response code and reference it with the table below. The following are all possible HTTP response codes for any request made to the API: Code Description **200: OK** Request succeeded **400: Bad Request** It seems that some part of the request is malformed. The exact reason is returned in the response. **401: Unauthorized** The request is not authenticated. **403: Forbidden** Not authorized. Indicates you're attempting to access a feed that is not accessible from your plan. **429: Too Many Requests** Too many requests. In order to make the API as responsive as possible, you have an hourly request limit. The limit for your current subscription can be found in any successful response. Check the "meta" section to find out your limit. **500: Internal Server Error** An internal error has occurred and has been logged for further inspection. Please email support if you are receiving this error. [PreviousQuery complexitychevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/query-complexity) [NextEndpointschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints) Last updated 3 years ago --- # Welcome | Odds API 3.0 | API 3.0 We'll briefly inform you about the features of our API and then you can explore our documentation for yourself. Sportmonks offers standard REST APIs. Requests are sent with URLs and responses will be returned in **JSON format**. Every authentication is spearheaded by an API token. We have assembled a library of all of our endpoints including example requests in **Postman**. If you want to get started right away, great! Head over to our **Getting Started section**, where you'll create your own API token and create your first request. Else, you can refer to our **Documentation Organization section**, to see what's relevant for you. Are you here for our [**API References Guide**arrow-up-right](https://football-postman.sportmonks.com/) ? No problem here's a link and enjoy! For any technical questions, you can email our support team [\[email protected\]envelope](https://docs.sportmonks.com/cdn-cgi/l/email-protection#51222421213e23251122213e23253c3e3f3a227f323e3c) . [NextAuthenticationchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/authentication) Last updated 3 years ago --- # Continents | Core API 3.0 | API 3.0 Gather an overview of all the continents available within your subscription via the continents' endpoint. Retrieve basic information or enrich your response. The continents endpoint helps you assign countries and leagues to the part of the World they belong to. Use one of our 2 contintents' endpoints. Per endpoint, you can find the details, including base URL, parameters, includes and more. * **GET All Continents:** returns all the continents that are available within your subscription. * **Get Continents by ID:** returns information from your requested continent ID. #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/continents#include-options) Include options [`countries`](https://docs.sportmonks.com/v3/core-api/entities/core#country) **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the continents endpoints are: * [Continent](https://docs.sportmonks.com/v3/core-api/entities/core#continent) Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Countries | Core API 3.0 | API 3.0 Gather an overview of all the countries available within your subscription via the countries' endpoint. Retrieve basic information or enrich your response. The countries' endpoint helps you with assigning leagues to the country they belong to. Use one of our 3 countries' endpoints. Per endpoint, you can find the details, including base URL, parameters, includes and more. * **GET All Countries:** returns all the countries that are available within your subscription. * **Get Country by ID:** returns information from your requested country ID. * **GET Countries by Search:** returns country information that matches your search query. #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/countries#include-options) Include options [`continent`](https://docs.sportmonks.com/v3/core-api/entities/core#continent) [`leagues`](https://docs.sportmonks.com/v3/endpoints-and-entities/entities/league-season-schedule-stage-and-round#league) [`regions`](https://docs.sportmonks.com/v3/core-api/entities/core#region) **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the countries' endpoints are: * [Country](https://docs.sportmonks.com/v3/core-api/entities/core#country) Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Regions | Core API 3.0 | API 3.0 Gather an overview of all the regions available within your subscription via the regions' endpoint. Retrieve basic information or enrich your response. Use one of our 3 regions' endpoints. Per endpoint, you can find the details, including base URL, parameters, includes and more. * **GET All Regions:** returns all the regions that are available within your subscription. * **GET Regions by ID:** returns information from your requested region ID. * **GET Regions by Search:** returns region information that matches your search query. #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/regions#include-options) Include options [`country`](https://docs.sportmonks.com/v3/core-api/entities/core#country) [`cities`](https://docs.sportmonks.com/v3/core-api/entities/core#city) **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the regions' endpoints are: * [Region](https://docs.sportmonks.com/v3/core-api/entities/core#region) Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Endpoints | Odds API 3.0 | API 3.0 [👓Pre-match Oddschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds) [🧠Inplay Oddschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds) [📚Bookmakerschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers) [📑Marketschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets) [PreviousResponse Codeschevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/response-codes) [NextPre-match Oddschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds) Last updated 3 years ago --- # Cities | Core API 3.0 | API 3.0 Gather an overview of all the cities available within your subscription via the cities' endpoint. Retrieve basic information or enrich your response. Use one of our 3 cities' endpoints. Per endpoint, you can find the details, including base URL, parameters, includes and more. * **GET All Cities:** returns all the cities that are available within your subscription. * **GET City by ID:** returns information from your requested city ID. * **GET Cities by Search:** returns city information that matches your search query. #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/cities#include-options) Include options [`region`](https://docs.sportmonks.com/v3/core-api/entities/core#region) **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the cities' endpoints are: * [City](https://docs.sportmonks.com/v3/core-api/entities/core#city) Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Timezones | Core API 3.0 | API 3.0 [GET All Supported Time Zoneschevron-right](https://docs.sportmonks.com/v3/core-api/endpoints/timezones/get-all-supported-time-zones) Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Filters | Core API 3.0 | API 3.0 Gather an overview of all the available filters. * **GET All Entity Filters:** returns all the filters available per entity. Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # My Sportmonks | Core API 3.0 | API 3.0 Retrieve information about your subscription. Check your data features and leagues available within your subscription. Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Types | Core API 3.0 | API 3.0 Gather an overview of all the types available via the types' endpoints. Use one of our 2 types' endpoints. Per endpoint, you can find the details, including base URL, parameters, includes and more. * **GET All Types:** returns all the types that are available within your subscription. * **GET Type by ID:** returns information from your requested type ID. #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/types#include-options) Include options Using includes is disabled for this endpoint. **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the types' endpoints are: * [Type](https://docs.sportmonks.com/v3/core-api/entities/core#type) Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Pre-match Odds | Odds API 3.0 | API 3.0 Enrich your application with betting functionalities. The odds endpoints can be used for Pre-match Odds, we do have an endpoint for In-Play Odds (live) as well. Use one of our 5 odds endpoints. Per endpoint, you can find the details, including base URL, parameters, includes and more. * **GET All Odds:** returns all the pre-match odds. * **GET Odds by Fixture ID:** returns the pre-match odds from your requested fixture ID. * **GET Odds by Fixture ID and Bookmaker ID:** returns the pre-match odds filtered on Bookmaker ID from your requested fixture ID. * **GET Odds by Fixture ID and Market ID:** returns the pre-match odds filtered on Market ID from your requested fixture ID. * **GET Last Updated Pre-match Odds:** returns the last updated pre-match odds. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds#include-options) Include options [`fixture`](https://docs.sportmonks.com/v3/) [`market`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [`bookmaker`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds#related-entities) Related entities [Odd](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/odd) [PreviousEndpointschevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints) [NextGET All Oddschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-all-odds) Last updated 3 years ago --- # Inplay Odds | Odds API 3.0 | API 3.0 Enrich your application with betting functionalities. The odds endpoints can be used for In-Play Odds (live), we do have an endpoint for pre-match odds as well. Use one of our 5 live odds endpoints. Per endpoint, you can find the details, including base URL, parameters, includes and more. * **GET All Inplay Odds:** returns all the live odds. * **GET Inplay Odds by Fixture ID:** returns the live odds from your requested fixture ID. * **GET Inplay Odds by Fixture ID and Bookmaker ID:** returns the live odds filtered on Bookmaker ID from your requested fixture ID. * **GET Inplay Odds by Fixture ID and Market ID:** returns the live odds filtered on Market ID from your requested fixture ID. * **GET Last Updated Inplay Odds:** returns the last updated inplay odds. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds#include-options) Include options [`fixture`](https://docs.sportmonks.com/v3/endpoints-and-entities/entities/fixture#fixture) [`market`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [`bookmaker`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds#related-entities) Related entities [InplayOdd](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/inplayodd) [PreviousGET Last Updated Oddschevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-last-updated-odds) [NextGET All Oddschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-all-odds) Last updated 3 years ago --- # Bookmakers | Odds API 3.0 | API 3.0 Are you looking for a specific bookmaker? Retrieve all the bookmakers our Football API offers via the bookmakers' endpoint. Use one of our 4 bookmakers endpoints. Per endpoint, you can find the details, including base URL, parameters, includes and more. * **GET All Bookmakers:** returns all the bookmakers available in our football API. * **GET Bookmaker by ID:** returns bookmakers' information from your requested bookmaker ID. * **GET Bookmakers by Fixture ID:** returns all the bookmakers available for your requested fixture ID. * **GET Bookmaker Event ID's by Fixture ID:** returns all the bookmakers event ids available for your requested fixture ID. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers#include-options) Include options `none` **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the bookmakers endpoints are: * [Bookmaker](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) [PreviousGET Last Updated Oddschevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-last-updated-odds) [NextGET All Bookmakerschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-all-bookmakers) Last updated 3 years ago --- # Entities | Odds API 3.0 | API 3.0 [📚Bookmakerchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) [📑Marketchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [👓Oddchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/odd) [🧠InplayOddchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/inplayodd) [PreviousGET Markets by Search by Namechevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-markets-by-search-by-name) [NextBookmakerchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) Last updated 3 years ago --- # GET My Resources | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/my/resources #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-resources#parameters) Parameters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `other parameters` #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-resources#pagination) Pagination NO #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-resources#include-depth) Include depth You can use a total of `0` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-resources#include-options) Include options `none` **Related Entities:** Not available #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-resources#code-example) Code Example Ruby Python PHP Java Node.js Go Last updated 9 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/my/resources?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/my/resources?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) Copy 'https://api.sportmonks.com/v3/my/resources?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/my/resources?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/my/resources?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/my/resources?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)) } sun-brightdesktopmoon --- # GET Continent by ID | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/core/continents/{ID} Copy { "data": { "id": 1, "name": "Europe", "code": "EU" }, Field Description Type id Refers to the id of the continent integer name Displays the name of the continent string code Displays the short code of the continent string Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. Not applicable for this endpoint. Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/continents/get-continent-by-id#pagination) Pagination No #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/continents/get-continent-by-id#include-depth) Include depth You can use a total of `3` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/continents/get-continent-by-id#include-options) Include options [`countries`](https://docs.sportmonks.com/v3/core-api/entities/core#country) **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the continents endpoints are: * [Continent](https://docs.sportmonks.com/v3/core-api/entities/core#continent) #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/continents/get-continent-by-id#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/core/continents/{ID}?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/core/continents/{ID}?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon Copy 'https://api.sportmonks.com/v3/core/continents/{ID}?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/core/continents/{ID}?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/core/continents/{ID}?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/core/continents/{ID}?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)) } sun-brightdesktopmoon --- # Markets | Odds API 3.0 | API 3.0 Are you looking for a specific market? Retrieve all the markets our Football API offers via the markets' endpoint. Use one of our 3 markets endpoints. Per endpoint, you can find the details, including base URL, parameters, includes and more. * **GET All Markets:** returns all the markets available in our football API. * **GET Market by ID:** returns markets' information from your requested markets ID. * **GET Markets by Search by Name:** returns all the markets that match your search query. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets#include-options) Include options `none` **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the markets endpoints are: * [Market](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [PreviousGET Bookmaker Event ID's by Fixture Idchevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmaker-event-ids-by-fixture-id) [NextGET All Marketschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-all-markets) Last updated 3 years ago --- # GET My Leagues | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/my/leagues #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-leagues#parameters) Parameters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `other parameters` #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-leagues#pagination) Pagination NO #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-leagues#include-depth) Include depth You can use a total of `0` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-leagues#include-options) Include options `none` **Related Entities:** Not available #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-leagues#code-example) Code Example Ruby Python PHP Java Node.js Go Last updated 9 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/my/leagues?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/my/leagues?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) Copy 'https://api.sportmonks.com/v3/my/leagues?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/my/leagues?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/my/leagues?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/my/leagues?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)) } sun-brightdesktopmoon --- # Market | Odds API 3.0 | API 3.0 #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market#related-endpoints) Related endpoints [📑Marketschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market#field-description) Field description Field Description Type `id` Refers to the unique id of the market integer `name` Displays the name of the market string developer\_name Displays the developer name of the market string #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market#include-options) Include options `none` [PreviousBookmakerchevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) [NextOddchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/odd) Last updated 3 years ago --- # GET Type by ID | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/core/types/{ID} Copy { "id": 1, "parent_id": null, "name": "1st Half", "code": "1st-half", "developer_name": "INPLAY_1ST_HALF", "group": null, "description": null }, Field Description Type id Refers to the id of the type integer parent\_id Refers to the parent type integer name Displays the name of the type string code Displays the code of the type string developer\_name Displays the developer name of the type string group Displays the group the type falls under string description Displays the description of the type string #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/types/get-type-by-id#parameters) Parameters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/types/get-type-by-id#pagination) Pagination No #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/types/get-type-by-id#include-depth) Include depth You can use a total of `0` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/types/get-type-by-id#include-options) Include options Using includes is disabled for this endpoint. **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the cities' endpoints are: * [Type](https://docs.sportmonks.com/v3/core-api/entities/core#type) #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/types/get-type-by-id#code-example) Code Example Ruby Python PHP Java Node.js Go Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/core/types/1?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/core/types/1?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) Copy 'https://api.sportmonks.com/v3/core/types/1?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/core/types/1?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/core/types/1?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/core/types/1?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)) } sun-brightdesktopmoon --- # Bookmaker | Odds API 3.0 | API 3.0 #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker#related-endpoints) Related endpoints [📚Bookmakerschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker#field-description) Field description Field Description Type `id` Refers to the unique id of the bookmaker integer `name` Displays the name of the bookmaker string `image_path` Displays the image path to the bookmaker logo string #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker#include-options) Include options `none` [PreviousEntitieschevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/entities) [NextMarketchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) Last updated 3 years ago --- # GET My Usage | Core API 3.0 | API 3.0 circle-info We retain user request logs for approximately two months, after which they are automatically deleted. Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/my/usage Copy { id: 98564461, endpoint: "api.sports.livescores.inplay", count: 1374, entity: "fixture", remaining_requests: 50878, period_start: 1694682000, period_end: 1694682300 }, { id: 98160610, endpoint: "api.sports.fixtures.show", count: 748, entity: "fixture", remaining_requests: 52252, period_start: 1694635200, period_end: 1694635500 }, Field Description id identifier of the record endpoint identifier of the requested endpoint count total calls for the given timeframe entity the entity the rate limit applies on remaining\_requests amount of requests remaining for the entity in the hourly rate limit period\_start timestamp representing the aggregation start time period\_end timestamp representing the aggregation end time #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-usage#parameters) Parameters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-usage#pagination) Pagination YES #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-usage#include-depth) Include depth Using includes is not supported on this endpoint. Last updated 9 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # GET Regions by Search | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/core/regions/search/{search_query} Copy { "data": { "id": 724, "country_id": 38, "name": "Utrecht" }, Field Description Type id Refers to the id of the region integer country\_id Refers to the country of the region integer name Displays the name of the region string Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. Not applicable for this endpoint. The **dynamic filters** are based on entities and includes. Each dynamic filter uses an entity to filter on and one entity to apply the filter on. Below are examples with explanations of how filters are set up. For more information, please look at our Filters page. Dynamic Filters Available on Entity Description Examples `countries` Coaches, Leagues, Players, Teams, and way more. Check this [endpointarrow-up-right](https://docs.sportmonks.com/football2/v/core/endpoints/filters/get-all-entity-filters) for all possibilities. Filter regions and more based on countries. `&include=countries&filters=countryRegions:countryIDS` `leagues` Check this [endpointarrow-up-right](https://docs.sportmonks.com/football2/v/core/endpoints/filters/get-all-entity-filters) for all possibilities. Filter regions and more based on cities. `&include=cities&filters=cityREgions:cityIDS` #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/regions/get-regions-by-search#pagination) Pagination Yes #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/regions/get-regions-by-search#include-depth) Include depth You can use a total of `3` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/regions/get-regions-by-search#include-options) Include options [`country`](https://docs.sportmonks.com/v3/core-api/entities/core#country) [`cities`](https://docs.sportmonks.com/v3/core-api/entities/core#city) **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the regions' endpoints are: * [Region](https://docs.sportmonks.com/v3/core-api/entities/core#region) #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/regions/get-regions-by-search#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/core/regions/search/{search_query}?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/core/regions/search/{search_query}?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon Copy 'https://api.sportmonks.com/v3/core/regions/search/{search_query}?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/core/regions/search/{search_query}?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/core/regions/search/{search_query}?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/core/regions/search/{search_query}?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)) } sun-brightdesktopmoon --- # GET My Enrichments | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/my/enrichments #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-enrichments#parameters) Parameters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `other parameters` #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-enrichments#pagination) Pagination NO #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-enrichments#include-depth) Include depth You can use a total of `0` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-enrichments#include-options) Include options `none` **Related Entities:** Not available #### [hashtag](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-enrichments#code-example) Code Example Ruby Python PHP Java Node.js Go Last updated 9 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/my/enrichments?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/my/enrichments?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) Copy 'https://api.sportmonks.com/v3/my/enrichments?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/my/enrichments?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/my/enrichments?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/my/enrichments?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)) } sun-brightdesktopmoon --- # GET Region by ID | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/core/regions/{ID} Copy { "data": { "id": 724, "country_id": 38, "name": "Utrecht" }, Field Description Type id Refers to the id of the region integer country\_id Refers to the country of the region integer name Displays the name of the region string Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. Not applicable for this endpoint. The **dynamic filters** are based on entities and includes. Each dynamic filter uses an entity to filter on and one entity to apply the filter on. Below are examples with explanations of how filters are set up. For more information, please look at our Filters page. Dynamic Filters Available on Entity Description Examples `countries` Coaches, Leagues, Players, Teams, and way more. Check this [endpointarrow-up-right](https://docs.sportmonks.com/football2/v/core/endpoints/filters/get-all-entity-filters) for all possibilities. Filter regions and more based on countries. `&include=countries&filters=countryRegions:countryIDS` `leagues` Check this [endpointarrow-up-right](https://docs.sportmonks.com/football2/v/core/endpoints/filters/get-all-entity-filters) for all possibilities. Filter regions and more based on cities. `&include=cities&filters=cityREgions:cityIDS` #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/regions/get-region-by-id#pagination) Pagination No #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/regions/get-region-by-id#include-depth) Include depth You can use a total of `3` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/regions/get-region-by-id#include-options) Include options [`country`](https://docs.sportmonks.com/v3/core-api/entities/core#country) [`cities`](https://docs.sportmonks.com/v3/core-api/entities/core#city) **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the regions' endpoints are: * [Region](https://docs.sportmonks.com/v3/core-api/entities/core#region) #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/regions/get-region-by-id#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/core/regions/{ID}?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/core/regions/{ID}?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon Copy 'https://api.sportmonks.com/v3/core/regions/{ID}?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/core/regions/{ID}?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/core/regions/{ID}?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/core/regions/{ID}?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)) } sun-brightdesktopmoon --- # GET All Continents | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/core/continents Copy { "data": [\ {\ "id": 1,\ "name": "Europe",\ "code": "EU"\ },\ {\ "id": 2,\ "name": "Asia",\ "code": "EU"\ },\ {\ "id": 3,\ "name": "Africa",\ "code": "EU"\ },\ {\ "id": 4,\ "name": "Oceania",\ "code": "EU"\ },\ {\ "id": 5,\ "name": "Antarctica",\ "code": "EU"\ },\ {\ "id": 6,\ "name": "North America",\ "code": "EU"\ },\ {\ "id": 7,\ "name": "South America",\ "code": "EU"\ }name\ \ Field\ \ Description\ \ Type\ \ id\ \ Refers to the id of the continent\ \ integer\ \ name\ \ Displays the name of the continent\ \ string\ \ code\ \ Displays the short code of the continent\ \ string\ \ Query Parameters\ \ Static Filters\ \ Dynamic Filters\ \ Query Parameters\ \ Required?\ \ Description\ \ `api_token`\ \ YES\ \ Your unique API token\ \ `include`\ \ NO\ \ Enrich the API with more data by using includes\ \ `select`\ \ NO\ \ Select specific fields on the base entity\ \ `filters`\ \ NO\ \ 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.\ \ Not applicable for this endpoint.\ \ Not applicable for this endpoint.\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/continents/get-all-continents#pagination)\ \ Pagination\ \ Yes\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/continents/get-all-continents#include-depth)\ \ Include depth\ \ You can use a total of `3` nested includes on this endpoint\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/continents/get-all-continents#include-options)\ \ Include options\ \ [`countries`](https://docs.sportmonks.com/v3/core-api/entities/core#country)\ \ **Related Entities:**\ \ Get an overview and explanation of all the fields returned in the API response. The related entities for the continents endpoints are:\ \ * [Continent](https://docs.sportmonks.com/v3/core-api/entities/core#continent)\ \ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/continents/get-all-continents#code-example)\ \ Code Example\ \ Ruby\ \ Python\ \ PHP\ \ Java\ \ Node.js\ \ Go\ \ Copy\ \ require "uri"\ require "net/http"\ \ url = URI("https://api.sportmonks.com/v3/core/continents?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\ \ \ Copy\ \ import http.client\ \ conn = http.client.HTTPSConnection("api.sportmonks.com")\ payload = ''\ headers = {}\ conn.request("GET", "/v3/core/continents?api_token={your_token}", payload, headers)\ res = conn.getresponse()\ data = res.read()\ print(data.decode("utf-8"))\ \ Last updated 3 years ago\ \ Was this helpful?\ \ Was this helpful?\ \ sun-brightdesktopmoon\ \ Copy\ \ 'https://api.sportmonks.com/v3/core/continents?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\ \ Copy\ \ OkHttpClient client = new OkHttpClient().newBuilder()\ .build();\ Request request = new Request.Builder()\ .url("https://api.sportmonks.com/v3/core/continents?api_token={your_token}")\ .method("GET", null)\ .build();\ Response response = client.newCall(request).execute();\ \ Copy\ \ var unirest = require('unirest');\ var req = unirest('GET', 'https://api.sportmonks.com/v3/core/continents?api_token={your_token}')\ .end(function (res) { \ if (res.error) throw new Error(res.error); \ console.log(res.raw_body);\ });\ \ Copy\ \ package main\ \ import (\ "fmt"\ "net/http"\ "io/ioutil"\ )\ \ func main() {\ \ url := "https://api.sportmonks.com/v3/core/continents?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))\ }\ \ sun-brightdesktopmoon --- # GET All Entity Filters | Core API 3.0 | API 3.0 Base URL Example Response Copy https://api.sportmonks.com/v3/my/filters/entity Copy "aggregate": [\ "aggregateLeagues",\ "aggregateSeasons",\ "aggregateStages"\ ], "coach": [\ "coachCountries"\ ], "coachstatistic": [\ "coachstatisticSeasons"\ ], "coachstatisticdetail": [\ "coachstatisticdetailTypes"\ ], "coachteam": [], "commentary": [], "event": [\ "eventTypes"\ ], "fixture": [\ "fixtureLeagues",\ "fixtureSeasons",\ "fixtureStates",\ "fixtureGroups",\ "fixtureStages",\ "participantsearch",\ "todaydate",\ "havingtrends",\ "venues",\ "deleted"\ ], #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/filters/get-all-entity-filters#parameters) Parameters Query Parameters Required? Description `api_token` YES Your unique API token #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/filters/get-all-entity-filters#pagination) Pagination No #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/filters/get-all-entity-filters#include-depth) Include depth You can use a total of `0` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/filters/get-all-entity-filters#include-options) Include options Using includes is disabled for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/filters/get-all-entity-filters#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/core/types?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/core/types?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon Copy 'https://api.sportmonks.com/v3/core/types?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/core/types?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/core/types?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/core/types?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)) } sun-brightdesktopmoon --- # GET City by ID | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/core/cities/{ID} Copy { "data": { "id": 53253, "country_id": 32, "region_id": 428, "name": "Madrid", "latitude": "21.9", "longitude": "-78.0833333", "geonameid": 3117735 }, Field Description Type id Refers to the id of the city integer country\_id Refers to the country of the city integer region Refers to the region of the city integer name Displays the name of the city string latitude The official latitude of the city string longitude The official lonitude of the city string geonameid The official geo name id of the city integer Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. Not applicable for this endpoint. The **dynamic filters** are based on entities and includes. Each dynamic filter uses an entity to filter on and one entity to apply the filter on. Below are examples with explanations of how filters are set up. For more information, please look at our Filters page. Dynamic Filters Available on Entity Description Examples `regions` Coaches, Leagues, Players, Teams, and way more. Check this [endpointarrow-up-right](https://docs.sportmonks.com/football2/v/core/endpoints/filters/get-all-entity-filters) for all possibilities. Filter regions and more based on cities. `&include=regions&filters=regionCities:regionIDS` #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/cities/get-city-by-id#pagination) Pagination No #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/cities/get-city-by-id#include-depth) Include depth You can use a total of `4` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/cities/get-city-by-id#include-options) Include options [`region`](https://docs.sportmonks.com/v3/core-api/entities/core#region) **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the cities' endpoints are: * [City](https://docs.sportmonks.com/v3/core-api/entities/core#city) #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/cities/get-city-by-id#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/core/cities/{ID}?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/core/cities/{ID}?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon Copy 'https://api.sportmonks.com/v3/core/cities/{ID}?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/core/cities/{ID}?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/core/cities/{ID}?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/core/cities/{ID}?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)) } sun-brightdesktopmoon --- # GET All Types | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/core/types Copy { "id": 1, "parent_id": null, "name": "1st Half", "code": "1st-half", "developer_name": "INPLAY_1ST_HALF", "group": null, "description": null }, { "id": 2, "parent_id": null, "name": "2nd Half", "code": "2nd-half", "developer_name": "INPLAY_2ND_HALF", "group": null, "description": null }, Field Description Type id Refers to the id of the type integer name Displays the name of the type string code Displays the code of the type string developer\_name Displays the developer name of the type string stat\_group Current available values are: _away, defensive, home, offensive, overall_ string|null model\_type Displays the model the type falls under string #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/types/get-all-types#parameters) Parameters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/types/get-all-types#pagination) Pagination Yes #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/types/get-all-types#include-depth) Include depth You can use a total of `0` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/types/get-all-types#include-options) Include options Using includes is disabled for this endpoint. **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the cities' endpoints are: * [Type](https://docs.sportmonks.com/v3/core-api/entities/core#type) #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/types/get-all-types#code-example) Code Example Ruby Python PHP Java Node.js Go Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/core/types?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/core/types?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) Copy 'https://api.sportmonks.com/v3/core/types?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/core/types?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/core/types?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/core/types?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)) } sun-brightdesktopmoon --- # GET Odds by Fixture ID and Market ID | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/{sport}/odds/pre-match/fixtures/{ID}/markets/{ID} Copy Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. **Static filters** are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our Filters page. Static Filters Available on Entity Description Example `Bookmakers` Odds Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14). &filters=bookmakers:bookmakerIDs &filters=bookmakers:2,14 `WinningOdds` Odds Filter all winning odds. &filters=winningOdds Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id-and-market-id#pagination) Pagination YES #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id-and-market-id#include-depth) Include depth You can use a total of `1` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id-and-market-id#include-options) Include options [`fixture`](https://docs.sportmonks.com/v3/) [`market`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [`bookmaker`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id-and-market-id#related-entities) Related entities [Odd](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/odd) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id-and-market-id#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/odds/pre-match/fixtures/{ID}/markets/{ID}?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/odds/pre-match/fixtures/{ID}/markets/{ID}?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) [PreviousGET Odds by Fixture ID and Bookmaker IDchevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id-and-bookmaker-id) [NextGET Last Updated Oddschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-last-updated-odds) Last updated 3 years ago Copy 'https://api.sportmonks.com/v3/odds/pre-match/fixtures/{ID}/markets/{ID}?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/odds/pre-match/fixtures/{ID}/markets/{ID}?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/pre-match/fixtures/{ID}/markets/{ID}?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/odds/pre-match/fixtures/{ID}/markets/{ID}?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)) } --- # GET Last Updated Odds | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/{sport}/odds/pre-match/latest Copy Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. **Static filters** are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our Filters page. Static Filters Available on Entity Description Example `Markets` Odds Filter the odds on a selection of markets separated by a comma. &filters=markets:marketIDs &filters=markets:12,14 `Bookmakers` Odds Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14). &filters=bookmakers:bookmakerIDs &filters=bookmakers:2,14 `WinningOdds` Odds Filter all winning odds. &filters=winningOdds Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-last-updated-odds#pagination) Pagination YES #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-last-updated-odds#include-depth) Include depth You can use a total of `1` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-last-updated-odds#include-options) Include options [`fixture`](https://docs.sportmonks.com/v3/) [`market`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [`bookmaker`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-last-updated-odds#related-entities) Related entities [Odd](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/odd) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-last-updated-odds#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/odds/pre-match/updates?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/odds/pre-match/updates?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) [PreviousGET Odds by Fixture ID and Market IDchevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id-and-market-id) [NextInplay Oddschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds) Last updated 3 years ago Copy 'https://api.sportmonks.com/v3/odds/pre-match/updates?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/odds/pre-match/updates?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/pre-match/updates?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/odds/pre-match/updates?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)) } --- # GET Odds by Fixture ID and Bookmaker ID | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/{sport}/odds/pre-match/fixtures/{ID}/bookmakers/{ID} Copy Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. **Static filters** are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our Filters page. Static Filters Available on Entity Description Example `Markets` Odds Filter the odds on a selection of markets separated by a comma. &filters=markets:marketIDs &filters=markets:12,14 `WinningOdds` Odds Filter all winning odds. &filters=winningOdds Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id-and-bookmaker-id#pagination) Pagination YES #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id-and-bookmaker-id#include-depth) Include depth You can use a total of `1` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id-and-bookmaker-id#include-options) Include options [`fixture`](https://docs.sportmonks.com/v3/) [`market`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [`bookmaker`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id-and-bookmaker-id#related-entities) Related entities [Odd](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/odd) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id-and-bookmaker-id#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/odds/pre-match/fixtures/{ID}/bookmakers/{ID}?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/odds/pre-match/fixtures/{ID}/bookmakers/{ID}?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) [PreviousGET Odds by Fixture IDchevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id) [NextGET Odds by Fixture ID and Market IDchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id-and-market-id) Last updated 3 years ago Copy 'https://api.sportmonks.com/v3/odds/pre-match/fixtures/{ID}/bookmakers/{ID}?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/odds/pre-match/fixtures/{ID}/bookmakers/{ID}?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/pre-match/fixtures/{ID}/bookmakers/{ID}?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/odds/pre-match/fixtures/{ID}/bookmakers/{ID}?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)) } --- # GET All Cities | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/core/cities Copy { "data": { "id": 53253, "country_id": 32, "region_id": 428, "name": "Madrid", "latitude": "21.9", "longitude": "-78.0833333", "geonameid": 3117735 }, Field Description Type id Refers to the id of the city integer country\_id Refers to the country of the city integer region Refers to the region of the city integer name Displays the name of the city string latitude The official latitude of the city string longitude The official lonitude of the city string geonameid The official geo name id of the city integer Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. **Static filters** are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our Filters page. Static Filters Available on Entity Description Example `IdAfter` GET All Cities Filter all cities starting from a certain city ID. Handy if you're doing an import for all cities and want to continue from a certain ID. `&filters=IdAfter:cityID` Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/cities/get-all-cities#pagination) Pagination Yes #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/cities/get-all-cities#include-depth) Include depth You can use a total of `4` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/cities/get-all-cities#include-options) Include options [`region`](https://docs.sportmonks.com/v3/core-api/entities/core#region) **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the cities' endpoints are: * [City](https://docs.sportmonks.com/v3/core-api/entities/core#city) #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/cities/get-all-cities#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/core/cities?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/core/cities?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon Copy 'https://api.sportmonks.com/v3/core/cities?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/core/cities?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/core/cities?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/core/cities?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)) } sun-brightdesktopmoon --- # GET Country by ID | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/core/countries/{ID} Copy { "data": { "id": 462, "continent_id": 1, "name": "United Kingdom", "official_name": "United Kingdom of Great Britain and Northern Ireland", "fifa_name": "ENG,NIR,SCO,WAL", "iso2": "GB", "iso3": "GBR", "latitude": "54.56088638305664", "longitude": "-2.2125117778778076", "geonameid": 2635167, "borders": [\ "IRL"\ ], "image_path": "https://cdn.sportmonks.com/images//countries/png/short/gb.png" }, Field Description Type id Refers to the id of the country integer continent\_id Refers to the continent of the country integer name Displays the name of the country string official\_name Displays the officiel name of the country string fifa\_name Displays the official fifa shortcode name of the country string iso2 Returns the two letter country code string iso3 Returns the three letter country code string latitude Returns the official latitude position of the country string longitude Returns the official longitude position of the country string geonameid Returns the official geonameid integer border Returns all the neighbour countries of the country string image\_path Returns the image path of the country string Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. Not applicable for this endpoint. Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/countries/get-country-by-id#pagination) Pagination No #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/countries/get-country-by-id#include-depth) Include depth You can use a total of `2` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/countries/get-country-by-id#include-options) Include options [`continent`](https://docs.sportmonks.com/v3/core-api/entities/core#continent) [`leagues`](https://docs.sportmonks.com/v3/endpoints-and-entities/entities/league-season-schedule-stage-and-round#league) [`regions`](https://docs.sportmonks.com/v3/core-api/entities/core#region) **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the countries' endpoints are: * [Country](https://docs.sportmonks.com/v3/core-api/entities/core#country) #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/countries/get-country-by-id#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/core/countries/{ID}?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/core/countries/{ID}?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon Copy 'https://api.sportmonks.com/v3/core/countries/{ID}?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/core/countries/{ID}?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/core/countries/{ID}?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/core/countries/{ID}?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)) } sun-brightdesktopmoon --- # Odd | Odds API 3.0 | API 3.0 #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/odd#related-endpoints) Related endpoints [👓Pre-match Oddschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/odd#field-description) Field description Field Description Type id Refers to the unique id of the odd integer fixture\_id Refers to the fixture related to the odd integer market\_id Refers to the market related to the odd integer bookmaker\_id Refers to the bookmaker related to the odd integer label Displays the label of the odd string value Displays the value of the odd string name Displays the name of the odd string market\_description Displays the description of the market string probability Displays the probability odd string dp3 Displays the dp3 odd string fractional Displays the fractional odd string american Displays the american odd string winning Determines if the odd is winning or not boolean stopped Determines if the odd is stopped or not boolean total Displays the total of the odd string / null handicap Displays the handicap of the odd string / null participants Displays the participants of the odd string / null #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/odd#include-options) Include options [`market`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [`bookmaker`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) [`fixture`](https://docs.sportmonks.com/v3/endpoints-and-entities/entities/fixture#fixture) ### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/odd#undefined) [PreviousMarketchevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [NextInplayOddchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/inplayodd) Last updated 3 years ago --- # InplayOdd | Odds API 3.0 | API 3.0 #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/inplayodd#related-endpoints) Related endpoints [🧠Inplay Oddschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/inplayodd#field-description) Field description Field Description Type id Refers to the unique id of the odd integer fixture\_id Refers to the fixture related to the odd integer market\_id Refers to the market related to the odd integer bookmaker\_id Refers to the bookmaker related to the odd integer label Displays the label of the odd string value Displays the value of the odd string name Displays the name of the odd string market\_description Displays the description of the market string probability Displays the probability odd string dp3 Displays the dp3 odd string fractional Displays the fractional odd string american Displays the american odd string winning Determines if the odd is winning or not boolean suspended Determines if the odd is suspended or not boolean stopped Determines if the odd is stopped or not boolean total Displays the total of the odd string / null handicap Displays the handicap of the odd string / null participants Displays the participants of the odd string / null #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/inplayodd#include-options) Include options [`market`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [`bookmaker`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) [`fixture`](https://docs.sportmonks.com/v3/endpoints-and-entities/entities/fixture#fixture) [PreviousOddchevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/odd) Last updated 3 years ago --- # Request options | Odds API 3.0 | API 3.0 This chapter will teach you how to filter out data from our API, which is useful when you want to request specific data and can omit the rest for faster response time. You can filter out data for various parameters per endpoint. See our **endpoint overviews** for more detailed information. [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/request-options#field-selection) Field selection ----------------------------------------------------------------------------------------------------------------------- API 3.0 introduces the possibility to request specific fields on entities. This possibility comes in handy when you only use particular fields in an API response. The advantage of selecting specific fields is that it reduces the response speed in mainly large responses. In addition to reducing response time, the response size can also be drastically reduced. Let's take a look together at an example. ### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/request-options#id-1.-only-select-a-specific-field) 1\. Only select a specific field One of our new additions to API 3.0 is a name field on the fixtures. The name field contains a textual representation of the participants playing the fixture. Without selecting a specific field, the API request and response would look like this: Request Response Copy https://api.sportmonks.com/v3/football/fixtures/18509783?api_token={your_token} Copy { "data": { "id": 18509783, "inplay": 0, "sport_id": 1, "league_id": 2, "season_id": 18346, "stage_id": 77453618, "group_id": null, "aggregate_id": 29195, "round_id": null, "state_id": 7, "venue_id": null, "name": "Real Madrid vs Manchester City", "home_score": 2, "away_score": 1, "starting_at": "2022-05-04 19:00:00", "result_info": "Real Madrid won after extra-time.", "ended_at": "2022-05-04 20:54:26", "leg": "2/2", "details": null, "length": 90, "placeholder": false, "is_final_result": 0 }, As you can see, the API response is rather large if you're only interested in the fixture's name. Let's select that API field to reduce the response length and size. We're using the fixtures endpoint. This means that we can select on all the fields of the fixtures entity. You can do this by adding &select={specific fields on the base [entity](https://docs.sportmonks.com/v3/odds-api/getting-started/entities) }. In our example, this would result in the below API request and response: Request Response Copy https://api.sportmonks.com/v3/football/fixtures/18509783?api_token={your_token}&select=name Copy { "data": { "name": "Real Madrid vs Manchester City", "id": 18509783, "sport_id": 1, "round_id": null, "stage_id": 77453618, "group_id": null, "aggregate_id": 29195, "league_id": 2, "season_id": 18346, "venue_id": null, "state_id": 7 }, As you can see in the example response above, the 'name' field is only returned for the fixture. circle-info Please note that the fields that have relations are also automatically included for technical reasons. ### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/request-options#id-2.-select-a-specific-field-on-an-include) 2\. Select a specific field on an include You can also use field selection based on includes. Imagine you want to access fixture lineup information from Manchester City vs Liverpool. Additional to the lineups, you also wish to receive the display names, player images and country details. circle-exclamation Please note that we only copied the first player in the lineup in the below examples. Download our full code examples to see the complete differences. Without selecting specific fields, you will receive a lot of information you don't need. The API request and partial API response would look like this: Request Response **Download full-example** file-download 66KB [old\_request\_selecting\_fields\_on\_includes.json](https://2807300797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd833Stdf2lpP4dN5FgEm%2Fuploads%2FRi91yeTFVVCPaXLJ7qxa%2Fold_request_selecting_fields_on_includes.json?alt=media&token=516ff850-c856-4f45-9a19-8d3e2b384fb0) downloadDownload[arrow-up-right-from-squareOpen](https://2807300797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd833Stdf2lpP4dN5FgEm%2Fuploads%2FRi91yeTFVVCPaXLJ7qxa%2Fold_request_selecting_fields_on_includes.json?alt=media&token=516ff850-c856-4f45-9a19-8d3e2b384fb0) The API response without selecting on fields Now, let's select specific fields on the base entities used. Since we're using the lineups.player include, the first base entity is players. We can select on all the fields of that entity. In our example, you need to select `display_name` and `image_path.` The second base entity is countries. Just like on the player entity, we can select on all the fields of the [countries](https://docs.sportmonks.com/v3/core-api/) entity. In our example, you need to select `name` and `image_path.` The new API request and partial API response would look like this: Request Response **Download full-example** file-download 37KB [new\_request\_selecting\_field\_on\_includes.json](https://2807300797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd833Stdf2lpP4dN5FgEm%2Fuploads%2FcdnrMYrQVCPCDdPDHedJ%2Fnew_request_selecting_field_on_includes.json?alt=media&token=e4ed68b2-86fc-4490-b127-4441fe6e4e3b) downloadDownload[arrow-up-right-from-squareOpen](https://2807300797-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd833Stdf2lpP4dN5FgEm%2Fuploads%2FcdnrMYrQVCPCDdPDHedJ%2Fnew_request_selecting_field_on_includes.json?alt=media&token=e4ed68b2-86fc-4490-b127-4441fe6e4e3b) The API response with selecting on fields As you can see in the example response, the size and length are reduced significantly. ### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/request-options#syntax) **Syntax** This syntax can be used across all endpoints, the documentation for each endpoint describes the exceptions regarding exclusions of some fields/relations. The table below describes the syntax for the usage of the field selection Syntax Usage Example &select= Select specific fields on the base entity &select=name &include= Include relations ?include=lineups ; Mark end of (nested) relation, you can start including of other relations here ?include=lineups;events : Mark field selection ?include=lineups:player\_name;events [PreviousAuthenticationchevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/authentication) [NextQuery complexitychevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/query-complexity) Last updated 3 years ago * [Field selection](https://docs.sportmonks.com/v3/odds-api/getting-started/request-options#field-selection) * [1\. Only select a specific field](https://docs.sportmonks.com/v3/odds-api/getting-started/request-options#id-1.-only-select-a-specific-field) * [2\. Select a specific field on an include](https://docs.sportmonks.com/v3/odds-api/getting-started/request-options#id-2.-select-a-specific-field-on-an-include) * [Syntax](https://docs.sportmonks.com/v3/odds-api/getting-started/request-options#syntax) Copy https://api.sportmonks.com/v3/football/fixtures/18138897?api_token={your_token}&include=lineups.player;lineups.player.country Copy { "data": { "id": 18138897, "inplay": 0, "sport_id": 1, "league_id": 8, "season_id": 18378, "stage_id": 77453700, "group_id": null, "aggregate_id": null, "round_id": 247615, "state_id": 5, "venue_id": 151, "name": "Manchester City vs Liverpool", "home_score": 2, "away_score": 2, "starting_at": "2022-04-10 15:30:00", "result_info": "Game ended in draw.", "ended_at": "2022-04-10 17:22:47", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "is_final_result": 0, "lineups": [\ {\ "id": 1574621,\ "sport_id": 1,\ "fixture_id": 18138897,\ "player_id": 129820,\ "team_id": 8,\ "position_id": 24,\ "detailed_position_id": null,\ "formation_field": null,\ "type_id": 11,\ "provider_id": 2,\ "yersey_number": 1,\ "formation_position": 1,\ "player_name": "Alisson",\ "player": {\ "id": 129820,\ "sport_id": 1,\ "country_id": 5,\ "nationality_id": null,\ "city_id": null,\ "position_id": 24,\ "detailed_position_id": 24,\ "type_id": 24,\ "common_name": "A. Becker",\ "firstname": "Alisson Ramsés",\ "lastname": "Becker",\ "name": "Alisson Ramsés Becker",\ "display_name": "Alisson",\ "image_path": "https://cdn.sportmonks.com/images/soccer/players/28/129820.png",\ "height": 193,\ "weight": 91,\ "date_of_birth": "1992-10-02",\ "gender": "male",\ "country": {\ "id": 5,\ "continent_id": 7,\ "name": "Brazil",\ "official_name": "Federative Republic of Brazil",\ "fifa_name": "BRA",\ "iso2": "BR",\ "iso3": "BRA",\ "latitude": "-10.81045150756836",\ "longitude": "-52.97311782836914",\ "geonameid": 3469034,\ "borders": [\ "ARG",\ "BOL",\ "COL",\ "GUF",\ "GUY",\ "PRY",\ "PER",\ "SUR",\ "URY",\ "VEN"\ ],\ "image_path": "https://cdn.sportmonks.com/images//countries/png/short/br.png"\ }\ }\ },\ \ Copy\ \ https://api.sportmonks.com/v3/football/fixtures/18138897?api_token={your_token}&include=lineups.player:display_name,image_path;lineups.player.country:name,image_path\ \ Copy\ \ {\ "data": {\ "id": 18138897,\ "inplay": 0,\ "sport_id": 1,\ "league_id": 8,\ "season_id": 18378,\ "stage_id": 77453700,\ "group_id": null,\ "aggregate_id": null,\ "round_id": 247615,\ "state_id": 5,\ "venue_id": 151,\ "name": "Manchester City vs Liverpool",\ "home_score": 2,\ "away_score": 2,\ "starting_at": "2022-04-10 15:30:00",\ "result_info": "Game ended in draw.",\ "ended_at": "2022-04-10 17:22:47",\ "leg": "1/1",\ "details": null,\ "length": 90,\ "placeholder": false,\ "is_final_result": 0,\ "lineups": [\ {\ "id": 1574621,\ "sport_id": 1,\ "fixture_id": 18138897,\ "player_id": 129820,\ "team_id": 8,\ "position_id": 24,\ "detailed_position_id": null,\ "formation_field": null,\ "type_id": 11,\ "provider_id": 2,\ "yersey_number": 1,\ "formation_position": 1,\ "player_name": "Alisson",\ "player": {\ "id": 129820,\ "country_id": 5,\ "sport_id": 1,\ "city_id": null,\ "position_id": 24,\ "detailed_position_id": 24,\ "display_name": "Alisson",\ "image_path": "https://cdn.sportmonks.com/images/soccer/players/28/129820.png",\ "country": {\ "id": 5,\ "continent_id": 7,\ "name": "Brazil",\ "image_path": "https://cdn.sportmonks.com/images//countries/png/short/br.png"\ }\ }\ }, --- # GET Bookmaker Event ID's by Fixture Id | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/odds/bookmakers/fixtures/{ID}/mapping Copy "data": [\ {\ "fixture_id": 18546969,\ "bookmaker_id": 2,\ "bookmaker_name": "bet365",\ "bookmaker_event_id": "121986418"\ }\ ], Field Description Type `fixture_id` Refers to the Sportmonks fixture\_id integer bookmaker\_id Refers to the id of the bookmaker integer bookmaker\_name contains the name of the bookmaker string bookmaker\_event\_id contains the id of this fixture at the bookmaker string Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. Not applicable for this endpoint. Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmaker-event-ids-by-fixture-id#pagination) Pagination YES #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmaker-event-ids-by-fixture-id#include-depth) Include depth You can use a total of `0` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmaker-event-ids-by-fixture-id#include-options) Include options `none` **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the bookmakers endpoints are: * [Bookmaker](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) [PreviousGET Bookmakers by Fixture IDchevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmakers-by-fixture-id) [NextMarketschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets) Last updated 3 years ago --- # GET All Regions | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/core/regions Copy { "data": [\ {\ "id": 1,\ "country_id": 107,\ "name": "Al Qadisiyah"\ },\ {\ "id": 2,\ "country_id": 802,\ "name": "HaTsafon"\ },\ {\ "id": 3,\ "country_id": 344167,\ "name": "Hawaii"\ },\ {\ "id": 4,\ "country_id": 614,\ "name": "Constantine"\ },\ {\ "id": 5,\ "country_id": 614,\ "name": "Tiaret"\ },\ {\ "id": 6,\ "country_id": 614,\ "name": "Djelfa"\ },\ \ Field\ \ Description\ \ Type\ \ id\ \ Refers to the id of the region\ \ integer\ \ country\_id\ \ Refers to the country of the region\ \ integer\ \ name\ \ Displays the name of the region\ \ string\ \ Query Parameters\ \ Static Filters\ \ Dynamic Filters\ \ Query Parameters\ \ Required?\ \ Description\ \ `api_token`\ \ YES\ \ Your unique API token\ \ `include`\ \ NO\ \ Enrich the API with more data by using includes\ \ `select`\ \ NO\ \ Select specific fields on the base entity\ \ `filters`\ \ NO\ \ 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.\ \ **Static filters** are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our Filters page.\ \ Static Filters\ \ Available on Entity\ \ Description\ \ Example\ \ `IdAfter`\ \ GET All Regions\ \ Filter all regions starting from a certain region ID. Handy if you're doing an import for all regions and want to continue from a certain ID.\ \ `&filters=IdAfter:regionID`\ \ The **dynamic filters** are based on entities and includes. Each dynamic filter uses an entity to filter on and one entity to apply the filter on. Below are examples with explanations of how filters are set up. For more information, please look at our Filters page.\ \ Dynamic Filters\ \ Available on Entity\ \ Description\ \ Examples\ \ `countries`\ \ Coaches, Leagues, Players, Teams, and way more. Check this [endpointarrow-up-right](https://docs.sportmonks.com/football2/v/core/endpoints/filters/get-all-entity-filters)\ for all possibilities.\ \ Filter regions and more based on countries.\ \ `&include=countries&filters= regionCountries:countryIDS`\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/regions/get-all-regions#pagination)\ \ Pagination\ \ Yes\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/regions/get-all-regions#include-depth)\ \ Include depth\ \ You can use a total of `3` nested includes on this endpoint\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/regions/get-all-regions#include-options)\ \ Include options\ \ [`country`](https://docs.sportmonks.com/v3/core-api/entities/core#country)\ [`cities`](https://docs.sportmonks.com/v3/core-api/entities/core#city)\ \ **Related Entities:**\ \ Get an overview and explanation of all the fields returned in the API response. The related entities for the regions' endpoints are:\ \ * [Region](https://docs.sportmonks.com/v3/core-api/entities/core#region)\ \ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/regions/get-all-regions#code-example)\ \ Code Example\ \ Ruby\ \ Python\ \ PHP\ \ Java\ \ Node.js\ \ Go\ \ Copy\ \ require "uri"\ require "net/http"\ \ url = URI("https://api.sportmonks.com/v3/core/regions?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\ \ \ Copy\ \ import http.client\ \ conn = http.client.HTTPSConnection("api.sportmonks.com")\ payload = ''\ headers = {}\ conn.request("GET", "/v3/core/regions?api_token={your_token}", payload, headers)\ res = conn.getresponse()\ data = res.read()\ print(data.decode("utf-8"))\ \ Last updated 3 years ago\ \ Was this helpful?\ \ Was this helpful?\ \ sun-brightdesktopmoon\ \ Copy\ \ 'https://api.sportmonks.com/v3/core/regions?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\ \ Copy\ \ OkHttpClient client = new OkHttpClient().newBuilder()\ .build();\ Request request = new Request.Builder()\ .url("https://api.sportmonks.com/v3/core/regions?api_token={your_token}")\ .method("GET", null)\ .build();\ Response response = client.newCall(request).execute();\ \ Copy\ \ var unirest = require('unirest');\ var req = unirest('GET', 'https://api.sportmonks.com/v3/core/regions?api_token={your_token}')\ .end(function (res) { \ if (res.error) throw new Error(res.error); \ console.log(res.raw_body);\ });\ \ Copy\ \ package main\ \ import (\ "fmt"\ "net/http"\ "io/ioutil"\ )\ \ func main() {\ \ url := "https://api.sportmonks.com/v3/core/regions?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))\ }\ \ sun-brightdesktopmoon --- # GET All Supported Time Zones | Core API 3.0 | API 3.0 Base URL Example Response Copy https://api.sportmonks.com/v3/core/timezones Copy "data": [\ "Europe/Amsterdam",\ "Europe/Andorra",\ "Europe/Astrakhan",\ "Europe/Athens",\ "Europe/Belgrade",\ "Europe/Berlin",\ "Europe/Bratislava",\ "Europe/Brussels",\ "Europe/Bucharest",\ "Europe/Budapest",\ "Europe/Busingen",\ "Europe/Chisinau",\ "Europe/Copenhagen",\ "Europe/Dublin",\ "Europe/Gibraltar",\ "Europe/Guernsey",\ "Europe/Helsinki",\ "Europe/Isle_of_Man",\ "Europe/Istanbul",\ "Europe/Jersey",\ "Europe/Kaliningrad",\ "Europe/Kirov",\ "Europe/Kyiv",\ "Europe/Lisbon",\ "Europe/Ljubljana",\ "Europe/London",\ "Europe/Luxembourg",\ "Europe/Madrid",\ "Europe/Malta",\ "Europe/Mariehamn",\ "Europe/Minsk",\ "Europe/Monaco",\ "Europe/Moscow",\ "Europe/Oslo",\ "Europe/Paris",\ "Europe/Podgorica",\ "Europe/Prague",\ "Europe/Riga",\ "Europe/Rome",\ "Europe/Samara",\ "Europe/San_Marino",\ "Europe/Sarajevo",\ "Europe/Saratov",\ "Europe/Simferopol",\ "Europe/Skopje",\ "Europe/Sofia",\ "Europe/Stockholm",\ "Europe/Tallinn",\ "Europe/Tirane",\ "Europe/Ulyanovsk",\ "Europe/Vaduz",\ "Europe/Vatican",\ "Europe/Vienna",\ "Europe/Vilnius",\ "Europe/Volgograd",\ "Europe/Warsaw",\ "Europe/Zagreb",\ "Europe/Zurich",\ "Indian/Antananarivo",\ "Indian/Chagos",\ "Indian/Christmas",\ "Indian/Cocos",\ "Indian/Comoro",\ "Indian/Kerguelen",\ "Indian/Mahe",\ "Indian/Maldives",\ "Indian/Mauritius",\ "Indian/Mayotte",\ "Indian/Reunion",\ "Pacific/Apia",\ "Pacific/Auckland",\ "Pacific/Bougainville",\ "Pacific/Chatham",\ "Pacific/Chuuk",\ "Pacific/Easter",\ "Pacific/Efate",\ "Pacific/Fakaofo",\ "Pacific/Fiji",\ "Pacific/Funafuti",\ "Pacific/Galapagos",\ "Pacific/Gambier",\ "Pacific/Guadalcanal",\ "Pacific/Guam",\ "Pacific/Honolulu",\ "Pacific/Kanton",\ "Pacific/Kiritimati",\ "Pacific/Kosrae",\ "Pacific/Kwajalein",\ "Pacific/Majuro",\ "Pacific/Marquesas",\ "Pacific/Midway",\ "Pacific/Nauru",\ "Pacific/Niue",\ "Pacific/Norfolk",\ "Pacific/Noumea",\ "Pacific/Pago_Pago",\ "Pacific/Palau",\ "Pacific/Pitcairn",\ "Pacific/Pohnpei",\ "Pacific/Port_Moresby",\ "Pacific/Rarotonga",\ "Pacific/Saipan",\ "Pacific/Tahiti",\ "Pacific/Tarawa",\ "Pacific/Tongatapu",\ "Pacific/Wake",\ "Pacific/Wallis",\ "UTC"\ ] #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/timezones/get-all-supported-time-zones#parameters) Parameters Query Parameters Required? Description `api_token` YES Your unique API token #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/timezones/get-all-supported-time-zones#pagination) Pagination No #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/timezones/get-all-supported-time-zones#include-depth) Include depth You can use a total of `0` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/timezones/get-all-supported-time-zones#include-options) Include options Using includes is disabled for this endpoint. Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # GET Cities by Search | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/core/cities/search/{search_query} Copy { "data": { "id": 53253, "country_id": 32, "region_id": 428, "name": "Madrid", "latitude": "21.9", "longitude": "-78.0833333", "geonameid": 3117735 }, Field Description Type id Refers to the id of the city integer country\_id Refers to the country of the city integer region Refers to the region of the city integer name Displays the name of the city string latitude The official latitude of the city string longitude The official lonitude of the city string geonameid The official geo name id of the city integer Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. Not applicable for this endpoint. The **dynamic filters** are based on entities and includes. Each dynamic filter uses an entity to filter on and one entity to apply the filter on. Below are examples with explanations of how filters are set up. For more information, please look at our Filters page. Dynamic Filters Available on Entity Description Examples `regions` Coaches, Leagues, Players, Teams, and way more. Check this [endpointarrow-up-right](https://docs.sportmonks.com/football2/v/core/endpoints/filters/get-all-entity-filters) for all possibilities. Filter regions and more based on cities. `&include=regions&filters=regionCities:regionIDS` #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/cities/get-cities-by-search#pagination) Pagination Yes #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/cities/get-cities-by-search#include-depth) Include depth You can use a total of `4` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/cities/get-cities-by-search#include-options) Include options [`region`](https://docs.sportmonks.com/v3/core-api/entities/core#region) **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the cities' endpoints are: * [City](https://docs.sportmonks.com/v3/core-api/entities/core#city) #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/cities/get-cities-by-search#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/core/cities/search/{search_query}?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/core/cities/search/{search_query}?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon Copy 'https://api.sportmonks.com/v3/core/cities/search/{search_query}?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/core/cities/search/{search_query}?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/core/cities/search/{search_query}?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/core/cities/search/{search_query}?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)) } sun-brightdesktopmoon --- # GET Type by Entity | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/core/types/entities Copy { "data": { "CoachStatisticDetail": { "updated_at": "2023-06-30T12:00:31.000000Z", "types": [\ {\ "id": 59,\ "name": "Substitutions",\ "code": "substitutions",\ "developer_name": "SUBSTITUTIONS",\ "model_type": "statistic",\ "stat_group": "overall"\ },\ {\ "id": 83,\ "name": "Redcards",\ "code": "redcards",\ "developer_name": "REDCARDS",\ "model_type": "statistic",\ "stat_group": "overall"\ },\ {\ "id": 84,\ "name": "Yellowcards",\ "code": "yellowcards",\ "developer_name": "YELLOWCARDS",\ "model_type": "statistic",\ "stat_group": "overall"\ },\ \ Field\ \ Description\ \ Type\ \ updated\_at\ \ Refers to the time the type was last updated\ \ string\ \ id\ \ Refers to the id of the type\ \ integer\ \ name\ \ Displays the name of the type\ \ string\ \ code\ \ Displays the code of the type\ \ string\ \ developer\_name\ \ Displays the developer name of the type\ \ string\ \ model\_type\ \ Displays the model\_type of the type\ \ string\ \ stat\_group\ \ Displays the stat group of the type\ \ string\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/types/get-type-by-entity#parameters)\ \ Parameters\ \ Query Parameters\ \ Required?\ \ Description\ \ `api_token`\ \ YES\ \ Your unique API token\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/types/get-type-by-entity#pagination)\ \ Pagination\ \ No\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/types/get-type-by-entity#include-options)\ \ Include options\ \ Using includes is **disabled** for this endpoint.\ \ **Related Entities:**\ \ Get an overview and explanation of all the fields returned in the API response. The related entities for the cities' endpoints are:\ \ * [Type](https://docs.sportmonks.com/v3/core-api/entities/core#type)\ \ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/types/get-type-by-entity#code-example)\ \ Code Example\ \ Ruby\ \ Python\ \ PHP\ \ Java\ \ Node.js\ \ Go\ \ Copy\ \ require "uri"\ require "net/http"\ \ url = URI("https://api.sportmonks.com/v3/core/types/1?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\ \ \ Copy\ \ import http.client\ \ conn = http.client.HTTPSConnection("api.sportmonks.com")\ payload = ''\ headers = {}\ conn.request("GET", "/v3/core/types/1?api_token={your_token}", payload, headers)\ res = conn.getresponse()\ data = res.read()\ print(data.decode("utf-8"))\ \ Last updated 2 years ago\ \ Was this helpful?\ \ Was this helpful?\ \ sun-brightdesktopmoon\ \ Copy\ \ 'https://api.sportmonks.com/v3/core/types/1?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\ \ Copy\ \ OkHttpClient client = new OkHttpClient().newBuilder()\ .build();\ Request request = new Request.Builder()\ .url("https://api.sportmonks.com/v3/core/types/1?api_token={your_token}")\ .method("GET", null)\ .build();\ Response response = client.newCall(request).execute();\ \ Copy\ \ var unirest = require('unirest');\ var req = unirest('GET', 'https://api.sportmonks.com/v3/core/types/1?api_token={your_token}')\ .end(function (res) { \ if (res.error) throw new Error(res.error); \ console.log(res.raw_body);\ });\ \ Copy\ \ package main\ \ import (\ "fmt"\ "net/http"\ "io/ioutil"\ )\ \ func main() {\ \ url := "https://api.sportmonks.com/v3/core/types/1?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))\ }\ \ sun-brightdesktopmoon --- # GET Countries by Search | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/core/countries/search/{search_query} Copy { "data": { "id": 462, "continent_id": 1, "name": "United Kingdom", "official_name": "United Kingdom of Great Britain and Northern Ireland", "fifa_name": "ENG,NIR,SCO,WAL", "iso2": "GB", "iso3": "GBR", "latitude": "54.56088638305664", "longitude": "-2.2125117778778076", "geonameid": 2635167, "borders": [\ "IRL"\ ], "image_path": "https://cdn.sportmonks.com/images//countries/png/short/gb.png" }, Field Description Type id Refers to the id of the country integer continent\_id Refers to the continent of the country integer name Displays the name of the country string official\_name Displays the officiel name of the country string fifa\_name Displays the official fifa shortcode name of the country string iso2 Returns the two letter country code string iso3 Returns the three letter country code string latitude Returns the official latitude position of the country string longitude Returns the official longitude position of the country string geonameid Returns the official geonameid integer border Returns all the neighbour countries of the country string image\_path Returns the image path of the country string Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. Not applicable for this endpoint. The **dynamic filters** are based on entities and includes. Each dynamic filter uses an entity to filter on and one entity to apply the filter on. Below are examples with explanations of how filters are set up. For more information, please look at our Filters page. Dynamic Filters Available on Entity Description Examples `regions` Coaches, Leagues, Players, Teams, and way more. Check this [endpointarrow-up-right](https://docs.sportmonks.com/football2/v/core/endpoints/filters/get-all-entity-filters) for all possibilities. Filter countries and more based on regions. `&include=regions&filters=regionCountries:regionIDS` `leagues` Check this [endpointarrow-up-right](https://docs.sportmonks.com/football2/v/core/endpoints/filters/get-all-entity-filters) for all possibilities. Filter countries and more based on leagues. `&include=leagues&filters=leagueCountries:leagueIDS` #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/countries/get-countries-by-search#pagination) Pagination Yes #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/countries/get-countries-by-search#include-depth) Include depth You can use a total of `2` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/countries/get-countries-by-search#include-options) Include options [`continent`](https://docs.sportmonks.com/v3/core-api/entities/core#continent) [`leagues`](https://docs.sportmonks.com/v3/endpoints-and-entities/entities/league-season-schedule-stage-and-round#league) [`regions`](https://docs.sportmonks.com/v3/core-api/entities/core#region) **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the countries' endpoints are: * [Country](https://docs.sportmonks.com/v3/core-api/entities/core#country) #### [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/countries/get-countries-by-search#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/core/countries/search/{search_query}?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/core/countries/search/{search_query}?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) Last updated 3 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon Copy 'https://api.sportmonks.com/v3/core/countries/search/{search_query}?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/core/countries/search/{search_query}?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/core/countries/search/{search_query}?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/core/countries/search/{search_query}?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)) } sun-brightdesktopmoon --- # GET All Odds | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/{sport}/odds/inplay Copy Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the [base entityarrow-up-right](https://app.gitbook.com/o/-MJWE53IpT91aRTPjruo/s/9zsNGu3HAzSnl5DWBD3Y/endpoints-and-entities/entities/fixtures) ​ `filters` NO 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. **Static filters** are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our [Filters pagearrow-up-right](https://docs.sportmonks.com/football2/api/request-options/filtering) . Static Filters Available on Entity Description Example `IdAfter` All Filter all inplay odds starting from a certain inplay odd ID. Handy if you're doing an import for all inplay odds and want to continue from a certain ID. &filters=IdAfter:inplayoddID &filters=IdAfter:4430465 `Deleted` Fixture Filter on deleted fixtures only. This filter helps to keep your database in sync. &include=fixtures&filters=IsDeleted `Markets` Odds Filter the odds on a selection of markets separated by a comma. &filters=markets:marketIDs &filters=markets:12,14 `Bookmakers` Odds Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14). &filters=bookmakers:bookmakerIDs &filters=bookmakers:2,14 `WinningOdds` Odds Filter all winning odds. &filters=winningOdds Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-all-odds#pagination) Pagination YES #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-all-odds#include-depth) Include depth You can use a total of `1` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-all-odds#include-options) Include options [`fixture`](https://docs.sportmonks.com/v3/) [`market`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [`bookmaker`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-all-odds#related-entities) Related entities [InplayOdd](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/inplayodd) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-all-odds#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/odds/inplay?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/odds/inplay?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) [PreviousInplay Oddschevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds) [NextGET Odds by Fixture IDchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id) Last updated 3 years ago Copy 'https://api.sportmonks.com/v3/odds/inplay?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/odds/inplay?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/inplay?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/odds/inplay?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)) } --- # GET Odds by Fixture ID and Bookmaker ID | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/{sport}/odds/inplay/fixtures/{ID}/bookmakers/{ID} Copy Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. **Static filters** are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our Filters page. Static Filters Available on Entity Description Example `Markets` Odds Filter the odds on a selection of markets separated by a comma. &filters=markets:marketIDs &filters=markets:12,14 `WinningOdds` Odds Filter all winning odds. &filters=winningOdds Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id-and-bookmaker-id#pagination) Pagination YES #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id-and-bookmaker-id#include-depth) Include depth You can use a total of `1` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id-and-bookmaker-id#include-options) Include options [`fixture`](https://docs.sportmonks.com/v3/) [`market`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [`bookmaker`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id-and-bookmaker-id#related-entities) Related entities [InplayOdd](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/inplayodd) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id-and-bookmaker-id#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/odds/inplay/fixtures/{ID}/bookmakers/{ID}?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/odds/inplay/fixtures/{ID}/bookmakers/{ID}?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) [PreviousGET Odds by Fixture IDchevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id) [NextGET Odds by Fixture ID and Market IDchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id-and-market-id) Last updated 3 years ago Copy 'https://api.sportmonks.com/v3/odds/inplay/fixtures/{ID}/bookmakers/{ID}?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/odds/inplay/fixtures/{ID}/bookmakers/{ID}?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/inplay/fixtures/{ID}/bookmakers/{ID}?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/odds/inplay/fixtures/{ID}/bookmakers/{ID}?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)) } --- # GET Bookmaker by ID | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/odds/bookmakers/{ID} Copy "data": [\ {\ "id": 2,\ "name": "bet365",\ "logo": null\ }\ \ Field\ \ Description\ \ Type\ \ `id`\ \ Refers to the unique id of the bookmaker\ \ integer\ \ `name`\ \ Refers to the name of the bookmaker\ \ string\ \ `image_path`\ \ Image path to the bookmaker logo\ \ string\ \ Query Parameters\ \ Static Filters\ \ Dynamic Filters\ \ Query Parameters\ \ Required?\ \ Description\ \ `api_token`\ \ YES\ \ Your unique API token\ \ `include`\ \ NO\ \ Enrich the API with more data by using includes\ \ `select`\ \ NO\ \ Select specific fields on the base entity\ \ `filters`\ \ NO\ \ 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.\ \ Not applicable for this endpoint.\ \ Not applicable for this endpoint.\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmaker-by-id#pagination)\ \ Pagination\ \ NO\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmaker-by-id#include-depth)\ \ Include depth\ \ You can use a total of `0` nested includes on this endpoint\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmaker-by-id#include-options)\ \ Include options\ \ `none`\ \ **Related Entities:**\ \ Get an overview and explanation of all the fields returned in the API response. The related entities for the bookmakers endpoints are:\ \ * [Bookmaker](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker)\ \ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmaker-by-id#code-example)\ \ Code Example\ \ Ruby\ \ Python\ \ PHP\ \ Java\ \ Node.js\ \ Go\ \ Copy\ \ require "uri"\ require "net/http"\ \ url = URI("https://api.sportmonks.com/v3/odds/bookmakers/{ID}?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\ \ \ Copy\ \ import http.client\ \ conn = http.client.HTTPSConnection("api.sportmonks.com")\ payload = ''\ headers = {}\ conn.request("GET", "/v3/odds/bookmakers/{ID}?api_token={your_token}", payload, headers)\ res = conn.getresponse()\ data = res.read()\ print(data.decode("utf-8"))\ \ [PreviousGET All Bookmakerschevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-all-bookmakers)\ [NextGET Bookmakers Search by Namechevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmakers-search-by-name)\ \ Last updated 3 years ago\ \ Copy\ \ 'https://api.sportmonks.com/v3/odds/bookmakers/{ID}?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\ \ Copy\ \ OkHttpClient client = new OkHttpClient().newBuilder()\ .build();\ Request request = new Request.Builder()\ .url("https://api.sportmonks.com/v3/odds/bookmakers/{ID}api_token={your_token}")\ .method("GET", null)\ .build();\ Response response = client.newCall(request).execute();\ \ Copy\ \ var unirest = require('unirest');\ var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/bookmakers/{ID}?api_token={your_token}')\ .end(function (res) { \ if (res.error) throw new Error(res.error); \ console.log(res.raw_body);\ });\ \ Copy\ \ package main\ \ import (\ "fmt"\ "net/http"\ "io/ioutil"\ )\ \ func main() {\ \ url := "https://api.sportmonks.com/v3/odds/bookmakers/{ID}?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))\ } --- # GET Bookmakers Search by Name | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/odds/bookmakers/search/{name} Copy "data": [\ {\ "id": 2,\ "legacy_id": 2,\ "name": "bet365"\ },\ {\ "id": 6,\ "legacy_id": 9,\ "name": "BetFred"\ },\ {\ "id": 7,\ "legacy_id": 11,\ "name": "Bet-At-Home"\ },\ {\ "id": 8,\ "legacy_id": 13,\ "name": "BetCRIS"\ },\ ] Field Description Type `id` Refers to the unique id of the bookmaker integer `name` Refers to the name of the bookmaker string `image_path` Image path to the bookmaker logo string Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. Not applicable for this endpoint. Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmakers-search-by-name#pagination) Pagination YES #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmakers-search-by-name#include-depth) Include depth You can use a total of `0` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmakers-search-by-name#include-options) Include options `none` **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the bookmakers endpoints are: * [Bookmaker](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmakers-search-by-name#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/odds/bookmakers/search/{name}?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/odds/bookmakers/search/{name}?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) [PreviousGET Bookmaker by IDchevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmaker-by-id) [NextGET Bookmakers by Fixture IDchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmakers-by-fixture-id) Last updated 3 years ago Copy 'https://api.sportmonks.com/v3/odds/bookmakers/search/{name}?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/odds/bookmakers/search/{name}?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/bookmakers/search/{name}?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/odds/bookmakers/search/{name}?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)) } --- # GET Market by ID | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/odds/markets/{ID} Copy "data": { "id": 1, "name": "3Way Result" }, Field Description Type `id` Refers to the unique id of the bookmaker integer `name` Refers to the name of the market string Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. Not applicable for this endpoint. Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-market-by-id#pagination) Pagination NO #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-market-by-id#include-depth) Include depth You can use a total of `0` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-market-by-id#include-options) Include options `none` #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-market-by-id#related-entities) **Related Entities:** Get an overview and explanation of all the fields returned in the API response. The related entities for the Markets endpoint are: * [Market](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-market-by-id#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/odds/markets/{ID}?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/odds/markets/{ID}?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) [PreviousGET All Marketschevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-all-markets) [NextGET Markets by Search by Namechevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-markets-by-search-by-name) Last updated 3 years ago Copy 'https://api.sportmonks.com/v3/odds/markets/{ID}?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/odds/markets/{ID}?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/markets/{ID}?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/odds/markets/{ID}?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)) } --- # GET Last Updated Odds | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/{sport}/odds/inplay/updates Copy Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. **Static filters** are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our Filters page. Static Filters Available on Entity Description Example `Markets` Odds Filter the odds on a selection of markets separated by a comma. &filters=markets:marketIDs &filters=markets:12,14 `Bookmakers` Odds Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14). &filters=bookmakers:bookmakerIDs &filters=bookmakers:2,14 `WinningOdds` Odds Filter all winning odds. &filters=winningOdds Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-last-updated-odds#pagination) Pagination YES #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-last-updated-odds#include-depth) Include depth You can use a total of `1` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-last-updated-odds#include-options) Include options [`fixture`](https://docs.sportmonks.com/v3/) [`market`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [`bookmaker`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-last-updated-odds#related-entities) Related entities [InplayOdd](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/inplayodd) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-last-updated-odds#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/odds/inplay/updates?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/odds/inplay/updates?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) [PreviousGET Odds by Fixture ID and Market IDchevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id-and-market-id) [NextBookmakerschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers) Last updated 3 years ago Copy 'https://api.sportmonks.com/v3/odds/inplay/updates?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/odds/inplay/updates?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/inplay/updates?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/odds/inplay/updates?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)) } --- # Core | Core API 3.0 | API 3.0 ### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#continent) Continent #### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#related-endpoints) Related endpoints [🗺️Continentschevron-right](https://docs.sportmonks.com/v3/core-api/endpoints/continents) **Field Description** Field Description Type id Refers to the id of the continent integer name Displays the name of the continent string code Displays the short code of the continent string #### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#include-options) Include options [`countries`](https://docs.sportmonks.com/v3/core-api/entities/core#country) ### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#country) **Country** #### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#related-endpoints-1) Related endpoints [🏳️Countrieschevron-right](https://docs.sportmonks.com/v3/core-api/endpoints/countries) **Field Description** Field Description Type id Refers to the id of the country integer continent\_id Refers to the continent of the country integer name Displays the name of the country string official\_name Displays the officiel name of the country string fifa\_name Displays the official fifa shortcode name of the country string iso2 Returns the two letter country code string iso3 Returns the three letter country code string latitude Returns the official latitude position of the country string longitude Returns the official longitude position of the country string geonameid Returns the official geonameid integer border Returns all the neighbour countries of the country string image\_path Returns the image path of the country string #### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#include-options-1) Include options [`continents`](https://docs.sportmonks.com/v3/core-api/entities/core#continent) [`leagues`](https://docs.sportmonks.com/v3/endpoints-and-entities/entities/league-season-schedule-stage-and-round#league) [`regions`](https://docs.sportmonks.com/v3/core-api/entities/core#region) ### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#region) Region #### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#related-endpoints-2) Related endpoints [🏴Regionschevron-right](https://docs.sportmonks.com/v3/core-api/endpoints/regions) #### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#field-description) Field Description Field Description Type id Refers to the id of the region integer country\_id Refers to the country of the region integer name Displays the name of the region string #### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#include-options-2) Include options [`country`](https://docs.sportmonks.com/v3/core-api/entities/core#country) [`cities`](https://docs.sportmonks.com/v3/core-api/entities/core#city) ### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#city) City #### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#related-endpoints-3) Related endpoints [🏙️Citieschevron-right](https://docs.sportmonks.com/v3/core-api/endpoints/cities) #### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#field-description-1) Field Description Field Description Type id Refers to the id of the city integer country\_id Refers to the country of the city integer region Refers to the region of the city integer name Displays the name of the city string latitude The official latitude of the city string longitude The official lonitude of the city string geonameid The official geo name id of the city integer #### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#include-options-3) Include options [`region`](https://docs.sportmonks.com/v3/core-api/entities/core#region) ### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#sport) Sport #### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#field-description-2) Field Description Field Description Type id Refers to the id of the sport integer name Displays the name of the sport string code Displays the code of the sport string #### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#include-options-4) Include options `none` ### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#type) Type #### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#related-endpoints-4) Related endpoints [⌨️Typeschevron-right](https://docs.sportmonks.com/v3/core-api/endpoints/types) #### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#field-description-3) Field Description Field Description Type id Refers to the id of the type integer parent\_id Refers to the parent type of the type integer name Displays the name of the type string code Displays the code of the type string developer\_name Displays the developer name of the type string group Displays the group the type falls under string description Displays the description of the type string #### [hashtag](https://docs.sportmonks.com/v3/core-api/entities/core#include-options-5) Include options Using includes is disabled for this endpoint. Last updated 3 years ago Was this helpful? * [Continent](https://docs.sportmonks.com/v3/core-api/entities/core#continent) * [Country](https://docs.sportmonks.com/v3/core-api/entities/core#country) * [Region](https://docs.sportmonks.com/v3/core-api/entities/core#region) * [City](https://docs.sportmonks.com/v3/core-api/entities/core#city) * [Sport](https://docs.sportmonks.com/v3/core-api/entities/core#sport) * [Type](https://docs.sportmonks.com/v3/core-api/entities/core#type) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # GET All Countries | Core API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/core/countries Copy { "data": [\ {\ "id": 2,\ "continent_id": 1,\ "name": "Poland",\ "official_name": "Republic of Poland",\ "fifa_name": "POL",\ "iso2": "PL",\ "iso3": "POL",\ "latitude": "52.147850036621094",\ "longitude": "19.37775993347168",\ "geonameid": 798544,\ "borders": [\ "BLR",\ "CZE",\ "DEU",\ "LTU",\ "RUS",\ "SVK",\ "UKR"\ ],\ "image_path": "https://cdn.sportmonks.com/images//countries/png/short/pl.png"\ },\ {\ "id": 5,\ "continent_id": 7,\ "name": "Brazil",\ "official_name": "Federative Republic of Brazil",\ "fifa_name": "BRA",\ "iso2": "BR",\ "iso3": "BRA",\ "latitude": "-10.81045150756836",\ "longitude": "-52.97311782836914",\ "geonameid": 3469034,\ "borders": [\ "ARG",\ "BOL",\ "COL",\ "GUF",\ "GUY",\ "PRY",\ "PER",\ "SUR",\ "URY",\ "VEN"\ ],\ "image_path": "https://cdn.sportmonks.com/images//countries/png/short/br.png"\ },\ {\ "id": 11,\ "continent_id": 1,\ "name": "Germany",\ "official_name": "Federal Republic of Germany",\ "fifa_name": "GER",\ "iso2": "DE",\ "iso3": "DEU",\ "latitude": "51.20246505737305",\ "longitude": "10.382203102111816",\ "geonameid": 2921044,\ "borders": [\ "AUT",\ "BEL",\ "CZE",\ "DNK",\ "FRA",\ "LUX",\ "NLD",\ "POL",\ "CHE"\ ],\ "image_path": "https://cdn.sportmonks.com/images//countries/png/short/de.png"\ },\ \ Field\ \ Description\ \ Type\ \ id\ \ Refers to the id of the country\ \ integer\ \ continent\_id\ \ Refers to the continent of the country\ \ integer\ \ name\ \ Displays the name of the country\ \ string\ \ official\_name\ \ Displays the officiel name of the country\ \ string\ \ fifa\_name\ \ Displays the official fifa shortcode name of the country\ \ string\ \ iso2\ \ Returns the two letter country code\ \ string\ \ iso3\ \ Returns the three letter country code\ \ string\ \ latitude\ \ Returns the official latitude position of the country\ \ string\ \ longitude\ \ Returns the official longitude position of the country\ \ string\ \ geonameid\ \ Returns the official geonameid\ \ integer\ \ border\ \ Returns all the neighbour countries of the country\ \ string\ \ image\_path\ \ Returns the image path of the country\ \ string\ \ Query Parameters\ \ Static Filters\ \ Dynamic Filters\ \ Query Parameters\ \ Required?\ \ Description\ \ `api_token`\ \ YES\ \ Your unique API token\ \ `include`\ \ NO\ \ Enrich the API with more data by using includes\ \ `select`\ \ NO\ \ Select specific fields on the base entity\ \ `filters`\ \ NO\ \ 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.\ \ **Static filters** are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our Filters page.\ \ Static Filters\ \ Available on Entity\ \ Description\ \ Example\ \ `IdAfter`\ \ GET All Countries\ \ Filter all countries starting from a certain country ID. Handy if you're doing an import for all countries and want to continue from a certain ID.\ \ `&filters=IdAfter:countryID`\ \ The **dynamic filters** are based on entities and includes. Each dynamic filter uses an entity to filter on and one entity to apply the filter on. Below are examples with explanations of how filters are set up. For more information, please look at our Filters page.\ \ Dynamic Filters\ \ Available on Entity\ \ Description\ \ Examples\ \ `regions`\ \ Region Check this [endpointarrow-up-right](https://docs.sportmonks.com/football2/v/core/endpoints/filters/get-all-entity-filters)\ for all possibilities.\ \ Filter regions based on countries.\ \ `&include=regions&filters=regionCountries:regionIDS`\ \ `leagues`\ \ Check this [endpointarrow-up-right](https://docs.sportmonks.com/football2/v/core/endpoints/filters/get-all-entity-filters)\ for all possibilities.\ \ Filter leagues based on countries.\ \ `&include=leagues&filters=leagueCountries:leagueIDS`\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/countries/get-all-countries#pagination)\ \ Pagination\ \ Yes\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/countries/get-all-countries#include-depth)\ \ Include depth\ \ You can use a total of `2` nested includes on this endpoint\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/countries/get-all-countries#include-options)\ \ Include options\ \ [`continent`](https://docs.sportmonks.com/v3/core-api/entities/core#continent)\ [`leagues`](https://docs.sportmonks.com/v3/endpoints-and-entities/entities/league-season-schedule-stage-and-round#league)\ [`regions`](https://docs.sportmonks.com/v3/core-api/entities/core#region)\ \ **Related Entities:**\ \ Get an overview and explanation of all the fields returned in the API response. The related entities for the countries' endpoints are:\ \ * [Country](https://docs.sportmonks.com/v3/core-api/entities/core#country)\ \ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/core-api/endpoints/countries/get-all-countries#code-example)\ \ Code Example\ \ Ruby\ \ Python\ \ PHP\ \ Java\ \ Node.js\ \ Go\ \ Copy\ \ require "uri"\ require "net/http"\ \ url = URI("https://api.sportmonks.com/v3/core/countries?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\ \ \ Copy\ \ import http.client\ \ conn = http.client.HTTPSConnection("api.sportmonks.com")\ payload = ''\ headers = {}\ conn.request("GET", "/v3/core/countries?api_token={your_token}", payload, headers)\ res = conn.getresponse()\ data = res.read()\ print(data.decode("utf-8"))\ \ Last updated 3 years ago\ \ Was this helpful?\ \ Was this helpful?\ \ sun-brightdesktopmoon\ \ Copy\ \ 'https://api.sportmonks.com/v3/core/countries?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\ \ Copy\ \ OkHttpClient client = new OkHttpClient().newBuilder()\ .build();\ Request request = new Request.Builder()\ .url("https://api.sportmonks.com/v3/core/countries?api_token={your_token}")\ .method("GET", null)\ .build();\ Response response = client.newCall(request).execute();\ \ Copy\ \ var unirest = require('unirest');\ var req = unirest('GET', 'https://api.sportmonks.com/v3/core/countries?api_token={your_token}')\ .end(function (res) { \ if (res.error) throw new Error(res.error); \ console.log(res.raw_body);\ });\ \ Copy\ \ package main\ \ import (\ "fmt"\ "net/http"\ "io/ioutil"\ )\ \ func main() {\ \ url := "https://api.sportmonks.com/v3/core/countries?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))\ }\ \ sun-brightdesktopmoon --- # GET Odds by Fixture ID and Market ID | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/{sport}/odds/inplay/fixtures/{ID}/markets/{ID} Copy Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. **Static filters** are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our Filters page. Static Filters Available on Entity Description Example `Bookmakers` Odds Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14). &filters=bookmakers:bookmakerIDs &filters=bookmakers:2,14 `WinningOdds` Odds Filter all winning odds. &filters=winningOdds Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id-and-market-id#pagination) Pagination YES #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id-and-market-id#include-depth) Include depth You can use a total of `1` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id-and-market-id#include-options) Include options [`fixture`](https://docs.sportmonks.com/v3/) [`market`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [`bookmaker`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id-and-market-id#related-entities) Related entities [InplayOdd](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/inplayodd) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id-and-market-id#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/odds/inplay/fixtures/{ID}/markets/{ID}?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/odds/inplay/fixtures/{ID}/markets/{ID}?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) [PreviousGET Odds by Fixture ID and Bookmaker IDchevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id-and-bookmaker-id) [NextGET Last Updated Oddschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-last-updated-odds) Last updated 3 years ago Copy 'https://api.sportmonks.com/v3/odds/inplay/fixtures/{ID}/markets/{ID}?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/odds/inplay/fixtures/{ID}/markets/{ID}?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/inplay/fixtures/{ID}/markets/{ID}?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/odds/inplay/fixtures/{ID}/markets/{ID}?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)) } --- # GET Odds by Fixture ID | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/{sport}/odds/pre-match/fixtures/{ID} Copy { "id": 1040325, "fixture_id": 18557891, "market_id": 1, "bookmaker_id": 28, "label": "1", "value": "2.05", "name": "Home", "sort_order": null, "market_description": "Match Winner", "probability": "48.78%", "dp3": "2.050", "fractional": "31/15", "american": "104", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": "10266" }, { "id": 1040326, "fixture_id": 18557891, "market_id": 1, "bookmaker_id": 28, "label": "X", "value": "3.10", "name": "Draw", "sort_order": null, "market_description": "Match Winner", "probability": "32.26%", "dp3": "3.100", "fractional": "25/8", "american": "210", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": null }, { "id": 1040327, "fixture_id": 18557891, "market_id": 1, "bookmaker_id": 28, "label": "2", "value": "3.20", "name": "Away", "sort_order": null, "market_description": "Match Winner", "probability": "31.25%", "dp3": "3.200", "fractional": "16/5", "american": "220", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": "6157" }, Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. **Static filters** are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our Filters page. Static Filters Available on Entity Description Example `Markets` Odds Filter the odds on a selection of markets separated by a comma. &filters=markets:marketIDs &filters=markets:12,14 `Bookmakers` Odds Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14). &filters=bookmakers:bookmakerIDs &filters=bookmakers:2,14 `WinningOdds` Odds Filter all winning odds. &filters=winningOdds Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id#pagination) Pagination YES #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id#include-depth) Include depth You can use a total of `1` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id#include-options) Include options [`fixture`](https://docs.sportmonks.com/v3/) [`market`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [`bookmaker`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id#related-entities) Related entities [Odd](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/odd) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/odds/pre-match/fixtures/{ID}?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/odds/pre-match/fixtures/{ID}?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) [PreviousGET All Oddschevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-all-odds) [NextGET Odds by Fixture ID and Bookmaker IDchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id-and-bookmaker-id) Last updated 3 years ago Copy 'https://api.sportmonks.com/v3/odds/pre-match/fixtures/{ID}?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/odds/pre-match/fixtures/{ID}?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/pre-match/fixtures/{ID}?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/odds/pre-match/fixtures/{ID}?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)) } --- # GET Markets by Search by Name | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/odds/markets/search/{search_query} Copy "data": [\ {\ "id": 3,\ "legacy_id": null,\ "name": "X Goal",\ "developer_name": "X_GOAL",\ "has_winning_calculations": false\ },\ {\ "id": 4,\ "legacy_id": 28077,\ "name": "Match Goals",\ "developer_name": "MATCH_GOALS",\ "has_winning_calculations": true\ },\ {\ "id": 5,\ "legacy_id": 136703813,\ "name": "Alternative Match Goals",\ "developer_name": "ALTERNATIVE_MATCH_GOALS",\ "has_winning_calculations": true\ },\ {\ "id": 7,\ "legacy_id": 136830707,\ "name": "Goal Line",\ "developer_name": "GOAL_LINE",\ "has_winning_calculations": false\ },\ ```\ \ Field\ \ Description\ \ Type\ \ `id`\ \ Refers to the unique id of the bookmaker\ \ integer\ \ `name`\ \ Refers to the name of the market\ \ string\ \ Query Parameters\ \ Static Filters\ \ Dynamic Filters\ \ Query Parameters\ \ Required?\ \ Description\ \ `api_token`\ \ YES\ \ Your unique API token\ \ `include`\ \ NO\ \ Enrich the API with more data by using includes\ \ `select`\ \ NO\ \ Select specific fields on the base entity\ \ `filters`\ \ NO\ \ 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.\ \ Not applicable for this endpoint.\ \ Not applicable for this endpoint.\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-markets-by-search-by-name#pagination)\ \ Pagination\ \ YES\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-markets-by-search-by-name#include-depth)\ \ Include depth\ \ You can use a total of `0` nested includes on this endpoint\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-markets-by-search-by-name#pagination-1)\ \ Pagination\ \ YES\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-markets-by-search-by-name#include-options)\ \ Include options\ \ `none`\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-markets-by-search-by-name#related-entities)\ \ **Related Entities:**\ \ Get an overview and explanation of all the fields returned in the API response. The related entities for the Markets endpoint are:\ \ * [Market](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market)\ \ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-markets-by-search-by-name#code-example)\ \ Code Example\ \ Ruby\ \ Python\ \ PHP\ \ Java\ \ Node.js\ \ Go\ \ [PreviousGET Market by IDchevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-market-by-id)\ [NextEntitieschevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/entities)\ \ Last updated 3 years ago\ \ Copy\ \ require "uri"\ require "net/http"\ \ url = URI("https://api.sportmonks.com/v3/odds/markets/{ID}/fixture?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\ \ \ Copy\ \ import http.client\ \ conn = http.client.HTTPSConnection("api.sportmonks.com")\ payload = ''\ headers = {}\ conn.request("GET", "/v3/odds/markets/{ID}/fixture?api_token={your_token}", payload, headers)\ res = conn.getresponse()\ data = res.read()\ print(data.decode("utf-8"))\ \ Copy\ \ 'https://api.sportmonks.com/v3/odds/markets/{ID}/fixture?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\ \ Copy\ \ OkHttpClient client = new OkHttpClient().newBuilder()\ .build();\ Request request = new Request.Builder()\ .url("https://api.sportmonks.com/v3/odds/markets/{ID}/fixture?api_token={your_token}")\ .method("GET", null)\ .build();\ Response response = client.newCall(request).execute();\ \ Copy\ \ var unirest = require('unirest');\ var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/markets/{ID}/fixture?api_token={your_token}')\ .end(function (res) { \ if (res.error) throw new Error(res.error); \ console.log(res.raw_body);\ });\ \ Copy\ \ package main\ \ import (\ "fmt"\ "net/http"\ "io/ioutil"\ )\ \ func main() {\ \ url := "https://api.sportmonks.com/v3/odds/markets/{ID}/fixture?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))\ } --- # GET All Odds | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/{sport}/pre-match Copy { "id": 1040325, "fixture_id": 18557891, "market_id": 1, "bookmaker_id": 28, "label": "1", "value": "2.05", "name": "Home", "sort_order": null, "market_description": "Match Winner", "probability": "48.78%", "dp3": "2.050", "fractional": "31/15", "american": "104", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": "10266" }, { "id": 1040326, "fixture_id": 18557891, "market_id": 1, "bookmaker_id": 28, "label": "X", "value": "3.10", "name": "Draw", "sort_order": null, "market_description": "Match Winner", "probability": "32.26%", "dp3": "3.100", "fractional": "25/8", "american": "210", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": null }, { "id": 1040327, "fixture_id": 18557891, "market_id": 1, "bookmaker_id": 28, "label": "2", "value": "3.20", "name": "Away", "sort_order": null, "market_description": "Match Winner", "probability": "31.25%", "dp3": "3.200", "fractional": "16/5", "american": "220", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": "6157" }, Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. **Static filters** are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our [Filters pagearrow-up-right](https://docs.sportmonks.com/football2/api/request-options/filtering) . Static Filters Available on Entity Description Example `IdAfter` All Filter all inplay odds starting from a certain inplay odd ID. Handy if you're doing an import for all inplay odds and want to continue from a certain ID. &filters=IdAfter:inplayoddID &filters=IdAfter:4430465 `Deleted` Fixture Filter on deleted fixtures only. This filter helps to keep your database in sync. &include=fixtures&filters=IsDeleted `Markets` Odds Filter the odds on a selection of markets separated by a comma. &filters=markets:marketIDs &filters=markets:12,14 `Bookmakers` Odds Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14). &filters=bookmakers:bookmakerIDs &filters=bookmakers:2,14 `WinningOdds` Odds Filter all winning odds. &filters=winningOdds Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-all-odds#pagination) Pagination YES #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-all-odds#include-depth) Include depth You can use a total of `1` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-all-odds#include-options) Include options [`fixture`](https://docs.sportmonks.com/v3/) [`market`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [`bookmaker`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-all-odds#related-entities) Related entities [Odd](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/odd) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-all-odds#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/odds/pre-match?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/odds/pre-match?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) [PreviousPre-match Oddschevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds) [NextGET Odds by Fixture IDchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/pre-match-odds/get-odds-by-fixture-id) Last updated 3 years ago Copy 'https://api.sportmonks.com/v3/odds/pre-match?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/odds/pre-match?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/pre-match?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/odds/pre-match?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)) } --- # Query complexity | Motorsport 3.0 (beta) | API 3.0 Our APIs provide a lot of flexibility regarding includes, sorting and filtering. This flexibility makes us unique and one of the reasons thousands of customers trust Sportmonks as their sports data provider. To be able to keep providing this high flexibility. We introduce a new mechanic to ensure our services do not get overloaded with requests that take too much processing power. In our previous API, each endpoint had a limited amount of nested includes, to prevent our databases from being overloaded. However, depending on the combination of includes, it was still possible to make a request which would become too big to process appropriately. We have now introduced the so-called 'query complexity' to prevent this from happening. The 'query complexity' is a mechanic where each include has a specific score, where the user can combine as many includes as he wants as long as the threshold is not exceeded. This mechanic allows us to monitor our systems better and keep them up and running. You can expect a higher response success rate and build even more trustworthy applications as a customer. You can find the query complexity score for each include on the docs page of the include. Last updated 1 month ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Welcome | Motorsport 3.0 (beta) | API 3.0 circle-exclamation **This version of the Motorsport API will be in BETA for the first few weeks. However, there are no plans for major or breaking changes during these weeks.** **Please contact us at** [**\[email protected\]**envelope](https://docs.sportmonks.com/cdn-cgi/l/email-protection#54272124243b26201427243b2620393b3a3f277a373b39) **if you have any feedback.** We'll briefly inform you about the features of our API and then you can explore our documentation for yourself. Sportmonks offers standard REST APIs. Requests are sent with URLs and responses will be returned in **JSON format**. Every authentication is spearheaded by an API token. If you want to get started right away, great! Head over to our [**Getting Started section**](https://docs.sportmonks.com/v3/motorsport-api/welcome/getting-started) , where you'll create your own API token and create your first request. Are you currently using the [Formula One API v1](https://docs.sportmonks.com/v2/formula-one-api/) and want to migrate now? Check out our [Migration Guide](https://docs.sportmonks.com/v3/motorsport-api/tutorials-and-guides/guides/migrating-from-formula-one-api-v1-to-motorsport-api-v3) to get started. For any technical questions, you can email our support team [\[email protected\]envelope](https://docs.sportmonks.com/cdn-cgi/l/email-protection#b0c3c5c0c0dfc2c4f0c3c0dfc2c4dddfdedbc39ed3dfdd) . Last updated 27 days ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Getting Started | Motorsport 3.0 (beta) | API 3.0 We'll briefly inform you about the features of our API, and then you can explore our documentation for yourself. You will also find out how to create **your** dream application. Sportmonks offers standard REST APIs. Requests are sent with URLs and responses will be returned in **JSON format**. Every authentication is spearheaded by an API token. Short introduction to Sportmonks: Now you know who we are, what we do, what we offer, and how we can help you: We suppose you want to get started right away. Head over to our [Authentication section](https://docs.sportmonks.com/v3/motorsport-api/welcome/authentication) , where you'll create your own API token and create your first request What else do we cover in the documentation? * [Endpoint overview](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints) * [Entities explained](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities) * [Tutorials](https://docs.sportmonks.com/v3/motorsport-api/tutorials-and-guides/tutorials) * [How-to guides](https://docs.sportmonks.com/v3/motorsport-api/tutorials-and-guides/guides) * [Includes, filters and select options](https://docs.sportmonks.com/v3/motorsport-api/welcome/request-options) * [Response code definitions](https://docs.sportmonks.com/v3/motorsport-api/welcome/response-codes) * [A guide on how to migrate from Formula One API v1](https://docs.sportmonks.com/v3/motorsport-api/tutorials-and-guides/guides/migrating-from-formula-one-api-v1-to-motorsport-api-v3) Last updated 1 month ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Changelog | Motorsport 3.0 (beta) | API 3.0 ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/changelog/changelog#id-2026-02-12) 2026-02-12 We released a few new endpoints and includes that help you more easily integrate the API and retrieve useful data: * There is now a [GET Drivers by Season ID](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/drivers/get-drivers-by-season-id) endpoint, which returns all the drivers in the lineup for the specified season. This also includes test drivers that are driving or have driven during a practice session in the season, and drivers that replace other drivers in the lineup. * You can now request the driver and team race results for a whole season using the following endpoints (only returns Race and Sprint Race sessions): * [GET Race Results by Season and Driver](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/race-results/get-race-results-by-season-and-driver) * [GET Race Results by Season and Team](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/race-results/get-race-results-by-season-and-team) * Two new includes are added: * Driver: seasonTeams - Returns season-level teams for the drivers, including season ID, team ID, lineup position and the driver number used. Available nested includes: .season, .team and .position * Team: seasonDrivers - Returns season-level drivers for the teams, including season ID, driver ID, lineup position and the driver number used. Available nested includes: .season, .driver and .position ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/changelog/changelog#id-2026-01-12) 2026-01-12 Motorsport API v3 is now officially released. Coming from Formula One API v1? Check out the [migration guide](https://docs.sportmonks.com/v3/motorsport-api/tutorials-and-guides/guides/migrating-from-formula-one-api-v1-to-motorsport-api-v3) to find helpful resources for migrating to this new version. Last updated 11 days ago Was this helpful? * [2026-02-12](https://docs.sportmonks.com/v3/motorsport-api/changelog/changelog#id-2026-02-12) * [2026-01-12](https://docs.sportmonks.com/v3/motorsport-api/changelog/changelog#id-2026-01-12) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # GET Odds by Fixture ID | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/{sport}/odds/inplay/fixtures/{ID} Copy { "id": 11300732, "fixture_id": 18530151, "external_id": 1263999600, "market_id": 1, "bookmaker_id": 2, "label": "1", "value": "1.62", "name": "Boca Juniors Reserves", "sort_order": 0, "market_description": "Fulltime Result", "probability": "61.73%", "dp3": "1.62", "fractional": "8/13", "american": "-162", "winning": false, "suspended": false, "stopped": false, "total": null, "handicap": null, "participants": "236557" }, { "id": 11300733, "fixture_id": 18530151, "external_id": 1263999602, "market_id": 1, "bookmaker_id": 2, "label": "X", "value": "3.60", "name": "Draw", "sort_order": 1, "market_description": "Fulltime Result", "probability": "27.78%", "dp3": "3.60", "fractional": "13/5", "american": "260", "winning": false, "suspended": false, "stopped": false, "total": null, "handicap": null, "participants": null }, { "id": 11300734, "fixture_id": 18530151, "external_id": 1263999603, "market_id": 1, "bookmaker_id": 2, "label": "2", "value": "4.50", "name": "San Lorenzo Reserves", "sort_order": 2, "market_description": "Fulltime Result", "probability": "22.22%", "dp3": "4.50", "fractional": "7/2", "american": "350", "winning": false, "suspended": false, "stopped": false, "total": null, "handicap": null, "participants": "236575" }, { "id": 11300735, "fixture_id": 18530151, "external_id": 1263999623, "market_id": 2, "bookmaker_id": 2, "label": "X1", "value": "1.17", "name": "Boca Juniors Reserves or Draw", "sort_order": 0, "market_description": "Double Chance", "probability": "85.47%", "dp3": "1.17", "fractional": "1/6", "american": "-589", "winning": false, "suspended": false, "stopped": false, "total": null, "handicap": null, "participants": "236557" }, Query Parameters Static Filters Dynamic Filters Query Parameters Required? Description `api_token` YES Your unique API token `include` NO Enrich the API with more data by using includes `select` NO Select specific fields on the base entity `filters` NO 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. **Static filters** are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our Filters page. Static Filters Available on Entity Description Example `Markets` Odds Filter the odds on a selection of markets separated by a comma. &filters=markets:marketIDs &filters=markets:12,14 `Bookmakers` Odds Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14). &filters=bookmakers:bookmakerIDs &filters=bookmakers:2,14 `WinningOdds` Odds Filter all winning odds. &filters=winningOdds Not applicable for this endpoint. #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id#pagination) Pagination YES #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id#include-depth) Include depth You can use a total of `1` nested includes on this endpoint #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id#include-options) Include options [`fixture`](https://docs.sportmonks.com/v3/) [`market`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market) [`bookmaker`](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id#related-entities) Related entities [InplayOdd](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/inplayodd) #### [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id#code-example) Code Example Ruby Python PHP Java Node.js Go Copy require "uri" require "net/http" url = URI("https://api.sportmonks.com/v3/odds/inplay/fixtures/{ID}?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 Copy import http.client conn = http.client.HTTPSConnection("api.sportmonks.com") payload = '' headers = {} conn.request("GET", "/v3/odds/inplay/fixtures/{ID}?api_token={your_token}", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) [PreviousGET All Oddschevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-all-odds) [NextGET Odds by Fixture ID and Bookmaker IDchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/inplay-odds/get-odds-by-fixture-id-and-bookmaker-id) Last updated 3 years ago Copy 'https://api.sportmonks.com/v3/odds/inplay/fixtures/{ID}?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 Copy OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("https://api.sportmonks.com/v3/odds/inplay/fixtures/{ID}?api_token={your_token}") .method("GET", null) .build(); Response response = client.newCall(request).execute(); Copy var unirest = require('unirest'); var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/inplay/fixtures/{ID}?api_token={your_token}') .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); Copy package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.sportmonks.com/v3/odds/inplay/fixtures/{ID}?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)) } --- # GET Bookmakers by Fixture ID | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/odds/bookmakers/fixtures/{ID} Copy "data": [\ {\ "id": 1,\ "name": "10Bet",\ "logo": null\ },\ {\ "id": 2,\ "name": "bet365",\ "logo": null\ },\ {\ "id": 3,\ "name": "188Bet",\ "logo": null\ },\ {\ "id": 5,\ "name": "5 Dimes",\ "logo": null\ },\ {\ "id": 7,\ "name": "888Sport",\ "logo": null\ },\ {\ "id": 11,\ "name": "Bet-At-Home",\ "logo": null\ },\ {\ "id": 13,\ "name": "BetCRIS",\ "logo": null\ },\ {\ "id": 15,\ "name": "Betfair",\ "logo": null\ },\ {\ "id": 21,\ "name": "BetVictor",\ "logo": null\ },\ {\ "id": 23,\ "name": "Coral",\ "logo": null\ },\ {\ "id": 25,\ "name": "Dafabet",\ "logo": null\ },\ {\ "id": 27,\ "name": "Intertops",\ "logo": null\ },\ {\ "id": 36,\ "name": "Marathonbet",\ "logo": null\ },\ {\ "id": 44,\ "name": "Matchbook",\ "logo": null\ },\ {\ "id": 70,\ "name": "Pncl",\ "logo": null\ },\ {\ "id": 88,\ "name": "Tipico",\ "logo": null\ },\ {\ "id": 97,\ "name": "Unibet",\ "logo": null\ },\ {\ "id": 114,\ "name": "Betsson",\ "logo": null\ },\ {\ "id": 150,\ "name": "bwin",\ "logo": null\ },\ {\ "id": 187,\ "name": "WilliamHill",\ "logo": null\ },\ \ Field\ \ Description\ \ Type\ \ `id`\ \ Refers to the unique id of the bookmaker\ \ integer\ \ `name`\ \ Refers to the name of the bookmaker\ \ string\ \ `image_path`\ \ Image path to the bookmaker logo\ \ string\ \ Query Parameters\ \ Static Filters\ \ Dynamic Filters\ \ Query Parameters\ \ Required?\ \ Description\ \ `api_token`\ \ YES\ \ Your unique API token\ \ `include`\ \ NO\ \ Enrich the API with more data by using includes\ \ `select`\ \ NO\ \ Select specific fields on the base entity\ \ `filters`\ \ NO\ \ 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.\ \ Not applicable for this endpoint.\ \ Not applicable for this endpoint.\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmakers-by-fixture-id#pagination)\ \ Pagination\ \ YES\ \ ### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmakers-by-fixture-id#paramaters)\ \ Paramaters\ \ Parameter\ \ Required\ \ Description\ \ Example\ \ `order`\ \ No\ \ Returns bookmakers ordered by **id** (`asc` or `desc`). Defaults to asc\ \ _&order=desc_\ \ `per_page`\ \ No\ \ The amount of results to return per page (max 50.). Defaults to 25.\ \ _&per\_page=30_\ \ `page`\ \ No\ \ You can paginate using the `has_more` parameter to determine if you can still propagate through the results.\ \ _&page=2_\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmakers-by-fixture-id#include-depth)\ \ Include depth\ \ You can use a total of `0` nested includes on this endpoint\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmakers-by-fixture-id#include-options)\ \ Include options\ \ `none`\ \ **Related Entities:**\ \ Get an overview and explanation of all the fields returned in the API response. The related entities for the bookmakers endpoints are:\ \ * [Bookmaker](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker)\ \ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmakers-by-fixture-id#code-example)\ \ Code Example\ \ Ruby\ \ Python\ \ PHP\ \ Java\ \ Node.js\ \ Go\ \ [PreviousGET Bookmakers Search by Namechevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmakers-search-by-name)\ [NextGET Bookmaker Event ID's by Fixture Idchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmaker-event-ids-by-fixture-id)\ \ Last updated 2 years ago\ \ Copy\ \ require "uri"\ require "net/http"\ \ url = URI("https://api.sportmonks.com/v3/football/livescores/inplay?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\ \ \ Copy\ \ import http.client\ \ conn = http.client.HTTPSConnection("api.sportmonks.com")\ payload = ''\ headers = {}\ conn.request("GET", "/v3/odds/bookmakers/fixtures/{ID}?api_token={your_token}", payload, headers)\ res = conn.getresponse()\ data = res.read()\ print(data.decode("utf-8"))\ \ Copy\ \ 'https://api.sportmonks.com/v3/odds/bookmakers/fixtures/{ID}?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\ \ Copy\ \ OkHttpClient client = new OkHttpClient().newBuilder()\ .build();\ Request request = new Request.Builder()\ .url("https://api.sportmonks.com/v3/odds/bookmakers/fixtures/{ID}?api_token={your_token}")\ .method("GET", null)\ .build();\ Response response = client.newCall(request).execute();\ \ Copy\ \ var unirest = require('unirest');\ var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/bookmakers/fixtures/{ID}?api_token={your_token}')\ .end(function (res) { \ if (res.error) throw new Error(res.error); \ console.log(res.raw_body);\ });\ \ Copy\ \ package main\ \ import (\ "fmt"\ "net/http"\ "io/ioutil"\ )\ \ func main() {\ \ url := "https://api.sportmonks.com/v3/odds/bookmakers/fixtures/{ID}?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))\ } --- # Authentication | Motorsport 3.0 (beta) | API 3.0 To make our first request, we’ll need to get authenticated first. We offer two different options for passing your API token. You are free to choose between the authentication methods. You can also use both of them at the same time. Please note that both methods count towards the same rate-limiting. * **Authenticate using a query parameter** You can pass your API token by passing 'api\_token' in your request parameters, like so: https://api3.sportmonks.com/api/v3/motorsport/livescores?api\_token_\=your\_token\_here_ * **Authenticate using a request header** You can also pass your token via an 'Authorization' header, like so: Header Value Authorization _your\_token\_here_ You can obtain and manage your API token in [**Mysportmonks.**arrow-up-right](https://my.sportmonks.com/) The API token is only meant for your eyes and, as such, should be stored away safely. Our tokens have no expiration date and will remain valid until you manually delete them yourself. When making a request, a code response will always be returned. The following are all possible HTTP response codes for any request made to the API: Code Description **200: OK** Request succeeded **400: Bad Request** It seems that some part of the request is malformed. The exact reason is returned in the response. **401: Unauthorized** The request is not authenticated. **403: Forbidden** Not authorized. Indicates you're attempting to access a feed that is not accessible from your plan. **429: Too Many Requests** Too many requests. In order to make the API as responsive as possible, you have an hourly request limit. The limit for your current subscription can be found in any successful response. Check the "meta" section to find out your limit. **500: Internal Server Error** An internal error has occurred and has been logged for further inspection. Please email support if you are receiving this error. Last updated 1 month ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # GET All Bookmakers | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/odds/bookmakers Copy "data": [\ {\ "id": 1,\ "name": "10Bet",\ "logo": null\ },\ {\ "id": 2,\ "name": "bet365",\ "logo": null\ },\ {\ "id": 3,\ "name": "188Bet",\ "logo": null\ },\ {\ "id": 5,\ "name": "5 Dimes",\ "logo": null\ },\ {\ "id": 7,\ "name": "888Sport",\ "logo": null\ },\ {\ "id": 9,\ "name": "BetFred",\ "logo": null\ },\ {\ "id": 11,\ "name": "Bet-At-Home",\ "logo": null\ },\ {\ "id": 13,\ "name": "BetCRIS",\ "logo": null\ },\ {\ "id": 15,\ "name": "Betfair",\ "logo": null\ },\ {\ "id": 17,\ "name": "BetOnline",\ "logo": null\ },\ {\ "id": 19,\ "name": "BetRedKings",\ "logo": null\ },\ {\ "id": 21,\ "name": "BetVictor",\ "logo": null\ },\ {\ "id": 23,\ "name": "Coral",\ "logo": null\ },\ {\ "id": 25,\ "name": "Dafabet",\ "logo": null\ },\ {\ "id": 27,\ "name": "Intertops",\ "logo": null\ },\ {\ "id": 36,\ "name": "Marathonbet",\ "logo": null\ },\ {\ "id": 44,\ "name": "Matchbook",\ "logo": null\ },\ {\ "id": 53,\ "name": "MyBet",\ "logo": null\ },\ {\ "id": 62,\ "name": "Paddy Power",\ "logo": null\ },\ {\ "id": 70,\ "name": "Pncl",\ "logo": null\ },\ \ Field\ \ Description\ \ Type\ \ `id`\ \ Refers to the unique id of the bookmaker\ \ integer\ \ `name`\ \ Refers to the name of the bookmaker\ \ string\ \ `image_path`\ \ Image path to the bookmaker logo\ \ string\ \ Query Parameters\ \ Static Filters\ \ Dynamic Filters\ \ Query Parameters\ \ Required?\ \ Description\ \ `api_token`\ \ YES\ \ Your unique API token\ \ `include`\ \ NO\ \ Enrich the API with more data by using includes\ \ `select`\ \ NO\ \ Select specific fields on the base entity\ \ `filters`\ \ NO\ \ 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.\ \ **Static filters** are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our Filters page.\ \ Static Filters\ \ Available on Entity\ \ Description\ \ Example\ \ `IdAfter`\ \ All\ \ Filter all bookmakers starting from a certain bookmaker ID. Handy if you're doing an import for all bookmakers and want to continue from a certain ID.\ \ &filters=IdAfter:bookmakerID\ \ Not applicable for this endpoint.\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-all-bookmakers#pagination)\ \ Pagination\ \ YES\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-all-bookmakers#include-depth)\ \ Include depth\ \ You can use a total of `0` nested includes on this endpoint\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-all-bookmakers#include-options)\ \ Include options\ \ `none`\ \ **Related Entities:**\ \ Get an overview and explanation of all the fields returned in the API response. The related entities for the bookmakers endpoints are:\ \ * [Bookmaker](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/bookmaker)\ \ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-all-bookmakers#code-example)\ \ Code Example\ \ Ruby\ \ Python\ \ PHP\ \ Java\ \ Node.js\ \ Go\ \ Copy\ \ require "uri"\ require "net/http"\ \ url = URI("https://api.sportmonks.com/v3/football/bookmakers?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\ \ \ Copy\ \ import http.client\ \ conn = http.client.HTTPSConnection("api.sportmonks.com")\ payload = ''\ headers = {}\ conn.request("GET", "/v3/football/bookmakers?api_token={your_token}", payload, headers)\ res = conn.getresponse()\ data = res.read()\ print(data.decode("utf-8"))\ \ [PreviousBookmakerschevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers)\ [NextGET Bookmaker by IDchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/bookmakers/get-bookmaker-by-id)\ \ Last updated 3 years ago\ \ Copy\ \ 'https://api.sportmonks.com/v3/football/bookmakers?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\ \ Copy\ \ OkHttpClient client = new OkHttpClient().newBuilder()\ .build();\ Request request = new Request.Builder()\ .url("https://api.sportmonks.com/v3/football/bookmakers?api_token={your_token}")\ .method("GET", null)\ .build();\ Response response = client.newCall(request).execute();\ \ Copy\ \ var unirest = require('unirest');\ var req = unirest('GET', 'https://api.sportmonks.com/football/bookmakers?api_token={your_token}')\ .end(function (res) { \ if (res.error) throw new Error(res.error); \ console.log(res.raw_body);\ });\ \ Copy\ \ package main\ \ import (\ "fmt"\ "net/http"\ "io/ioutil"\ )\ \ func main() {\ \ url := "https://api.sportmonks.com/v3/football/bookmakers?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))\ } --- # Response Codes | Motorsport 3.0 (beta) | API 3.0 Whenever you receive an unexpected response, or are experiencing unexpected behaviour, you should check the request's HTTP response code and reference it with the table below. The following are all possible HTTP response codes for any request made to the API: Code Description **200: OK** Request succeeded **400: Bad Request** It seems that some part of the request is malformed. The exact reason is returned in the response. **401: Unauthorized** The request is not authenticated. **403: Forbidden** Not authorized. Indicates you're attempting to access a feed that is not accessible from your plan. **429: Too Many Requests** Too many requests. In order to make the API as responsive as possible, you have an hourly request limit. The limit for your current subscription can be found in any successful response. Check the "meta" section to find out your limit. **500: Internal Server Error** An internal error has occurred and has been logged for further inspection. Please email support if you are receiving this error. Last updated 1 month ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # GET All Markets | Odds API 3.0 | API 3.0 Base URL Example Response Field Description Copy https://api.sportmonks.com/v3/odds/markets Copy "data": [\ {\ "id": 1,\ "name": "3Way Result"\ },\ {\ "id": 10,\ "name": "Home/Away"\ },\ {\ "id": 12,\ "name": "Over/Under"\ },\ {\ "id": 28,\ "name": "Asian Handicap"\ },\ {\ "id": 29,\ "name": "Asian Handicap Cards"\ },\ {\ "id": 30,\ "name": "Asian Total Cards"\ },\ {\ "id": 31,\ "name": "First Card Received"\ },\ {\ "id": 32,\ "name": "Time Of First Card"\ },\ {\ "id": 33,\ "name": "Team Cards"\ },\ {\ "id": 34,\ "name": "Corner Match Bet"\ },\ {\ "id": 35,\ "name": "Corner Handicap"\ },\ {\ "id": 36,\ "name": "Time Of First Corner"\ },\ {\ "id": 37,\ "name": "3Way Result 1st Half"\ },\ {\ "id": 38,\ "name": "Goals Over/Under 2nd Half"\ },\ {\ "id": 39,\ "name": "Team Corners"\ },\ {\ "id": 47,\ "name": "Over/Under 2nd Half"\ },\ {\ "id": 63,\ "name": "Double Chance"\ },\ {\ "id": 69,\ "name": "Team To Score First"\ },\ {\ "id": 75,\ "name": "Team To Score Last"\ },\ {\ "id": 80,\ "name": "3Way Result 2nd Half"\ },\ {\ "id": 83,\ "name": "Handicap Result"\ },\ {\ "id": 13343,\ "name": "Team Clean Sheet"\ },\ {\ "id": 28075,\ "name": "Fulltime Result"\ },\ {\ "id": 28076,\ "name": "To Win 2nd Half"\ },\ \ Field\ \ Description\ \ Type\ \ `id`\ \ Refers to the unique id of the bookmaker\ \ integer\ \ `name`\ \ Refers to the name of the market\ \ string\ \ Query Parameters\ \ Static Filters\ \ Dynamic Filters\ \ Query Parameters\ \ Required?\ \ Description\ \ `api_token`\ \ YES\ \ Your unique API token\ \ `include`\ \ NO\ \ Enrich the API with more data by using includes\ \ `select`\ \ NO\ \ Select specific fields on the base entity\ \ `filters`\ \ NO\ \ 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.\ \ **Static filters** are always the same and filter in one specific way without any custom options. Each static filter is listed below and has a description of how it filters. For more information, please look at our Filters page.\ \ Static Filters\ \ Available on Entity\ \ Description\ \ Example\ \ `IdAfter`\ \ All\ \ Filter all markets starting from a certain market ID. Handy if you're doing an import for all markets and want to continue from a certain ID.\ \ &filters=IdAfter:marketID\ \ Not applicable for this endpoint.\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-all-markets#pagination)\ \ Pagination\ \ YES\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-all-markets#include-depth)\ \ Include depth\ \ You can use a total of `0` nested includes on this endpoint\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-all-markets#include-options)\ \ Include options\ \ `none`\ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-all-markets#related-entities)\ \ **Related Entities:**\ \ Get an overview and explanation of all the fields returned in the API response. The related entities for the Markets endpoint are:\ \ * [Market](https://docs.sportmonks.com/v3/odds-api/getting-started/entities/market)\ \ \ #### \ \ [hashtag](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-all-markets#code-example)\ \ Code Example\ \ Ruby\ \ Python\ \ PHP\ \ Java\ \ Node.js\ \ Go\ \ Copy\ \ require "uri"\ require "net/http"\ \ url = URI("https://api.sportmonks.com/v3/odds/markets?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\ \ \ Copy\ \ import http.client\ \ conn = http.client.HTTPSConnection("api.sportmonks.com")\ payload = ''\ headers = {}\ conn.request("GET", "/v3/odds/markets?api_token={your_token}", payload, headers)\ res = conn.getresponse()\ data = res.read()\ print(data.decode("utf-8"))\ \ [PreviousMarketschevron-left](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets)\ [NextGET Market by IDchevron-right](https://docs.sportmonks.com/v3/odds-api/getting-started/endpoints/markets/get-market-by-id)\ \ Last updated 3 years ago\ \ Copy\ \ 'https://api.sportmonks.com/v3/odds/markets?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\ \ Copy\ \ OkHttpClient client = new OkHttpClient().newBuilder()\ .build();\ Request request = new Request.Builder()\ .url("https://api.sportmonks.com/v3/odds/markets?api_token={your_token}")\ .method("GET", null)\ .build();\ Response response = client.newCall(request).execute();\ \ Copy\ \ var unirest = require('unirest');\ var req = unirest('GET', 'https://api.sportmonks.com/v3/odds/markets?api_token={your_token}')\ .end(function (res) { \ if (res.error) throw new Error(res.error); \ console.log(res.raw_body);\ });\ \ Copy\ \ package main\ \ import (\ "fmt"\ "net/http"\ "io/ioutil"\ )\ \ func main() {\ \ url := "https://api.sportmonks.com/v3/odds/markets?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))\ } --- # Quick Start Guide | API 3.0 Setting up your first API request doesn’t have to be difficult. Whether you’re a developer, analyst, or product owner, this **Quick Start Guide** will walk you through the entire process: from account setup to your first successful call. #### [hashtag](https://docs.sportmonks.com/v3/welcome/quick-start-guide#whats-inside-the-guide) 📄 What’s Inside the Guide? * ✅ How to create and verify your MySportmonks account * 🔐 How to generate and secure your API token * 🔧 How to structure your first API request * 📚 How to explore the documentation effectively * 💡 Tips for choosing the right subscription plan file-pdf 44MB [Quick Start Guide MySportmonks.pdf](https://3469464275-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9zsNGu3HAzSnl5DWBD3Y%2Fuploads%2FlsMo42BPvdu56TEvehAN%2FMySportmonks%20essentials.pdf?alt=media&token=fe29d03d-58e5-40ec-8428-995715c0988f) PDF downloadDownload[arrow-up-right-from-squareOpen](https://3469464275-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9zsNGu3HAzSnl5DWBD3Y%2Fuploads%2FlsMo42BPvdu56TEvehAN%2FMySportmonks%20essentials.pdf?alt=media&token=fe29d03d-58e5-40ec-8428-995715c0988f) The PDF is a short, visual, step-by-step guide designed to get you up and running in under **6 minutes**. [PreviousGetting Startedchevron-left](https://docs.sportmonks.com/v3/welcome/getting-started) [NextMost important docs pageschevron-right](https://docs.sportmonks.com/v3/welcome/most-important-docs-pages) Last updated 2 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Guides | Motorsport 3.0 (beta) | API 3.0 [Migrating from Formula One API (v1) to Motorsport API v3chevron-right](https://docs.sportmonks.com/v3/motorsport-api/tutorials-and-guides/guides/migrating-from-formula-one-api-v1-to-motorsport-api-v3) [Understanding Race Results, Driver, Team and Track Data in v3chevron-right](https://docs.sportmonks.com/v3/motorsport-api/tutorials-and-guides/guides/understanding-race-results-driver-team-and-track-data-in-v3) Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Tutorials | Motorsport 3.0 (beta) | API 3.0 [Retrieving resultschevron-right](https://docs.sportmonks.com/v3/motorsport-api/tutorials-and-guides/tutorials/retrieving-results) Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Endpoints | Motorsport 3.0 (beta) | API 3.0 [🔴Livechevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/live) [🏁Fixtureschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/fixtures) [🏎️Driverschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/drivers) [🧑‍🤝‍🧑Teamschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/teams) [🛣️Venueschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/venues) [🔂Lapschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/laps) [🛞Pitstopschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/pitstops) [↔️Stintschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/stints) [🥇Race Resultschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/race-results) [🔢Standingschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/standings) [🏆Leagueschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/leagues) [📅Seasonschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/seasons) [🗓️Scheduleschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/schedules) [📆Stageschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/stages) [🟢Stateschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/states) Last updated 2 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Metadata & Per-Season Data Type Reference | Motorsport 3.0 (beta) | API 3.0 ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/welcome/metadata-and-per-season-data-type-reference#fixture) Fixture Include: `metadata` ID Name Developer Name/Code Value Type Description 9737 Is Qualification IS\_QUALIFICATION / is-qualification boolean Indicates if the session is 1/3rd of a (Sprint) Qualification session 9734 Sprint Race SPRINT\_RACE / sprint-race boolean Indicates if the session is a Sprint Race and the Sprint Points system is applied 164 Has Standings HAS\_STANDING / has-standings boolean Indicates if the session has points which are calculated in the standings 172 Split Points Rule SPLIT\_POINTS\_RULE / split-points-rule boolean Indicates if the session has the half points rule applied 9736 Current Lap CURRENT\_LAP / current-lap object (lap) Contains the current lap number 105427 Total Laps TOTAL\_LAPS / total-laps object (laps) Contains the total number of laps 9716 Fastest Lap FASTEST\_LAP / fastest-lap object (time, lap\_number) Contains information about the fastest lap in the entire session 114509 Race Distance RACE\_DISTANCE / race-distance object (distance) Contains the race distance (formatted in kilometers, suffixed with km) 110619 Legacy ID LEGACY\_ID / legacy-id object (legacy\_id) Contains the v1 stage ID ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/welcome/metadata-and-per-season-data-type-reference#venue) Venue Include: `metadata` ID Name Developer Name/Code Value Type Description 109729 Track Length TRACK\_LENGTH / track-length object (length) Contains the track length (formatted in kilometers, with 3 decimal precision, suffixed with km) 109730 Track Direction TRACK\_DIRECTION / track-direction object (direction) Contains the track direction (clockwise, anti-clockwise, 50/50) 109731 Track Type TRACK\_TYPE / track-type object (type) Contains the track type (race-circuit, street-circuit) 113403 Grand Prix Name GRAND\_PRIX\_NAME / grand-prix-name object (name) Contains the Grand Prix name related to the track 110619 Legacy ID LEGACY\_ID / legacy-id object (legacy\_id) Contains the v1 track ID ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/welcome/metadata-and-per-season-data-type-reference#team) Team Include: `seasonDetails` ID Name Developer Name/Code Value Type Description 109854 Engine ENGINE / engine object (engine) Contains the engine name of the team car 109855 Chassis CHASSIS / chassis object (chassis) Contains the chassis name of the team car 109856 Team Color TEAM\_COLOR / team-color object (color\_code) Contains the team color in hexadecimal 109857 Team Lead TEAM\_LEAD / team-lead object (team\_lead) Contains the name of the team lead 109858 Technical Lead TECHNICAL\_LEAD / technical-lead object (technical\_lead) Contains the name of the team technical lead 109861 Team Name TEAM\_NAME / team-name object (name) Contains the name the team is/was known as during this season 109862 Team Image TEAM\_IMAGE / team-image object (image\_path) Contains the URL of the logo the team used during this season 110619 Legacy ID LEGACY\_ID / legacy-id object (legacy\_id) Contains the v1 team ID ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/welcome/metadata-and-per-season-data-type-reference#driver) Driver Include: `metadata` ID Name Developer Name/Code Value Type Description 109851 Debut Season DEBUT\_SEASON / debut-season object (season) Contains the debut season (year) of the driver 109852 Debut Track DEBUT\_TRACK / debut-track object (track) Contains the track name the driver debuted at 109853 Debut Result DEBUT\_RESULT / debut-result object (result) Contains the result position (e.g. P14) or status (e.g. DNF) of the drivers debut 109984 Short Name SHORT\_NAME / short-name object (short\_name) Contains three-letter short name of the driver 110619 Legacy ID LEGACY\_ID / legacy-id object (legacy\_id) Contains the v1 driver ID (Other IDs used in different seasons are available via the `seasonDetails` include) Last updated 6 days ago Was this helpful? * [Fixture](https://docs.sportmonks.com/v3/motorsport-api/welcome/metadata-and-per-season-data-type-reference#fixture) * [Venue](https://docs.sportmonks.com/v3/motorsport-api/welcome/metadata-and-per-season-data-type-reference#venue) * [Team](https://docs.sportmonks.com/v3/motorsport-api/welcome/metadata-and-per-season-data-type-reference#team) * [Driver](https://docs.sportmonks.com/v3/motorsport-api/welcome/metadata-and-per-season-data-type-reference#driver) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Differences between API 2 and API 3 | API 3.0 [hashtag](https://docs.sportmonks.com/v3/welcome/differences-between-api-2-and-api-3#introduction) Introduction -------------------------------------------------------------------------------------------------------------------- We've made various changes to our new API. These changes result in some groundbreaking differences between API 2 and API 3. This section of the documentation is here to help you understand how to adopt all the latest changes, improve the quality of your applications and streamline your development experience. Here's a quick overview of some differences between API 2 and API 3.0: * API changes * States and types * Strict typing * Include changes * Rate limit per entity * Syntax, extensive filtering and select options * New data features and endpoints circle-info Checking the differences between two API versions can help you identify changes that may affect your code and make any necessary adjustments. Please don't hesitate to contact us with any questions or concerns. To better serve our growing customer base and meet the demand for more sports-related services, we have introduced a new API: Sportmonks V3. This updated configuration is designed to deliver improved reliability, broader coverage, and a variety of new data features and endpoints that were simply not possible with API V2. You can find these enhancements [here](https://docs.sportmonks.com/v3/welcome/differences-between-api-2-and-api-3/new-endpoints-and-data-features) . To maintain the highest possible data quality, the validation for V3 is stricter. Additionally, the entire structure of V3 is different compared to V2. As a result, data discrepancies may arise between V2 and V3. We strongly recommend using the newest version of our Football API (V3) to benefit from improved data quality. The data quality of V3 is way more reliable and accurate due to its new structure and the validation methods we use. Furthermore, future innovations will only be available on API 3.0, so we recommend switching as soon as possible. [PreviousWhat can you do with Sportmonks' data?chevron-left](https://docs.sportmonks.com/v3/welcome/what-can-you-do-with-sportmonks-data) [NextAPI Changeschevron-right](https://docs.sportmonks.com/v3/welcome/differences-between-api-2-and-api-3/api-changes) Last updated 11 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Status / State | Motorsport 3.0 (beta) | API 3.0 v1 name v3 ID v3 name v3 developer name When Not Started 1 Not Started NS Before session Live 27 Live LIVE During session Finished 5 Full Time FULL\_TIME After Chequered Flag / Session ended Delayed 16 Delayed DELAYED Session start delayed Interrupted 18 Interrupted INTERRUPTED Red Flag Cancelled 12 Cancelled CANCELLED Session cancelled (Stage removed from API) 20 Deleted DELETED Fixture marked as deleted Last updated 1 month ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Teams | Motorsport 3.0 (beta) | API 3.0 circle-info Prefer mapping the IDs programmatically? You can use the following URL: `https://api.sportmonks.com/v3/motorsport/teams?api_token=YOUR_TOKEN&include=seasonDetails&filter=participantSeasonDetailTypes:110619;participantSeasonDetailSeasons:26733` Name v1 ID v3 ID Ferrari 11 276189 Mercedes 13 276198 McLaren 14 276191 Red Bull 15 276190 Alpine 16 276196 Racing Bulls 17 276197 Haas 18 276195 Audi 19 276193 Aston Martin 20 276194 Williams 57 276192 Cadillac 58 279498 Last updated 28 days ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Seasons | Motorsport 3.0 (beta) | API 3.0 Season v1 ID v3 ID v3 Pre-season testing ID (NEW) 2021 6 Added soon Added soon 2022 7 Added soon Added soon 2023 8 Added soon Added soon 2024 9 Added soon Added soon 2025 10 25273 26743 2026 11 26733 26736 Last updated 1 month ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Code libraries | API 3.0 ### [hashtag](https://docs.sportmonks.com/v3/api/code-libraries#community-libraries) Community libraries To help developers integrate the Sportmonks Football API more efficiently, the community has contributed various SDKs and packages across different programming languages. Below is a collection of available resources: #### [hashtag](https://docs.sportmonks.com/v3/api/code-libraries#laravel) Laravel * **sportmonks-fpicosm** ([GitHub Repositoryarrow-up-right](https://github.com/fpicosm/sportmonks) ) A Laravel package for interacting with the Sportmonks Football API, making it easier to fetch and process football data. ### [hashtag](https://docs.sportmonks.com/v3/api/code-libraries#contribute-your-own-library) Contribute your own library We encourage developers to build and share their own libraries, SDKs, and integrations for the Sportmonks Football API. If you've created a package in any programming language, feel free to submit it for inclusion in this list. To contribute: 1. Publish your package on GitHub or a relevant package registry (e.g., PyPI, npm, Maven). 2. Share the repository link with us by [contacting our support teamarrow-up-right](https://www.sportmonks.com/contact-support/) . 3. Ensure that your library is well-documented and adheres to best practices for API integration. By contributing, you help expand the ecosystem and make it easier for other developers to integrate football data into their projects! [PreviousOther Exceptionschevron-left](https://docs.sportmonks.com/v3/api/error-codes/other-exceptions) [NextTranslations (beta)chevron-right](https://docs.sportmonks.com/v3/api/translations-beta) Last updated 11 months ago Was this helpful? * [Community libraries](https://docs.sportmonks.com/v3/api/code-libraries#community-libraries) * [Contribute your own library](https://docs.sportmonks.com/v3/api/code-libraries#contribute-your-own-library) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Request options | API 3.0 This chapter shows you how to fine-tune your API calls using **includes**, **selecting fields**, using **filtering**, and **ordering / sorting**. Mastering request options helps you fetch exactly what you need and omit what you don’t for faster, leaner, more efficient responses. [Includeschevron-right](https://docs.sportmonks.com/v3/api/request-options/includes) [Selecting fieldschevron-right](https://docs.sportmonks.com/v3/tutorials-and-guides/tutorials/filter-and-select-fields/selecting-fields) [Filteringchevron-right](https://docs.sportmonks.com/v3/api/request-options/filtering) [Selecting and filteringchevron-right](https://docs.sportmonks.com/v3/api/request-options/selecting-and-filtering) [Ordering and sortingchevron-right](https://docs.sportmonks.com/v3/api/request-options/ordering-and-sorting) [PreviousSyntaxchevron-left](https://docs.sportmonks.com/v3/api/syntax) [NextIncludeschevron-right](https://docs.sportmonks.com/v3/api/request-options/includes) Last updated 2 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Getting Started | API 3.0 We'll briefly inform you about the features of our API, and then you can explore our documentation for yourself. You will also find out how to create **your** dream application. Sportmonks offers standard REST APIs. Requests are sent with URLs and responses will be returned in **JSON format**. Every authentication is spearheaded by an API token. We have assembled a library of all of our endpoints including example requests in **Postman**. circle-info 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 [![Run in Postman](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2Frun.pstmn.io%2Fbutton.svg&width=300&dpr=3&quality=100&sign=5f4dbf4c&sv=2)arrow-up-right](https://app.getpostman.com/run-collection/11949411-c7a3a0a0-b5c5-4109-9bf6-f430fec65316?action=collection%2Ffork&collection-url=entityId%3D11949411-c7a3a0a0-b5c5-4109-9bf6-f430fec65316%26entityType%3Dcollection%26workspaceId%3D17c720d0-d97b-42a9-9ea7-23260ed53ddf) Short introduction to Sportmonks: Now you know who we are, what we do, what we offer, and how we can help you: We suppose you want to get started right away. Head over to our [Getting Started section](https://docs.sportmonks.com/v3/welcome/making-your-first-request) , where you'll create your own API token and create your first request What else do we cover in the documentation? * [Getting started](https://docs.sportmonks.com/v3) * [API section](https://docs.sportmonks.com/v3/api/syntax) * [Endpoint overview](https://docs.sportmonks.com/v3/endpoints-and-entities/endpoints) * [Entities explained](https://docs.sportmonks.com/v3/endpoints-and-entities/entities) * [Tutorials](https://docs.sportmonks.com/v3/tutorials-and-guides/tutorials) * [How-to guides](https://docs.sportmonks.com/v3/tutorials-and-guides/guides) * [Definitions](https://docs.sportmonks.com/v3/definitions/response-codes) **API Structure** ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3469464275-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F9zsNGu3HAzSnl5DWBD3Y%252Fuploads%252FbZNf8RKajQMhw7nGHMaA%252FAPI%2520Structure.png%3Falt%3Dmedia%26token%3D19010526-bbe7-475c-b2b8-c96c31c07301&width=768&dpr=3&quality=100&sign=5dc16b7e&sv=2) We constantly seek to improve and expand our documentation. If you think something is missing, have an idea for a great tutorial or how-to guide, or have any other questions, don't hesitate to contact us! We value your input. Contact us at [\[email protected\]](https://docs.sportmonks.com/cdn-cgi/l/email-protection) . [PreviousWelcomechevron-left](https://docs.sportmonks.com/v3) [NextQuick Start Guidechevron-right](https://docs.sportmonks.com/v3/welcome/quick-start-guide) Last updated 8 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Most important docs pages | API 3.0 #### [hashtag](https://docs.sportmonks.com/v3/welcome/most-important-docs-pages#introduction-tutorial) 🧭 Introduction tutorial **Kickstart your Sportmonks experience.** New to our API? Start here. Learn how authentication works, how endpoints are structured, and how to make your first successful request. Step-by-step guidance helps you move from your first call to confident querying. > 🎯 _Perfect for developers integrating Sportmonks for the first time._ [Go to Introduction Tutorial →arrow-up-right](https://docs.sportmonks.com/football/tutorials-and-guides/tutorials/introduction) #### [hashtag](https://docs.sportmonks.com/v3/welcome/most-important-docs-pages#request-options) 🔧 Request Options **Shape your data, your way.** Master the art of efficient requests. Learn how to filter, sort, paginate, and include related data without unnecessary overhead. Build smaller, faster, and more precise responses. > ⚙️ _Essential for performance-focused applications._ [Explore Request Options →arrow-up-right](https://docs.sportmonks.com/football/api/request-options) #### [hashtag](https://docs.sportmonks.com/v3/welcome/most-important-docs-pages#demo-response-files) 📁 Demo Response Files **See it before you build it.** Preview actual JSON responses for fixtures, teams, players, and standings. These files are ideal for planning data models, front-end components, or testing integrations before going live. > 🧩 _Useful for developers designing data structures and prototypes._ [View Demo Files →envelope](https://docs.sportmonks.com/cdn-cgi/l/email-protection#c1b4afa5a4a7a8afa4a5) #### [hashtag](https://docs.sportmonks.com/v3/welcome/most-important-docs-pages#best-practices) ✅ Best Practices **Build smarter and scale confidently.** Avoid common pitfalls with expert guidance on topics like caching, rate-limiting, timezone handling, and database synchronisation. These principles ensure your integration remains stable and efficient as you grow. > 🛠 _Highly recommended for production setups._ [Read Best Practices →arrow-up-right](https://docs.sportmonks.com/football/welcome/best-practices) #### [hashtag](https://docs.sportmonks.com/v3/welcome/most-important-docs-pages#guides-collection-incl.-components-guide) 📚 Guides Collection (incl. Components Guide) **Go beyond the basics.** Explore structured tutorials packed with real examples. Learn how to build modular and reusable data structures with the Components system, and how to combine endpoints effectively. > 📘 _For developers expanding from simple requests to advanced builds._ [Browse Guides →arrow-up-right](https://docs.sportmonks.com/football/tutorials-and-guides/guides/how-to-use-components) #### [hashtag](https://docs.sportmonks.com/v3/welcome/most-important-docs-pages#states) 🔄 States **Track every match’s lifecycle.** Understand how fixture states define the timeline of a match — scheduled, live, halftime, finished, or cancelled. Use them to power live dashboards and notifications with real-time accuracy. > ⏱ _Key for live-score and timeline applications._ [Learn about States →arrow-up-right](https://docs.sportmonks.com/football/definitions/states) #### [hashtag](https://docs.sportmonks.com/v3/welcome/most-important-docs-pages#events) ⚡ Events **Follow every key moment.** Events capture the action: goals, cards, substitutions, and more. Learn how to include and interpret them to build detailed match feeds, commentary systems, and visual timelines. > 🎯 _Ideal for match trackers and live commentary widgets._ [Read Events Docs →envelope](https://docs.sportmonks.com/cdn-cgi/l/email-protection#add8c3c9c8cbc4c3c8c9) #### [hashtag](https://docs.sportmonks.com/v3/welcome/most-important-docs-pages#statistics) 📊 Statistics **Turn data into insight.** Dive deep into performance metrics like shots, passes, possession, and expected goals. Use this data to fuel analytics dashboards, fantasy scoring, and predictive models. > 📈 _Perfect for analytics, scouting, and performance tools._ [Explore Statistics →arrow-up-right](https://docs.sportmonks.com/football/definitions/types/statistics) [PreviousQuick Start Guidechevron-left](https://docs.sportmonks.com/v3/welcome/quick-start-guide) [NextWhat can you do with Sportmonks' data?chevron-right](https://docs.sportmonks.com/v3/welcome/what-can-you-do-with-sportmonks-data) Last updated 4 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Other Exceptions | API 3.0 Whenever you make a request that is accepted and gives an error you can check the status code or name in the table below for more information. The description will show more details about how the error is created and what possible steps you can take to avoid these kind of errors. Status Name Description `5003` Pagination Limit The page you are requesting does not exist. Please change the &page= attribute to another value. `5005` Rate limit You have reached the rate limit of your plan. This resets every hour. If you still hit the rate limit you can always add more API calls on my.sportmonks.com. Check [Rate Limit](https://docs.sportmonks.com/v3/api/rate-limit) for more information. `5007` Insufficient Resources You do not have access to this resource in your current subscription. If you would like to add more resources please update your subscription or contact support. `5002` Insufficient Includes You do not have access to this include in your current subscription. If you would like to add more includes please update your subscription or contact support. [PreviousFiltering and Complexity Exceptionschevron-left](https://docs.sportmonks.com/v3/api/error-codes/filtering-and-complexity-exceptions) [NextCode librarieschevron-right](https://docs.sportmonks.com/v3/api/code-libraries) Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Results & Live Data Type Reference | Motorsport 3.0 (beta) | API 3.0 circle-info These types are all related to individual drivers. For the session-level lap counter and fastest lap types, please check the fixture metadata types in [Metadata & Per-Season Data Type Reference](https://docs.sportmonks.com/v3/motorsport-api/welcome/metadata-and-per-season-data-type-reference) ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/welcome/results-and-live-data-type-reference#result-lineup-detail-types) Result / lineup detail types Includes: `results` (basic types) / `lineups.details` (all types) ID Name Developer Name / Code Description (Practice, Qualification and Sprint Qualification sessions) Description (Races and Sprint Races) Available in results include Available in lineup details include Available from F1 season Available from season in F1 v1 (old API) 9707 Points POINTS / points N/A The points received by the driver No Yes All Not available 9708 Time TIME / time The fastest lap time The latest lap time Yes Yes All All 9709 Pitstops PITSTOPS / pitstops The number of pitstops made by the driver The number of pitstops made by the driver No Yes All All 9710 Laps LAPS / laps The number of laps finished by the driver The number of laps finished by the driver No Yes All All 9711 Position POSITION / position The position of the driver The position of the driver Yes Yes All All 9712 Grid Position GRID\_POSITION / grid-position N/A The grid position where the driver starts No Yes 2022 2022 9713 Status STATUS / status The driver status, like DNS and DNF The driver status, like DNS, DNF and DSQ No Yes All Only as boolean (retired) 9716 Fastest Lap FASTEST\_LAP / fastest-lap The fastest lap time and number The fastest lap time and number No Yes 2021 (limited), 2023 (full) 2021 (limited), 2023 (full) 9729 Tyre TYRE / tyre The tyre type and age The tyre type and age Yes Yes 2023 Not available (new in v3) 9732 Gap To Leader GAP\_TO\_LEADER / gap-to-leader The interval between the driver time and leader time The interval between the driver time and leader time Yes Yes All Not available (new in v3) 9733 Interval INTERVAL / interval The interval between the driver time and higher position driver time The interval between the driver time and time of driver in front Yes Yes All All 9738 In Pit IN\_PIT / in-pit If the driver is currently in the pit If the driver is currently in the pit No Yes 2025 Not available (new in v3) ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/welcome/results-and-live-data-type-reference#lap-details) Lap Details Include: `details` ID Name Developer Name / Code Description 9718 Lap Duration LAP\_DURATION / lap-duration The total lap time in seconds 9719 Lap Sector One LAP\_SECTOR\_ONE / lap-sector-one The first lap sector time in seconds 9720 Lap Sector Two LAP\_SECTOR\_TWO / lap-sector-two The second lap sector time in seconds 9721 Lap Sector Three LAP\_SECTOR\_THREE / lap-sector-three The third lap sector time in seconds 9722 Lap Timestamp LAP\_TIMESTAMP / lap-timestamp The unix timestamp of the lap start 9723 Lap Number LAP\_NUMBER / lap-number The lap number ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/welcome/results-and-live-data-type-reference#pitstop-details) Pitstop Details Include: `details` ID Name Developer Name / Code Description 9727 Pit Timestamp PIT\_TIMESTAMP / pit-timestamp The unix timestamp when the driver entered the pit lane 9728 Pit Duration PIT\_DURATION / pit-duration The time how long the driver was in the pit lane in seconds ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/welcome/results-and-live-data-type-reference#stint-details) Stint Details Include: `details` ID Name Developer Name / Code Description 9725 Stint Lap Info STINT\_LAP\_INFO / stint-lap-info The start and end lap numbers of the stint 9726 Stint Number STINT\_NUMBER / stint-number The stint number ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/welcome/results-and-live-data-type-reference#positions) Positions Include: `position` (on drivers) / `lineup.position` (on fixtures) ID Name Developer Name / Code Description 9730 First Driver FIRST\_DRIVER / first-driver The first driver within the team lineup 9731 Second Driver SECOND\_DRIVER / second-driver The second driver within the team lineup 61150 Test Driver TEST\_DRIVER / test-driver A test/reserve driver of the team Last updated 5 days ago Was this helpful? * [Result / lineup detail types](https://docs.sportmonks.com/v3/motorsport-api/welcome/results-and-live-data-type-reference#result-lineup-detail-types) * [Lap Details](https://docs.sportmonks.com/v3/motorsport-api/welcome/results-and-live-data-type-reference#lap-details) * [Pitstop Details](https://docs.sportmonks.com/v3/motorsport-api/welcome/results-and-live-data-type-reference#pitstop-details) * [Stint Details](https://docs.sportmonks.com/v3/motorsport-api/welcome/results-and-live-data-type-reference#stint-details) * [Positions](https://docs.sportmonks.com/v3/motorsport-api/welcome/results-and-live-data-type-reference#positions) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Include Exceptions | API 3.0 Whenever you make a request that is accepted and gives an error based on **includes** you can check the status code or name in the table below for more information. The description will show more details about how the error is created and what possible steps you can take to avoid these kind of errors. Status Name Description `5000` Include not allowed This include is not allowed on this entity, try removing the include from the request. Check the list of includes that are allowed for this [endpoint](https://docs.sportmonks.com/v3/endpoints-and-entities/endpoints) . `5001` Include not found This include is not available in the API, please remove the inlcude from the request. Check the docs for the requested entity to check all the available includes. `5008` Include depth You have reached the limit on [nested includes](https://docs.sportmonks.com/v3/tutorials-and-guides/tutorials/enrich-your-response/nested-includes) . Try removing the last nested include or try other endpoints to reduce the amount of nested includes. `5013` Include not available This include is not available on the requested entity. Check the docs for the requested entity to check all the available includes. [PreviousError codeschevron-left](https://docs.sportmonks.com/v3/api/error-codes) [NextFiltering and Complexity Exceptionschevron-right](https://docs.sportmonks.com/v3/api/error-codes/filtering-and-complexity-exceptions) Last updated 2 years ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Error codes | API 3.0 Whenever you receive an unexpected response, or are experiencing unexpected behaviour, you should check the request's HTTP response code and reference it with the table below. The following are all possible HTTP response codes for any request made to the API: Code Description `**200: OK**` Request succeeded `**400: Bad Request**` It seems that some part of the request is malformed. The exact reason is returned in the response. This error is also show when making requests with invalid filters. `**401: Unauthorized**` The request is not authenticated. `**403: Forbidden**` Not authorized. Indicates you're attempting to access a feed that is not accessible from your plan. `**429: Too Many Requests**` Too many requests. In order to make the API as responsive as possible, you have an hourly request limit. The limit for your current subscription can be found in any successful response. Check the "meta" section to find out your limit. `**500: Internal Server Error**` An internal error has occurred and has been logged for further inspection. Please email support if you are receiving this error. [PreviousMeta descriptionchevron-left](https://docs.sportmonks.com/v3/api/meta-description) [NextInclude Exceptionschevron-right](https://docs.sportmonks.com/v3/api/error-codes/include-exceptions) Last updated 11 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Rate limit | API 3.0 ### [hashtag](https://docs.sportmonks.com/v3/api/rate-limit#how-does-the-rate-limit-work) How does the rate limit work? Every default plan has 3000 API calls per entity per hour. For example: the teams entity is used in multiple [teams endpointsarrow-up-right](about:blank) . This means that all the requests made from the team endpoints count for the same entity: [teamsarrow-up-right](about:blank) . The rate starts counting after the first request has been made. The rate limit will reset back to your original amount when an hour has passed. When your API calls are depleted, until the hour is finished, you will not be able to request data from the entity for which you surpassed the rate limit\[1\] . You can however make requests to other entities that have not hit the rate-limit. For example: If you make the first of your requests at 18:18 UTC it will be reset at 19:18. circle-info Want to learn more about entities? Check our [entities section.](https://docs.sportmonks.com/v3/endpoints-and-entities/entities) ### [hashtag](https://docs.sportmonks.com/v3/api/rate-limit#what-happens-when-i-hit-the-rate-limit) What happens when I hit the rate limit? Once you’ve hit the rate limit, you will receive a 429 response. You can check all response codes on our [response codes pagearrow-up-right](about:blank) . If you reach the limit quite often, it might be interesting to upgrade the number of API calls via [my.sportmonksarrow-up-right](https://my.sportmonks.com/) . #### [hashtag](https://docs.sportmonks.com/v3/api/rate-limit#how-can-i-find-how-many-api-requests-i-have-left) How can I find how many API requests I have left? When you make a request, the API response includes a **rate\_limit** object in the response, this object has 3 properties: Property Meaning resets\_in\_seconds The amount of seconds remaining in before your rate limits resets for the given entity. remaining The amount of requests left in the current rate limit timeframe. requested\_entity The entity that the rate limit for your current request applies on. [PreviousOrdering and sortingchevron-left](https://docs.sportmonks.com/v3/api/request-options/ordering-and-sorting) [NextMeta descriptionchevron-right](https://docs.sportmonks.com/v3/api/meta-description) Last updated 3 years ago Was this helpful? * [How does the rate limit work?](https://docs.sportmonks.com/v3/api/rate-limit#how-does-the-rate-limit-work) * [What happens when I hit the rate limit?](https://docs.sportmonks.com/v3/api/rate-limit#what-happens-when-i-hit-the-rate-limit) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Data corrections | API 3.0 [hashtag](https://docs.sportmonks.com/v3/api/data-corrections#how-do-we-handle-data-corrections) How do we handle data corrections? ---------------------------------------------------------------------------------------------------------------------------------------- Our in-house data collection platform manages all of our data. Our dedicated scout teams from all over the world add, manage and validate the data collected by this platform. We collaborate with high-class data partners to ensure our football data is reliable and always up to date. However, since data is also human work, errors or inconsistencies may occur. To ensure the highest quality of football data, we have a mandatory process for promptly and effectively handling data corrections. ### [hashtag](https://docs.sportmonks.com/v3/api/data-corrections#data-verification-and-validation) Data verification and validation Before making any updates or corrections, we employ a rigorous verification and validation process. Our dedicated team of data experts reviews and cross-checks the information from our data scouts and professional data partners. Once a data correction is reported or identified, our data correction team immediately investigates the issue and takes the necessary steps to fix it. We have a system in place to identify the priority of the data error and fix it accordingly. ### [hashtag](https://docs.sportmonks.com/v3/api/data-corrections#continuous-improvement) Continuous improvement We are committed to continuous improvement and strive to enhance the accuracy and reliability of our data. To identify areas for improvement, we regularly review our internal processes, systems, and feedback mechanisms. By leveraging user feedback and utilising the latest technologies, we aim to provide the most comprehensive and error-free data in the sports field. _**We’re dedicated to maintaining the highest data quality and reliability standards.**_ ### [hashtag](https://docs.sportmonks.com/v3/api/data-corrections#error-reporting) Error Reporting We greatly value the feedback and contributions from our users in identifying any inaccuracies or errors in our data. We encourage you to notify us via [\[email protected\]](https://docs.sportmonks.com/cdn-cgi/l/email-protection) ### [hashtag](https://docs.sportmonks.com/v3/api/data-corrections#further-questions-and-legal-information) Further questions and legal information Please refer to our [Terms of Servicearrow-up-right](https://www.sportmonks.com/terms-of-service/) for additional details regarding usage, disclaimers, or other legal matters. If you have further questions, please consult this document for comprehensive information. [PreviousDemo response fileschevron-left](https://docs.sportmonks.com/v3/api/demo-response-files) [NextEndpointschevron-right](https://docs.sportmonks.com/v3/endpoints-and-entities/endpoints) Last updated 1 year ago Was this helpful? * [How do we handle data corrections?](https://docs.sportmonks.com/v3/api/data-corrections#how-do-we-handle-data-corrections) * [Data verification and validation](https://docs.sportmonks.com/v3/api/data-corrections#data-verification-and-validation) * [Continuous improvement](https://docs.sportmonks.com/v3/api/data-corrections#continuous-improvement) * [Error Reporting](https://docs.sportmonks.com/v3/api/data-corrections#error-reporting) * [Further questions and legal information](https://docs.sportmonks.com/v3/api/data-corrections#further-questions-and-legal-information) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Filtering | API 3.0 [hashtag](https://docs.sportmonks.com/v3/api/request-options/filtering#filter-your-request) Filter your request -------------------------------------------------------------------------------------------------------------------- ### [hashtag](https://docs.sportmonks.com/v3/api/request-options/filtering#filter-on-includes) Filter on includes Next to selecting specific fields on the base entity or includes, it’s possible to filter your request. Filters are improved in API 3 to give even more possibilities to get the data the way you need it. Each endpoint has two types of filters, static and dynamic filters. You can combine any dynamic filter with any static filter or use a multitude. **Static filters** are always the same and filter in one specific way without any custom options. The **dynamic filters** are based on entities and includes. Each dynamic filter uses an entity to filter on and one entity to apply the filter to. Below is an example with an explanation of how filters are set up. circle-info https://api.sportmonks.com/v3/football/fixtures?api\_token=YOUR\_TOKEN&include=statistics&filters=statisticTypes:42,49 ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3469464275-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F9zsNGu3HAzSnl5DWBD3Y%252Fuploads%252FRuVSLwxBRoff4O7Pbb2S%252FFiltering.png%3Falt%3Dmedia%26token%3D1db20a7b-d532-4972-9cbb-91b78a969fb6&width=768&dpr=3&quality=100&sign=fef8cec&sv=2) 1. The include or base Entity you want to filter, this entity defines what you are filtering and what results are modified. In this case, you want to filter statistics. This is always a **singular** version of the entity. 2. The Entities you expect to receive when filtering. In this case, you want to receive all the statistics that have a specific type. This is always a **plural** version of the entity. 3. The ID's you want to filter on for the 2nd part, in this case types. You can separate the ID's by using a comma. **You can find more information in our Filtering Tutorial:** [Filteringchevron-right](https://docs.sportmonks.com/v3/tutorials-and-guides/tutorials/filter-and-select-fields/filtering) [PreviousSelecting fieldschevron-left](https://docs.sportmonks.com/v3/api/request-options/selecting-fields) [NextSelecting and filteringchevron-right](https://docs.sportmonks.com/v3/api/request-options/selecting-and-filtering) Last updated 1 year ago Was this helpful? * [Filter your request](https://docs.sportmonks.com/v3/api/request-options/filtering#filter-your-request) * [Filter on includes](https://docs.sportmonks.com/v3/api/request-options/filtering#filter-on-includes) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Syntax | API 3.0 > This syntax applies broadly across most Sportmonks endpoints. Each endpoint’s documentation will point out any exceptions. ### [hashtag](https://docs.sportmonks.com/v3/api/syntax#syntax-operators-and-usage) Syntax operators & usage Operator Purpose Example `&select=` Pick specific fields on the base entity `&select=name,starting_at` `&include=` Include related entities / relations `&include=lineups,events` `;` Terminates one include chain and allows new ones `&include=lineups;events` `:` Indicates field selection inside an include `&include=events:player_name,minute` `,` Separates multiple IDs or fields `&filters=eventTypes:14,18` ### [hashtag](https://docs.sportmonks.com/v3/api/syntax#example-use-patterns) Example use patterns **Base field selection** Fetch only fields you need: Copy ?api_token=…&select=name,starting_at **Including relations** Include related data objects: Copy ?api_token=…&include=lineups,events **Field filtering inside includes** Limit fields of included relations: Copy ?api_token=…&include=events:player_name,minute&filters=eventTypes:14,18 **Nested includes (multi-level)** Chain includes for nested relations: ### [hashtag](https://docs.sportmonks.com/v3/api/syntax#exceptions-and-endpoint-specific-notes) Exceptions & endpoint-specific notes > ⚠️ Some endpoints do **not** support certain operators or include relations. Always review the endpoint’s documentation for allowed fields and relations. * Invalid syntax (wrong field names, relations, or separators) may cause a **400 Bad Request**. * When using both `include` and `filters`, filters may apply to the base entity or included entities depending on endpoint behavior. * Some endpoints restrict depth of includes or fields allowed — use the “Allowed includes / fields” section of that endpoint page. Syntax Usage Example `&select=` Select specific fields on the base entity `&select=name` `&include=` Include relations `&include=lineups` `&filters=` Filter your request `&filters=eventTypes:15` `;` Mark end of (nested) relation. You can start including other relations from here `&include=lineups;events;participants` `:` Mark field selection `&include=lineups:player_name;events:player_name,related_player_name,minute` `,` Used as separation to select or filter on more IDs `&include=events:player_name,related_player_name,minute&filters=eventTypes:15` [PreviousChangelog (BETA)chevron-left](https://docs.sportmonks.com/v3/changelog/changelog-1) [NextRequest optionschevron-right](https://docs.sportmonks.com/v3/api/request-options) Last updated 4 months ago Was this helpful? * [Syntax operators & usage](https://docs.sportmonks.com/v3/api/syntax#syntax-operators-and-usage) * [Example use patterns](https://docs.sportmonks.com/v3/api/syntax#example-use-patterns) * [Exceptions & endpoint-specific notes](https://docs.sportmonks.com/v3/api/syntax#exceptions-and-endpoint-specific-notes) Was this helpful? sun-brightdesktopmoon Copy ?api_token=…&include=events.player.country:name sun-brightdesktopmoon --- # Meta description | API 3.0 Every request has a meta description. Let's take a look at a quick example. chevron-rightResponse[hashtag](https://docs.sportmonks.com/v3/api/meta-description#response) Copy "subscription": [\ {\ "meta": [\ \ ],\ "plans": [\ {\ "plan": "Football Free Plan",\ "sport": "Football",\ "category": "Standard"\ },\ {\ "plan": "Cricket Free Plan",\ "sport": "Cricket",\ "category": "Standard"\ }\ ],\ "add_ons": [\ \ ],\ "widgets": [\ \ ]\ }\ ], "rate_limit": { "resets_in_seconds": 3600, "remaining": 179, "requested_entity": "League" }, "timezone": "UTC" } It's easy to stay on top of your subscription details. You can find out what plan(s), add-ons and widgets you have, and see the timezone you're using. You'll also know when your trial ends (if you have one) and when your subscription expires. Additionally, you can see information about your rate limit. This way, you have all the information you need to manage your subscription. In the _rate\_limit_ object, the following information is available: * _requested\_entity:_ The requested entity for the current request * _remaining:_ The number of API calls remaining for the requested entity * _resets\_in\_seconds:_ amount of seconds left before the rate limit resets for the requested entity circle-info Check how our rate limit works in our [rate limit section.](https://docs.sportmonks.com/v3/api/rate-limit) [PreviousRate limitchevron-left](https://docs.sportmonks.com/v3/api/rate-limit) [NextError codeschevron-right](https://docs.sportmonks.com/v3/api/error-codes) Last updated 1 year ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # API Coach | API 3.0 ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2F3469464275-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F9zsNGu3HAzSnl5DWBD3Y%252Fuploads%252FoxXk2rYKxV9RKJHUQW1j%252FMacbook-Air-my.sportmonks.com.png%3Falt%3Dmedia%26token%3D50fab7c7-f48b-4a77-a1ef-f0bd000d55fd&width=768&dpr=3&quality=100&sign=9c12aeae&sv=2) API Coach - MySportmonks dashboard ### [hashtag](https://docs.sportmonks.com/v3/api-coach#id-1.-purpose-of-this-page) 1\. Purpose of this page This guide explains how to access the API Coach, what it can do today, its known limitations, and how your feedback can help us improve it. ### [hashtag](https://docs.sportmonks.com/v3/api-coach#id-2.-key-benefits-at-a-glance) 2\. Key benefits at a glance * 24 / 7 availability! Instant answers any time. * Personalised guidance. Responses adapt to your account and context. * Embedded help. No need to open a ticket or leave the page. Access to resources, direct links to docs, tutorials and FAQS. ### [hashtag](https://docs.sportmonks.com/v3/api-coach#id-3.-getting-started) 3\. Getting started 1. Visit [MySportmonks.comarrow-up-right](https://my.sportmonks.com/dashboard) 2. Click the persistent chat bubble in the bottom‑right corner. 3. Type a question (e.g. “How do I integrate the API?”) and press Enter. 4. The API Coach responds immediately; follow any suggested links or buttons. 5. To end the session, simply close the chat window. ### [hashtag](https://docs.sportmonks.com/v3/api-coach#id-4.-what-can-you-ask-currently) 4\. What can you ask currently? The API Coach can currently help with: * Troubleshooting common error messages. * Questions about which API requests to make and which docs pages to use for common queries. * Best‑practice recommendations. * Links to detailed guides and tutorials. Feel free to experiment. If the API Coach cannot complete a request, you can click on ‘thumbs down’. We will then receive a message about the inaccurate or incomplete query. Then you can contact [\[email protected\]envelope](https://docs.sportmonks.com/cdn-cgi/l/email-protection#a4d7d1d4d4cbd6d0e4d7d4cbd6d0c9cbcacfd78ac7cbc9) for further assistance. ### [hashtag](https://docs.sportmonks.com/v3/api-coach#id-5.-known-limitations) 5\. Known limitations * Does not yet support account-specific actions, such as password resets or viewing billing information. * English language only; multilingual support is planned. * May occasionally provide incomplete or overly broad answers; please use the “thumbs‑down” button to flag these. Knowledge cutoff: Product changes made after April 2025 may not be reflected. ### [hashtag](https://docs.sportmonks.com/v3/api-coach#id-6.-providing-feedback) 6\. Providing feedback Feedback is a gift, and we appreciate you taking the time to help us grow and learn from your experience! Your insights directly shape our roadmap. You can: * Click on the “thumbs‑down” button to flag inaccurate/incomplete answers. This way, you provide us with valuable feedback about the responses. We review all feedback on a weekly basis and publish progress updates on the Changelog page. ### [hashtag](https://docs.sportmonks.com/v3/api-coach#id-7.-data-privacy-and-security) 7\. Data privacy & security * We store chat history for a limited period to improve quality; you may request its deletion at any time. * Never share sensitive personal data (credit‑card numbers, passwords, etc.) with the API Coach. * All of our APIS require authentication. You can create API tokens in MySportmonks. You need to be authenticated before making your first request. We offer two different options for passing your API token. You are free to choose between the authentication methods, and you can use both simultaneously. Please note that both methods count towards the same rate-limiting. 1. Authenticate using a query parameter. * You can pass your API token by passing 'api\_token' in your request parameters, like so: https://api.sportmonks.com/api/v3/football/livescores?api\_token=YOUR\_TOKEN 1. Authenticate using a request header. * You can also pass your token via an 'Authorisation' header, like so: ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2Flh7-rt.googleusercontent.com%2Fdocsz%2FAD_4nXczSJ-y9czgVCUzGXi5fflO0pjkUfIoiamNoKOCjyj8vwlUZPydgLbvn0i7i8u5cwEw3ClqDSdtVBUaanIqojRsrSy6in5GFRrEh9Zh-0gsSp6XfRxndWRsVPX1QEvkeLL9Wuh8nw%3Fkey%3DzGOzoj_Nmn_NnhMWrNScDYf6&width=768&dpr=3&quality=100&sign=45d590f2&sv=2) You can obtain and manage your API token in [MySportmonks.arrow-up-right](https://my.sportmonks.com/api/tokens) The API token is meant for your eyes only and, as such, should be stored securely. Our tokens have no expiration date and will remain valid until you manually delete them yourself. ### [hashtag](https://docs.sportmonks.com/v3/api-coach#id-8.-frequently-asked-questions) 8\. Frequently asked questions Q: Is the API Coach replacing human support? A: No. The API Coach handles routine queries, allowing our specialists to focus on more complex issues. Q: How accurate are the answers? A: Our internal testing shows ≈90 % accuracy on covered topics. Your feedback helps us close the gap. ### [hashtag](https://docs.sportmonks.com/v3/api-coach#id-9.-need-help) 9.  Need help? If you have questions that this guide does not cover, reach out to [\[email protected\]](https://docs.sportmonks.com/cdn-cgi/l/email-protection) . Thank you for using the API Coach and helping us build a better API Coach experience for everyone! [PreviousBest practiceschevron-left](https://docs.sportmonks.com/v3/welcome/best-practices) [NextChangelogchevron-right](https://docs.sportmonks.com/v3/changelog/changelog) Last updated 6 months ago Was this helpful? * [1\. Purpose of this page](https://docs.sportmonks.com/v3/api-coach#id-1.-purpose-of-this-page) * [2\. Key benefits at a glance](https://docs.sportmonks.com/v3/api-coach#id-2.-key-benefits-at-a-glance) * [3\. Getting started](https://docs.sportmonks.com/v3/api-coach#id-3.-getting-started) * [4\. What can you ask currently?](https://docs.sportmonks.com/v3/api-coach#id-4.-what-can-you-ask-currently) * [5\. Known limitations](https://docs.sportmonks.com/v3/api-coach#id-5.-known-limitations) * [6\. Providing feedback](https://docs.sportmonks.com/v3/api-coach#id-6.-providing-feedback) * [7\. Data privacy & security](https://docs.sportmonks.com/v3/api-coach#id-7.-data-privacy-and-security) * [8\. Frequently asked questions](https://docs.sportmonks.com/v3/api-coach#id-8.-frequently-asked-questions) * [9.  Need help?](https://docs.sportmonks.com/v3/api-coach#id-9.-need-help) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Entities | Motorsport 3.0 (beta) | API 3.0 [🔴Livechevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/live) [🏁Fixturechevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/fixture) [🏎️Driverchevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/driver) [🧑‍🤝‍🧑Teamchevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/team) [🛣️Venuechevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/venue) [🔂Lapchevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/lap) [🛞Pitstopchevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/pitstop) [↔️Stintchevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/stint) [🔢Standingchevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/standing) [🏆Leaguechevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/league) [🗓️Seasonchevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/season) [📆Schedulechevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/schedule) [📆Stagechevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/stage) [🟢Statechevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/state) Last updated 1 month ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Authentication | API 3.0 To make our first request, we’ll need to get authenticated first. We offer two different options for passing your API token. You are free to choose between the authentication methods. You can also use both of them at the same time. Please note that both methods count towards the same rate-limiting. * **Authenticate using a query parameter** You can pass your API token by passing 'api\_token' in your request parameters, like so: https://api.sportmonks.com/api/v3/football/livescores?api\_token_\=_YOUR\_TOKEN * **Authenticate using a request header** You can also pass your token via an 'Authorisation' header, like so: Header Value Authorization ### [hashtag](https://docs.sportmonks.com/v3/welcome/authentication#how-to-create-a-new-api-token-in-mysportmonks) How to create a new API Token in MySportmonks You can obtain and manage your API token in [**MySportmonks.**arrow-up-right](https://my.sportmonks.com/api/tokens) The API token is intended for your eyes only and, as such, should be stored securely. Our tokens have no expiration date and will remain valid until you manually delete them yourself. Follow these simple steps to generate your API token: 1. Log in to [MySportmonksarrow-up-right](https://my.sportmonks.com/) . If you do not have an account, you can create one using this link: [https://my.sportmonks.com/registerarrow-up-right](https://my.sportmonks.com/register) 2. Go to the API section in your dashboard. A dropdown will unfold; select 'Tokens'. 3. Enter a name for your new token in the 'Token name' field. 4. Click the "Create" button. ![](https://docs.sportmonks.com/v3/~gitbook/image?url=https%3A%2F%2Flh7-rt.googleusercontent.com%2Fdocsz%2FAD_4nXd65aUUZEfVEXzxuKQrJQGRVyCjoDVFFIlo1LlHGciEFbAdaeU8nU7FY0zZg17RYOC7vs2IKEVCOVnkeErt0qoP889FtsxB1cpghRdzdKe_GxTEWFIG3lxaquNaQeczQ1hus1VCpg%3Fkey%3DrJzgPtdIjMzeOcMdJVVi4g&width=300&dpr=3&quality=100&sign=9704d09f&sv=2) 5. Your new API token will be generated instantly and ready to use! Note: Be sure to store your token securely after it has been created. For security reasons, it will not be shown again or stored in MySportmonks. ### [hashtag](https://docs.sportmonks.com/v3/welcome/authentication#error-codes) Error codes When making a request, a code response will always be returned. The following are all possible HTTP response codes for any request made to the API: Code Description **200: OK** Request succeeded **400: Bad Request** It seems that some part of the request is malformed. The exact reason is returned in the response. **401: Unauthorized** The request is not authenticated. **403: Forbidden** Not authorized. Indicates you're attempting to access a feed that is not accessible from your plan. **429: Too Many Requests** Too many requests. In order to make the API as responsive as possible, you have an hourly request limit. The limit for your current subscription can be found in any successful response. Check the "meta" section to find out your limit. **500: Internal Server Error** An internal error has occurred and has been logged for further inspection. Please email support if you are receiving this error. Check our [status pagearrow-up-right](https://status.sportmonks.com/) to see if we are aware of any possible issues triangle-exclamation Directly integrating an API into the frontend of a web application can be risky as it can expose sensitive information, such as your Sportmonks API token, to potential security breaches. To avoid this, it is best practice to use a middleware, such as a backend or proxy server, to handle all communication between the frontend and the API. This middleware acts as an intermediary, making sure your API tokens are stored securely and not exposed to users. Using middleware makes it much harder for malicious actors to access sensitive information, keeping your application more secure overall. [PreviousNew endpoints and data featureschevron-left](https://docs.sportmonks.com/v3/welcome/differences-between-api-2-and-api-3/new-endpoints-and-data-features) [NextMaking your first requestchevron-right](https://docs.sportmonks.com/v3/welcome/making-your-first-request) Last updated 8 months ago Was this helpful? * [How to create a new API Token in MySportmonks](https://docs.sportmonks.com/v3/welcome/authentication#how-to-create-a-new-api-token-in-mysportmonks) * [Error codes](https://docs.sportmonks.com/v3/welcome/authentication#error-codes) Was this helpful? sun-brightdesktopmoon Copy YOUR_TOKEN sun-brightdesktopmoon --- # Request options | Motorsport 3.0 (beta) | API 3.0 This chapter will teach you how to filter out data from our API, which is useful when you want to request specific data and can omit the rest for faster response time. You can filter out data for various parameters per endpoint. See our **endpoint overviews** for more detailed information. [hashtag](https://docs.sportmonks.com/v3/motorsport-api/welcome/request-options#field-selection) Field selection --------------------------------------------------------------------------------------------------------------------- API 3.0 introduces the possibility to request specific fields on entities. This possibility comes in handy when you only use particular fields in an API response. The advantage of selecting specific fields is that it reduces the response speed in mainly large responses. In addition to reducing response time, the response size can also be drastically reduced. Let's take a look together at an example. ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/welcome/request-options#id-1.-only-select-a-specific-field) 1\. Only select a specific field One of our new additions to API 3.0 is a name field on the fixtures. The name field contains a textual representation of the participants playing the fixture. Without selecting a specific field, the API request and response would look like this: Request Response Copy https://api.sportmonks.com/v3/motorsport/fixtures/19408487?api_token={your_token} Copy { "data": { "id": 18509783, "inplay": 0, "sport_id": 1, "league_id": 2, "season_id": 18346, "stage_id": 77453618, "group_id": null, "aggregate_id": 29195, "round_id": null, "state_id": 7, "venue_id": null, "name": "Real Madrid vs Manchester City", "home_score": 2, "away_score": 1, "starting_at": "2022-05-04 19:00:00", "result_info": "Real Madrid won after extra-time.", "ended_at": "2022-05-04 20:54:26", "leg": "2/2", "details": null, "length": 90, "placeholder": false, "is_final_result": 0 }, As you can see, the API response is rather large if you're only interested in the fixture's name. Let's select that API field to reduce the response length and size. We're using the fixtures endpoint. This means that we can select on all the fields of the fixtures entity. You can do this by adding &select={specific fields on the base [entity](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities) }. In our example, this would result in the below API request and response: Request Response Copy https://api.sportmonks.com/v3/motorsport/fixtures/19408487?api_token={your_token}&select=name Copy { "data": { "name": "Real Madrid vs Manchester City", "id": 18509783, "sport_id": 1, "round_id": null, "stage_id": 77453618, "group_id": null, "aggregate_id": 29195, "league_id": 2, "season_id": 18346, "venue_id": null, "state_id": 7 }, As you can see in the example response above, the 'name' field is only returned for the fixture. circle-info Please note that the fields that have relations are also automatically included for technical reasons. ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/welcome/request-options#id-2.-select-a-specific-field-on-an-include) 2\. Select a specific field on an include You can also use field selection based on includes. Imagine you want to access fixture lineup information from Manchester City vs Liverpool. Additional to the lineups, you also wish to receive the display names, player images and country details. circle-exclamation Please note that we only copied the first player in the lineup in the below examples. Download our full code examples to see the complete differences. Without selecting specific fields, you will receive a lot of information you don't need. The API request and partial API response would look like this: Request Response **Download full-example** file-download 66KB [old\_request\_selecting\_fields\_on\_includes.json](https://content.gitbook.com/content/FnlmCoPQl0hTWxA9V938/blobs/ikJwp54nFAhh0Hz1VGgt/old_request_selecting_fields_on_includes.json) downloadDownload[arrow-up-right-from-squareOpen](https://content.gitbook.com/content/FnlmCoPQl0hTWxA9V938/blobs/ikJwp54nFAhh0Hz1VGgt/old_request_selecting_fields_on_includes.json) The API response without selecting on fields Now, let's select specific fields on the base entities used. Since we're using the lineups.player include, the first base entity is players. We can select on all the fields of that entity. In our example, you need to select `display_name` and `image_path.` The second base entity is countries. Just like on the player entity, we can select on all the fields of the [countries](https://docs.sportmonks.com/v3/core-api/) entity. In our example, you need to select `name` and `image_path.` The new API request and partial API response would look like this: Request Response **Download full-example** file-download 37KB [new\_request\_selecting\_field\_on\_includes.json](https://content.gitbook.com/content/FnlmCoPQl0hTWxA9V938/blobs/LmBBg6fyO4uH0yzsftZj/new_request_selecting_field_on_includes.json) downloadDownload[arrow-up-right-from-squareOpen](https://content.gitbook.com/content/FnlmCoPQl0hTWxA9V938/blobs/LmBBg6fyO4uH0yzsftZj/new_request_selecting_field_on_includes.json) The API response with selecting on fields As you can see in the example response, the size and length are reduced significantly. ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/welcome/request-options#syntax) **Syntax** This syntax can be used across all endpoints, the documentation for each endpoint describes the exceptions regarding exclusions of some fields/relations. The table below describes the syntax for the usage of the field selection Syntax Usage Example &select= Select specific fields on the base entity &select=name &include= Include relations ?include=lineups ; Mark end of (nested) relation, you can start including of other relations here ?include=lineups;results : Mark field selection ?include=lineups:driver\_name;results Last updated 1 month ago Was this helpful? * [Field selection](https://docs.sportmonks.com/v3/motorsport-api/welcome/request-options#field-selection) * [1\. Only select a specific field](https://docs.sportmonks.com/v3/motorsport-api/welcome/request-options#id-1.-only-select-a-specific-field) * [2\. Select a specific field on an include](https://docs.sportmonks.com/v3/motorsport-api/welcome/request-options#id-2.-select-a-specific-field-on-an-include) * [Syntax](https://docs.sportmonks.com/v3/motorsport-api/welcome/request-options#syntax) Was this helpful? sun-brightdesktopmoon Copy https://api.sportmonks.com/v3/motorsport/fixtures/19408487?api_token={your_token}&include=lineups.driver;lineups.driver.country Copy { "data": { "id": 18138897, "inplay": 0, "sport_id": 1, "league_id": 8, "season_id": 18378, "stage_id": 77453700, "group_id": null, "aggregate_id": null, "round_id": 247615, "state_id": 5, "venue_id": 151, "name": "Manchester City vs Liverpool", "home_score": 2, "away_score": 2, "starting_at": "2022-04-10 15:30:00", "result_info": "Game ended in draw.", "ended_at": "2022-04-10 17:22:47", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "is_final_result": 0, "lineups": [\ {\ "id": 1574621,\ "sport_id": 1,\ "fixture_id": 18138897,\ "player_id": 129820,\ "team_id": 8,\ "position_id": 24,\ "detailed_position_id": null,\ "formation_field": null,\ "type_id": 11,\ "provider_id": 2,\ "yersey_number": 1,\ "formation_position": 1,\ "player_name": "Alisson",\ "player": {\ "id": 129820,\ "sport_id": 1,\ "country_id": 5,\ "nationality_id": null,\ "city_id": null,\ "position_id": 24,\ "detailed_position_id": 24,\ "type_id": 24,\ "common_name": "A. Becker",\ "firstname": "Alisson Ramsés",\ "lastname": "Becker",\ "name": "Alisson Ramsés Becker",\ "display_name": "Alisson",\ "image_path": "https://cdn.sportmonks.com/images/soccer/players/28/129820.png",\ "height": 193,\ "weight": 91,\ "date_of_birth": "1992-10-02",\ "gender": "male",\ "country": {\ "id": 5,\ "continent_id": 7,\ "name": "Brazil",\ "official_name": "Federative Republic of Brazil",\ "fifa_name": "BRA",\ "iso2": "BR",\ "iso3": "BRA",\ "latitude": "-10.81045150756836",\ "longitude": "-52.97311782836914",\ "geonameid": 3469034,\ "borders": [\ "ARG",\ "BOL",\ "COL",\ "GUF",\ "GUY",\ "PRY",\ "PER",\ "SUR",\ "URY",\ "VEN"\ ],\ "image_path": "https://cdn.sportmonks.com/images//countries/png/short/br.png"\ }\ }\ },\ \ Copy\ \ https://api.sportmonks.com/v3/motorsport/fixtures/19408487?api_token={your_token}&include=lineups.driver:display_name,image_path;lineups.driver.country:name,image_path\ \ Copy\ \ {\ "data": {\ "id": 18138897,\ "inplay": 0,\ "sport_id": 1,\ "league_id": 8,\ "season_id": 18378,\ "stage_id": 77453700,\ "group_id": null,\ "aggregate_id": null,\ "round_id": 247615,\ "state_id": 5,\ "venue_id": 151,\ "name": "Manchester City vs Liverpool",\ "home_score": 2,\ "away_score": 2,\ "starting_at": "2022-04-10 15:30:00",\ "result_info": "Game ended in draw.",\ "ended_at": "2022-04-10 17:22:47",\ "leg": "1/1",\ "details": null,\ "length": 90,\ "placeholder": false,\ "is_final_result": 0,\ "lineups": [\ {\ "id": 1574621,\ "sport_id": 1,\ "fixture_id": 18138897,\ "player_id": 129820,\ "team_id": 8,\ "position_id": 24,\ "detailed_position_id": null,\ "formation_field": null,\ "type_id": 11,\ "provider_id": 2,\ "yersey_number": 1,\ "formation_position": 1,\ "player_name": "Alisson",\ "player": {\ "id": 129820,\ "country_id": 5,\ "sport_id": 1,\ "city_id": null,\ "position_id": 24,\ "detailed_position_id": 24,\ "display_name": "Alisson",\ "image_path": "https://cdn.sportmonks.com/images/soccer/players/28/129820.png",\ "country": {\ "id": 5,\ "continent_id": 7,\ "name": "Brazil",\ "image_path": "https://cdn.sportmonks.com/images//countries/png/short/br.png"\ }\ }\ },\ \ sun-brightdesktopmoon --- # Includes | API 3.0 The `includes` parameter in the Sportmonks Football API allows you to enrich your API responses by including related resources in a single request. By using includes, you can avoid making multiple API calls to gather related data, making your integrations more efficient and performant. ### [hashtag](https://docs.sportmonks.com/v3/api/request-options/includes#overview) Overview When querying an endpoint, you can include additional related data by specifying the `include` parameter in your request. This allows you to receive related entities, such as team details, player statistics, and more, all within the same response. The available includes depend on the specific endpoint you're accessing. Parameter Required Description `include` No Enrich the API response with more data by using includes. ### [hashtag](https://docs.sportmonks.com/v3/api/request-options/includes#example) Example Let's say you want to retrieve fixture alongside with the associated teams for that fixture. You can do this by adding the `include` parameter to your request: Request Response Copy https://api.sportmonks.com/v3/football/fixtures/{ID}&include=participants Copy { "data": { "id": 19032598, "sport_id": 1, "league_id": 1326, "season_id": 22842, "stage_id": 77468270, "group_id": null, "aggregate_id": null, "round_id": null, "state_id": 5, "venue_id": 1944, "name": "Spain vs England", "starting_at": "2024-07-14 19:00:00", "result_info": "Spain won after full-time.", "leg": "1/1", "details": "Match 51", "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1720983600, "participants": [\ {\ "id": 18645,\ "sport_id": 1,\ "country_id": 462,\ "venue_id": 1315,\ "gender": "male",\ "name": "England",\ "short_code": "ENG",\ "image_path": "https://cdn.sportmonks.com/images/soccer/teams/21/18645.png",\ "founded": 1863,\ "type": "national",\ "placeholder": false,\ "last_played_at": "2024-07-14 19:00:00",\ "meta": {\ "location": "away",\ "winner": false,\ "position": 2\ }\ },\ {\ "id": 18710,\ "sport_id": 1,\ "country_id": 32,\ "venue_id": 2020,\ "gender": "male",\ "name": "Spain",\ "short_code": "ESP",\ "image_path": "https://cdn.sportmonks.com/images/soccer/teams/22/18710.png",\ "founded": 1913,\ "type": "national",\ "placeholder": false,\ "last_played_at": "2024-07-14 19:00:00",\ "meta": {\ "location": "home",\ "winner": true,\ "position": 1\ }\ }\ ] }, ### [hashtag](https://docs.sportmonks.com/v3/api/request-options/includes#nested-includes) Nested Includes Some includes allow you to drill down even further into related data by using nested includes.You can read more on that on this page: [Nested includeschevron-right](https://docs.sportmonks.com/v3/api/request-options/includes/nested-includes) [PreviousRequest optionschevron-left](https://docs.sportmonks.com/v3/api/request-options) [NextNested includeschevron-right](https://docs.sportmonks.com/v3/api/request-options/includes/nested-includes) Last updated 1 year ago Was this helpful? * [Overview](https://docs.sportmonks.com/v3/api/request-options/includes#overview) * [Example](https://docs.sportmonks.com/v3/api/request-options/includes#example) * [Nested Includes](https://docs.sportmonks.com/v3/api/request-options/includes#nested-includes) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Live | Motorsport 3.0 (beta) | API 3.0 You can obtain all the fixtures that are currently live, starting shortly or recently ended via our live endpoints. Responses of the live endpoint are highly customisable because many includes are available to extend the response. You can find a list of available includes below, listed per endpoint option. circle-check To retrieve results for a fixture, you can use the `results` include. Alternatively, you can use the `lineups.details` nested include to retrieve additional lineup information and more result types. The types for these results are described in [Results & Live Data Type Reference](https://docs.sportmonks.com/v3/motorsport-api/welcome/results-and-live-data-type-reference) . You can also use the `metadata` include to enrich the response with detailed information about the fixture, like the current and total lap count, race distance and fastest lap. The type reference for these details are described in [Metadata & Per-Season Data Type Reference](https://docs.sportmonks.com/v3/motorsport-api/welcome/metadata-and-per-season-data-type-reference) . circle-info The endpoint to retrieve livescores is: * [**GET All Livescores**arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/live/get-all-livescores) **:** returns the fixtures that are currently live, starting shortly or recently ended. * * * ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/live#include-options) Include options [`sport`arrow-up-right](https://docs.sportmonks.com/v3/core-api/entities/core#sport) [`league`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/league) [`season`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/season) [`stage`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/stage) [`state`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/state) [`venue`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/state) [`participants`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/stint) [`results`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/fixture) [`metadata`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/fixture) [`lineups`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/driver) [`latestLaps`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/fixture) [`pitstops`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/pitstop) [`latestPitstops`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/pitstop) [`stints`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/stint) [`latestStints`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/stint) * * * ### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/live#related-entities) Related Entities Get an overview and explanation of all the fields returned in the API response. The related entities for the live endpoints are: * [Livearrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/live) Last updated 6 days ago Was this helpful? * [Include options](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/live#include-options) * [Related Entities](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/live#related-entities) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Filtering and Complexity Exceptions | API 3.0 Whenever you make a request that is accepted and gives an error based on **filters and/or complexity** you can check the status code or name in the table below for more information. The description will show more details about how the error is created and what possible steps you can take to avoid these kind of errors. Status Name Description `5004` Query complexity This query (includes,filters etc) is too complex to process by the server, please check [query complexity](https://docs.sportmonks.com/v3/api/request-options) for more information. `5006` Invalid query parameter This parameter is not allowed on the request, please remove this parameter before trying again. `5010` Inapplicable Filter This filter cannot be used on this request, please check if the filter is correct or remove the filter. Check [filtering](https://docs.sportmonks.com/v3/tutorials-and-guides/tutorials/filter-and-select-fields/filtering) for more information. [PreviousInclude Exceptionschevron-left](https://docs.sportmonks.com/v3/api/error-codes/include-exceptions) [NextOther Exceptionschevron-right](https://docs.sportmonks.com/v3/api/error-codes/other-exceptions) Last updated 1 year ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # State | Motorsport 3.0 (beta) | API 3.0 **Related endpoints** [🟢Stateschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/states) **Field description** Field Description Type `id` The unique id of the state integer `state` The abbreviation of the state string `name` The full name of the state string `short_name` The short name of the state string `developer_name` The name recommended for developers to use string **Include options** None Last updated 2 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Pitstops | Motorsport 3.0 (beta) | API 3.0 A pitstop represents each stop a driver makes during a motorsport fixture. Use the pitstops endpoints to retrieve pitstop details for a specific fixture or driver, or to break down pit activity by lap. circle-check You can also use the `details` include to enrich the response with detailed information about each pitstop, like the pit duration. The type reference for these details are described in [Results & Live Data Type Reference](https://docs.sportmonks.com/v3/motorsport-api/welcome/results-and-live-data-type-reference) . * * * #### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/pitstops#available-endpoints) Available endpoints * [**GET Pitstops by Fixture ID and Driver ID**arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/pitstops/get-pitstops-by-fixture-id-and-driver-id) : returns all pitstops for a provided fixture ID and driver ID. * [**GET Pitstops by Fixture ID and Lap Number**arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/pitstops/get-pitstops-by-fixture-id-and-lap-number) : returns all pitstops for a provided fixture ID and lap number. * * * #### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/pitstops#include-options) Include options [`fixture`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/fixture) , [`participant`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/driver) , `details` * * * #### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/pitstops#related-entities) Related entities [Laparrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/getting-started/entities/pitstop) Last updated 6 days ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Venues | Motorsport 3.0 (beta) | API 3.0 A venue represents a racing track where motorsport fixtures take place. Use the venues endpoints to retrieve venue details, search for venues, or list venues for a season. circle-check You can also use the `metadata` include to enrich the response with detailed information about the track, like the direction and length. The type reference for these details are described in [Metadata & Per-Season Data Type Reference](https://docs.sportmonks.com/v3/motorsport-api/welcome/metadata-and-per-season-data-type-reference) . * * * #### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/venues#available-endpoints) Available endpoints * [**GET All Venues**arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/venues/get-all-venues) : Returns all venues (racing tracks) available in the Motorsport API. * [**GET Venues by ID**arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/venues/get-venues-by-id) : Returns a venue (racing track) by its ID. * [**GET Venues by Search**arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/venues/get-venues-by-search) : Returns venues (racing tracks) matching a provided search query. * [**GET Venues by Season ID**arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/venues/get-venues-by-season-id) **:** Returns the venues (racing tracks) for a provided season ID. * * * #### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/venues#include-options) Include options You can enrich venue responses using `include`. [`country`arrow-up-right](https://docs.sportmonks.com/v3/core-api/entities/core#country) ,[`fixtures`arrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/fixture) , [`city`arrow-up-right](https://docs.sportmonks.com/v3/core-api/entities/core#city) , `metadata` * * * #### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/venues#related-entities) Related entities * [Venuearrow-up-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/venue) Last updated 6 days ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Race Results | Motorsport 3.0 (beta) | API 3.0 The race results endpoints contain all the live and past (sprint) races, grouped by stage (Race Weekend), with the results belonging to the requested driver or team. Use the race results endpoints to retrieve complete season results that include stages, fixtures, lineups and lineup details (including results) of the requested driver or team. * * * #### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/race-results#available-endpoints) Available endpoints * [**GET Race Results by Season and Driver**](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/race-results/get-race-results-by-season-and-driver) : returns the race results for a provided season ID and driver ID. The endpoint includes all the stages, race fixtures, lineups and lineup details for that season and driver ID. * [**GET Race Results by Season and Team**](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/race-results/get-race-results-by-season-and-team) : returns the race results for a provided season ID and team ID. The endpoint includes all the stages, race fixtures, lineups and lineup details for that season and team ID. * * * #### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/race-results#include-options) Include options circle-info None available at this time * * * #### [hashtag](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/race-results#related-entities) Related entities [Stage](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/stage) [Fixture](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/entities/fixture) Last updated 11 days ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Pitstop | Motorsport 3.0 (beta) | API 3.0 **Related endpoints** [🛞Pitstopschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/pitstops) **Field description** Field Description Type `id` TBC integer `fixture_id` The fixture of the pitstop integer `lap_number` The lap number of the pitstop integer `driver_number` The number of the driver integer `participant_id` The driver of the pitstop integer `is_latest` Indicates if it was the latest pitstop boolean **Include options** `sport` `fixture` `participant` Last updated 2 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Lap | Motorsport 3.0 (beta) | API 3.0 **Related endpoints** [🔂Lapschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/laps) **Field description** Field Description Type `id` The unique lap ID integer `fixture_id` The fixture ID related to the lap integer `lap_number` The number of the lap in the fixture integer `driver_number` The driver related to the lap integer `participant_id` The team of the driver related to the lap integer `is_latest` Indicates if it's the lasp boolean **Include options** `sport` `fixture` `participant` Last updated 2 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Stint | Motorsport 3.0 (beta) | API 3.0 **Related endpoints** [↔️Stintschevron-right](https://docs.sportmonks.com/v3/motorsport-api/endpoints-and-entities/endpoints/stints) **Field description** Field Description Type `id` TBC integer `fixture_id` The fixture of the stint integer `stint_number` The stint number integer `driver_number` The number of the driver integer `participant_id` The driver of the stint integer `is_latest` Indicates if it was the latest pitstop boolean **Include options** `sport` `fixture` `participant` Last updated 2 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon ---