{ "openapi": "3.1.1", "info": { "title": "Sportmonks Football API", "summary": "Complete OpenAPI 3.1.1 specification for the Sportmonks Football API.", "description": "Auto-generated from the Sportmonks public Postman collection, the GitBook documentation pages, and live API responses. The spec covers Football, Core, Odds, and My endpoints.", "version": "3.0.0", "contact": { "email": "support@sportmonks.com", "url": "https://www.sportmonks.com" }, "license": { "name": "Proprietary", "url": "https://www.sportmonks.com/legal/" } }, "servers": [ { "url": "https://api.sportmonks.com/v3", "description": "Sportmonks production API" } ], "security": [ { "ApiKeyAuth": [] }, { "ApiKeyHeaderAuth": [] } ], "tags": [ { "name": "Bookmakers", "description": "Odds → Bookmakers" }, { "name": "Cities", "description": "Core → Cities" }, { "name": "Coaches", "description": "Football → Coaches" }, { "name": "Commentaries", "description": "Football → Commentaries" }, { "name": "Continents", "description": "Core → Continents" }, { "name": "Countries", "description": "Core → Countries" }, { "name": "Expected", "description": "Football → Expected" }, { "name": "Filters", "description": "Core → Filters" }, { "name": "Fixtures", "description": "Football → Fixtures" }, { "name": "Leagues", "description": "Football → Leagues" }, { "name": "Livescores", "description": "Football → Livescores" }, { "name": "Markets", "description": "Odds → Markets" }, { "name": "Match Facts - beta", "description": "Football → Match Facts - beta" }, { "name": "MySportmonks", "description": "My → MySportmonks" }, { "name": "News", "description": "Football → News" }, { "name": "Players", "description": "Football → Players" }, { "name": "Predictions", "description": "Football → Predictions" }, { "name": "Premium Expected Lineups", "description": "Football → Premium Expected Lineups" }, { "name": "Premium Odds Feed", "description": "Odds → Premium Odds Feed" }, { "name": "Referees", "description": "Football → Referees" }, { "name": "Regions", "description": "Core → Regions" }, { "name": "Rivals", "description": "Football → Rivals" }, { "name": "Rounds", "description": "Football → Rounds" }, { "name": "Schedules", "description": "Football → Schedules" }, { "name": "Seasons", "description": "Football → Seasons" }, { "name": "Squads", "description": "Football → Squads" }, { "name": "Stages", "description": "Football → Stages" }, { "name": "Standard Odds Feed", "description": "Odds → Standard Odds Feed" }, { "name": "Standings", "description": "Football → Standings" }, { "name": "States", "description": "Football → States" }, { "name": "Statistics", "description": "Football → Statistics" }, { "name": "TV Stations", "description": "Football → TV Stations" }, { "name": "Team Of the Week (ToTW) - beta", "description": "Football → Team Of the Week (ToTW) - beta" }, { "name": "Teams", "description": "Football → Teams" }, { "name": "Timezones", "description": "Core → Timezones" }, { "name": "Topscorers", "description": "Football → Topscorers" }, { "name": "Transfer Rumours", "description": "Football → Transfer Rumours" }, { "name": "Transfers", "description": "Football → Transfers" }, { "name": "Types", "description": "Core → Types" }, { "name": "Venues", "description": "Football → Venues" } ], "paths": { "/core/cities": { "get": { "operationId": "getAllCities", "summary": "All Cities", "tags": [ "Cities" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API with more data by using includes\n\nAllowed values: region. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=region`.", "schema": { "type": "string" }, "x-includes": [ "region" ], "x-include-depth-max": 4, "example": "region" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity\n\nSelectable fields: id, country_id, region, name, latitude, longitude, geonameid. Pass as a comma-separated list, e.g. `select=id,country_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "country_id", "region", "name", "latitude", "longitude", "geonameid" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "country_id", "region", "name", "latitude", "longitude", "geonameid" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "GET All Cities", "description": "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.", "example": "&filters=IdAfter:cityID" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "GET All Cities", "description": "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.", "example": "&filters=IdAfter:cityID" } ] }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/City" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "country_id": 107, "region_id": 1, "name": "'Afak", "latitude": "24.84926", "longitude": "46.84591" }, { "id": 2, "country_id": 802, "region_id": 2, "name": "'Afula 'Illit", "latitude": "32.61197", "longitude": "35.28753" }, { "id": 3, "country_id": 24143344, "region_id": 3, "name": "'Aiea", "latitude": "0.00000", "longitude": "0.00000" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/core/cities?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all cities available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/core-api/endpoints/cities/get-all-cities\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/endpoints/cities/get-all-cities)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/endpoints/cities/get-all-cities", "description": "Sportmonks docs" } } }, "/core/cities/search/{name}": { "get": { "operationId": "getCitiesBySearch", "summary": "Cities by Search", "tags": [ "Cities" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name you want to search on." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API with more data by using includes\n\nAllowed values: region. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=region`.", "schema": { "type": "string" }, "x-includes": [ "region" ], "x-include-depth-max": 4, "example": "region" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity\n\nSelectable fields: id, country_id, region, name, latitude, longitude, geonameid. Pass as a comma-separated list, e.g. `select=id,country_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "country_id", "region", "name", "latitude", "longitude", "geonameid" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "country_id", "region", "name", "latitude", "longitude", "geonameid" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: regionCities. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "regions", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter regions and more based on cities.", "example": "&include=regions&filters=regionCities:regionIDS" } ], "x-filters": [ { "kind": "dynamic", "entity": "regions", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter regions and more based on cities.", "example": "&include=regions&filters=regionCities:regionIDS", "name": "regionCities" } ] }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/City" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 25389, "country_id": 146, "region_id": 635, "name": "East London", "latitude": "-33.011051", "longitude": "27.910049" }, { "id": 51662, "country_id": 1004, "region_id": 224, "name": "London", "latitude": "42.983612", "longitude": "81.249725" }, { "id": 51663, "country_id": 462, "region_id": 47, "name": "London", "latitude": "51.509865", "longitude": "-0.118092" } ], "pagination": { "count": 20, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns cities information that matches your search query. For more information, please visit:https://docs.sportmonks.com/football/core-api/endpoints/cities/get-cities-by-search\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/endpoints/cities/get-cities-by-search)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/endpoints/cities/get-cities-by-search", "description": "Sportmonks docs" } } }, "/core/cities/{cityId}": { "get": { "operationId": "getCityById", "summary": "City by ID", "tags": [ "Cities" ], "parameters": [ { "name": "cityId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the city you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API with more data by using includes\n\nAllowed values: region. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=region`.", "schema": { "type": "string" }, "x-includes": [ "region" ], "x-include-depth-max": 4, "example": "region" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity\n\nSelectable fields: id, country_id, region, name, latitude, longitude, geonameid. Pass as a comma-separated list, e.g. `select=id,country_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "country_id", "region", "name", "latitude", "longitude", "geonameid" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "country_id", "region", "name", "latitude", "longitude", "geonameid" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: regionCities. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "regions", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter regions and more based on cities.", "example": "&include=regions&filters=regionCities:regionIDS" } ], "x-filters": [ { "kind": "dynamic", "entity": "regions", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter regions and more based on cities.", "example": "&include=regions&filters=regionCities:regionIDS", "name": "regionCities" } ] } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/City" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 1, "country_id": 107, "region_id": 1, "name": "'Afak", "latitude": "24.84926", "longitude": "46.84591" }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns information from your requested city ID. For more information, please visit:https://docs.sportmonks.com/football/core-api/endpoints/cities/get-city-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/endpoints/cities/get-city-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/endpoints/cities/get-city-by-id", "description": "Sportmonks docs" } } }, "/core/continents": { "get": { "operationId": "getAllContinents", "summary": "All Continents", "tags": [ "Continents" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API with more data by using includes\n\nAllowed values: countries. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=countries`.", "schema": { "type": "string" }, "x-includes": [ "countries" ], "x-include-depth-max": 3, "example": "countries" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity\n\nSelectable fields: id, name, code. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "code" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name", "code" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Continent" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "name": "Europe", "code": "EU" }, { "id": 2, "name": "Asia", "code": "AS" }, { "id": 3, "name": "Africa", "code": "AF" } ], "pagination": { "count": 7, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the continents available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/core-api/endpoints/continents/get-all-continents\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/endpoints/continents/get-all-continents)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/endpoints/continents/get-all-continents", "description": "Sportmonks docs" } } }, "/core/continents/{continentId}": { "get": { "operationId": "getContinentsById", "summary": "Continents by ID", "tags": [ "Continents" ], "parameters": [ { "name": "continentId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the continent you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API with more data by using includes\n\nAllowed values: countries. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=countries`.", "schema": { "type": "string" }, "x-includes": [ "countries" ], "x-include-depth-max": 3, "example": "countries" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity\n\nSelectable fields: id, name, code. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "code" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name", "code" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Continent" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 1, "name": "Europe", "code": "EU" }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns information from your requested continent ID. For more information, please visit:https://docs.sportmonks.com/football/core-api/endpoints/continents/get-continent-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/endpoints/continents/get-continent-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/endpoints/continents/get-continent-by-id", "description": "Sportmonks docs" } } }, "/core/countries": { "get": { "operationId": "getAllCountries", "summary": "All Countries", "tags": [ "Countries" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API with more data by using includes\n\nAllowed values: continent, leagues, regions. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=continent;leagues`.", "schema": { "type": "string" }, "x-includes": [ "continent", "leagues", "regions" ], "x-include-depth-max": 2, "example": "continent;leagues" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity\n\nSelectable fields: id, continent_id, name, official_name, fifa_name, iso2, iso3, latitude, longitude, geonameid, border, image_path. Pass as a comma-separated list, e.g. `select=id,continent_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "continent_id", "name", "official_name", "fifa_name", "iso2", "iso3", "latitude", "longitude", "geonameid", "border", "image_path" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "continent_id", "name", "official_name", "fifa_name", "iso2", "iso3", "latitude", "longitude", "geonameid", "border", "image_path" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, regionCountries, leagueCountries. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "GET All Countries", "description": "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.", "example": "&filters=IdAfter:countryID" } ], "x-filters-dynamic": [ { "entity": "regions", "use": "Region Check this endpoint for all possibilities.", "description": "Filter regions based on countries.", "example": "&include=regions&filters=regionCountries:regionIDS" }, { "entity": "leagues", "use": "Check this endpoint for all possibilities.", "description": "Filter leagues based on countries.", "example": "&include=leagues&filters=leagueCountries:leagueIDS" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "GET All Countries", "description": "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.", "example": "&filters=IdAfter:countryID" }, { "kind": "dynamic", "entity": "regions", "use": "Region Check this endpoint for all possibilities.", "description": "Filter regions based on countries.", "example": "&include=regions&filters=regionCountries:regionIDS", "name": "regionCountries" }, { "kind": "dynamic", "entity": "leagues", "use": "Check this endpoint for all possibilities.", "description": "Filter leagues based on countries.", "example": "&include=leagues&filters=leagueCountries:leagueIDS", "name": "leagueCountries" } ] }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "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", "borders": [ "BLR", "CZE" ], "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", "borders": [ "ARG", "BOL" ], "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", "borders": [ "AUT", "BEL" ], "image_path": "https://cdn.sportmonks.com/images/countries/png/short/de.png" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/core/countries?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the countries available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/core-api/endpoints/countries/get-all-countries\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/endpoints/countries/get-all-countries)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/endpoints/countries/get-all-countries", "description": "Sportmonks docs" } } }, "/core/countries/search/{name}": { "get": { "operationId": "getCountriesBySearch", "summary": "Countries by Search", "tags": [ "Countries" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name you want to search on." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API with more data by using includes\n\nAllowed values: continent, leagues, regions. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=continent;leagues`.", "schema": { "type": "string" }, "x-includes": [ "continent", "leagues", "regions" ], "x-include-depth-max": 2, "example": "continent;leagues" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity\n\nSelectable fields: id, continent_id, name, official_name, fifa_name, iso2, iso3, latitude, longitude, geonameid, border, image_path. Pass as a comma-separated list, e.g. `select=id,continent_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "continent_id", "name", "official_name", "fifa_name", "iso2", "iso3", "latitude", "longitude", "geonameid", "border", "image_path" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "continent_id", "name", "official_name", "fifa_name", "iso2", "iso3", "latitude", "longitude", "geonameid", "border", "image_path" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: regionCountries, leagueCountries. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "regions", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter countries and more based on regions.", "example": "&include=regions&filters=regionCountries:regionIDS" }, { "entity": "leagues", "use": "Check this endpoint for all possibilities.", "description": "Filter countries and more based on leagues.", "example": "&include=leagues&filters=leagueCountries:leagueIDS" } ], "x-filters": [ { "kind": "dynamic", "entity": "regions", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter countries and more based on regions.", "example": "&include=regions&filters=regionCountries:regionIDS", "name": "regionCountries" }, { "kind": "dynamic", "entity": "leagues", "use": "Check this endpoint for all possibilities.", "description": "Filter countries and more based on leagues.", "example": "&include=leagues&filters=leagueCountries:leagueIDS", "name": "leagueCountries" } ] }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 462, "continent_id": 1, "name": "England", "official_name": "England", "fifa_name": "ENG", "iso2": "EN", "iso3": "ENG", "latitude": "54.56088638305664", "longitude": "-2.2125117778778076", "borders": [ "IRL" ], "image_path": "https://cdn.sportmonks.com/images/countries/png/short/en.png" } ], "pagination": { "count": 1, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns country information that matches your search query. For more information, please visit:https://docs.sportmonks.com/football/core-api/endpoints/countries/get-countries-by-search\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/endpoints/countries/get-countries-by-search)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/endpoints/countries/get-countries-by-search", "description": "Sportmonks docs" } } }, "/core/countries/{countryId}": { "get": { "operationId": "getCountryById", "summary": "Country by ID", "tags": [ "Countries" ], "parameters": [ { "name": "countryId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the country you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API with more data by using includes\n\nAllowed values: continent, leagues, regions. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=continent;leagues`.", "schema": { "type": "string" }, "x-includes": [ "continent", "leagues", "regions" ], "x-include-depth-max": 2, "example": "continent;leagues" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity\n\nSelectable fields: id, continent_id, name, official_name, fifa_name, iso2, iso3, latitude, longitude, geonameid, border, image_path. Pass as a comma-separated list, e.g. `select=id,continent_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "continent_id", "name", "official_name", "fifa_name", "iso2", "iso3", "latitude", "longitude", "geonameid", "border", "image_path" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "continent_id", "name", "official_name", "fifa_name", "iso2", "iso3", "latitude", "longitude", "geonameid", "border", "image_path" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Country" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "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", "borders": [ "BLR", "CZE" ], "image_path": "https://cdn.sportmonks.com/images/countries/png/short/pl.png" }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns information from your requested country ID. For more information, please visit:https://docs.sportmonks.com/football/core-api/endpoints/countries/get-country-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/endpoints/countries/get-country-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/endpoints/countries/get-country-by-id", "description": "Sportmonks docs" } } }, "/my/filters/entity": { "get": { "operationId": "getAllEntityFilters", "summary": "All Entity Filters", "tags": [ "Filters" ], "parameters": [], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "aioverview": { "type": "array", "items": { "type": "string" } }, "aggregate": { "type": "array", "items": { "type": "string" } }, "coach": { "type": "array", "items": { "type": "string" } }, "coachstatistic": { "type": "array", "items": { "type": "string" } }, "coachstatisticdetail": { "type": "array", "items": { "type": "string" } }, "coachteam": { "type": "array" }, "commentary": { "type": "array", "items": { "type": "string" } }, "detailedperiod": { "type": "array", "items": { "type": "string" } }, "event": { "type": "array", "items": { "type": "string" } }, "expectedlineup": { "type": "array", "items": { "type": "string" } }, "fixture": { "type": "array", "items": { "type": "string" } }, "fixtureballposition": { "type": "array" }, "fixtureformation": { "type": "array" }, "fixturereferee": { "type": "array", "items": { "type": "string" } }, "fixturesidelined": { "type": "array", "items": { "type": "string" } }, "fixturestatistic": { "type": "array", "items": { "type": "string" } }, "fixturetvstation": { "type": "array", "items": { "type": "string" } }, "group": { "type": "array" }, "lap": { "type": "array" }, "lapdetail": { "type": "array", "items": { "type": "string" } }, "league": { "type": "array", "items": { "type": "string" } }, "lineup": { "type": "array", "items": { "type": "string" } }, "lineupdetail": { "type": "array", "items": { "type": "string" } }, "livestanding": { "type": "array", "items": { "type": "string" } }, "matchfact": { "type": "array", "items": { "type": "string" } }, "medium": { "type": "array" }, "metadata": { "type": "array", "items": { "type": "string" } }, "newsitem": { "type": "array", "items": { "type": "string" } }, "newsitemline": { "type": "array" }, "participant": { "type": "array" }, "participantseasondetail": { "type": "array", "items": { "type": "string" } }, "participanttrophy": { "type": "array", "items": { "type": "string" } }, "period": { "type": "array", "items": { "type": "string" } }, "periodstatistic": { "type": "array", "items": { "type": "string" } }, "pitstop": { "type": "array" }, "pitstopdetail": { "type": "array", "items": { "type": "string" } }, "player": { "type": "array", "items": { "type": "string" } }, "playerstatistic": { "type": "array", "items": { "type": "string" } }, "playerstatisticdetail": { "type": "array", "items": { "type": "string" } }, "playerteam": { "type": "array", "items": { "type": "string" } }, "position": { "type": "array" }, "predictability": { "type": "array", "items": { "type": "string" } }, "predictedlineup": { "type": "array", "items": { "type": "string" } }, "prediction": { "type": "array", "items": { "type": "string" } }, "pressure": { "type": "array" }, "provider": { "type": "array" }, "ranking": { "type": "array" }, "referee": { "type": "array", "items": { "type": "string" } }, "refereestatistic": { "type": "array", "items": { "type": "string" } }, "refereestatisticdetail": { "type": "array", "items": { "type": "string" } }, "rival": { "type": "array" }, "round": { "type": "array", "items": { "type": "string" } }, "roundstanding": { "type": "array", "items": { "type": "string" } }, "roundstatistic": { "type": "array", "items": { "type": "string" } }, "score": { "type": "array", "items": { "type": "string" } }, "season": { "type": "array", "items": { "type": "string" } }, "seasonstatistic": { "type": "array", "items": { "type": "string" } }, "seasontopscorer": { "type": "array", "items": { "type": "string" } }, "shotmap": { "type": "array" }, "sidelined": { "type": "array", "items": { "type": "string" } }, "social": { "type": "array" }, "socialchannel": { "type": "array" }, "sport": { "type": "array" }, "stage": { "type": "array", "items": { "type": "string" } }, "stagestatistic": { "type": "array", "items": { "type": "string" } }, "stagetopscorer": { "type": "array", "items": { "type": "string" } }, "standing": { "type": "array", "items": { "type": "string" } }, "standingcorrection": { "type": "array", "items": { "type": "string" } }, "standingdetail": { "type": "array", "items": { "type": "string" } }, "standingform": { "type": "array" }, "standingrule": { "type": "array", "items": { "type": "string" } }, "state": { "type": "array", "items": { "type": "string" } }, "stint": { "type": "array" }, "stintdetail": { "type": "array", "items": { "type": "string" } }, "team": { "type": "array", "items": { "type": "string" } }, "teamoftheweek": { "type": "array", "items": { "type": "string" } }, "teamstatistic": { "type": "array", "items": { "type": "string" } }, "teamstatisticdetail": { "type": "array", "items": { "type": "string" } }, "topscorer": { "type": "array", "items": { "type": "string" } }, "topscorerparticipant": { "type": "array" }, "transfer": { "type": "array", "items": { "type": "string" } }, "transferrumour": { "type": "array", "items": { "type": "string" } }, "trend": { "type": "array", "items": { "type": "string" } }, "trophy": { "type": "array" }, "tvstation": { "type": "array" }, "venue": { "type": "array", "items": { "type": "string" } }, "weatherreport": { "type": "array" }, "bookmaker": { "type": "array" }, "inplayodd": { "type": "array", "items": { "type": "string" } }, "mappingproviderbookmaker": { "type": "array" }, "mappingprovidermarket": { "type": "array" }, "market": { "type": "array" }, "odd": { "type": "array", "items": { "type": "string" } }, "premiumodd": { "type": "array", "items": { "type": "string" } }, "premiumoddhistory": { "type": "array" }, "city": { "type": "array" }, "continent": { "type": "array" }, "country": { "type": "array" }, "region": { "type": "array", "items": { "type": "string" } }, "subtype": { "type": "array" }, "type": { "type": "array" } }, "required": [ "aggregate", "aioverview", "bookmaker", "city", "coach", "coachstatistic", "coachstatisticdetail", "coachteam", "commentary", "continent", "country", "detailedperiod", "event", "expectedlineup", "fixture", "fixtureballposition", "fixtureformation", "fixturereferee", "fixturesidelined", "fixturestatistic", "fixturetvstation", "group", "inplayodd", "lap", "lapdetail", "league", "lineup", "lineupdetail", "livestanding", "mappingproviderbookmaker", "mappingprovidermarket", "market", "matchfact", "medium", "metadata", "newsitem", "newsitemline", "odd", "participant", "participantseasondetail", "participanttrophy", "period", "periodstatistic", "pitstop", "pitstopdetail", "player", "playerstatistic", "playerstatisticdetail", "playerteam", "position", "predictability", "predictedlineup", "prediction", "premiumodd", "premiumoddhistory", "pressure", "provider", "ranking", "referee", "refereestatistic", "refereestatisticdetail", "region", "rival", "round", "roundstanding", "roundstatistic", "score", "season", "seasonstatistic", "seasontopscorer", "shotmap", "sidelined", "social", "socialchannel", "sport", "stage", "stagestatistic", "stagetopscorer", "standing", "standingcorrection", "standingdetail", "standingform", "standingrule", "state", "stint", "stintdetail", "subtype", "team", "teamoftheweek", "teamstatistic", "teamstatisticdetail", "topscorer", "topscorerparticipant", "transfer", "transferrumour", "trend", "trophy", "tvstation", "type", "venue", "weatherreport" ] }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "aioverview": [ "aioverviewTypes" ], "aggregate": [ "aggregateLeagues", "aggregateSeasons" ], "coach": [ "coachCountries", "coachPlayers" ], "coachstatistic": [ "coachstatisticSeasons", "currentseasons" ], "coachstatisticdetail": [ "coachstatisticdetailTypes" ], "coachteam": [], "commentary": [ "commentaryPlayers" ], "detailedperiod": [ "detailedperiodTypes" ], "event": [ "eventTypes", "eventPlayers" ], "expectedlineup": [ "expectedlineupTypes", "expectedlineupPlayers" ], "fixture": [ "fixtureLeagues", "fixtureSeasons" ], "fixtureballposition": [], "fixtureformation": [], "fixturereferee": [ "fixturerefereeTypes" ], "fixturesidelined": [ "fixturesidelinedTypes", "fixturesidelinedPlayers" ], "fixturestatistic": [ "fixturestatisticTypes" ], "fixturetvstation": [ "fixturetvstationCountries" ], "group": [], "lap": [], "lapdetail": [ "lapdetailTypes" ], "league": [ "leagueLeagues", "leagueCountries" ], "lineup": [ "lineupTypes", "lineupPlayers" ], "lineupdetail": [ "lineupdetailTypes", "lineupdetailPlayers" ], "livestanding": [ "livestandingLeagues", "livestandingSeasons" ], "matchfact": [ "matchfactTypes", "participant" ], "medium": [], "metadata": [ "metadataTypes" ], "newsitem": [ "newsitemLeagues" ], "newsitemline": [], "participant": [], "participantseasondetail": [ "participantseasondetailSeasons", "participantseasondetailTypes" ], "participanttrophy": [ "participanttrophyLeagues", "participanttrophySeasons" ], "period": [ "periodTypes" ], "periodstatistic": [ "periodstatisticTypes" ], "pitstop": [], "pitstopdetail": [ "pitstopdetailTypes" ], "player": [ "playerCountries", "genders" ], "playerstatistic": [ "playerstatisticSeasons", "playerstatisticPlayers" ], "playerstatisticdetail": [ "playerstatisticdetailTypes" ], "playerteam": [ "playerteamPlayers" ], "position": [], "predictability": [ "predictabilityLeagues", "predictabilityTypes" ], "predictedlineup": [ "predictedlineupTypes", "predictedlineupPlayers" ], "prediction": [ "predictionTypes" ], "pressure": [], "provider": [], "ranking": [], "referee": [ "refereeCountries" ], "refereestatistic": [ "refereestatisticSeasons", "currentseasons" ], "refereestatisticdetail": [ "refereestatisticdetailTypes" ], "rival": [], "round": [ "roundLeagues", "roundSeasons" ], "roundstanding": [ "roundstandingLeagues", "roundstandingSeasons" ], "roundstatistic": [ "roundstatisticTypes" ], "score": [ "scoreTypes" ], "season": [ "seasonLeagues" ], "seasonstatistic": [ "seasonstatisticSeasons", "seasonstatisticTypes" ], "seasontopscorer": [ "seasontopscorerSeasons", "seasontopscorerTypes" ], "shotmap": [], "sidelined": [ "sidelinedSeasons", "sidelinedTypes" ], "social": [], "socialchannel": [], "sport": [], "stage": [ "stageLeagues", "stageSeasons" ], "stagestatistic": [ "stagestatisticTypes", "stagestatisticStages" ], "stagetopscorer": [ "stagetopscorerSeasons", "stagetopscorerTypes" ], "standing": [ "standingLeagues", "standingSeasons" ], "standingcorrection": [ "standingcorrectionSeasons", "standingcorrectionTypes" ], "standingdetail": [ "standingdetailTypes" ], "standingform": [], "standingrule": [ "standingruleTypes" ], "state": [ "stateTypes" ], "stint": [], "stintdetail": [ "stintdetailTypes" ], "team": [ "teamCountries", "genders" ], "teamoftheweek": [ "teamoftheweekPlayers" ], "teamstatistic": [ "teamstatisticSeasons", "currentseasons" ], "teamstatisticdetail": [ "teamstatisticdetailTypes" ], "topscorer": [ "topscorerSeasons", "topscorerTypes" ], "topscorerparticipant": [], "transfer": [ "transferTypes", "transferPlayers" ], "transferrumour": [ "transferrumourTypes", "transferrumourPlayers" ], "trend": [ "trendTypes" ], "trophy": [], "tvstation": [], "venue": [ "venueCountries" ], "weatherreport": [], "bookmaker": [], "inplayodd": [ "markets", "bookmakers" ], "mappingproviderbookmaker": [], "mappingprovidermarket": [], "market": [], "odd": [ "markets", "bookmakers" ], "premiumodd": [ "markets", "bookmakers" ], "premiumoddhistory": [], "city": [], "continent": [], "country": [], "region": [ "regionCountries" ], "subtype": [], "type": [] }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all types available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/core-api/endpoints/filters/get-all-entity-filters\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/endpoints/filters/get-all-entity-filters)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/endpoints/filters/get-all-entity-filters", "description": "Sportmonks docs" } } }, "/core/regions": { "get": { "operationId": "getAllRegions", "summary": "All Regions", "tags": [ "Regions" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API with more data by using includes\n\nAllowed values: country, cities. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=country;cities`.", "schema": { "type": "string" }, "x-includes": [ "country", "cities" ], "x-include-depth-max": 3, "example": "country;cities" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity\n\nSelectable fields: id, country_id, name. Pass as a comma-separated list, e.g. `select=id,country_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "country_id", "name" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "country_id", "name" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "GET All Regions", "description": "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.", "example": "&filters=IdAfter:regionID" } ], "x-filters-dynamic": [ { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter regions and more based on countries.", "example": "&include=countries&filters= regionCountries:countryIDS" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "GET All Regions", "description": "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.", "example": "&filters=IdAfter:regionID" }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter regions and more based on countries.", "example": "&include=countries&filters= regionCountries:countryIDS" } ] }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Region" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "country_id": 107, "name": "Al Qadisiyah" }, { "id": 2, "country_id": 802, "name": "HaTsafon" }, { "id": 3, "country_id": 3483, "name": "Hawaii" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/core/regions?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the regions available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/core-api/endpoints/regions/get-all-regions\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/endpoints/regions/get-all-regions)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/endpoints/regions/get-all-regions", "description": "Sportmonks docs" } } }, "/core/regions/{regionId}": { "get": { "operationId": "getRegionById", "summary": "Region by ID", "tags": [ "Regions" ], "parameters": [ { "name": "regionId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the region you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API with more data by using includes\n\nAllowed values: country, cities. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=country;cities`.", "schema": { "type": "string" }, "x-includes": [ "country", "cities" ], "x-include-depth-max": 3, "example": "country;cities" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity\n\nSelectable fields: id, country_id, name. Pass as a comma-separated list, e.g. `select=id,country_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "country_id", "name" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "country_id", "name" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: countryRegions, cityREgions. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter regions and more based on countries.", "example": "&include=countries&filters=countryRegions:countryIDS" }, { "entity": "leagues", "use": "Check this endpoint for all possibilities.", "description": "Filter regions and more based on cities.", "example": "&include=cities&filters=cityREgions:cityIDS" } ], "x-filters": [ { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter regions and more based on countries.", "example": "&include=countries&filters=countryRegions:countryIDS", "name": "countryRegions" }, { "kind": "dynamic", "entity": "leagues", "use": "Check this endpoint for all possibilities.", "description": "Filter regions and more based on cities.", "example": "&include=cities&filters=cityREgions:cityIDS", "name": "cityREgions" } ] } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Region" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 1, "country_id": 107, "name": "Al Qadisiyah" }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns information from your requested region ID. For more information, please visit:https://docs.sportmonks.com/football/core-api/endpoints/regions/get-region-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/endpoints/regions/get-region-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/endpoints/regions/get-region-by-id", "description": "Sportmonks docs" } } }, "/core/regions/search/{name}": { "get": { "operationId": "getRegionsBySearch", "summary": "Regions by Search", "tags": [ "Regions" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name you want to search on." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API with more data by using includes\n\nAllowed values: country, cities. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=country;cities`.", "schema": { "type": "string" }, "x-includes": [ "country", "cities" ], "x-include-depth-max": 3, "example": "country;cities" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity\n\nSelectable fields: id, country_id, name. Pass as a comma-separated list, e.g. `select=id,country_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "country_id", "name" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "country_id", "name" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: countryRegions, cityREgions. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter regions and more based on countries.", "example": "&include=countries&filters=countryRegions:countryIDS" }, { "entity": "leagues", "use": "Check this endpoint for all possibilities.", "description": "Filter regions and more based on cities.", "example": "&include=cities&filters=cityREgions:cityIDS" } ], "x-filters": [ { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter regions and more based on countries.", "example": "&include=countries&filters=countryRegions:countryIDS", "name": "countryRegions" }, { "kind": "dynamic", "entity": "leagues", "use": "Check this endpoint for all possibilities.", "description": "Filter regions and more based on cities.", "example": "&include=cities&filters=cityREgions:cityIDS", "name": "cityREgions" } ] }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Region" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 47, "country_id": 462, "name": "England" } ], "pagination": { "count": 1, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns region information that matches your search query. For more information, please visit:https://docs.sportmonks.com/football/core-api/endpoints/regions/get-regions-by-search\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/endpoints/regions/get-regions-by-search)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/endpoints/regions/get-regions-by-search", "description": "Sportmonks docs" } } }, "/core/timezones": { "get": { "operationId": "getAllSupportedTimeZones", "summary": "All Supported Time Zones", "tags": [ "Timezones" ], "parameters": [], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa" ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the available time zones that are supported by the API. For more information, please visit:https://docs.sportmonks.com/football/core-api/endpoints/timezones/get-all-supported-time-zones\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/endpoints/timezones/get-all-supported-time-zones)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/endpoints/timezones/get-all-supported-time-zones", "description": "Sportmonks docs" } } }, "/core/types": { "get": { "operationId": "getAllTypes", "summary": "All Types", "tags": [ "Types" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, name, code, developer_name, stat_group, model_type. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "code", "developer_name", "stat_group", "model_type" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name", "code", "developer_name", "stat_group", "model_type" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns types ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Type" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "name": "1st Half", "code": "1st-half", "developer_name": "1ST_HALF", "model_type": "period", "stat_group": null }, { "id": 2, "name": "2nd Half", "code": "2nd-half", "developer_name": "2ND_HALF", "model_type": "period", "stat_group": null }, { "id": 3, "name": "Extra Time", "code": "extra-time", "developer_name": "ET", "model_type": "period", "stat_group": null } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/core/types?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all types available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/types/get-all-types\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/types/get-all-types)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/types/get-all-types", "description": "Sportmonks docs" } } }, "/core/types/entities": { "get": { "operationId": "getTypeByEntity", "summary": "Type by Entity", "tags": [ "Types" ], "parameters": [], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "CoachStatisticDetail": { "type": "object", "properties": { "updated_at": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601)." }, "types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "developer_name": { "type": "string" }, "model_type": { "type": "string" }, "stat_group": { "type": [ "null", "string" ] } }, "required": [ "code", "developer_name", "id", "model_type", "name", "stat_group" ] } } }, "required": [ "types", "updated_at" ] }, "Event": { "type": "object", "properties": { "updated_at": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601)." }, "types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "developer_name": { "type": "string" }, "model_type": { "type": "string" }, "stat_group": { "type": [ "null", "string" ] } }, "required": [ "code", "developer_name", "id", "model_type", "name", "stat_group" ] } } }, "required": [ "types", "updated_at" ] }, "FixtureStatistic": { "type": "object", "properties": { "updated_at": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601)." }, "types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "developer_name": { "type": "string" }, "model_type": { "type": "string" }, "stat_group": { "type": "string" } }, "required": [ "code", "developer_name", "id", "model_type", "name", "stat_group" ] } } }, "required": [ "types", "updated_at" ] }, "Lineup": { "type": "object", "properties": { "updated_at": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601)." }, "types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "developer_name": { "type": "string" }, "model_type": { "type": "string" }, "stat_group": { "type": "null" } }, "required": [ "code", "developer_name", "id", "model_type", "name", "stat_group" ] } } }, "required": [ "types", "updated_at" ] }, "PeriodStatistic": { "type": "object", "properties": { "updated_at": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601)." }, "types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "developer_name": { "type": "string" }, "model_type": { "type": "string" }, "stat_group": { "type": "string" } }, "required": [ "code", "developer_name", "id", "model_type", "name", "stat_group" ] } } }, "required": [ "types", "updated_at" ] }, "PlayerStatisticDetail": { "type": "object", "properties": { "updated_at": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601)." }, "types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "developer_name": { "type": "string" }, "model_type": { "type": "string" }, "stat_group": { "type": [ "null", "string" ] } }, "required": [ "code", "developer_name", "id", "model_type", "name", "stat_group" ] } } }, "required": [ "types", "updated_at" ] }, "Prediction": { "type": "object", "properties": { "updated_at": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601)." }, "types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "developer_name": { "type": "string" }, "model_type": { "type": "string" }, "stat_group": { "type": "null" } }, "required": [ "code", "developer_name", "id", "model_type", "name", "stat_group" ] } } }, "required": [ "types", "updated_at" ] }, "RefereeStatisticDetail": { "type": "object", "properties": { "updated_at": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601)." }, "types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "developer_name": { "type": "string" }, "model_type": { "type": "string" }, "stat_group": { "type": [ "null", "string" ] } }, "required": [ "code", "developer_name", "id", "model_type", "name", "stat_group" ] } } }, "required": [ "types", "updated_at" ] }, "SeasonStatistic": { "type": "object", "properties": { "updated_at": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601)." }, "types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "developer_name": { "type": "string" }, "model_type": { "type": "string" }, "stat_group": { "type": [ "null", "string" ] } }, "required": [ "code", "developer_name", "id", "model_type", "name", "stat_group" ] } } }, "required": [ "types", "updated_at" ] }, "StageStatistic": { "type": "object", "properties": { "updated_at": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601)." }, "types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "developer_name": { "type": "string" }, "model_type": { "type": "string" }, "stat_group": { "type": [ "null", "string" ] } }, "required": [ "code", "developer_name", "id", "model_type", "name", "stat_group" ] } } }, "required": [ "types", "updated_at" ] }, "TeamStatisticDetail": { "type": "object", "properties": { "updated_at": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601)." }, "types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "developer_name": { "type": "string" }, "model_type": { "type": "string" }, "stat_group": { "type": [ "null", "string" ] } }, "required": [ "code", "developer_name", "id", "model_type", "name", "stat_group" ] } } }, "required": [ "types", "updated_at" ] } }, "required": [ "CoachStatisticDetail", "Event", "FixtureStatistic", "Lineup", "PeriodStatistic", "PlayerStatisticDetail", "Prediction", "RefereeStatisticDetail", "SeasonStatistic", "StageStatistic", "TeamStatisticDetail" ] }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "CoachStatisticDetail": { "updated_at": "2026-05-06T12:00:41.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" } ] }, "Event": { "updated_at": "2026-05-06T12:00:43.000000Z", "types": [ { "id": 10, "name": "VAR", "code": "VAR", "developer_name": "VAR", "model_type": "event", "stat_group": null }, { "id": 14, "name": "Goal", "code": "goal", "developer_name": "GOAL", "model_type": "event", "stat_group": null } ] }, "FixtureStatistic": { "updated_at": "2026-05-06T12:00:48.000000Z", "types": [ { "id": 34, "name": "Corners", "code": "corners", "developer_name": "CORNERS", "model_type": "statistic", "stat_group": "offensive" }, { "id": 41, "name": "Shots Off Target", "code": "shots-off-target", "developer_name": "SHOTS_OFF_TARGET", "model_type": "statistic", "stat_group": "offensive" } ] }, "Lineup": { "updated_at": "2026-05-06T12:00:57.000000Z", "types": [ { "id": 11, "name": "Lineup", "code": "lineup", "developer_name": "LINEUP", "model_type": "lineup", "stat_group": null }, { "id": 12, "name": "Bench", "code": "bench", "developer_name": "BENCH", "model_type": "lineup", "stat_group": null } ] }, "PeriodStatistic": { "updated_at": "2026-05-06T12:00:51.000000Z", "types": [ { "id": 34, "name": "Corners", "code": "corners", "developer_name": "CORNERS", "model_type": "statistic", "stat_group": "offensive" }, { "id": 41, "name": "Shots Off Target", "code": "shots-off-target", "developer_name": "SHOTS_OFF_TARGET", "model_type": "statistic", "stat_group": "offensive" } ] }, "PlayerStatisticDetail": { "updated_at": "2026-05-06T12:00:55.000000Z", "types": [ { "id": 40, "name": "Captain", "code": "captain", "developer_name": "CAPTAIN", "model_type": "statistic", "stat_group": "overall" }, { "id": 41, "name": "Shots Off Target", "code": "shots-off-target", "developer_name": "SHOTS_OFF_TARGET", "model_type": "statistic", "stat_group": "offensive" } ] }, "Prediction": { "updated_at": "2026-05-06T12:00:56.000000Z", "types": [ { "id": 33, "name": "Valuebet", "code": "valuebet", "developer_name": "VALUEBET", "model_type": "prediction", "stat_group": null }, { "id": 231, "name": "Both Teams To Score Probability", "code": "both-teams-to-score-probability", "developer_name": "BTTS_PROBABILITY", "model_type": "prediction", "stat_group": null } ] }, "RefereeStatisticDetail": { "updated_at": "2026-05-06T12:00:53.000000Z", "types": [ { "id": 47, "name": "Penalties", "code": "penalties", "developer_name": "PENALTIES", "model_type": "statistic", "stat_group": "offensive" }, { "id": 56, "name": "Fouls", "code": "fouls", "developer_name": "FOULS", "model_type": "statistic", "stat_group": "defensive" } ] }, "SeasonStatistic": { "updated_at": "2026-05-06T12:00:54.000000Z", "types": [ { "id": 34, "name": "Corners", "code": "corners", "developer_name": "CORNERS", "model_type": "statistic", "stat_group": "offensive" }, { "id": 43, "name": "Attacks", "code": "attacks", "developer_name": "ATTACKS", "model_type": "statistic", "stat_group": "offensive" } ] }, "StageStatistic": { "updated_at": "2026-05-06T12:00:54.000000Z", "types": [ { "id": 34, "name": "Corners", "code": "corners", "developer_name": "CORNERS", "model_type": "statistic", "stat_group": "offensive" }, { "id": 43, "name": "Attacks", "code": "attacks", "developer_name": "ATTACKS", "model_type": "statistic", "stat_group": "offensive" } ] }, "TeamStatisticDetail": { "updated_at": "2026-05-06T12:00:56.000000Z", "types": [ { "id": 194, "name": "Cleansheets", "code": "cleansheets", "developer_name": "CLEANSHEET", "model_type": "statistic", "stat_group": null }, { "id": 196, "name": "Scoring Minutes", "code": "scoring-minutes", "developer_name": "SCORING_MINUTES", "model_type": "statistic", "stat_group": null } ] } }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns types which are available per entity. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/types/get-type-by-entity\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/types/get-type-by-entity)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/types/get-type-by-entity", "description": "Sportmonks docs" } } }, "/core/types/{typeId}": { "get": { "operationId": "getTypeById", "summary": "Type by ID", "tags": [ "Types" ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the type you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, name, code, developer_name, model_type. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "code", "developer_name", "model_type" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name", "code", "developer_name", "model_type" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Type" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 1, "name": "1st Half", "code": "1st-half", "developer_name": "1ST_HALF", "model_type": "period", "stat_group": null }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all types available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/types/get-type-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/types/get-type-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/types/get-type-by-id", "description": "Sportmonks docs" } } }, "/football/coaches": { "get": { "operationId": "getAllCoaches", "summary": "All Coaches", "tags": [ "Coaches" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, teams, statistics, nationality, trophies, player, fixtures. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "teams", "statistics", "nationality", "trophies", "player", "fixtures" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, player_id, sport_id, country_id, nationality_id, city_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender. Pass as a comma-separated list, e.g. `select=id,player_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "player_id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "player_id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, coachstatisticdetailTypes, coachCountries, coachstatisticSeasons. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "Coaches", "description": "Filter all coaches starting from a certain coach ID. Handy if you're doing an import for all coaches and want to continue from a certain ID.", "example": "&filters=IdAfter:coachID &filters=IdAfter:153" } ], "x-filters-dynamic": [ { "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the coach statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=coachstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=coachstatisticdetailTypes:59" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter coaches based on countries.", "example": "&include=country&filters=coachCountries:countryIDS &include=country&filters=coachCountries:462" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter coach statistics based on seasons.", "example": "&include=statistics.details.type&filters=coachstatisticSeasons:seasonIDS &include=statistics.details.type&filters=coachstatisticSeasons:19735" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "Coaches", "description": "Filter all coaches starting from a certain coach ID. Handy if you're doing an import for all coaches and want to continue from a certain ID.", "example": "&filters=IdAfter:coachID &filters=IdAfter:153" }, { "kind": "dynamic", "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the coach statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=coachstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=coachstatisticdetailTypes:59", "name": "coachstatisticdetailTypes", "names": [ "coachstatisticdetailTypes", "coachstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter coaches based on countries.", "example": "&include=country&filters=coachCountries:countryIDS &include=country&filters=coachCountries:462", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter coach statistics based on seasons.", "example": "&include=statistics.details.type&filters=coachstatisticSeasons:seasonIDS &include=statistics.details.type&filters=coachstatisticSeasons:19735", "name": "coachstatisticSeasons", "names": [ "coachstatisticSeasons", "coachstatisticSeasons" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns choaches ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Coach" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 2, "player_id": 2, "sport_id": 1, "country_id": 462, "nationality_id": 462, "city_id": null, "common_name": "R. Fowler", "firstname": "Robbie", "lastname": "Fowler", "name": "Robbie Fowler", "display_name": "Robbie Fowler", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": 170, "weight": 75, "date_of_birth": "1975-04-09", "gender": "male" }, { "id": 3, "player_id": 3, "sport_id": 1, "country_id": 462, "nationality_id": 462, "city_id": null, "common_name": "C. Morgan", "firstname": "Chris", "lastname": "Morgan", "name": "Chris Morgan", "display_name": "Chris Morgan", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": 185, "weight": 77, "date_of_birth": "1977-09-11", "gender": "male" }, { "id": 4, "player_id": 4, "sport_id": 1, "country_id": 38, "nationality_id": null, "city_id": null, "common_name": "J. Kromkamp", "firstname": "Jan", "lastname": "Kromkamp", "name": "Jan Kromkamp", "display_name": "Jan Kromkamp", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": 184, "weight": 83, "date_of_birth": "1980-08-17", "gender": "male" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/coaches?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the coaches available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/coaches/get-all-coaches\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/coaches/get-all-coaches)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/coaches/get-all-coaches", "description": "Sportmonks docs" } } }, "/football/coaches/{coachId}": { "get": { "operationId": "getCoachById", "summary": "Coach by ID", "tags": [ "Coaches" ], "parameters": [ { "name": "coachId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the coach you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, teams, statistics, nationality, trophies, player, fixtures. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "teams", "statistics", "nationality", "trophies", "player", "fixtures" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, player_id, sport_id, country_id, nationality_id, city_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender. Pass as a comma-separated list, e.g. `select=id,player_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "player_id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "player_id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: coachstatisticdetailTypes, coachstatisticSeasons. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the coach statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=coachstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=coachstatisticdetailTypes:59" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter coach statistics based on seasons.", "example": "&include=statistics.details.type&filters=coachstatisticSeasons:seasonIDS &include=statistics.details.type&filters=coachstatisticSeasons:19735" } ], "x-filters": [ { "kind": "dynamic", "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the coach statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=coachstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=coachstatisticdetailTypes:59", "name": "coachstatisticdetailTypes", "names": [ "coachstatisticdetailTypes", "coachstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter coach statistics based on seasons.", "example": "&include=statistics.details.type&filters=coachstatisticSeasons:seasonIDS &include=statistics.details.type&filters=coachstatisticSeasons:19735", "name": "coachstatisticSeasons", "names": [ "coachstatisticSeasons", "coachstatisticSeasons" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Coach" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 23180, "player_id": 23180, "sport_id": 1, "country_id": 38, "nationality_id": 38, "city_id": null, "common_name": "A. Slot", "firstname": "Arne", "lastname": "Slot", "name": "Arne Slot", "display_name": "Arne Slot", "image_path": "https://cdn.sportmonks.com/images/soccer/players/12/23180.png", "height": 185, "weight": 75, "date_of_birth": "1978-09-17", "gender": "male" }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns coach information from your requested coach ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/coaches/get-coach-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/coaches/get-coach-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/coaches/get-coach-by-id", "description": "Sportmonks docs" } } }, "/football/coaches/countries/{countryId}": { "get": { "operationId": "getCoachesByCountryId", "summary": "Coaches by Country ID", "tags": [ "Coaches" ], "parameters": [ { "name": "countryId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the country you want to retrieve coaches from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, teams, statistics, nationality, trophies, player, fixtures. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "teams", "statistics", "nationality", "trophies", "player", "fixtures" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, player_id, sport_id, country_id, nationality_id, city_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender. Pass as a comma-separated list, e.g. `select=id,player_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "player_id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "player_id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: coachstatisticdetailTypes, coachstatisticSeasons. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the coach statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=coachstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=coachstatisticdetailTypes:59" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter coach statistics based on seasons.", "example": "&include=statistics.details.type&filters=coachstatisticSeasons:seasonIDS &include=statistics.details.type&filters=coachstatisticSeasons:19735" } ], "x-filters": [ { "kind": "dynamic", "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the coach statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=coachstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=coachstatisticdetailTypes:59", "name": "coachstatisticdetailTypes", "names": [ "coachstatisticdetailTypes", "coachstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter coach statistics based on seasons.", "example": "&include=statistics.details.type&filters=coachstatisticSeasons:seasonIDS &include=statistics.details.type&filters=coachstatisticSeasons:19735", "name": "coachstatisticSeasons", "names": [ "coachstatisticSeasons", "coachstatisticSeasons" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Coach" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1577, "player_id": 1577, "sport_id": 1, "country_id": 2, "nationality_id": 2, "city_id": null, "common_name": "M. Saganowski", "firstname": "Marek", "lastname": "Saganowski", "name": "Marek Saganowski", "display_name": "Marek Saganowski", "image_path": "https://cdn.sportmonks.com/images/soccer/players/9/1577.png", "height": 178, "weight": 81, "date_of_birth": "1978-10-31", "gender": "male" }, { "id": 2346, "player_id": 2346, "sport_id": 1, "country_id": 2, "nationality_id": null, "city_id": null, "common_name": "S. Peszko", "firstname": "Sławomir", "lastname": "Peszko", "name": "Sławomir Peszko", "display_name": "Sławomir Peszko", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": 173, "weight": 70, "date_of_birth": "1985-02-19", "gender": "male" }, { "id": 7436, "player_id": 7436, "sport_id": 1, "country_id": 2, "nationality_id": 2, "city_id": null, "common_name": "P. Abbott", "firstname": "Pawel", "lastname": "Abbott", "name": "Pawel Abbott", "display_name": "Paweł Abbott", "image_path": "https://cdn.sportmonks.com/images/soccer/players/12/7436.png", "height": 189, "weight": 95, "date_of_birth": "1982-05-05", "gender": "male" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/coaches/countries/2?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns coach information from your requested country ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/coaches/get-coaches-by-country-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/coaches/get-coaches-by-country-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/coaches/get-coaches-by-country-id", "description": "Sportmonks docs" } } }, "/football/coaches/search/{name}": { "get": { "operationId": "getCoachesSearchByName", "summary": "Coaches Search by Name", "tags": [ "Coaches" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name you want to search on." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, teams, statistics, nationality, trophies, player, fixtures. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "teams", "statistics", "nationality", "trophies", "player", "fixtures" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, player_id, sport_id, country_id, nationality_id, city_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender. Pass as a comma-separated list, e.g. `select=id,player_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "player_id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "player_id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: coachstatisticdetailTypes, coachstatisticSeasons. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the coach statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=coachstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=coachstatisticdetailTypes:59" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter coach statistics based on seasons.", "example": "&include=statistics.details.type&filters=coachstatisticSeasons:seasonIDS &include=statistics.details.type&filters=coachstatisticSeasons:19735" } ], "x-filters": [ { "kind": "dynamic", "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the coach statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=coachstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=coachstatisticdetailTypes:59", "name": "coachstatisticdetailTypes", "names": [ "coachstatisticdetailTypes", "coachstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter coach statistics based on seasons.", "example": "&include=statistics.details.type&filters=coachstatisticSeasons:seasonIDS &include=statistics.details.type&filters=coachstatisticSeasons:19735", "name": "coachstatisticSeasons", "names": [ "coachstatisticSeasons", "coachstatisticSeasons" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns choaches ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Coach" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 455361, "player_id": 455361, "sport_id": 1, "country_id": 32, "nationality_id": 32, "city_id": null, "common_name": "Josep Guardiola", "firstname": "Josep", "lastname": "Guardiola i Sala", "name": "Josep Guardiola i Sala", "display_name": "Pep Guardiola", "image_path": "https://cdn.sportmonks.com/images/soccer/players/1/455361.png", "height": 180, "weight": 70, "date_of_birth": "1971-01-18", "gender": "male" }, { "id": 27431212, "player_id": 27431212, "sport_id": 1, "country_id": 17, "nationality_id": 17, "city_id": null, "common_name": "F. Guardiola", "firstname": "Frank", "lastname": "Guardiola", "name": "Frank Guardiola", "display_name": "Frank Guardiola", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": null, "gender": "male" } ], "pagination": { "count": 2, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the coaches that match your search query. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/coaches/get-coaches-search-by-name\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/coaches/get-coaches-search-by-name)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/coaches/get-coaches-search-by-name", "description": "Sportmonks docs" } } }, "/football/coaches/latest": { "get": { "operationId": "getLastUpdatedCoaches", "summary": "Last Updated Coaches", "tags": [ "Coaches" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, teams, statistics, nationality, trophies, player, fixtures. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "teams", "statistics", "nationality", "trophies", "player", "fixtures" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, player_id, sport_id, country_id, nationality_id, city_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender. Pass as a comma-separated list, e.g. `select=id,player_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "player_id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "player_id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: coachstatisticdetailTypes, coachstatisticSeasons. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the coach statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=coachstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=coachstatisticdetailTypes:59" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter coach statistics based on seasons.", "example": "&include=statistics.details.type&filters=coachstatisticSeasons:seasonIDS &include=statistics.details.type&filters=coachstatisticSeasons:19735" } ], "x-filters": [ { "kind": "dynamic", "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the coach statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=coachstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=coachstatisticdetailTypes:59", "name": "coachstatisticdetailTypes", "names": [ "coachstatisticdetailTypes", "coachstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter coach statistics based on seasons.", "example": "&include=statistics.details.type&filters=coachstatisticSeasons:seasonIDS &include=statistics.details.type&filters=coachstatisticSeasons:19735", "name": "coachstatisticSeasons", "names": [ "coachstatisticSeasons", "coachstatisticSeasons" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Coach" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 37647637, "player_id": null, "sport_id": 1, "country_id": 5, "nationality_id": 5, "city_id": null, "common_name": "W. Teixeira Borges Heiler", "firstname": "Willian", "lastname": "Teixeira Borges Heiler", "name": "Willian Teixeira Borges Heiler", "display_name": "Willian Teixeira Borges Heiler", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": "2000-02-18", "gender": "male" }, { "id": 37647638, "player_id": null, "sport_id": 1, "country_id": 5, "nationality_id": 5, "city_id": null, "common_name": "Lucas Guarienti", "firstname": "Lucas", "lastname": "do Pinho Guarienti", "name": "Lucas do Pinho Guarienti", "display_name": "Lucas do Pinho Guarienti", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": "1997-11-05", "gender": "male" }, { "id": 37647639, "player_id": null, "sport_id": 1, "country_id": 5, "nationality_id": 5, "city_id": null, "common_name": "C. Leonardo Encarnação", "firstname": "Cristiano", "lastname": "Leonardo Encarnação", "name": "Cristiano Leonardo Encarnação", "display_name": "Cristiano Leonardo Encarnação", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": "1982-10-08", "gender": "male" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the coaches that have received updates in the past two hours. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/coaches/get-last-updated-coaches\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/coaches/get-last-updated-coaches)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/coaches/get-last-updated-coaches", "description": "Sportmonks docs" } } }, "/football/commentaries": { "get": { "operationId": "getAllCommentaries", "summary": "All Commentaries", "tags": [ "Commentaries" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=fixture`.", "schema": { "type": "string" }, "x-includes": [ "fixture" ], "x-include-depth-max": 1, "example": "fixture" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .", "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "Commentary", "description": "Filter all commentaries starting from a certain ID. Handy if you're doing an import for all commentaries and want to continue from a commentary ID.", "example": "&filters=IdAfter:commentaryID" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "Commentary", "description": "Filter all commentaries starting from a certain ID. Handy if you're doing an import for all commentaries and want to continue from a commentary ID.", "example": "&filters=IdAfter:commentaryID" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns commentaries ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Commentary" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "fixture_id": 18444499, "comment": "First Half starts.", "minute": null, "extra_minute": null, "is_goal": false, "is_important": false, "order": 1 }, { "id": 2, "fixture_id": 18444499, "comment": "Corner - Brisbane Roar FC. Conceded by Nicholas Pennington.", "minute": 2, "extra_minute": null, "is_goal": false, "is_important": false, "order": 2 }, { "id": 3, "fixture_id": 18444499, "comment": "Shot blocked. Ryo Wada - Brisbane Roar FC - shot with left foot from outside the box is blocked.", "minute": 7, "extra_minute": null, "is_goal": false, "is_important": false, "order": 3 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/commentaries?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns a textual representation from the requested fixture ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/commentaries/get-all-commentaries\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/commentaries/get-all-commentaries)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/commentaries/get-all-commentaries", "description": "Sportmonks docs" } } }, "/football/commentaries/fixtures/{fixtureId}": { "get": { "operationId": "getCommentariesByFixtureId", "summary": "Commentaries by Fixture ID", "tags": [ "Commentaries" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the fixture you want to retrieve commentaries from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: fixture, player, relatedPlayer. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=fixture;player`.", "schema": { "type": "string" }, "x-includes": [ "fixture", "player", "relatedPlayer" ], "x-include-depth-max": 1, "example": "fixture;player" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .", "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Commentary" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 10602953, "fixture_id": 19427201, "comment": "Foul committed by Dominik Szoboszlai of Liverpool.", "minute": 15, "extra_minute": null, "is_goal": false, "is_important": false, "order": 16856415 }, { "id": 10603054, "fixture_id": 19427201, "comment": "Curtis Jones commits a handball for Liverpool.", "minute": 22, "extra_minute": null, "is_goal": false, "is_important": false, "order": 16856493 }, { "id": 10603052, "fixture_id": 19427201, "comment": "Daniel Muñoz of Crystal Palace receives a yellow card for a bad foul.", "minute": 19, "extra_minute": null, "is_goal": false, "is_important": true, "order": 16856491 } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns a textual representation from the requested fixture ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/commentaries/get-commentaries-by-fixture-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/commentaries/get-commentaries-by-fixture-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/commentaries/get-commentaries-by-fixture-id", "description": "Sportmonks docs" } } }, "/football/expected/lineups": { "get": { "operationId": "getExpectedByPlayer", "summary": "Expected by Player", "tags": [ "Expected" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API with more data by using includes\n\nAllowed values: type, fixture, player, team. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=type;fixture`.", "schema": { "type": "string" }, "x-includes": [ "type", "fixture", "player", "team" ], "x-include-depth-max": 3, "example": "type;fixture" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity.\n\nSelectable fields: id, fixture_id, player_id, lineup_id, type_id, value. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "player_id", "lineup_id", "type_id", "value" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "player_id", "lineup_id", "type_id", "value" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: lineupDetailTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "Types", "use": "LineupDetail", "description": "Filters the player statistics on a specific type separated by commas.", "example": "&filters=lineupDetailTypes:TypeIDs &filters=lineupDetailTypes:5304" } ], "x-filters": [ { "kind": "dynamic", "entity": "Types", "use": "LineupDetail", "description": "Filters the player statistics on a specific type separated by commas.", "example": "&filters=lineupDetailTypes:TypeIDs &filters=lineupDetailTypes:5304", "name": "lineupDetailTypes", "names": [ "lineupDetailTypes", "lineupDetailTypes" ] } ] }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Expected" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 2063740120, "fixture_id": 19664354, "player_id": null, "team_id": 18272, "lineup_id": 14673807548, "type_id": 1535, "data": { "value": 1 } }, { "id": 2063740119, "fixture_id": 19614333, "player_id": 33165760, "team_id": 2276, "lineup_id": 14673809040, "type_id": 56, "data": { "value": 1 } }, { "id": 2063740118, "fixture_id": 19614333, "player_id": 109142, "team_id": 2276, "lineup_id": 14673809038, "type_id": 51, "data": { "value": 1 } } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/expected/lineups?order=desc&page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint allows you to get all the xG values we have available per player (lineup). For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/expected-xg/get-expected-by-player\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/expected-xg/get-expected-by-player)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/expected-xg/get-expected-by-player", "description": "Sportmonks docs" } } }, "/football/expected/fixtures": { "get": { "operationId": "getExpectedByTeam", "summary": "Expected by Team", "tags": [ "Expected" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API with more data by using includes\n\nAllowed values: type, fixture, participant. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=type;fixture`.", "schema": { "type": "string" }, "x-includes": [ "type", "fixture", "participant" ], "x-include-depth-max": 3, "example": "type;fixture" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity.\n\nSelectable fields: id, fixture_id, type_id, participant_id, value, location. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "type_id", "participant_id", "value", "location" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "type_id", "participant_id", "value", "location" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: fixtureStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics", "description": "Filter the statistics on a selection of type IDs separated by a comma.", "example": "&include=statistics&filters=fixtureStatisticTypes:TYPEIDS &include=statistics&filters=fixtureStatisticTypes:42,49" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics", "description": "Filter the statistics on a selection of type IDs separated by a comma.", "example": "&include=statistics&filters=fixtureStatisticTypes:TYPEIDS &include=statistics&filters=fixtureStatisticTypes:42,49", "name": "fixtureStatisticTypes", "names": [ "fixtureStatisticTypes", "fixtureStatisticTypes" ] } ] }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Expected" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 894332039, "fixture_id": 19630308, "type_id": 64, "participant_id": 3690, "data": { "value": 1 }, "location": "home" }, { "id": 894332038, "fixture_id": 19630308, "type_id": 64, "participant_id": 17806, "data": { "value": 0 }, "location": "away" }, { "id": 894329677, "fixture_id": 19665484, "type_id": 9686, "participant_id": 4017, "data": { "value": 0.0102 }, "location": "away" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/expected/fixtures?order=desc&page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint allows you to get all the xG values we have available per team. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/expected-xg/get-expected-by-team\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/expected-xg/get-expected-by-team)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/expected-xg/get-expected-by-team", "description": "Sportmonks docs" } } }, "/football/fixtures": { "get": { "operationId": "getAllFixtures", "summary": "All Fixtures", "tags": [ "Fixtures" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, round, stage, group, aggregate, league, season, coaches, tvStations, venue, state, weatherReport, lineups, events, timeline, comments, trends, statistics, periods, currentPeriod, participants, odds, premiumOdds, inplayOdds, prematchNews, postmatchNews, metadata, sidelined, predictions, referees, formations, ballCoordinates, scores, xGFixture, pressure, expectedLineups, matchfacts. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;round`.", "schema": { "type": "string" }, "x-includes": [ "sport", "round", "stage", "group", "aggregate", "league", "season", "coaches", "tvStations", "venue", "state", "weatherReport", "lineups", "events", "timeline", "comments", "trends", "statistics", "periods", "currentPeriod", "participants", "odds", "premiumOdds", "inplayOdds", "prematchNews", "postmatchNews", "metadata", "sidelined", "predictions", "referees", "formations", "ballCoordinates", "scores", "xGFixture", "pressure", "expectedLineups", "matchfacts" ], "x-include-depth-max": 3, "example": "sport;round" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, stage_id, group_id, aggregate_id, state_id, round_id, venue_id, name, starting_at, result_info, leg, details, length. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: participantSearch, todayDate, venues, Deleted, IdAfter, markets, bookmakers, WinningOdds, fixturestatisticTypes, eventTypes, lineupdetailTypes, fixtureStates, fixtureLeagues, fixtureGroups, coachCountries, seasonStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "name": "IdAfter", "use": "All", "description": "Filter all fixtures starting from a certain fixture ID. Handy when you are only interested in the most recent fixtures.", "example": "&filters=IdAfter:fixtureID &filters=IdAfter:18535487" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118" }, { "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52" } ], "x-filters": [ { "kind": "static", "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "kind": "static", "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "kind": "static", "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "kind": "static", "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all fixtures starting from a certain fixture ID. Handy when you are only interested in the most recent fixtures.", "example": "&filters=IdAfter:fixtureID &filters=IdAfter:18535487" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118", "name": "fixturestatisticTypes", "names": [ "fixturestatisticTypes", "fixturestatisticTypes", "eventTypes", "lineupdetailTypes" ] }, { "kind": "dynamic", "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1", "name": "fixtureStates", "names": [ "fixtureStates", "fixtureStates" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271", "name": "fixtureLeagues", "names": [ "fixtureLeagues", "fixtureLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691", "name": "fixtureGroups", "names": [ "fixtureGroups", "fixtureGroups" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns fixtures ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fixture" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "sport_id": 1, "league_id": 66, "season_id": 1, "stage_id": 1, "group_id": null, "aggregate_id": null, "round_id": null, "state_id": 5, "venue_id": 1182, "name": "Bridgwater Town vs Bishop's Cleeve", "starting_at": "2013-08-17 14:00:00", "result_info": "Bishop's Cleeve won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 1376748000 }, { "id": 2, "sport_id": 1, "league_id": 66, "season_id": 1, "stage_id": 1, "group_id": null, "aggregate_id": null, "round_id": null, "state_id": 5, "venue_id": 455, "name": "Cinderford Town vs Fleet Town", "starting_at": "2013-08-17 14:00:00", "result_info": "Cinderford Town won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 1376748000 }, { "id": 3, "sport_id": 1, "league_id": 66, "season_id": 1, "stage_id": 1, "group_id": null, "aggregate_id": null, "round_id": null, "state_id": 5, "venue_id": 294, "name": "Evesham United vs Taunton Town", "starting_at": "2013-08-17 14:00:00", "result_info": "Game ended in draw.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 1376748000 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/fixtures?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the fixtures accessible within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-all-fixtures\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-all-fixtures)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-all-fixtures", "description": "Sportmonks docs" } } }, "/football/fixtures/{fixtureId}": { "get": { "operationId": "getFixtureById", "summary": "Fixture by ID", "tags": [ "Fixtures" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the fixture you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, round, stage, group, aggregate, league, season, coaches, tvStations, venue, state, weatherReport, lineups, events, timeline, comments, trends, statistics, periods, participants, odds, premiumOdds, inplayOdds, prematchNews, postmatchNews, metadata, sidelined, predictions, referees, formations, ballCoordinates, scores, xGFixture, pressure, expectedLineups, matchfacts. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;round`.", "schema": { "type": "string" }, "x-includes": [ "sport", "round", "stage", "group", "aggregate", "league", "season", "coaches", "tvStations", "venue", "state", "weatherReport", "lineups", "events", "timeline", "comments", "trends", "statistics", "periods", "participants", "odds", "premiumOdds", "inplayOdds", "prematchNews", "postmatchNews", "metadata", "sidelined", "predictions", "referees", "formations", "ballCoordinates", "scores", "xGFixture", "pressure", "expectedLineups", "matchfacts" ], "x-include-depth-max": 3, "example": "sport;round" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, stage_id, group_id, aggregate_id, state_id, round_id, venue_id, name, starting_at, result_info, leg, details, length. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: markets, bookmakers, WinningOdds, fixturestatisticTypes, eventTypes, lineupdetailTypes, fixtureStates, fixtureLeagues, fixtureGroups, coachCountries, seasonStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118" }, { "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52" } ], "x-filters": [ { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118", "name": "fixturestatisticTypes", "names": [ "fixturestatisticTypes", "fixturestatisticTypes", "eventTypes", "lineupdetailTypes" ] }, { "kind": "dynamic", "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1", "name": "fixtureStates", "names": [ "fixtureStates", "fixtureStates" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271", "name": "fixtureLeagues", "names": [ "fixtureLeagues", "fixtureLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691", "name": "fixtureGroups", "names": [ "fixtureGroups", "fixtureGroups" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fixture" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 19427201, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "aggregate_id": null, "round_id": 372150, "state_id": 5, "venue_id": 230, "name": "Liverpool vs Crystal Palace", "starting_at": "2026-04-25 14:00:00", "result_info": "Liverpool won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1777125600 }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the single fixture you’ve requested by ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixture-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixture-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixture-by-id", "description": "Sportmonks docs" } } }, "/football/fixtures/date/{date}": { "get": { "operationId": "getFixturesByDate", "summary": "Fixtures by Date", "tags": [ "Fixtures" ], "parameters": [ { "name": "date", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "The date you want to retrieve fixtures from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, round, stage, group, aggregate, league, season, coaches, tvStations, venue, state, weatherReport, lineups, events, timeline, comments, trends, statistics, periods, participants, odds, premiumOdds, inplayOdds, prematchNews, postmatchNews, metadata, sidelined, predictions, referees, formations, ballCoordinates, scores, xGFixture, pressure, expectedLineups, matchfacts. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;round`.", "schema": { "type": "string" }, "x-includes": [ "sport", "round", "stage", "group", "aggregate", "league", "season", "coaches", "tvStations", "venue", "state", "weatherReport", "lineups", "events", "timeline", "comments", "trends", "statistics", "periods", "participants", "odds", "premiumOdds", "inplayOdds", "prematchNews", "postmatchNews", "metadata", "sidelined", "predictions", "referees", "formations", "ballCoordinates", "scores", "xGFixture", "pressure", "expectedLineups", "matchfacts" ], "x-include-depth-max": 3, "example": "sport;round" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, stage_id, group_id, aggregate_id, state_id, round_id, venue_id, name, starting_at, result_info, leg, details, length. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: participantSearch, todayDate, venues, Deleted, markets, bookmakers, WinningOdds, fixturestatisticTypes, eventTypes, lineupdetailTypes, fixtureStates, fixtureLeagues, fixtureGroups, coachCountries, seasonStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118" }, { "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52" } ], "x-filters": [ { "kind": "static", "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "kind": "static", "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "kind": "static", "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "kind": "static", "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118", "name": "fixturestatisticTypes", "names": [ "fixturestatisticTypes", "fixturestatisticTypes", "eventTypes", "lineupdetailTypes" ] }, { "kind": "dynamic", "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1", "name": "fixtureStates", "names": [ "fixtureStates", "fixtureStates" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271", "name": "fixtureLeagues", "names": [ "fixtureLeagues", "fixtureLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691", "name": "fixtureGroups", "names": [ "fixtureGroups", "fixtureGroups" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns fixtures ordered by starting_at ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fixture" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 19430763, "sport_id": 1, "league_id": 1222, "season_id": 25639, "stage_id": 77476907, "group_id": null, "aggregate_id": null, "round_id": 372610, "state_id": 17, "venue_id": 8165, "name": "Kalisz vs Jastrzębie", "starting_at": "2026-04-25 00:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 1777075200 }, { "id": 19431266, "sport_id": 1, "league_id": 555, "season_id": 25644, "stage_id": 77476912, "group_id": null, "aggregate_id": null, "round_id": 372690, "state_id": 12, "venue_id": 3822, "name": "Domžale vs Mura", "starting_at": "2026-04-25 00:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 1777075200 }, { "id": 19461352, "sport_id": 1, "league_id": 2474, "season_id": 25847, "stage_id": 77477123, "group_id": null, "aggregate_id": null, "round_id": 376122, "state_id": 17, "venue_id": 2518, "name": "Górnik Zabrze II vs Stal Jasień", "starting_at": "2026-04-25 00:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 1777075200 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/fixtures/date/2026-04-25?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the fixtures from your requested date. All you have to do is parse the date in YYYY-MM-DD format. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-date\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-date)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-date", "description": "Sportmonks docs" } } }, "/football/fixtures/between/{startDate}/{endDate}": { "get": { "operationId": "getFixturesByDateRange", "summary": "Fixtures by Date Range", "tags": [ "Fixtures" ], "parameters": [ { "name": "startDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "The start date you want to retrieve fixtures from." }, { "name": "endDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "The end date you want to retrieve fixtures from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, round, stage, group, aggregate, league, season, coaches, tvStations, venue, state, weatherReport, lineups, events, timeline, comments, trends, statistics, periods, participants, odds, premiumOdds, inplayOdds, prematchNews, postmatchNews, metadata, sidelined, predictions, referees, formations, ballCoordinates, scores, xGFixture, pressure, expectedLineups, matchfacts. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;round`.", "schema": { "type": "string" }, "x-includes": [ "sport", "round", "stage", "group", "aggregate", "league", "season", "coaches", "tvStations", "venue", "state", "weatherReport", "lineups", "events", "timeline", "comments", "trends", "statistics", "periods", "participants", "odds", "premiumOdds", "inplayOdds", "prematchNews", "postmatchNews", "metadata", "sidelined", "predictions", "referees", "formations", "ballCoordinates", "scores", "xGFixture", "pressure", "expectedLineups", "matchfacts" ], "x-include-depth-max": 3, "example": "sport;round" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, stage_id, group_id, aggregate_id, state_id, round_id, venue_id, name, starting_at, result_info, leg, details, length. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: participantSearch, todayDate, venues, Deleted, markets, bookmakers, WinningOdds, fixturestatisticTypes, eventTypes, lineupdetailTypes, fixtureStates, fixtureLeagues, fixtureGroups, coachCountries, seasonStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118" }, { "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52" } ], "x-filters": [ { "kind": "static", "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "kind": "static", "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "kind": "static", "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "kind": "static", "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118", "name": "fixturestatisticTypes", "names": [ "fixturestatisticTypes", "fixturestatisticTypes", "eventTypes", "lineupdetailTypes" ] }, { "kind": "dynamic", "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1", "name": "fixtureStates", "names": [ "fixtureStates", "fixtureStates" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271", "name": "fixtureLeagues", "names": [ "fixtureLeagues", "fixtureLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691", "name": "fixtureGroups", "names": [ "fixtureGroups", "fixtureGroups" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns fixtures ordered by starting_at ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fixture" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 19630798, "sport_id": 1, "league_id": 1082, "season_id": 26758, "stage_id": 77479519, "group_id": null, "aggregate_id": null, "round_id": null, "state_id": 5, "venue_id": 11576, "name": "Brazil vs Croatia", "starting_at": "2026-04-01 00:00:00", "result_info": "Brazil won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1775001600 }, { "id": 19660435, "sport_id": 1, "league_id": 678, "season_id": 27229, "stage_id": 77480302, "group_id": null, "aggregate_id": null, "round_id": 401060, "state_id": 5, "venue_id": 10844, "name": "Real Cartagena vs Deportes Quindío", "starting_at": "2026-04-01 00:00:00", "result_info": "Real Cartagena won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1775001600 }, { "id": 19681242, "sport_id": 1, "league_id": 2682, "season_id": 27258, "stage_id": 77480784, "group_id": null, "aggregate_id": null, "round_id": 403241, "state_id": 12, "venue_id": null, "name": "Independiente Valle W vs Ñañas W", "starting_at": "2026-04-01 00:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 1775001600 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/fixtures/between/2026-04-01/2026-04-30?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the fixtures from your requested date range. The maximum range is 100 days. All you have to do is parse the date in YYYY-MM-DD format. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-date-range\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-date-range)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-date-range", "description": "Sportmonks docs" } } }, "/football/fixtures/between/{startDate}/{endDate}/{teamId}": { "get": { "operationId": "getFixturesByDateRangeForTeam", "summary": "Fixtures by Date Range for Team", "tags": [ "Fixtures" ], "parameters": [ { "name": "startDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "The start date you want to retrieve fixtures from." }, { "name": "endDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "The end date you want to retrieve fixtures from." }, { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the team you want to retrieve fixtures from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, round, stage, group, aggregate, league, season, coaches, tvStations, venue, state, weatherReport, lineups, events, timeline, comments, trends, statistics, periods, participants, odds, premiumOdds, inplayOdds, prematchNews, postmatchNews, metadata, sidelined, predictions, referees, formations, ballCoordinates, scores, xGFixture, pressure, expectedLineups, matchfacts. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;round`.", "schema": { "type": "string" }, "x-includes": [ "sport", "round", "stage", "group", "aggregate", "league", "season", "coaches", "tvStations", "venue", "state", "weatherReport", "lineups", "events", "timeline", "comments", "trends", "statistics", "periods", "participants", "odds", "premiumOdds", "inplayOdds", "prematchNews", "postmatchNews", "metadata", "sidelined", "predictions", "referees", "formations", "ballCoordinates", "scores", "xGFixture", "pressure", "expectedLineups", "matchfacts" ], "x-include-depth-max": 3, "example": "sport;round" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, stage_id, group_id, aggregate_id, state_id, round_id, venue_id, name, starting_at, result_info, leg, details, length. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: participantSearch, todayDate, venues, Deleted, markets, bookmakers, WinningOdds, fixturestatisticTypes, eventTypes, lineupdetailTypes, fixtureStates, fixtureLeagues, fixtureGroups, coachCountries, seasonStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118" }, { "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52" } ], "x-filters": [ { "kind": "static", "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "kind": "static", "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "kind": "static", "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "kind": "static", "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118", "name": "fixturestatisticTypes", "names": [ "fixturestatisticTypes", "fixturestatisticTypes", "eventTypes", "lineupdetailTypes" ] }, { "kind": "dynamic", "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1", "name": "fixtureStates", "names": [ "fixtureStates", "fixtureStates" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271", "name": "fixtureLeagues", "names": [ "fixtureLeagues", "fixtureLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691", "name": "fixtureGroups", "names": [ "fixtureGroups", "fixtureGroups" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns fixtures ordered by starting_at ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fixture" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 19687560, "sport_id": 1, "league_id": 24, "season_id": 25919, "stage_id": 77480968, "group_id": null, "aggregate_id": null, "round_id": null, "state_id": 5, "venue_id": 151, "name": "Manchester City vs Liverpool", "starting_at": "2026-04-04 11:45:00", "result_info": "Manchester City won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1775303100 }, { "id": 19683236, "sport_id": 1, "league_id": 2, "season_id": 25580, "stage_id": 77480821, "group_id": null, "aggregate_id": 60305, "round_id": null, "state_id": 5, "venue_id": 131, "name": "Paris Saint Germain vs Liverpool", "starting_at": "2026-04-08 19:00:00", "result_info": "Paris Saint Germain won after full-time.", "leg": "1/2", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1775674800 }, { "id": 19427197, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "aggregate_id": null, "round_id": 372149, "state_id": 5, "venue_id": 230, "name": "Liverpool vs Fulham", "starting_at": "2026-04-11 16:30:00", "result_info": "Liverpool won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1775925000 } ], "pagination": { "count": 6, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the fixtures from your requested date range for your team. All you have to do is parse the date in YYYY-MM-DD format and add the team ID. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-date-range-for-team\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-date-range-for-team)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-date-range-for-team", "description": "Sportmonks docs" } } }, "/football/fixtures/head-to-head/{firstTeam}/{secondTeam}": { "get": { "operationId": "getFixturesByHeadToHead", "summary": "Fixtures by Head to Head", "tags": [ "Fixtures" ], "parameters": [ { "name": "firstTeam", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The ID of the first team retrieve fixtures from." }, { "name": "secondTeam", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The ID of the second team retrieve fixtures from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, round, stage, group, aggregate, league, season, coaches, tvStations, venue, state, weatherReport, lineups, events, timeline, comments, trends, statistics, periods, participants, odds, premiumOdds, inplayOdds, prematchNews, postmatchNews, metadata, sidelined, predictions, referees, formations, ballCoordinates, scores, xGFixture, pressure, expectedLineups, matchfacts. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;round`.", "schema": { "type": "string" }, "x-includes": [ "sport", "round", "stage", "group", "aggregate", "league", "season", "coaches", "tvStations", "venue", "state", "weatherReport", "lineups", "events", "timeline", "comments", "trends", "statistics", "periods", "participants", "odds", "premiumOdds", "inplayOdds", "prematchNews", "postmatchNews", "metadata", "sidelined", "predictions", "referees", "formations", "ballCoordinates", "scores", "xGFixture", "pressure", "expectedLineups", "matchfacts" ], "x-include-depth-max": 3, "example": "sport;round" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, stage_id, group_id, aggregate_id, state_id, round_id, venue_id, name, starting_at, result_info, leg, details, length. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: participantSearch, todayDate, venues, Deleted, markets, bookmakers, WinningOdds, fixturestatisticTypes, eventTypes, lineupdetailTypes, fixtureStates, fixtureLeagues, fixtureGroups, coachCountries, seasonStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118" }, { "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52" } ], "x-filters": [ { "kind": "static", "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "kind": "static", "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "kind": "static", "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "kind": "static", "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118", "name": "fixturestatisticTypes", "names": [ "fixturestatisticTypes", "fixturestatisticTypes", "eventTypes", "lineupdetailTypes" ] }, { "kind": "dynamic", "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1", "name": "fixtureStates", "names": [ "fixtureStates", "fixtureStates" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271", "name": "fixtureLeagues", "names": [ "fixtureLeagues", "fixtureLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691", "name": "fixtureGroups", "names": [ "fixtureGroups", "fixtureGroups" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fixture" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 19427201, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "aggregate_id": null, "round_id": 372150, "state_id": 5, "venue_id": 230, "name": "Liverpool vs Crystal Palace", "starting_at": "2026-04-25 14:00:00", "result_info": "Liverpool won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1777125600 }, { "id": 19585905, "sport_id": 1, "league_id": 27, "season_id": 25654, "stage_id": 77478370, "group_id": null, "aggregate_id": null, "round_id": 391135, "state_id": 5, "venue_id": 230, "name": "Liverpool vs Crystal Palace", "starting_at": "2025-10-29 19:45:00", "result_info": "Crystal Palace won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1761767100 }, { "id": 19427508, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "aggregate_id": null, "round_id": 372200, "state_id": 5, "venue_id": 201, "name": "Crystal Palace vs Liverpool", "starting_at": "2025-09-27 14:00:00", "result_info": "Crystal Palace won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1758981600 } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the head to head fixtures of the two teams you’ve requested. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-head-to-head\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-head-to-head)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-head-to-head", "description": "Sportmonks docs" } } }, "/football/fixtures/multi/{fixtureIds}": { "get": { "operationId": "getFixturesByMultipleIds", "summary": "Fixtures by Multiple IDs", "tags": [ "Fixtures" ], "parameters": [ { "name": "fixtureIds", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^\\d+(,\\d+){0,49}$" }, "description": "The IDs you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, round, stage, group, aggregate, league, season, coaches, tvStations, venue, state, weatherReport, lineups, events, timeline, comments, trends, statistics, periods, participants, odds, premiumOdds, inplayOdds, prematchNews, metadata, sidelined, predictions, referees, formations, ballCoordinates, scores, xGFixture, pressure, expectedLineups, matchfacts. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;round`.", "schema": { "type": "string" }, "x-includes": [ "sport", "round", "stage", "group", "aggregate", "league", "season", "coaches", "tvStations", "venue", "state", "weatherReport", "lineups", "events", "timeline", "comments", "trends", "statistics", "periods", "participants", "odds", "premiumOdds", "inplayOdds", "prematchNews", "metadata", "sidelined", "predictions", "referees", "formations", "ballCoordinates", "scores", "xGFixture", "pressure", "expectedLineups", "matchfacts" ], "x-include-depth-max": 3, "example": "sport;round" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, stage_id, group_id, aggregate_id, state_id, round_id, venue_id, name, starting_at, result_info, leg, details, length. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: participantSearch, todayDate, venues, Deleted, markets, bookmakers, WinningOdds, fixturestatisticTypes, eventTypes, lineupdetailTypes, fixtureStates, fixtureLeagues, fixtureGroups, coachCountries, seasonStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118" }, { "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52" } ], "x-filters": [ { "kind": "static", "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "kind": "static", "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "kind": "static", "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "kind": "static", "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118", "name": "fixturestatisticTypes", "names": [ "fixturestatisticTypes", "fixturestatisticTypes", "eventTypes", "lineupdetailTypes" ] }, { "kind": "dynamic", "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1", "name": "fixtureStates", "names": [ "fixtureStates", "fixtureStates" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271", "name": "fixtureLeagues", "names": [ "fixtureLeagues", "fixtureLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691", "name": "fixtureGroups", "names": [ "fixtureGroups", "fixtureGroups" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fixture" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 19427201, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "aggregate_id": null, "round_id": 372150, "state_id": 5, "venue_id": 230, "name": "Liverpool vs Crystal Palace", "starting_at": "2026-04-25 14:00:00", "result_info": "Liverpool won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1777125600 } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the fixtures you’ve requested by IDs. The maximum number of fixture IDs you can include in a single request when using this endpoint is 50. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-multiple-ids\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-multiple-ids)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-multiple-ids", "description": "Sportmonks docs" } } }, "/football/fixtures/search/{name}": { "get": { "operationId": "getFixturesBySearchByName", "summary": "Fixtures by Search by Name", "tags": [ "Fixtures" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name you want search on." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, round, stage, group, aggregate, league, season, coaches, tvStations, venue, state, weatherReport, lineups, events, timeline, comments, trends, statistics, periods, participants, odds, premiumOdds, inplayOdds, prematchNews, postmatchNews, metadata, sidelined, predictions, referees, formations, ballCoordinates, scores, xGFixture, pressure, expectedLineups, matchfacts. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;round`.", "schema": { "type": "string" }, "x-includes": [ "sport", "round", "stage", "group", "aggregate", "league", "season", "coaches", "tvStations", "venue", "state", "weatherReport", "lineups", "events", "timeline", "comments", "trends", "statistics", "periods", "participants", "odds", "premiumOdds", "inplayOdds", "prematchNews", "postmatchNews", "metadata", "sidelined", "predictions", "referees", "formations", "ballCoordinates", "scores", "xGFixture", "pressure", "expectedLineups", "matchfacts" ], "x-include-depth-max": 3, "example": "sport;round" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, stage_id, group_id, aggregate_id, state_id, round_id, venue_id, name, starting_at, result_info, leg, details, length. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: participantSearch, todayDate, venues, Deleted, markets, bookmakers, WinningOdds, fixturestatisticTypes, eventTypes, lineupdetailTypes, fixtureStates, fixtureLeagues, fixtureGroups, coachCountries, seasonStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118" }, { "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52" } ], "x-filters": [ { "kind": "static", "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "kind": "static", "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "kind": "static", "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "kind": "static", "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118", "name": "fixturestatisticTypes", "names": [ "fixturestatisticTypes", "fixturestatisticTypes", "eventTypes", "lineupdetailTypes" ] }, { "kind": "dynamic", "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1", "name": "fixtureStates", "names": [ "fixtureStates", "fixtureStates" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271", "name": "fixtureLeagues", "names": [ "fixtureLeagues", "fixtureLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691", "name": "fixtureGroups", "names": [ "fixtureGroups", "fixtureGroups" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns fixtures ordered by starting_at ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fixture" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 19253428, "sport_id": 1, "league_id": 8, "season_id": 24263, "stage_id": 77473163, "group_id": null, "aggregate_id": null, "round_id": null, "state_id": 5, "venue_id": 667, "name": "Charlton Athletic vs Manchester City", "starting_at": "2000-08-18 22:00:00", "result_info": "Charlton Athletic won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 966636000 }, { "id": 19253431, "sport_id": 1, "league_id": 8, "season_id": 24263, "stage_id": 77473163, "group_id": null, "aggregate_id": null, "round_id": null, "state_id": 5, "venue_id": 206, "name": "Manchester United vs Newcastle United", "starting_at": "2000-08-19 22:00:00", "result_info": "Manchester United won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 966722400 }, { "id": 19253434, "sport_id": 1, "league_id": 8, "season_id": 24263, "stage_id": 77473163, "group_id": null, "aggregate_id": null, "round_id": null, "state_id": 5, "venue_id": 504, "name": "Ipswich Town vs Manchester United", "starting_at": "2000-08-21 22:00:00", "result_info": "Game ended in draw.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 966895200 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/fixtures/search/Manchester?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the fixtures that match your search query. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-search-by-name\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-search-by-name)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-fixtures-by-search-by-name", "description": "Sportmonks docs" } } }, "/football/fixtures/latest": { "get": { "operationId": "getLatestUpdatedFixtures", "summary": "Latest Updated Fixtures", "tags": [ "Fixtures" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, round, stage, group, aggregate, league, season, coaches, tvStations, venue, state, weatherReport, lineups, events, timeline, comments, trends, statistics, periods, participants, odds, premiumOdds, inplayOdds, prematchNews, postmatchNews, metadata, sidelined, predictions, referees, formations, ballCoordinates, scores, xGFixture, pressure, expectedLineups, matchfacts. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;round`.", "schema": { "type": "string" }, "x-includes": [ "sport", "round", "stage", "group", "aggregate", "league", "season", "coaches", "tvStations", "venue", "state", "weatherReport", "lineups", "events", "timeline", "comments", "trends", "statistics", "periods", "participants", "odds", "premiumOdds", "inplayOdds", "prematchNews", "postmatchNews", "metadata", "sidelined", "predictions", "referees", "formations", "ballCoordinates", "scores", "xGFixture", "pressure", "expectedLineups", "matchfacts" ], "x-include-depth-max": 3, "example": "sport;round" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, stage_id, group_id, aggregate_id, state_id, round_id, venue_id, name, starting_at, result_info, leg, details, length. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: participantSearch, todayDate, venues, Deleted, markets, bookmakers, WinningOdds, fixturestatisticTypes, eventTypes, lineupdetailTypes, fixtureStates, fixtureLeagues, fixtureGroups, coachCountries, seasonStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118" }, { "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52" } ], "x-filters": [ { "kind": "static", "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "kind": "static", "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "kind": "static", "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "kind": "static", "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118", "name": "fixturestatisticTypes", "names": [ "fixturestatisticTypes", "fixturestatisticTypes", "eventTypes", "lineupdetailTypes" ] }, { "kind": "dynamic", "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1", "name": "fixtureStates", "names": [ "fixtureStates", "fixtureStates" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271", "name": "fixtureLeagues", "names": [ "fixtureLeagues", "fixtureLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691", "name": "fixtureGroups", "names": [ "fixtureGroups", "fixtureGroups" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fixture" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 19518522, "sport_id": 1, "league_id": 836, "season_id": 26203, "stage_id": 77477550, "group_id": null, "aggregate_id": null, "round_id": 382943, "state_id": 1, "venue_id": null, "name": "Young Apostles vs Vision", "starting_at": "2026-05-06 15:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1778079600 }, { "id": 19654480, "sport_id": 1, "league_id": 1710, "season_id": 26937, "stage_id": 77480227, "group_id": null, "aggregate_id": null, "round_id": 400238, "state_id": 1, "venue_id": 338788, "name": "Valur W vs ÍBV W", "starting_at": "2026-05-06 16:30:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1778085000 }, { "id": 19664750, "sport_id": 1, "league_id": 175, "season_id": 25994, "stage_id": 77477295, "group_id": null, "aggregate_id": null, "round_id": 401458, "state_id": 1, "venue_id": 3635, "name": "Ararat-Armenia vs Pyunik", "starting_at": "2026-05-06 15:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1778079600 } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns you all the games that have received updates within 10 seconds. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-latest-updated-fixtures\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-latest-updated-fixtures)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-latest-updated-fixtures", "description": "Sportmonks docs" } } }, "/football/fixtures/past/tv-stations/{tvStationId}": { "get": { "operationId": "getPastFixturesByTvStationId", "summary": "Past Fixtures by TV Station ID", "tags": [ "Fixtures" ], "parameters": [ { "name": "tvStationId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the TV station you want to retrieve past fixtures from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, round, stage, group, aggregate, league, season, coaches, tvStations, venue, state, weatherReport, lineups, events, timeline, comments, trends, statistics, periods, participants, odds, premiumOdds, inplayOdds, prematchNews, postmatchNews, metadata, sidelined, predictions, referees, formations, ballCoordinates, scores, xGFixture, pressure, expectedLineups, matchfacts. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;round`.", "schema": { "type": "string" }, "x-includes": [ "sport", "round", "stage", "group", "aggregate", "league", "season", "coaches", "tvStations", "venue", "state", "weatherReport", "lineups", "events", "timeline", "comments", "trends", "statistics", "periods", "participants", "odds", "premiumOdds", "inplayOdds", "prematchNews", "postmatchNews", "metadata", "sidelined", "predictions", "referees", "formations", "ballCoordinates", "scores", "xGFixture", "pressure", "expectedLineups", "matchfacts" ], "x-include-depth-max": 3, "example": "sport;round" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, stage_id, group_id, aggregate_id, state_id, round_id, venue_id, name, starting_at, result_info, leg, details, length. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: participantSearch, todayDate, venues, Deleted, markets, bookmakers, WinningOdds, fixturestatisticTypes, eventTypes, lineupdetailTypes, fixtureStates, fixtureLeagues, fixtureGroups, coachCountries, seasonStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118" }, { "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52" } ], "x-filters": [ { "kind": "static", "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "kind": "static", "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "kind": "static", "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "kind": "static", "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118", "name": "fixturestatisticTypes", "names": [ "fixturestatisticTypes", "fixturestatisticTypes", "eventTypes", "lineupdetailTypes" ] }, { "kind": "dynamic", "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1", "name": "fixtureStates", "names": [ "fixtureStates", "fixtureStates" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271", "name": "fixtureLeagues", "names": [ "fixtureLeagues", "fixtureLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691", "name": "fixtureGroups", "names": [ "fixtureGroups", "fixtureGroups" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns fixtures ordered by starting_at ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fixture" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 19095123, "sport_id": 1, "league_id": 648, "season_id": 23265, "stage_id": 77470132, "group_id": null, "aggregate_id": null, "round_id": 334604, "state_id": 5, "venue_id": 343454, "name": "Atlético Mineiro vs Grêmio", "starting_at": "2024-10-09 22:30:00", "result_info": "Atlético Mineiro won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1728513000 }, { "id": 19068176, "sport_id": 1, "league_id": 1955, "season_id": 23096, "stage_id": 77469532, "group_id": null, "aggregate_id": null, "round_id": 331340, "state_id": 5, "venue_id": 102926, "name": "Brisbane Olympic W vs FQ QAS W", "starting_at": "2024-08-22 10:30:00", "result_info": "Game ended in draw.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1724322600 }, { "id": 19082970, "sport_id": 1, "league_id": 1349, "season_id": 23176, "stage_id": 77469849, "group_id": null, "aggregate_id": null, "round_id": 333204, "state_id": 5, "venue_id": 339449, "name": "Nasaf vs Navbakhor", "starting_at": "2024-06-30 15:00:00", "result_info": "Nasaf won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1719759600 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/fixtures/past/tv-stations/33?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the past fixtures that were available in one or more countries from your requested TV Station ID. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-past-fixtures-by-tv-station-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-past-fixtures-by-tv-station-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-past-fixtures-by-tv-station-id", "description": "Sportmonks docs" } } }, "/football/fixtures/upcoming/markets/{marketId}": { "get": { "operationId": "getUpcomingFixturesByMarketId", "summary": "Upcoming Fixtures by Market ID", "tags": [ "Fixtures" ], "parameters": [ { "name": "marketId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the market you want to retrieve upcoming fixtures from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, round, stage, group, aggregate, league, season, coaches, tvStations, venue, state, weatherReport, lineups, events, timeline, comments, trends, statistics, periods, participants, odds, premiumOdds, inplayOdds, prematchNews, postmatchNews, metadata, sidelined, predictions, referees, formations, ballCoordinates, scores, xGFixture, pressure, expectedLineups, matchfacts. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;round`.", "schema": { "type": "string" }, "x-includes": [ "sport", "round", "stage", "group", "aggregate", "league", "season", "coaches", "tvStations", "venue", "state", "weatherReport", "lineups", "events", "timeline", "comments", "trends", "statistics", "periods", "participants", "odds", "premiumOdds", "inplayOdds", "prematchNews", "postmatchNews", "metadata", "sidelined", "predictions", "referees", "formations", "ballCoordinates", "scores", "xGFixture", "pressure", "expectedLineups", "matchfacts" ], "x-include-depth-max": 3, "example": "sport;round" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, stage_id, group_id, aggregate_id, state_id, round_id, venue_id, name, starting_at, result_info, leg, details, length. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: participantSearch, todayDate, venues, Deleted, markets, bookmakers, WinningOdds, fixturestatisticTypes, eventTypes, lineupdetailTypes, fixtureStates, fixtureLeagues, fixtureGroups, coachCountries, seasonStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118" }, { "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52" } ], "x-filters": [ { "kind": "static", "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "kind": "static", "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "kind": "static", "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "kind": "static", "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118", "name": "fixturestatisticTypes", "names": [ "fixturestatisticTypes", "fixturestatisticTypes", "eventTypes", "lineupdetailTypes" ] }, { "kind": "dynamic", "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1", "name": "fixtureStates", "names": [ "fixtureStates", "fixtureStates" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271", "name": "fixtureLeagues", "names": [ "fixtureLeagues", "fixtureLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691", "name": "fixtureGroups", "names": [ "fixtureGroups", "fixtureGroups" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns fixtures ordered by starting_at ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fixture" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 19706241, "sport_id": 1, "league_id": 881, "season_id": 26717, "stage_id": 77479122, "group_id": null, "aggregate_id": null, "round_id": 406376, "state_id": 1, "venue_id": 11958, "name": "Al Jaish vs Wahda", "starting_at": "2026-05-06 13:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": false, "starting_at_timestamp": 1778072400 }, { "id": 19705647, "sport_id": 1, "league_id": 1488, "season_id": 26039, "stage_id": 77477341, "group_id": null, "aggregate_id": null, "round_id": 406334, "state_id": 1, "venue_id": null, "name": "Prishtina e Re vs Prishtina", "starting_at": "2026-05-06 13:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1778072400 }, { "id": 19662022, "sport_id": 1, "league_id": 872, "season_id": 26441, "stage_id": 77478060, "group_id": null, "aggregate_id": null, "round_id": null, "state_id": 1, "venue_id": 12796, "name": "Mukura vs Police Rwanda", "starting_at": "2026-05-06 13:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1778072400 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/fixtures/upcoming/markets/1?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the fixtures from your requested market ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-upcoming-fixtures-by-market-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-upcoming-fixtures-by-market-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-upcoming-fixtures-by-market-id", "description": "Sportmonks docs" } } }, "/football/fixtures/upcoming/tv-stations/{tvStationId}": { "get": { "operationId": "getUpcomingFixturesByTvStationId", "summary": "Upcoming Fixtures by TV Station ID", "tags": [ "Fixtures" ], "parameters": [ { "name": "tvStationId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the TV station you want to retrieve upcoming fixtures from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, round, stage, group, aggregate, league, season, coaches, tvStations, venue, state, weatherReport, lineups, events, timeline, comments, trends, statistics, periods, participants, odds, premiumOdds, inplayOdds, prematchNews, postmatchNews, metadata, sidelined, predictions, referees, formations, ballCoordinates, scores, xGFixture, pressure, expectedLineups, matchfacts. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;round`.", "schema": { "type": "string" }, "x-includes": [ "sport", "round", "stage", "group", "aggregate", "league", "season", "coaches", "tvStations", "venue", "state", "weatherReport", "lineups", "events", "timeline", "comments", "trends", "statistics", "periods", "participants", "odds", "premiumOdds", "inplayOdds", "prematchNews", "postmatchNews", "metadata", "sidelined", "predictions", "referees", "formations", "ballCoordinates", "scores", "xGFixture", "pressure", "expectedLineups", "matchfacts" ], "x-include-depth-max": 3, "example": "sport;round" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, stage_id, group_id, aggregate_id, state_id, round_id, venue_id, name, starting_at, result_info, leg, details, length. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: participantSearch, todayDate, venues, Deleted, markets, bookmakers, WinningOdds, fixturestatisticTypes, eventTypes, lineupdetailTypes, fixtureStates, fixtureLeagues, fixtureGroups, coachCountries, seasonStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118" }, { "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52" } ], "x-filters": [ { "kind": "static", "name": "participantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "kind": "static", "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "kind": "static", "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "kind": "static", "name": "Deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=Deleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics, events and more on a selection of type ids separated by a comma.", "example": "&include=statistics.type&filters=fixturestatisticTypes:TypeIDs &include=statistics.type&filters=fixturestatisticTypes:42,49 &include=events&filters=eventTypes:14 &include=lineups.details.type&filters=lineupdetailTypes:118", "name": "fixturestatisticTypes", "names": [ "fixturestatisticTypes", "fixturestatisticTypes", "eventTypes", "lineupdetailTypes" ] }, { "kind": "dynamic", "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1", "name": "fixtureStates", "names": [ "fixtureStates", "fixtureStates" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271", "name": "fixtureLeagues", "names": [ "fixtureLeagues", "fixtureLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691", "name": "fixtureGroups", "names": [ "fixtureGroups", "fixtureGroups" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns fixtures ordered by starting_at ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fixture" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 19682003, "sport_id": 1, "league_id": 393, "season_id": 27438, "stage_id": 77480802, "group_id": null, "aggregate_id": null, "round_id": 403330, "state_id": 1, "venue_id": 343924, "name": "Kaisar vs Kairat", "starting_at": "2026-05-06 14:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1778076000 }, { "id": 19665485, "sport_id": 1, "league_id": 1007, "season_id": 27393, "stage_id": 77480477, "group_id": null, "aggregate_id": null, "round_id": 402912, "state_id": 1, "venue_id": 13903, "name": "Minerva Punjab vs Chennaiyin", "starting_at": "2026-05-06 14:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1778076000 }, { "id": 19702720, "sport_id": 1, "league_id": 959, "season_id": 26000, "stage_id": 77477300, "group_id": null, "aggregate_id": null, "round_id": 406070, "state_id": 1, "venue_id": 13447, "name": "Al Wahda vs Al Wasl", "starting_at": "2026-05-06 14:05:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1778076300 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/fixtures/upcoming/tv-stations/47?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the upcoming fixtures available in one or more countries from your requested TV Station ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-upcoming-fixtures-by-tv-station-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-upcoming-fixtures-by-tv-station-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/fixtures/get-upcoming-fixtures-by-tv-station-id", "description": "Sportmonks docs" } } }, "/football/leagues": { "get": { "operationId": "getAllLeagues", "summary": "All Leagues", "tags": [ "Leagues" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, stages, latest, upcoming, inplay, today, currentSeason, seasons. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "stages", "latest", "upcoming", "inplay", "today", "currentSeason", "seasons" ], "x-include-depth-max": 2, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, name, active, short_code, image_path, type, sub_type, last_played_at, category. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, leagueCountries, seasonStatisticTypes, stageTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "All", "description": "Filter all leagues starting from a certain league ID.", "example": "&filters=IdAfter:leagueID &filters=IdAfter:12" } ], "x-filters-dynamic": [ { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the leagues based on countries.", "example": "&include=country&filters=leagueCountries:countryIDs &include=country&filters=leagueCountries:41" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52" }, { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all leagues starting from a certain league ID.", "example": "&filters=IdAfter:leagueID &filters=IdAfter:12" }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the leagues based on countries.", "example": "&include=country&filters=leagueCountries:countryIDs &include=country&filters=leagueCountries:41", "name": "leagueCountries", "names": [ "leagueCountries", "leagueCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224", "name": "stageTypes", "names": [ "stageTypes", "stageTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns leagues ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/League" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 2, "sport_id": 1, "country_id": 41, "name": "Champions League", "active": true, "short_code": "UEFA CL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/2.png", "type": "league", "sub_type": "cup_international", "last_played_at": "2026-05-05 19:00:00", "category": 1, "has_jerseys": false }, { "id": 5, "sport_id": 1, "country_id": 41, "name": "Europa League", "active": true, "short_code": "UEFA EL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/5/5.png", "type": "league", "sub_type": "cup_international", "last_played_at": "2026-04-30 19:00:00", "category": 1, "has_jerseys": false }, { "id": 8, "sport_id": 1, "country_id": 462, "name": "Premier League", "active": true, "short_code": "UK PL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/8/8.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-05-04 19:00:00", "category": 1, "has_jerseys": false } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/leagues?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the leagues available within your subscription. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-all-leagues\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-all-leagues)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-all-leagues", "description": "Sportmonks docs" } } }, "/football/leagues/teams/{teamId}": { "get": { "operationId": "getAllLeaguesByTeamId", "summary": "All Leagues by Team ID", "tags": [ "Leagues" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the team you want to retrieve all leagues from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, stages, latest, upcoming, inplay, today, currentSeason, seasons. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "stages", "latest", "upcoming", "inplay", "today", "currentSeason", "seasons" ], "x-include-depth-max": 2, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, name, active, short_code, image_path, type, sub_type, last_played_at, category. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: leagueCountries, seasonStatisticTypes, stageTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the leagues based on countries.", "example": "&include=country&filters=leagueCountries:countryIDs &include=country&filters=leagueCountries:41" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52" }, { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224" } ], "x-filters": [ { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the leagues based on countries.", "example": "&include=country&filters=leagueCountries:countryIDs &include=country&filters=leagueCountries:41", "name": "leagueCountries", "names": [ "leagueCountries", "leagueCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224", "name": "stageTypes", "names": [ "stageTypes", "stageTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns leagues ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/League" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 2, "sport_id": 1, "country_id": 41, "name": "Champions League", "active": true, "short_code": "UEFA CL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/2.png", "type": "league", "sub_type": "cup_international", "last_played_at": "2026-05-05 19:00:00", "category": 1, "has_jerseys": false }, { "id": 5, "sport_id": 1, "country_id": 41, "name": "Europa League", "active": true, "short_code": "UEFA EL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/5/5.png", "type": "league", "sub_type": "cup_international", "last_played_at": "2026-04-30 19:00:00", "category": 1, "has_jerseys": false }, { "id": 8, "sport_id": 1, "country_id": 462, "name": "Premier League", "active": true, "short_code": "UK PL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/8/8.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-05-04 19:00:00", "category": 1, "has_jerseys": false } ], "pagination": { "count": 10, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the current and historical leagues from your requested team ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-all-leagues-by-team-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-all-leagues-by-team-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-all-leagues-by-team-id", "description": "Sportmonks docs" } } }, "/football/leagues/teams/{teamId}/current": { "get": { "operationId": "getCurrentLeaguesByTeamId", "summary": "Current Leagues by Team ID", "tags": [ "Leagues" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the team you want to retrieve current leagues from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, stages, latest, upcoming, inplay, today, currentSeason, seasons. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "stages", "latest", "upcoming", "inplay", "today", "currentSeason", "seasons" ], "x-include-depth-max": 2, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, name, active, short_code, image_path, type, sub_type, last_played_at, category. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: leagueCountries, seasonStatisticTypes, stageTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the leagues based on countries.", "example": "&include=country&filters=leagueCountries:countryIDs &include=country&filters=leagueCountries:41" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52" }, { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224" } ], "x-filters": [ { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the leagues based on countries.", "example": "&include=country&filters=leagueCountries:countryIDs &include=country&filters=leagueCountries:41", "name": "leagueCountries", "names": [ "leagueCountries", "leagueCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224", "name": "stageTypes", "names": [ "stageTypes", "stageTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/League" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 2, "sport_id": 1, "country_id": 41, "name": "Champions League", "active": true, "short_code": "UEFA CL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/2.png", "type": "league", "sub_type": "cup_international", "last_played_at": "2026-05-05 19:00:00", "category": 1, "has_jerseys": false }, { "id": 8, "sport_id": 1, "country_id": 462, "name": "Premier League", "active": true, "short_code": "UK PL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/8/8.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-05-04 19:00:00", "category": 1, "has_jerseys": false }, { "id": 23, "sport_id": 1, "country_id": 462, "name": "Community Shield", "active": true, "short_code": "UK COMM", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/23/23.png", "type": "league", "sub_type": "domestic_cup", "last_played_at": "2025-08-10 14:00:00", "category": 2, "has_jerseys": false } ], "pagination": { "count": 6, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the current leagues of your requested team ID. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-current-leagues-by-team-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-current-leagues-by-team-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-current-leagues-by-team-id", "description": "Sportmonks docs" } } }, "/football/leagues/{leagueId}": { "get": { "operationId": "getLeagueById", "summary": "League by ID", "tags": [ "Leagues" ], "parameters": [ { "name": "leagueId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the league you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, stages, latest, upcoming, inplay, today, currentSeason, seasons. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "stages", "latest", "upcoming", "inplay", "today", "currentSeason", "seasons" ], "x-include-depth-max": 2, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, name, active, short_code, image_path, type, sub_type, last_played_at, category. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: seasonStatisticTypes, stageTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52" }, { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224" } ], "x-filters": [ { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224", "name": "stageTypes", "names": [ "stageTypes", "stageTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/League" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 8, "sport_id": 1, "country_id": 462, "name": "Premier League", "active": true, "short_code": "UK PL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/8/8.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-05-04 19:00:00", "category": 1, "has_jerseys": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the league you've requested by ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-all-leagues\n\n[Sportmonks documentation](https://docs.sportmonks.com/v3/endpoints-and-entities/endpoints/leagues/get-league-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/v3/endpoints-and-entities/endpoints/leagues/get-league-by-id", "description": "Sportmonks docs" } } }, "/football/leagues/countries/{countryId}": { "get": { "operationId": "getLeaguesByCountryId", "summary": "Leagues by Country ID", "tags": [ "Leagues" ], "parameters": [ { "name": "countryId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the country you want to retrieve leagues from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, stages, latest, upcoming, inplay, today, currentSeason, seasons. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "stages", "latest", "upcoming", "inplay", "today", "currentSeason", "seasons" ], "x-include-depth-max": 2, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, name, active, short_code, image_path, type, sub_type, last_played_at, category. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: seasonStatisticTypes, stageTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52" }, { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224" } ], "x-filters": [ { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224", "name": "stageTypes", "names": [ "stageTypes", "stageTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/League" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 453, "sport_id": 1, "country_id": 2, "name": "Ekstraklasa", "active": true, "short_code": "POL E", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/5/453.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-05-04 17:00:00", "category": 2, "has_jerseys": false }, { "id": 456, "sport_id": 1, "country_id": 2, "name": "1. Liga", "active": true, "short_code": "POL L1", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/8/456.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-05-04 16:00:00", "category": 4, "has_jerseys": false }, { "id": 459, "sport_id": 1, "country_id": 2, "name": "Polish Cup", "active": true, "short_code": "POL Cup", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/11/459.png", "type": "league", "sub_type": "domestic_cup", "last_played_at": "2026-05-02 14:00:00", "category": 2, "has_jerseys": false } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/leagues/countries/2?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the leagues from your requested country ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-leagues-by-country-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-leagues-by-country-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-leagues-by-country-id", "description": "Sportmonks docs" } } }, "/football/leagues/date/{date}": { "get": { "operationId": "getLeaguesByFixtureDate", "summary": "Leagues by Fixture Date", "tags": [ "Leagues" ], "parameters": [ { "name": "date", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "The date of fixtures you want to retrieve leagues from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, stages, latest, upcoming, inplay, today, currentSeason, seasons. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "stages", "latest", "upcoming", "inplay", "today", "currentSeason", "seasons" ], "x-include-depth-max": 2, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, name, active, short_code, image_path, type, sub_type, last_played_at, category. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: leagueCountries, seasonStatisticTypes, stageTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the leagues based on countries.", "example": "&include=country&filters=leagueCountries:countryIDs &include=country&filters=leagueCountries:41" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52" }, { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224" } ], "x-filters": [ { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the leagues based on countries.", "example": "&include=country&filters=leagueCountries:countryIDs &include=country&filters=leagueCountries:41", "name": "leagueCountries", "names": [ "leagueCountries", "leagueCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224", "name": "stageTypes", "names": [ "stageTypes", "stageTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns leagues ordered by id ( asc or desc ). Defaults to asc (if league priority is not present).", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/League" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 8, "sport_id": 1, "country_id": 462, "name": "Premier League", "active": true, "short_code": "UK PL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/8/8.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-05-04 19:00:00", "category": 1, "has_jerseys": false }, { "id": 9, "sport_id": 1, "country_id": 462, "name": "Championship", "active": true, "short_code": "UK CHAMP", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/9/9.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-05-02 11:30:00", "category": 2, "has_jerseys": false }, { "id": 12, "sport_id": 1, "country_id": 462, "name": "League One", "active": true, "short_code": "UK L1", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/12/12.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-05-02 14:00:00", "category": 2, "has_jerseys": false } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/leagues/date/2026-04-25?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the leagues with fixtures from your requested fixture date. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-all-leagues\n\n[Sportmonks documentation](https://docs.sportmonks.com/v3/endpoints-and-entities/endpoints/leagues/get-leagues-by-fixture-date)", "externalDocs": { "url": "https://docs.sportmonks.com/v3/endpoints-and-entities/endpoints/leagues/get-leagues-by-fixture-date", "description": "Sportmonks docs" } } }, "/football/leagues/live": { "get": { "operationId": "getLeaguesByLive", "summary": "Leagues by Live", "tags": [ "Leagues" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, stages, latest, upcoming, inplay, today, currentSeason, seasons. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "stages", "latest", "upcoming", "inplay", "today", "currentSeason", "seasons" ], "x-include-depth-max": 2, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, name, active, short_code, image_path, type, sub_type, last_played_at, category. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: leagueCountries, seasonStatisticTypes, stageTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the leagues based on countries.", "example": "&include=country&filters=leagueCountries:countryIDs &include=country&filters=leagueCountries:41" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52" }, { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224" } ], "x-filters": [ { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the leagues based on countries.", "example": "&include=country&filters=leagueCountries:countryIDs &include=country&filters=leagueCountries:41", "name": "leagueCountries", "names": [ "leagueCountries", "leagueCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224", "name": "stageTypes", "names": [ "stageTypes", "stageTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/League" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 3547, "sport_id": 1, "country_id": 862868, "name": "National League", "active": true, "short_code": "NEP NL", "image_path": "https://cdn.sportmonks.com/images/soccer/league_placeholder.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-03-19 12:15:00", "category": 3, "has_jerseys": false }, { "id": 3129, "sport_id": 1, "country_id": 179748, "name": "Campeonato Nacional", "active": true, "short_code": null, "image_path": "https://cdn.sportmonks.com/images/soccer/league_placeholder.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-04-28 15:00:00", "category": 4, "has_jerseys": false }, { "id": 3003, "sport_id": 1, "country_id": 251, "name": "U18 Serie A/B", "active": true, "short_code": null, "image_path": "https://cdn.sportmonks.com/images/soccer/league_placeholder.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-05-06 09:00:00", "category": 4, "has_jerseys": false } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the leagues that have fixtures that are currently being played. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-all-leagues\n\n[Sportmonks documentation](https://docs.sportmonks.com/v3/endpoints-and-entities/endpoints/leagues/get-leagues-by-live)", "externalDocs": { "url": "https://docs.sportmonks.com/v3/endpoints-and-entities/endpoints/leagues/get-leagues-by-live", "description": "Sportmonks docs" } } }, "/football/leagues/search/{name}": { "get": { "operationId": "getLeaguesSearchByName", "summary": "Leagues Search by Name", "tags": [ "Leagues" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name you want to search on." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, stages, latest, upcoming, inplay, today, currentSeason, seasons. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "stages", "latest", "upcoming", "inplay", "today", "currentSeason", "seasons" ], "x-include-depth-max": 2, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, name, active, short_code, image_path, type, sub_type, last_played_at, category. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: leagueCountries, seasonStatisticTypes, stageTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the leagues based on countries.", "example": "&include=country&filters=leagueCountries:countryIDs &include=country&filters=leagueCountries:41" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52" }, { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224" } ], "x-filters": [ { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the leagues based on countries.", "example": "&include=country&filters=leagueCountries:countryIDs &include=country&filters=leagueCountries:41", "name": "leagueCountries", "names": [ "leagueCountries", "leagueCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224", "name": "stageTypes", "names": [ "stageTypes", "stageTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns leagues ordered by category ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/League" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 8, "sport_id": 1, "country_id": 462, "name": "Premier League", "active": true, "short_code": "UK PL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/8/8.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-05-04 19:00:00", "category": 1, "has_jerseys": false }, { "id": 806, "sport_id": 1, "country_id": 146, "name": "Premier League", "active": true, "short_code": "ZAF PL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/6/806.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-05-05 17:30:00", "category": 2, "has_jerseys": false }, { "id": 220, "sport_id": 1, "country_id": 507, "name": "Premier Liga", "active": true, "short_code": "BIH PL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/28/220.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-05-03 17:30:00", "category": 2, "has_jerseys": false } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/leagues/search/Premier?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the leagues that match your search query. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-leagues-search-by-name\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-leagues-search-by-name)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/leagues/get-leagues-search-by-name", "description": "Sportmonks docs" } } }, "/football/leagues/{leagueId}/jerseys": { "get": { "operationId": "getShirtsByLeagueId", "summary": "Shirts By League ID", "tags": [ "Leagues" ], "parameters": [ { "name": "leagueId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the league you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, stages, latest, upcoming, inplay, today, currentSeason, seasons. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "stages", "latest", "upcoming", "inplay", "today", "currentSeason", "seasons" ], "x-include-depth-max": 2, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, name, active, short_code, image_path, type, sub_type, last_played_at, category. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "name", "active", "short_code", "image_path", "type", "sub_type", "last_played_at", "category" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: seasonStatisticTypes, stageTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52" }, { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224" } ], "x-filters": [ { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=seasons.statistics&filters=seasonStatisticTypes:TypeIDs &include=seasons.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the league stages on a selection of type ID's separated by a comma.", "example": "&include=stages.type&filters=stageTypes:TypeIDs &include=stages.type&filters=stageTypes:224", "name": "stageTypes", "names": [ "stageTypes", "stageTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/League" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "deprecated": true, "description": "Returns information about kits from all teams from your requested league ID.\n\n[Sportmonks documentation](https://docs.sportmonks.com/v3/endpoints-and-entities/endpoints/leagues/get-league-by-id)\n\n_Deprecated. The Jerseys endpoint was only populated for the 2024 EUROS and is not maintained. Calls return 422 'Jerseys are currently not supported for this league' for any league outside that one-off scope._", "externalDocs": { "url": "https://docs.sportmonks.com/v3/endpoints-and-entities/endpoints/leagues/get-league-by-id", "description": "Sportmonks docs" } } }, "/football/livescores": { "get": { "operationId": "getAll", "summary": "All", "tags": [ "Livescores" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, round, stage, group, aggregate, league, season, coaches, tvStations, venue, state, weatherReport, lineups, events, timeline, comments, trends, statistics, periods, participants, inplayOdds, prematchNews, postmatchNews, metadata, sidelined, predictions, referees, formations, ballCoordinates, scores, xGFixture, expectedLineups, matchfacts. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;round`.", "schema": { "type": "string" }, "x-includes": [ "sport", "round", "stage", "group", "aggregate", "league", "season", "coaches", "tvStations", "venue", "state", "weatherReport", "lineups", "events", "timeline", "comments", "trends", "statistics", "periods", "participants", "inplayOdds", "prematchNews", "postmatchNews", "metadata", "sidelined", "predictions", "referees", "formations", "ballCoordinates", "scores", "xGFixture", "expectedLineups", "matchfacts" ], "x-include-depth-max": 3, "example": "sport;round" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, stage_id, group_id, aggregate_id, state_id, round_id, venue_id, name, starting_at, result_info, leg, details, length. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: ParticipantSearch, TodayDate, venues, IsDeleted, markets, bookmakers, WinningOdds, statisticTypes, eventTypes, fixtureStates, fixtureLeagues, fixtureGroups, coachCountries, seasonStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "ParticipantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "name": "TodayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "name": "IsDeleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=IsDeleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of Fixture statistics separated by a comma. Filter on the specific events you want to show.", "example": "&include=statistics&filters=statisticTypes:TypeIDs &include=statistics&filters=statisticTypes:42,49 &include=events&filters=eventTypes:14" }, { "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52" } ], "x-filters": [ { "kind": "static", "name": "ParticipantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "kind": "static", "name": "TodayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "kind": "static", "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "kind": "static", "name": "IsDeleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=IsDeleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of Fixture statistics separated by a comma. Filter on the specific events you want to show.", "example": "&include=statistics&filters=statisticTypes:TypeIDs &include=statistics&filters=statisticTypes:42,49 &include=events&filters=eventTypes:14", "name": "statisticTypes", "names": [ "statisticTypes", "statisticTypes", "eventTypes" ] }, { "kind": "dynamic", "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1", "name": "fixtureStates", "names": [ "fixtureStates", "fixtureStates" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271", "name": "fixtureLeagues", "names": [ "fixtureLeagues", "fixtureLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691", "name": "fixtureGroups", "names": [ "fixtureGroups", "fixtureGroups" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fixture" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 19562241, "sport_id": 1, "league_id": 196, "season_id": 26395, "stage_id": 77477982, "group_id": null, "aggregate_id": null, "round_id": 388082, "state_id": 2, "venue_id": null, "name": "Difai Ağsu vs Safa", "starting_at": "2026-05-06 12:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": true, "starting_at_timestamp": 1778068800 }, { "id": 19503079, "sport_id": 1, "league_id": 42, "season_id": 26129, "stage_id": 77479190, "group_id": null, "aggregate_id": null, "round_id": 395548, "state_id": 5, "venue_id": null, "name": "Reading U18 vs Tottenham U18", "starting_at": "2026-05-06 10:30:00", "result_info": "Game ended in draw.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 1778063400 }, { "id": 19631829, "sport_id": 1, "league_id": 3390, "season_id": 26676, "stage_id": 77479682, "group_id": null, "aggregate_id": null, "round_id": 397771, "state_id": 19, "venue_id": null, "name": "Groningen U19 vs De Graafschap U19", "starting_at": "2026-05-06 12:30:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 1778070600 } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the fixtures 15 minutes before the game starts. It will also disappear 15 minutes after the game is finished. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/livescores/get-all-livescores\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/livescores/get-all-livescores)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/livescores/get-all-livescores", "description": "Sportmonks docs" } } }, "/football/livescores/inplay": { "get": { "operationId": "getAllInplay", "summary": "All Inplay", "tags": [ "Livescores" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, round, stage, group, aggregate, league, season, coaches, tvStations, venue, state, weatherReport, lineups, events, timeline, comments, trends, statistics, periods, participants, inplayOdds, prematchNews, postmatchNews, metadata, sidelined, predictions, referees, formations, ballCoordinates, scores, xGFixture, expectedLineups, matchfacts. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;round`.", "schema": { "type": "string" }, "x-includes": [ "sport", "round", "stage", "group", "aggregate", "league", "season", "coaches", "tvStations", "venue", "state", "weatherReport", "lineups", "events", "timeline", "comments", "trends", "statistics", "periods", "participants", "inplayOdds", "prematchNews", "postmatchNews", "metadata", "sidelined", "predictions", "referees", "formations", "ballCoordinates", "scores", "xGFixture", "expectedLineups", "matchfacts" ], "x-include-depth-max": 3, "example": "sport;round" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, stage_id, group_id, aggregate_id, state_id, round_id, venue_id, name, starting_at, result_info, leg, details, length. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: ParticipantSearch, todayDate, venues, IsDeleted, markets, bookmakers, WinningOdds, statisticTypes, eventTypes, fixtureStates, fixtureLeagues, fixtureGroups, coachCountries, seasonStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "ParticipantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "name": "IsDeleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=IsDeleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of Fixture statistics separated by a comma. Filter on the specific events you want to show.", "example": "&include=statistics&filters=statisticTypes:TypeIDs &include=statistics&filters=statisticTypes:42,49 &include=events&filters=eventTypes:14" }, { "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52" } ], "x-filters": [ { "kind": "static", "name": "ParticipantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "kind": "static", "name": "todayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "kind": "static", "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "kind": "static", "name": "IsDeleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=IsDeleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of Fixture statistics separated by a comma. Filter on the specific events you want to show.", "example": "&include=statistics&filters=statisticTypes:TypeIDs &include=statistics&filters=statisticTypes:42,49 &include=events&filters=eventTypes:14", "name": "statisticTypes", "names": [ "statisticTypes", "statisticTypes", "eventTypes" ] }, { "kind": "dynamic", "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1", "name": "fixtureStates", "names": [ "fixtureStates", "fixtureStates" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271", "name": "fixtureLeagues", "names": [ "fixtureLeagues", "fixtureLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691", "name": "fixtureGroups", "names": [ "fixtureGroups", "fixtureGroups" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Livescore" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 19562241, "sport_id": 1, "league_id": 196, "season_id": 26395, "stage_id": 77477982, "group_id": null, "aggregate_id": null, "round_id": 388082, "state_id": 2, "venue_id": null, "name": "Difai Ağsu vs Safa", "starting_at": "2026-05-06 12:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": true, "starting_at_timestamp": 1778068800 }, { "id": 19503079, "sport_id": 1, "league_id": 42, "season_id": 26129, "stage_id": 77479190, "group_id": null, "aggregate_id": null, "round_id": 395548, "state_id": 5, "venue_id": null, "name": "Reading U18 vs Tottenham U18", "starting_at": "2026-05-06 10:30:00", "result_info": "Game ended in draw.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 1778063400 }, { "id": 19631829, "sport_id": 1, "league_id": 3390, "season_id": 26676, "stage_id": 77479682, "group_id": null, "aggregate_id": null, "round_id": 397771, "state_id": 19, "venue_id": null, "name": "Groningen U19 vs De Graafschap U19", "starting_at": "2026-05-06 12:30:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 1778070600 } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "GET All Inplay Livescores: returns all the inplay fixtures. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/livescores/get-inplay-livescores\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/livescores/get-inplay-livescores)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/livescores/get-inplay-livescores", "description": "Sportmonks docs" } } }, "/football/livescores/latest": { "get": { "operationId": "getLatestUpdatedLivescores", "summary": "Latest Updated Livescores", "tags": [ "Livescores" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, round, stage, group, aggregate, league, season, coaches, tvStations, venue, state, weatherReport, lineups, events, timeline, comments, trends, statistics, periods, participants, inplayOdds, prematchNews, metadata, sidelined, predictions, referees, formations, ballCoordinates, scores, xGFixture, expectedLineups, matchfacts. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;round`.", "schema": { "type": "string" }, "x-includes": [ "sport", "round", "stage", "group", "aggregate", "league", "season", "coaches", "tvStations", "venue", "state", "weatherReport", "lineups", "events", "timeline", "comments", "trends", "statistics", "periods", "participants", "inplayOdds", "prematchNews", "metadata", "sidelined", "predictions", "referees", "formations", "ballCoordinates", "scores", "xGFixture", "expectedLineups", "matchfacts" ], "x-include-depth-max": 3, "example": "sport;round" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, stage_id, group_id, aggregate_id, state_id, round_id, venue_id, name, starting_at, result_info, leg, details, length. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "aggregate_id", "state_id", "round_id", "venue_id", "name", "starting_at", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: ParticipantSearch, TodayDate, venues, IsDeleted, markets, bookmakers, WinningOdds, statisticTypes, eventTypes, fixtureStates, fixtureLeagues, fixtureGroups, coachCountries, seasonStatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "ParticipantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "name": "TodayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "name": "IsDeleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=IsDeleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of Fixture statistics separated by a comma. Filter on the specific events you want to show.", "example": "&include=statistics&filters=statisticTypes:TypeIDs &include=statistics&filters=statisticTypes:42,49 &include=events&filters=eventTypes:14" }, { "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52" } ], "x-filters": [ { "kind": "static", "name": "ParticipantSearch", "use": "Fixture", "description": "Filter on the matches of specific participants.", "example": "&include=participants&filters=participantSearch:Celtic" }, { "kind": "static", "name": "TodayDate", "use": "Fixture", "description": "Filter all fixtures to find only the fixtures of today.", "example": "&filters=todayDate" }, { "kind": "static", "name": "venues", "use": "Fixture", "description": "Find all fixtures that are played in a specific venue.", "example": "&include=venue&filters=venues:venueIDs &include=venue&filters=venues:10,12" }, { "kind": "static", "name": "IsDeleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&filters=IsDeleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=odds&filters=markets:marketIDs &include=odds&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=odds&filters=bookmakers:bookmakerIDs &include=odds&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&include=odds&filters=WinningOdds" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of Fixture statistics separated by a comma. Filter on the specific events you want to show.", "example": "&include=statistics&filters=statisticTypes:TypeIDs &include=statistics&filters=statisticTypes:42,49 &include=events&filters=eventTypes:14", "name": "statisticTypes", "names": [ "statisticTypes", "statisticTypes", "eventTypes" ] }, { "kind": "dynamic", "entity": "states", "use": "Fixtures Check this endpoint for all possibilities.", "description": "Filter the states of fixtures separated by a comma.", "example": "&include=state&filters=fixtureStates:StateIDs &include=state&filters=fixtureStates:1", "name": "fixtureStates", "names": [ "fixtureStates", "fixtureStates" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on leagues and their rounds.", "example": "&filters=fixtureLeagues:leagueIDs &filters=fixtureLeagues:501,271", "name": "fixtureLeagues", "names": [ "fixtureLeagues", "fixtureLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the fixtures based on groups. Get their fixtures and standings.", "example": "&include=group&filters=fixtureGroups:groupIDs &include=group&filters=fixtureGroups:246691", "name": "fixtureGroups", "names": [ "fixtureGroups", "fixtureGroups" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=coaches&filters=coachCountries:CountryIDs &include=coaches&filters=coachCountries:1161", "name": "coachCountries", "names": [ "coachCountries", "coachCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter statistics, standings and topscorers based on seasons.", "example": "&include=season.statistics&filters=seasonStatisticTypes:TypeIDs &include=season.statistics&filters=seasonStatisticTypes:52", "name": "seasonStatisticTypes", "names": [ "seasonStatisticTypes", "seasonStatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fixture" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 19674740, "sport_id": 1, "league_id": 989, "season_id": 27223, "stage_id": 77480631, "group_id": null, "aggregate_id": null, "round_id": 402759, "state_id": 22, "venue_id": 3772, "name": "Shanghai Port vs Shenzhen Peng City", "starting_at": "2026-05-06 11:35:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1778067300 }, { "id": 19674738, "sport_id": 1, "league_id": 989, "season_id": 27223, "stage_id": 77480631, "group_id": null, "aggregate_id": null, "round_id": 402759, "state_id": 2, "venue_id": 17879, "name": "Yunnan Yukun vs Zhejiang", "starting_at": "2026-05-06 12:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1778068800 }, { "id": 19701017, "sport_id": 1, "league_id": 178, "season_id": 26028, "stage_id": 77477377, "group_id": null, "aggregate_id": null, "round_id": 405841, "state_id": 2, "venue_id": 239194, "name": "Pyunik II vs Andranik", "starting_at": "2026-05-06 12:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": false, "starting_at_timestamp": 1778068800 } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns you all livescores that have received updates within 10 seconds. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/livescores/get-latest-updated-livescores\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/livescores/get-latest-updated-livescores)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/livescores/get-latest-updated-livescores", "description": "Sportmonks docs" } } }, "/football/match-facts": { "get": { "operationId": "getAllAvailableMatchFacts", "summary": "All Available Match Facts", "tags": [ "Match Facts - beta" ], "parameters": [ { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MatchFactCatalog" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 113, "sport_id": 1, "fixture_id": 19173461, "type_id": 76088, "participant": "away", "basis": "h2h", "data": { "all": { "count": 6, "percentage": 37.5 }, "home": { "count": 5, "percentage": 83.33 }, "away": { "count": 1, "percentage": 16.67 } }, "natural_language": "Paradou AC has 6 wins against JS Saoura", "category": "statistics", "scope": "all_matches" }, { "id": 114, "sport_id": 1, "fixture_id": 19173461, "type_id": 76088, "participant": "away", "basis": "overall", "data": { "all": { "count": 5, "percentage": 50 }, "home": { "count": 3, "percentage": 60 }, "away": { "count": 2, "percentage": 40 } }, "natural_language": "Paradou AC has 5 wins in their 10 most recent matches.", "category": "statistics", "scope": "all_matches" }, { "id": 115, "sport_id": 1, "fixture_id": 19173461, "type_id": 76088, "participant": "home", "basis": "h2h", "data": { "all": { "count": 8, "percentage": 50 }, "home": { "count": 6, "percentage": 75 }, "away": { "count": 2, "percentage": 25 } }, "natural_language": "JS Saoura has 8 wins against Paradou AC", "category": "statistics", "scope": "all_matches" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/match-facts?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all match facts available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/match-facts-beta\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/match-facts-beta)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/match-facts-beta", "description": "Sportmonks docs" } } }, "/football/match-facts/fixtures/between/{startDate}/{endDate}": { "get": { "operationId": "getMatchFactsByDateRange", "summary": "Match Facts by Date Range", "tags": [ "Match Facts - beta" ], "parameters": [ { "name": "startDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "The start date of the range you want to retrieve match facts from." }, { "name": "endDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "The end date of the range you want to retrieve match facts from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=fixture;player;team\n\nAllowed values: type, sport, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=type;sport`.", "schema": { "type": "string" }, "x-includes": [ "type", "sport", "fixture" ], "x-include-depth-max": 3, "example": "type;sport" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, fixture_id, type_id, participant, basis. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "fixture_id", "type_id", "participant", "basis" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "fixture_id", "type_id", "participant", "basis" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "fixture_id", "type_id", "participant", "basis" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "fixture_id", "type_id", "participant", "basis" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: matchFactTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "matchFactTypes", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the match facts on a selection of type ids separated by a comma.", "example": "&filters=matchFactTypes:{type ids}" } ], "x-filters": [ { "kind": "dynamic", "entity": "matchFactTypes", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the match facts on a selection of type ids separated by a comma.", "example": "&filters=matchFactTypes:{type ids}", "name": "matchFactTypes" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MatchFact" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 44579650, "sport_id": 1, "fixture_id": 19691815, "type_id": 76086, "participant": "home", "basis": "h2h", "data": { "win": { "all": { "count": 1, "percentage": 100 }, "home": { "count": 1, "percentage": 100 }, "away": { "count": 0, "percentage": 0 }, "context": { "n_match_checked": 4, "similar_matches": 1, "first_match": "2011-07-31" } }, "loss": { "all": { "count": 0, "percentage": 0 }, "home": { "count": 0, "percentage": 0 }, "away": { "count": 0, "percentage": 0 }, "context": { "n_match_checked": 4, "similar_matches": 1, "first_match": "2011-07-31" } }, "draw": { "all": { "count": 0, "percentage": 0 }, "home": { "count": 0, "percentage": 0 }, "away": { "count": 0, "percentage": 0 }, "context": { "n_match_checked": 4, "similar_matches": 1, "first_match": "2011-07-31" } } }, "natural_language": null, "category": "statistics", "scope": "all_matches" }, { "id": 44579651, "sport_id": 1, "fixture_id": 19691815, "type_id": 76086, "participant": "home", "basis": "team", "data": { "win": { "all": { "count": 1, "percentage": 100 }, "home": { "count": 0, "percentage": 0 }, "away": { "count": 1, "percentage": 100 }, "context": { "n_match_checked": 4, "similar_matches": 1, "first_match": "2026-03-25" } }, "loss": { "all": { "count": 0, "percentage": 0 }, "home": { "count": 0, "percentage": 0 }, "away": { "count": 0, "percentage": 0 }, "context": { "n_match_checked": 4, "similar_matches": 1, "first_match": "2026-03-25" } }, "draw": { "all": { "count": 0, "percentage": 0 }, "home": { "count": 0, "percentage": 0 }, "away": { "count": 0, "percentage": 0 }, "context": { "n_match_checked": 4, "similar_matches": 1, "first_match": "2026-03-25" } } }, "natural_language": null, "category": "statistics", "scope": "league_matches" }, { "id": 44579652, "sport_id": 1, "fixture_id": 19691815, "type_id": 76087, "participant": "away", "basis": "h2h", "data": { "win": { "all": { "count": 0, "percentage": 0 }, "home": { "count": 0, "percentage": 0 }, "away": { "count": 0, "percentage": 0 }, "context": { "n_match_checked": 4, "similar_matches": 1, "first_match": "2011-07-31" } }, "loss": { "all": { "count": 1, "percentage": 100 }, "home": { "count": 0, "percentage": 0 }, "away": { "count": 1, "percentage": 100 }, "context": { "n_match_checked": 4, "similar_matches": 1, "first_match": "2011-07-31" } }, "draw": { "all": { "count": 0, "percentage": 0 }, "home": { "count": 0, "percentage": 0 }, "away": { "count": 0, "percentage": 0 }, "context": { "n_match_checked": 4, "similar_matches": 1, "first_match": "2011-07-31" } } }, "natural_language": null, "category": "statistics", "scope": "all_matches" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/match-facts/fixtures/between/2026-04-01/2026-04-30?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all match facts available between a date range within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/match-facts-beta/get-match-facts-by-date-range\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/match-facts-beta/get-match-facts-by-date-range)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/match-facts-beta/get-match-facts-by-date-range", "description": "Sportmonks docs" } } }, "/football/match-facts/{fixtureId}": { "get": { "operationId": "getMatchFactsByFixtureId", "summary": "Match Facts by Fixture ID", "tags": [ "Match Facts - beta" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the fixture you want to retrieve match facts from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=fixture;player;team\n\nAllowed values: type, sport, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=type;sport`.", "schema": { "type": "string" }, "x-includes": [ "type", "sport", "fixture" ], "x-include-depth-max": 3, "example": "type;sport" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, fixture_id, type_id, participant, basis. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "fixture_id", "type_id", "participant", "basis" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "fixture_id", "type_id", "participant", "basis" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "fixture_id", "type_id", "participant", "basis" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "fixture_id", "type_id", "participant", "basis" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: matchFactTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "matchFactTypes", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the match facts on a selection of type ids separated by a comma.", "example": "&filters=matchFactTypes:{type ids}" } ], "x-filters": [ { "kind": "dynamic", "entity": "matchFactTypes", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the match facts on a selection of type ids separated by a comma.", "example": "&filters=matchFactTypes:{type ids}", "name": "matchFactTypes" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MatchFact" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 41382469, "sport_id": 1, "fixture_id": 19427201, "type_id": 76115, "participant": "both", "basis": "h2h", "data": { "count": 28 }, "natural_language": null, "category": "statistics", "scope": "all_matches" }, { "id": 41382470, "sport_id": 1, "fixture_id": 19427201, "type_id": 76115, "participant": "both", "basis": "h2h", "data": { "count": 25 }, "natural_language": null, "category": "statistics", "scope": "league_matches" }, { "id": 41382471, "sport_id": 1, "fixture_id": 19427201, "type_id": 76116, "participant": "both", "basis": "h2h", "data": { "streak": 2, "matches": 2 }, "natural_language": null, "category": "streaks", "scope": "all_matches" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/match-facts/19427201?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all match facts available by fixture ID within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/match-facts-beta/get-match-facts-by-fixture-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/match-facts-beta/get-match-facts-by-fixture-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/match-facts-beta/get-match-facts-by-fixture-id", "description": "Sportmonks docs" } } }, "/football/match-facts/leagues/{leagueId}": { "get": { "operationId": "getMatchFactsByLeagueId", "summary": "Match Facts by League ID", "tags": [ "Match Facts - beta" ], "parameters": [ { "name": "leagueId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the league you want to retrieve match facts from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=fixture;player;team\n\nAllowed values: type, sport, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=type;sport`.", "schema": { "type": "string" }, "x-includes": [ "type", "sport", "fixture" ], "x-include-depth-max": 3, "example": "type;sport" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, fixture_id, type_id, participant, basis. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "fixture_id", "type_id", "participant", "basis" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "fixture_id", "type_id", "participant", "basis" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "fixture_id", "type_id", "participant", "basis" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "sport_id", "fixture_id", "type_id", "participant", "basis" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: matchFactTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "matchFactTypes", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the match facts on a selection of type ids separated by a comma.", "example": "&filters=matchFactTypes:{type ids}" } ], "x-filters": [ { "kind": "dynamic", "entity": "matchFactTypes", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the match facts on a selection of type ids separated by a comma.", "example": "&filters=matchFactTypes:{type ids}", "name": "matchFactTypes" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MatchFact" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 33325649, "sport_id": 1, "fixture_id": 19134954, "type_id": 76088, "participant": "away", "basis": "h2h", "data": { "all": { "count": 5, "percentage": 55.56 }, "home": { "count": 4, "percentage": 80 }, "away": { "count": 1, "percentage": 20 } }, "natural_language": "Nottingham Forest have 5 wins (55.56%) in their matches against Ipswich Town (away only: 1, 20.0%).", "category": "statistics", "scope": "all_matches" }, { "id": 33325650, "sport_id": 1, "fixture_id": 19134954, "type_id": 76088, "participant": "away", "basis": "h2h", "data": { "all": { "count": 1, "percentage": 100 }, "home": { "count": 1, "percentage": 100 } }, "natural_language": null, "category": "statistics", "scope": "league_matches" }, { "id": 33325651, "sport_id": 1, "fixture_id": 19134954, "type_id": 76088, "participant": "home", "basis": "h2h", "data": { "all": { "count": 2, "percentage": 22.22 }, "home": { "count": 2, "percentage": 100 }, "away": { "count": 0, "percentage": 0 } }, "natural_language": "Ipswich Town have 2 wins (22.22%) in their matches against Nottingham Forest (home only: 2, 100.0%).", "category": "statistics", "scope": "all_matches" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/match-facts/leagues/8?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all match facts available by league ID within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/match-facts-beta/get-match-facts-by-league-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/match-facts-beta/get-match-facts-by-league-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/match-facts-beta/get-match-facts-by-league-id", "description": "Sportmonks docs" } } }, "/football/news/pre-match": { "get": { "operationId": "getAllPreMatchNews", "summary": "All Pre-match News", "tags": [ "News" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: fixture, league, lines. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=fixture;league`.", "schema": { "type": "string" }, "x-includes": [ "fixture", "league", "lines" ], "x-include-depth-max": 1, "example": "fixture;league" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, league_id, title, type. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "league_id", "title", "type" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "league_id", "title", "type" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, newsitemLeagues. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "News", "description": "Filter all news starting from a certain news ID. Handy if you're doing an import for all news and want to continue from a certain ID.", "example": "&filters=IdAfter:newsitemID &filters=IdAfter:1980" } ], "x-filters-dynamic": [ { "entity": "newsitemLeagues", "use": "Leagues Check this endpoint for all possibilities.", "description": "Filter the news items on a selection of leagues separated by a comma.", "example": "&include=leagues&filters=newsitemLeagues:leagueIDS &include=leagues&filters=newsitemLeagues:8" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "News", "description": "Filter all news starting from a certain news ID. Handy if you're doing an import for all news and want to continue from a certain ID.", "example": "&filters=IdAfter:newsitemID &filters=IdAfter:1980" }, { "kind": "dynamic", "entity": "newsitemLeagues", "use": "Leagues Check this endpoint for all possibilities.", "description": "Filter the news items on a selection of leagues separated by a comma.", "example": "&include=leagues&filters=newsitemLeagues:leagueIDS &include=leagues&filters=newsitemLeagues:8", "name": "newsitemLeagues", "names": [ "newsitemLeagues", "newsitemLeagues" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns news ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/News" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "fixture_id": 16943127, "league_id": 8, "title": "Preview: Arsenal vs Everton", "type": "prematch" }, { "id": 2, "fixture_id": 16943132, "league_id": 8, "title": "Preview: Liverpool vs Newcastle United", "type": "prematch" }, { "id": 3, "fixture_id": 16943135, "league_id": 8, "title": "Preview: West Ham United vs Chelsea", "type": "prematch" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/news/pre-match?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns all the available pre-match news articles within your subscription. Our Pre-Match News is available at a minimum of 48 hours before the start of a match. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/news/get-pre-match-news\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/news/get-pre-match-news)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/news/get-pre-match-news", "description": "Sportmonks docs" } } }, "/football/news/post-match": { "get": { "operationId": "getPostMatchNews", "summary": "Post-match News", "tags": [ "News" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: fixture, league, lines. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=fixture;league`.", "schema": { "type": "string" }, "x-includes": [ "fixture", "league", "lines" ], "x-include-depth-max": 1, "example": "fixture;league" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, league_id, title, type. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "league_id", "title", "type" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "league_id", "title", "type" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, newsitemLeagues. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "News", "description": "Filter all news starting from a certain news ID. Handy if you're doing an import for all news and want to continue from a certain ID.", "example": "&filters=IdAfter:newsitemID &filters=IdAfter:1980" } ], "x-filters-dynamic": [ { "entity": "newsitemLeagues", "use": "Leagues Check this endpoint for all possibilities.", "description": "Filter the news items on a selection of leagues separated by a comma.", "example": "&include=league&filters=newsitemLeagues:leagueIDS &include=league&filters=newsitemLeagues:8" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "News", "description": "Filter all news starting from a certain news ID. Handy if you're doing an import for all news and want to continue from a certain ID.", "example": "&filters=IdAfter:newsitemID &filters=IdAfter:1980" }, { "kind": "dynamic", "entity": "newsitemLeagues", "use": "Leagues Check this endpoint for all possibilities.", "description": "Filter the news items on a selection of leagues separated by a comma.", "example": "&include=league&filters=newsitemLeagues:leagueIDS &include=league&filters=newsitemLeagues:8", "name": "newsitemLeagues", "names": [ "newsitemLeagues", "newsitemLeagues" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns news ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/News" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 2796, "fixture_id": 18841626, "league_id": 8, "title": "Aston Villa took command from the start against Everton", "type": "postmatch" }, { "id": 2848, "fixture_id": 18841665, "league_id": 8, "title": "Liverpool keep on winning and now have four straight wins", "type": "postmatch" }, { "id": 2864, "fixture_id": 18841664, "league_id": 8, "title": "In-form Manchester City win again in game against West Ham", "type": "postmatch" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/news/post-match?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns all the available post-match news articles within your subscription. Our Post-Match News is available immediately after the fixture has finished. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/news/get-post-match-news\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/news/get-post-match-news)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/news/get-post-match-news", "description": "Sportmonks docs" } } }, "/football/news/post-match/seasons/{seasonId}": { "get": { "operationId": "getPostMatchNewsBySeasonId", "summary": "Post-match News by Season ID", "tags": [ "News" ], "parameters": [ { "name": "seasonId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the season you want to retrieve post-match news from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: fixture, league, lines. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=fixture;league`.", "schema": { "type": "string" }, "x-includes": [ "fixture", "league", "lines" ], "x-include-depth-max": 1, "example": "fixture;league" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, league_id, title, type. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "league_id", "title", "type" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "league_id", "title", "type" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: newsitemLeagues. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "newsitemLeagues", "use": "Leagues Check this endpoint for all possibilities.", "description": "Filter the news items on a selection of leagues separated by a comma.", "example": "&include=leagues&filters=newsitemLeagues:leagueIDS &include=leagues&filters=newsitemLeagues:8" } ], "x-filters": [ { "kind": "dynamic", "entity": "newsitemLeagues", "use": "Leagues Check this endpoint for all possibilities.", "description": "Filter the news items on a selection of leagues separated by a comma.", "example": "&include=leagues&filters=newsitemLeagues:leagueIDS &include=leagues&filters=newsitemLeagues:8", "name": "newsitemLeagues", "names": [ "newsitemLeagues", "newsitemLeagues" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns latest updated news ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/News" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 8536, "fixture_id": 19427455, "league_id": 8, "title": "Liverpool are Top of the League Following Victory Over AFC Bournemouth", "type": "postmatch" }, { "id": 8546, "fixture_id": 19427456, "league_id": 8, "title": "Newcastle United Holds Firm to Secure Valuable Point Against Aston Villa", "type": "postmatch" }, { "id": 8548, "fixture_id": 19427460, "league_id": 8, "title": "Tottenham Hotspur Secures Victory, Keeping Burnley Scoreless", "type": "postmatch" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/news/post-match/seasons/25583?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns all post-match news articles from your requested season ID. Our Post-Match News is available instantly after a match has finished. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/news/get-post-match-news-by-season-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/news/get-post-match-news-by-season-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/news/get-post-match-news-by-season-id", "description": "Sportmonks docs" } } }, "/football/news/pre-match/seasons/{seasonId}": { "get": { "operationId": "getPreMatchNewsBySeasonId", "summary": "Pre-match News by Season ID", "tags": [ "News" ], "parameters": [ { "name": "seasonId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the season you want to retrieve post-match news from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: fixture, league, lines. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=fixture;league`.", "schema": { "type": "string" }, "x-includes": [ "fixture", "league", "lines" ], "x-include-depth-max": 1, "example": "fixture;league" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, league_id, title, type. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "league_id", "title", "type" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "league_id", "title", "type" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: newsitemLeagues. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "newsitemLeagues", "use": "Leagues Check this endpoint for all possibilities.", "description": "Filter the news items on a selection of leagues separated by a comma.", "example": "&include=leagues&filters=newsitemLeagues:leagueIDS &include=leagues&filters=newsitemLeagues:8" } ], "x-filters": [ { "kind": "dynamic", "entity": "newsitemLeagues", "use": "Leagues Check this endpoint for all possibilities.", "description": "Filter the news items on a selection of leagues separated by a comma.", "example": "&include=leagues&filters=newsitemLeagues:leagueIDS &include=leagues&filters=newsitemLeagues:8", "name": "newsitemLeagues", "names": [ "newsitemLeagues", "newsitemLeagues" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns latest updated news ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/News" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 8496, "fixture_id": 19427455, "league_id": 8, "title": "Liverpool take on AFC Bournemouth in season opener.", "type": "prematch" }, { "id": 8503, "fixture_id": 19427456, "league_id": 8, "title": "Aston Villa eye back-to-back opening-day victories as Newcastle visits.", "type": "prematch" }, { "id": 8504, "fixture_id": 19427457, "league_id": 8, "title": "Seagulls take on Fulham in opening weekend clash.", "type": "prematch" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/news/pre-match/seasons/25583?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns all pre-match news articles from your requested season ID. Our Pre-Match News is available at a minimum of 48 hours before the start of a match. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/news/get-pre-match-news-by-season-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/news/get-pre-match-news-by-season-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/news/get-pre-match-news-by-season-id", "description": "Sportmonks docs" } } }, "/football/news/pre-match/upcoming": { "get": { "operationId": "getPreMatchNewsForUpcomingFixtures", "summary": "Pre-match News for Upcoming Fixtures", "tags": [ "News" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: fixture, league, lines. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=fixture;league`.", "schema": { "type": "string" }, "x-includes": [ "fixture", "league", "lines" ], "x-include-depth-max": 1, "example": "fixture;league" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, league_id, title, type. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "league_id", "title", "type" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "league_id", "title", "type" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: newsitemLeagues. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "newsitemLeagues", "use": "Leagues Check this endpoint for all possibilities.", "description": "Filter the news items on a selection of leagues separated by a comma.", "example": "&include=leagues&filters=newsitemLeagues:leagueIDS​&include=leagues&filters=newsitemLeagues:8" } ], "x-filters": [ { "kind": "dynamic", "entity": "newsitemLeagues", "use": "Leagues Check this endpoint for all possibilities.", "description": "Filter the news items on a selection of leagues separated by a comma.", "example": "&include=leagues&filters=newsitemLeagues:leagueIDS​&include=leagues&filters=newsitemLeagues:8", "name": "newsitemLeagues", "names": [ "newsitemLeagues", "newsitemLeagues" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns latest updated news ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/News" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 12571, "fixture_id": 19683238, "league_id": 2, "title": "Bayern eager to overturn one-goal deficit as PSG visits for showdown.", "type": "prematch" } ], "pagination": { "count": 1, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns all pre-match news articles for the upcoming fixtures within your subscription. Our Pre-Match News is available at a minimum of 48 hours before the start of a match. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/news/get-pre-match-news-for-upcoming-fixtures\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/news/get-pre-match-news-for-upcoming-fixtures)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/news/get-pre-match-news-for-upcoming-fixtures", "description": "Sportmonks docs" } } }, "/football/players": { "get": { "operationId": "getAllPlayers", "summary": "All Players", "tags": [ "Players" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, city, nationality, transfers, pendingTransfers, teams.team, statistics, latest, position, detailedPosition, lineups, trophies, metadata. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "city", "nationality", "transfers", "pendingTransfers", "teams.team", "statistics", "latest", "position", "detailedPosition", "lineups", "trophies", "metadata" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, nationality_id, city_id, position_id, detailed_position_id, type_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "position_id", "detailed_position_id", "type_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "position_id", "detailed_position_id", "type_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, playerstatisticdetailTypes, playerCountries, playerstatisticSeasons, lineupTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "GET All Players", "description": "Filter all players starting from a certain player ID. Handy if you're doing an import for all players and want to continue from a certain ID.", "example": "&filters=IdAfter:playerID &filters=IdAfter:758" } ], "x-filters-dynamic": [ { "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=playerstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=playerstatisticdetailTypes:59" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter players and more based on countries.", "example": "&include=country&filters=playerCountries:countryIDS &include=country&filters=playerCountries:462" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter player statistics based on seasons.", "example": "&include=statistics.details.type&filters=playerstatisticSeasons:seasonIDS &include=statistics.details.type&filters=playerstatisticSeasons:19735" }, { "entity": "lineups", "use": "Players", "description": "Filter the player lineups on types", "example": "&include=lineups.type&filters=lineupTypes:typeIDS &include=lineups.type&filters=lineupTypes:12" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "GET All Players", "description": "Filter all players starting from a certain player ID. Handy if you're doing an import for all players and want to continue from a certain ID.", "example": "&filters=IdAfter:playerID &filters=IdAfter:758" }, { "kind": "dynamic", "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=playerstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=playerstatisticdetailTypes:59", "name": "playerstatisticdetailTypes", "names": [ "playerstatisticdetailTypes", "playerstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter players and more based on countries.", "example": "&include=country&filters=playerCountries:countryIDS &include=country&filters=playerCountries:462", "name": "playerCountries", "names": [ "playerCountries", "playerCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter player statistics based on seasons.", "example": "&include=statistics.details.type&filters=playerstatisticSeasons:seasonIDS &include=statistics.details.type&filters=playerstatisticSeasons:19735", "name": "playerstatisticSeasons", "names": [ "playerstatisticSeasons", "playerstatisticSeasons" ] }, { "kind": "dynamic", "entity": "lineups", "use": "Players", "description": "Filter the player lineups on types", "example": "&include=lineups.type&filters=lineupTypes:typeIDS &include=lineups.type&filters=lineupTypes:12", "name": "lineupTypes", "names": [ "lineupTypes", "lineupTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns players ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Player" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "sport_id": 1, "country_id": 462, "nationality_id": 462, "city_id": 21022, "position_id": 26, "detailed_position_id": 150, "type_id": 27, "common_name": "R. Hulse", "firstname": "Rob", "lastname": "Hulse", "name": "Rob Hulse", "display_name": "Rob Hulse", "image_path": "https://cdn.sportmonks.com/images/soccer/players/1/1.png", "height": 187, "weight": 78, "date_of_birth": "1979-10-25", "gender": "male" }, { "id": 2, "sport_id": 1, "country_id": 462, "nationality_id": 462, "city_id": 91281, "position_id": null, "detailed_position_id": null, "type_id": 221, "common_name": "R. Fowler", "firstname": "Robbie", "lastname": "Fowler", "name": "Robbie Fowler", "display_name": "Robbie Fowler", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": 170, "weight": 75, "date_of_birth": "1975-04-09", "gender": "male" }, { "id": 3, "sport_id": 1, "country_id": 462, "nationality_id": 462, "city_id": 6773, "position_id": null, "detailed_position_id": null, "type_id": 221, "common_name": "C. Morgan", "firstname": "Chris", "lastname": "Morgan", "name": "Chris Morgan", "display_name": "Chris Morgan", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": 185, "weight": 77, "date_of_birth": "1977-09-11", "gender": "male" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/players?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns player information from your requested player ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/players/get-all-players\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/players/get-all-players)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/players/get-all-players", "description": "Sportmonks docs" } } }, "/football/players/latest": { "get": { "operationId": "getLastUpdatedPlayers", "summary": "Last Updated Players", "tags": [ "Players" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, city, nationality, transfers, pendingTransfers, teams.team, statistics, latest, position, detailedPosition, lineups, trophies, metadata. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "city", "nationality", "transfers", "pendingTransfers", "teams.team", "statistics", "latest", "position", "detailedPosition", "lineups", "trophies", "metadata" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, nationality_id, city_id, position_id, detailed_position_id, type_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "position_id", "detailed_position_id", "type_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "position_id", "detailed_position_id", "type_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: playerstatisticdetailTypes, playerstatisticSeasons, lineupTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the statistics (detailTypes) on a selection of player statistics separated by a comma.", "example": "&include=statistics.details.type&filters=playerstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=playerstatisticdetailTypes:59" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter player statistics based on seasons.", "example": "&include=statistics.details.type&filters=playerstatisticSeasons:seasonIDS &include=statistics.details.type&filters=playerstatisticSeasons:19735" }, { "entity": "lineups", "use": "Players", "description": "Filter the player lineups on types", "example": "&include=lineups.type&filters=lineupTypes:typeIDS &include=lineups.type&filters=lineupTypes:12" } ], "x-filters": [ { "kind": "dynamic", "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the statistics (detailTypes) on a selection of player statistics separated by a comma.", "example": "&include=statistics.details.type&filters=playerstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=playerstatisticdetailTypes:59", "name": "playerstatisticdetailTypes", "names": [ "playerstatisticdetailTypes", "playerstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter player statistics based on seasons.", "example": "&include=statistics.details.type&filters=playerstatisticSeasons:seasonIDS &include=statistics.details.type&filters=playerstatisticSeasons:19735", "name": "playerstatisticSeasons", "names": [ "playerstatisticSeasons", "playerstatisticSeasons" ] }, { "kind": "dynamic", "entity": "lineups", "use": "Players", "description": "Filter the player lineups on types", "example": "&include=lineups.type&filters=lineupTypes:typeIDS &include=lineups.type&filters=lineupTypes:12", "name": "lineupTypes", "names": [ "lineupTypes", "lineupTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns latest updated players ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Player" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 29294358, "sport_id": 1, "country_id": 44, "nationality_id": 44, "city_id": 79992, "position_id": 25, "detailed_position_id": 148, "type_id": 26, "common_name": "N. Capaldo", "firstname": "Nicolás", "lastname": "Capaldo", "name": "Nicolás Capaldo", "display_name": "Nicolás Capaldo", "image_path": "https://cdn.sportmonks.com/images/soccer/players/22/29294358.png", "height": 177, "weight": 75, "date_of_birth": "1998-09-14", "gender": "male" }, { "id": 37645260, "sport_id": 1, "country_id": 11, "nationality_id": 11, "city_id": null, "position_id": 26, "detailed_position_id": 153, "type_id": null, "common_name": "I. Ugoh", "firstname": "Ikem", "lastname": "Ugoh", "name": "Ikem Ugoh", "display_name": "I. Ugoh", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": "2005-07-11", "gender": "male" }, { "id": 37527678, "sport_id": 1, "country_id": 143, "nationality_id": 143, "city_id": null, "position_id": 27, "detailed_position_id": 151, "type_id": 27, "common_name": "F. Ristanic", "firstname": "Filip", "lastname": "Ristanic", "name": "Filip Ristanic", "display_name": "Filip Ristanić", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": 181, "weight": 72, "date_of_birth": "2004-01-30", "gender": "male" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns all the players that have received updates in the past two hours. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/players/get-last-updated-players\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/players/get-last-updated-players)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/players/get-last-updated-players", "description": "Sportmonks docs" } } }, "/football/players/{playerId}": { "get": { "operationId": "getPlayerById", "summary": "Player by ID", "tags": [ "Players" ], "parameters": [ { "name": "playerId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the player you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, city, nationality, transfers, pendingTransfers, teams.team, statistics, latest, position, detailedPosition, lineups, trophies, metadata. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "city", "nationality", "transfers", "pendingTransfers", "teams.team", "statistics", "latest", "position", "detailedPosition", "lineups", "trophies", "metadata" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, nationality_id, city_id, position_id, detailed_position_id, type_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "position_id", "detailed_position_id", "type_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "position_id", "detailed_position_id", "type_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: playerstatisticdetailTypes, playerstatisticSeasons, lineupTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the statistics (detailTypes) on a selection of type ids separated by a comma.", "example": "&include=statistics.details.type&filters=playerstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=playerstatisticdetailTypes:59" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter player statistics based on seasons.", "example": "&include=statistics.details.type&filters=playerstatisticSeasons:seasonIDS &include=statistics.details.type&filters=playerstatisticSeasons:19735" }, { "entity": "lineups", "use": "Players", "description": "Filter the player lineups on types", "example": "&include=lineups.type&filters=lineupTypes:typeIDS &include=lineups.type&filters=lineupTypes:12" } ], "x-filters": [ { "kind": "dynamic", "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the statistics (detailTypes) on a selection of type ids separated by a comma.", "example": "&include=statistics.details.type&filters=playerstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=playerstatisticdetailTypes:59", "name": "playerstatisticdetailTypes", "names": [ "playerstatisticdetailTypes", "playerstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter player statistics based on seasons.", "example": "&include=statistics.details.type&filters=playerstatisticSeasons:seasonIDS &include=statistics.details.type&filters=playerstatisticSeasons:19735", "name": "playerstatisticSeasons", "names": [ "playerstatisticSeasons", "playerstatisticSeasons" ] }, { "kind": "dynamic", "entity": "lineups", "use": "Players", "description": "Filter the player lineups on types", "example": "&include=lineups.type&filters=lineupTypes:typeIDS &include=lineups.type&filters=lineupTypes:12", "name": "lineupTypes", "names": [ "lineupTypes", "lineupTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Player" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 1743, "sport_id": 1, "country_id": 38, "nationality_id": 38, "city_id": 11824, "position_id": 25, "detailed_position_id": 148, "type_id": 25, "common_name": "V. van Dijk", "firstname": "Virgil", "lastname": "van Dijk", "name": "Virgil van Dijk", "display_name": "Virgil van Dijk ", "image_path": "https://cdn.sportmonks.com/images/soccer/players/15/1743.png", "height": 195, "weight": 92, "date_of_birth": "1991-07-08", "gender": "male" }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns player information from your requested player ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/players/get-player-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/players/get-player-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/players/get-player-by-id", "description": "Sportmonks docs" } } }, "/football/players/countries/{countryId}": { "get": { "operationId": "getPlayersByCountryId", "summary": "Players by Country ID", "tags": [ "Players" ], "parameters": [ { "name": "countryId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the country you want to retrieve players from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, city, nationality, transfers, pendingTransfers, teams.team, statistics, latest, position, detailedPosition, lineups, trophies, metadata. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "city", "nationality", "transfers", "pendingTransfers", "teams.team", "statistics", "latest", "position", "detailedPosition", "lineups", "trophies", "metadata" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, nationality_id, city_id, position_id, detailed_position_id, type_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "position_id", "detailed_position_id", "type_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "position_id", "detailed_position_id", "type_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: playerstatisticdetailTypes, playerstatisticSeasons, lineupTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the statistics (detailTypes) on a selection of type ids separated by a comma.", "example": "&include=statistics.details.type&filters=playerstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=playerstatisticdetailTypes:59" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter player statistics based on seasons.", "example": "&include=statistics.details.type&filters=playerstatisticSeasons:seasonIDS &include=statistics.details.type&filters=playerstatisticSeasons:19735" }, { "entity": "lineups", "use": "Players", "description": "Filter the player lineups on types", "example": "&include=lineups.type&filters=lineupTypes:typeIDS &include=lineups.type&filters=lineupTypes:12" } ], "x-filters": [ { "kind": "dynamic", "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the statistics (detailTypes) on a selection of type ids separated by a comma.", "example": "&include=statistics.details.type&filters=playerstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=playerstatisticdetailTypes:59", "name": "playerstatisticdetailTypes", "names": [ "playerstatisticdetailTypes", "playerstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter player statistics based on seasons.", "example": "&include=statistics.details.type&filters=playerstatisticSeasons:seasonIDS &include=statistics.details.type&filters=playerstatisticSeasons:19735", "name": "playerstatisticSeasons", "names": [ "playerstatisticSeasons", "playerstatisticSeasons" ] }, { "kind": "dynamic", "entity": "lineups", "use": "Players", "description": "Filter the player lineups on types", "example": "&include=lineups.type&filters=lineupTypes:typeIDS &include=lineups.type&filters=lineupTypes:12", "name": "lineupTypes", "names": [ "lineupTypes", "lineupTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns players ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Player" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 589, "sport_id": 1, "country_id": 2, "nationality_id": 1004, "city_id": null, "position_id": 27, "detailed_position_id": null, "type_id": 27, "common_name": "T. Radzinski", "firstname": "Tomasz", "lastname": "Radzinski", "name": "Tomasz Radzinski", "display_name": "Tomasz Radzinski", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": 174, "weight": 75, "date_of_birth": "1973-12-14", "gender": "male" }, { "id": 733, "sport_id": 1, "country_id": 2, "nationality_id": 2, "city_id": 45868, "position_id": 24, "detailed_position_id": 24, "type_id": 24, "common_name": "Ł. Fabiański", "firstname": "Łukasz", "lastname": "Fabiański", "name": "Łukasz Fabiański", "display_name": "Lukasz Fabianski ", "image_path": "https://cdn.sportmonks.com/images/soccer/players/29/733.png", "height": 190, "weight": 83, "date_of_birth": "1985-04-18", "gender": "male" }, { "id": 752, "sport_id": 1, "country_id": 2, "nationality_id": 2, "city_id": 46321, "position_id": 24, "detailed_position_id": null, "type_id": 24, "common_name": "T. Kuszczak", "firstname": "Tomasz", "lastname": "Kuszczak", "name": "Tomasz Kuszczak", "display_name": "Tomasz Kuszczak", "image_path": "https://cdn.sportmonks.com/images/soccer/players/16/752.png", "height": 191, "weight": 84, "date_of_birth": "1982-03-20", "gender": "male" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/players/countries/2?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns player information from your requested country ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/players/get-players-by-country-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/players/get-players-by-country-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/players/get-players-by-country-id", "description": "Sportmonks docs" } } }, "/football/players/search/{name}": { "get": { "operationId": "getPlayersBySearchByName", "summary": "Players by Search by Name", "tags": [ "Players" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name you want to search on." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, city, nationality, transfers, pendingTransfers, teams.team, statistics, latest, position, detailedPosition, lineups, trophies, metadata. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "city", "nationality", "transfers", "pendingTransfers", "teams.team", "statistics", "latest", "position", "detailedPosition", "lineups", "trophies", "metadata" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, nationality_id, city_id, position_id, detailed_position_id, type_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "position_id", "detailed_position_id", "type_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "position_id", "detailed_position_id", "type_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: playerstatisticdetailTypes, playerstatisticSeasons, lineupTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the statistics (detailTypes) on a selection of type ids separated by a comma.", "example": "&include=statistics.details.type&filters=playerstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=playerstatisticdetailTypes:59" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter player statistics based on seasons.", "example": "&include=statistics.details.type&filters=playerstatisticSeasons:seasonIDS &include=statistics.details.type&filters=playerstatisticSeasons:19735" }, { "entity": "lineups", "use": "Players", "description": "Filter the player lineups on types", "example": "&include=lineups.type&filters=lineupTypes:typeIDS &include=lineups.type&filters=lineupTypes:12" } ], "x-filters": [ { "kind": "dynamic", "entity": "detailTypes", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the statistics (detailTypes) on a selection of type ids separated by a comma.", "example": "&include=statistics.details.type&filters=playerstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=playerstatisticdetailTypes:59", "name": "playerstatisticdetailTypes", "names": [ "playerstatisticdetailTypes", "playerstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter player statistics based on seasons.", "example": "&include=statistics.details.type&filters=playerstatisticSeasons:seasonIDS &include=statistics.details.type&filters=playerstatisticSeasons:19735", "name": "playerstatisticSeasons", "names": [ "playerstatisticSeasons", "playerstatisticSeasons" ] }, { "kind": "dynamic", "entity": "lineups", "use": "Players", "description": "Filter the player lineups on types", "example": "&include=lineups.type&filters=lineupTypes:typeIDS &include=lineups.type&filters=lineupTypes:12", "name": "lineupTypes", "names": [ "lineupTypes", "lineupTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns players ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Player" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 42274, "sport_id": 1, "country_id": 11, "nationality_id": 11, "city_id": null, "position_id": 25, "detailed_position_id": null, "type_id": 25, "common_name": "P. Messingschlager", "firstname": "Philip", "lastname": "Messingschlager", "name": "Philip Messingschlager", "display_name": "Philip Messingschlager", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": 179, "weight": 73, "date_of_birth": "1992-10-02", "gender": "male" }, { "id": 70672, "sport_id": 1, "country_id": 593, "nationality_id": 593, "city_id": null, "position_id": 26, "detailed_position_id": null, "type_id": 26, "common_name": "G. Tiko Messina", "firstname": "Germain Francelin", "lastname": "Tiko Messina", "name": "Germain Francelin Tiko Messina", "display_name": "Germain Francelin Tiko Messina", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": 170, "weight": null, "date_of_birth": "1990-04-29", "gender": "male" }, { "id": 77504, "sport_id": 1, "country_id": 116, "nationality_id": 116, "city_id": null, "position_id": 25, "detailed_position_id": null, "type_id": 25, "common_name": "P. Messiou", "firstname": "Petros", "lastname": "Messiou", "name": "Petros Messiou", "display_name": "Petros Messiou", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": "1984-11-09", "gender": "male" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/players/search/Messi?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns all the players that match your search query. The query returns only the players that have played matches in leagues that are part of your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/players/get-players-by-search-by-name\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/players/get-players-by-search-by-name)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/players/get-players-by-search-by-name", "description": "Sportmonks docs" } } }, "/football/predictions/value-bets": { "get": { "operationId": "getAllValueBets", "summary": "All Value Bets", "tags": [ "Predictions" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: type, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=type;fixture`.", "schema": { "type": "string" }, "x-includes": [ "type", "fixture" ], "x-include-depth-max": 1, "example": "type;fixture" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, predictions, type_id. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "predictions", "type_id" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "predictions", "type_id" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Prediction" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 20706, "fixture_id": 18298414, "predictions": { "bet": "X", "bookmaker": "bet365", "fair_odd": 3.73, "odd": 4, "stake": 0.51, "is_value": false }, "type_id": 33 }, { "id": 191304, "fixture_id": 18302600, "predictions": { "bet": "1", "bookmaker": "bet365", "fair_odd": 2.16, "odd": 2.25, "stake": 0.8, "is_value": false }, "type_id": 33 }, { "id": 195273, "fixture_id": 18138818, "predictions": { "bet": "1", "bookmaker": "williamhill", "fair_odd": 1.38, "odd": 1.4, "stake": 1.5, "is_value": false }, "type_id": 33 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/predictions/value-bets?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns all value bets available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/predictions/get-value-bets\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/predictions/get-value-bets)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/predictions/get-value-bets", "description": "Sportmonks docs" } } }, "/football/predictions/predictability/leagues/{leagueId}": { "get": { "operationId": "getPredictabilityByLeagueId", "summary": "Predictability by League ID", "tags": [ "Predictions" ], "parameters": [ { "name": "leagueId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the league you want to retrieve the predictability from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: type, league. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=type;league`.", "schema": { "type": "string" }, "x-includes": [ "type", "league" ], "x-include-depth-max": 1, "example": "type;league" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, league_id, type_id, data. Pass as a comma-separated list, e.g. `select=id,league_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "league_id", "type_id", "data" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "league_id", "type_id", "data" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: predictabilityTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the predictability on a selection of type IDs separated by a comma.", "example": "&filters=predictabilityTypes:typeIDs &filters=predictabilityTypes:245" } ], "x-filters": [ { "kind": "dynamic", "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the predictability on a selection of type IDs separated by a comma.", "example": "&filters=predictabilityTypes:typeIDs &filters=predictabilityTypes:245", "name": "predictabilityTypes", "names": [ "predictabilityTypes", "predictabilityTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Probability" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "league_id": 8, "type_id": 241, "data": { "fulltime_result": -1.1077, "away_over_under_0_5": -0.5918, "away_over_under_1_5": -0.6457, "both_teams_to_score": -0.6928, "team_to_score_first": -0.9502, "home_over_under_0_5": -0.5821, "home_over_under_1_5": -0.6975, "over_under_1_5": -0.5901, "over_under_2_5": -0.6845, "over_under_3_5": -0.6021, "correct_score": -3.3969, "ht_ft": -2.0314, "fulltime_result_1st_half": -1.1144 } }, { "id": 2, "league_id": 8, "type_id": 242, "data": { "fulltime_result": 0.48, "away_over_under_0_5": 0.72, "away_over_under_1_5": 0.65, "both_teams_to_score": 0.58, "team_to_score_first": 0.59, "home_over_under_0_5": 0.72, "home_over_under_1_5": 0.63, "over_under_1_5": 0.74, "over_under_2_5": 0.5, "over_under_3_5": 0.72, "correct_score": 0.11, "ht_ft": 0.28, "fulltime_result_1st_half": 0.47 } }, { "id": 3, "league_id": 8, "type_id": 243, "data": { "fulltime_result": "good", "away_over_under_0_5": "poor", "away_over_under_1_5": "poor", "both_teams_to_score": "poor", "team_to_score_first": "good", "home_over_under_0_5": "good", "home_over_under_1_5": "medium", "over_under_1_5": "medium", "over_under_2_5": "poor", "over_under_3_5": "poor", "correct_score": "high", "ht_ft": "good", "fulltime_result_1st_half": "high" } } ], "pagination": { "count": 5, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns the performances of our Predictions Model by requested league ID. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/predictions/get-predictability-by-league-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/predictions/get-predictability-by-league-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/predictions/get-predictability-by-league-id", "description": "Sportmonks docs" } } }, "/football/predictions/probabilities": { "get": { "operationId": "getProbabilities", "summary": "Probabilities", "tags": [ "Predictions" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: type, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=type;fixture`.", "schema": { "type": "string" }, "x-includes": [ "type", "fixture" ], "x-include-depth-max": 1, "example": "type;fixture" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, predictions, type_id. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "predictions", "type_id" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "predictions", "type_id" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: predictionTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the predictions on a selection of type IDs separated by a comma.", "example": "&filters=predictionTypes:typeIDs &filters=predictionTypes:236" } ], "x-filters": [ { "kind": "dynamic", "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the predictions on a selection of type IDs separated by a comma.", "example": "&filters=predictionTypes:typeIDs &filters=predictionTypes:236", "name": "predictionTypes", "names": [ "predictionTypes", "predictionTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns probabilities ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Prediction" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 236, "fixture_id": 17762386, "predictions": { "home": 53.992, "away": 25.543, "draw": 20.464 }, "type_id": 237 }, { "id": 237, "fixture_id": 17762386, "predictions": { "yes": 57.029, "no": 42.971 }, "type_id": 231 }, { "id": 238, "fixture_id": 17762386, "predictions": { "home_home": 22.412, "home_away": 6.222, "home_draw": 7.745, "away_home": 6.658, "away_away": 13.04, "away_draw": 7.533, "draw_draw": 12.543, "draw_home": 13.571, "draw_away": 10.275 }, "type_id": 232 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/predictions/probabilities?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns all probabilities available within your subscription. Note: All probabilities are available 21 days before the match starts. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/predictions/get-probabilities\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/predictions/get-probabilities)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/predictions/get-probabilities", "description": "Sportmonks docs" } } }, "/football/predictions/probabilities/fixtures/{fixtureId}": { "get": { "operationId": "getProbabilitiesByFixtureId", "summary": "Probabilities by Fixture ID", "tags": [ "Predictions" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the fixture you want to retrieve probabilities from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: type, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=type;fixture`.", "schema": { "type": "string" }, "x-includes": [ "type", "fixture" ], "x-include-depth-max": 1, "example": "type;fixture" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, predictions, type_id. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "predictions", "type_id" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "predictions", "type_id" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: predictionTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the predictions on a selection of type IDs separated by a comma.", "example": "&filters=predictionTypes:typeIDs &filters=predictionTypes:236" } ], "x-filters": [ { "kind": "dynamic", "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the predictions on a selection of type IDs separated by a comma.", "example": "&filters=predictionTypes:typeIDs &filters=predictionTypes:236", "name": "predictionTypes", "names": [ "predictionTypes", "predictionTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Prediction" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 26476362, "fixture_id": 19427201, "predictions": { "yes": 56.7, "no": 43.3 }, "type_id": 231 }, { "id": 26476364, "fixture_id": 19427201, "predictions": { "home_home": 37.06, "home_away": 2.09, "home_draw": 4.92, "away_home": 3.42, "away_away": 11.72, "away_draw": 4.18, "draw_draw": 11.89, "draw_home": 16.93, "draw_away": 7.79 }, "type_id": 232 }, { "id": 26476367, "fixture_id": 19427201, "predictions": { "home": 43.41, "away": 20, "draw": 36.59 }, "type_id": 233 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/predictions/probabilities/fixtures/19427201?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns all the predictions available for your requested fixture ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/predictions/get-probabilities-by-fixture-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/predictions/get-probabilities-by-fixture-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/predictions/get-probabilities-by-fixture-id", "description": "Sportmonks docs" } } }, "/football/predictions/value-bets/fixtures/{fixtureId}": { "get": { "operationId": "getValueBetsByFixtureId", "summary": "Value Bets by Fixture ID", "tags": [ "Predictions" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the fixture you want to retrieve value bets from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: type, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=type;fixture`.", "schema": { "type": "string" }, "x-includes": [ "type", "fixture" ], "x-include-depth-max": 1, "example": "type;fixture" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, predictions, type_id. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "predictions", "type_id" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "predictions", "type_id" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Prediction" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 20706, "fixture_id": 18298414, "predictions": { "bet": "X", "bookmaker": "bet365", "fair_odd": 3.73, "odd": 4, "stake": 0.51, "is_value": false }, "type_id": 33 } ], "pagination": { "count": 1, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns the value bets for the requested fixture. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/predictions/get-value-bets-by-fixture-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/predictions/get-value-bets-by-fixture-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/predictions/get-value-bets-by-fixture-id", "description": "Sportmonks docs" } } }, "/football/expected-lineups/teams/{teamId}": { "get": { "operationId": "getExpectedLineupByTeamId", "summary": "Expected Lineup by Team ID", "tags": [ "Premium Expected Lineups" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the team you want to retrieve expected lineups from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API with more data by using includes\n\nAllowed values: type, fixture, participant. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=type;fixture`.", "schema": { "type": "string" }, "x-includes": [ "type", "fixture", "participant" ], "x-include-depth-max": 3, "example": "type;fixture" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity.\n\nSelectable fields: id, sport_id, fixture_id, player_id, team_id, formation_field, position_id, detailed_position_id, type_id, formation_position, player_name, jersey_number. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "fixture_id", "player_id", "team_id", "formation_field", "position_id", "detailed_position_id", "type_id", "formation_position", "player_name", "jersey_number" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "fixture_id", "player_id", "team_id", "formation_field", "position_id", "detailed_position_id", "type_id", "formation_position", "player_name", "jersey_number" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExpectedLineup" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 420395, "sport_id": 1, "fixture_id": 19427187, "player_id": 1453, "team_id": 8, "formation_field": null, "position_id": null, "detailed_position_id": null, "type_id": 77615, "formation_position": null, "player_name": "Joe Gomez", "jersey_number": 2 }, { "id": 420396, "sport_id": 1, "fixture_id": 19427187, "player_id": 1743, "team_id": 8, "formation_field": "2:2", "position_id": 155, "detailed_position_id": 148, "type_id": 77614, "formation_position": 4, "player_name": "Virgil van Dijk", "jersey_number": 4 }, { "id": 430176, "sport_id": 1, "fixture_id": 19427187, "player_id": 100556, "team_id": 8, "formation_field": "2:3", "position_id": 154, "detailed_position_id": 148, "type_id": 77614, "formation_position": 3, "player_name": "Ibrahima Konaté", "jersey_number": 5 } ], "pagination": { "count": 190, "per_page": 190, "current_page": 1, "next_page": "/?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint allows you to get all the xG values we have available per team within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-expected-lineups/get-expected-lineup-by-team\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-expected-lineups/get-expected-lineup-by-team)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-expected-lineups/get-expected-lineup-by-team", "description": "Sportmonks docs" } } }, "/football/expected-lineups/players/{playerId}": { "get": { "operationId": "getExpectedLineupsByPlayerId", "summary": "Expected Lineups by Player ID", "tags": [ "Premium Expected Lineups" ], "parameters": [ { "name": "playerId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the player you want to retrieve expected data from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API with more data by using includes\n\nAllowed values: type, fixture, player, team. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=type;fixture`.", "schema": { "type": "string" }, "x-includes": [ "type", "fixture", "player", "team" ], "x-include-depth-max": 3, "example": "type;fixture" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity.\n\nSelectable fields: id, sport_id, fixture_id, player_id, team_id, formation_field, position_id, detailed_position_id, type_id, formation_position, player_name, jersey_number. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "fixture_id", "player_id", "team_id", "formation_field", "position_id", "detailed_position_id", "type_id", "formation_position", "player_name", "jersey_number" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "fixture_id", "player_id", "team_id", "formation_field", "position_id", "detailed_position_id", "type_id", "formation_position", "player_name", "jersey_number" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: lineupDetailTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "Types", "use": "LineupDetail", "description": "Filters the player statistics on a specific type separated by commas.", "example": "&filters=lineupDetailTypes:TypeIDs &filters=lineupDetailTypes:5304" } ], "x-filters": [ { "kind": "dynamic", "entity": "Types", "use": "LineupDetail", "description": "Filters the player statistics on a specific type separated by commas.", "example": "&filters=lineupDetailTypes:TypeIDs &filters=lineupDetailTypes:5304", "name": "lineupDetailTypes", "names": [ "lineupDetailTypes", "lineupDetailTypes" ] } ] }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExpectedLineup" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 507017, "sport_id": 1, "fixture_id": 19427220, "player_id": 1743, "team_id": 8, "formation_field": "2:3", "position_id": 155, "detailed_position_id": 148, "type_id": 77614, "formation_position": 4, "player_name": "Virgil van Dijk", "jersey_number": 4 }, { "id": 497031, "sport_id": 1, "fixture_id": 19427213, "player_id": 1743, "team_id": 8, "formation_field": "2:2", "position_id": 155, "detailed_position_id": 148, "type_id": 77614, "formation_position": 4, "player_name": "Virgil van Dijk", "jersey_number": 4 }, { "id": 477123, "sport_id": 1, "fixture_id": 19427201, "player_id": 1743, "team_id": 8, "formation_field": "2:3", "position_id": 155, "detailed_position_id": 148, "type_id": 77614, "formation_position": 4, "player_name": "Virgil van Dijk", "jersey_number": 4 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/expected-lineups/players/1743?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint allows you to get all the xG values we have available per player (lineup) within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-expected-lineups/get-expected-lineups-by-player\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-expected-lineups/get-expected-lineups-by-player)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-expected-lineups/get-expected-lineups-by-player", "description": "Sportmonks docs" } } }, "/football/referees": { "get": { "operationId": "getAllReferees", "summary": "All Referees", "tags": [ "Referees" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, nationality, statistics, city. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "nationality", "statistics", "city" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, nationality_id, city_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, refereestatisticdetailTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "All", "description": "Filter all fixtures starting from a certain fixture ID. Handy when you are only interested in the most recent fixtures.", "example": "&filters=IdAfter:refereeID &filters=IdAfter:18535487" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics on a selection of type ids separated by a comma.", "example": "&include=statistics.details&filters=refereestatisticdetailTypes:typeIDs &include=statistics.details&filters=refereestatisticdetailTypes:188" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&refereeCountries:CountryIDs &refereeCountries:44" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all fixtures starting from a certain fixture ID. Handy when you are only interested in the most recent fixtures.", "example": "&filters=IdAfter:refereeID &filters=IdAfter:18535487" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics on a selection of type ids separated by a comma.", "example": "&include=statistics.details&filters=refereestatisticdetailTypes:typeIDs &include=statistics.details&filters=refereestatisticdetailTypes:188", "name": "refereestatisticdetailTypes", "names": [ "refereestatisticdetailTypes", "refereestatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&refereeCountries:CountryIDs &refereeCountries:44" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns referees ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Referee" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 3, "sport_id": 1, "country_id": null, "city_id": null, "common_name": "C. Cakir", "firstname": "Cuneyt", "lastname": "Cakir", "name": "Cuneyt Cakir", "display_name": "Cuneyt Cakir", "image_path": "https://cdn.sportmonks.com/images//soccer/referees/3/3.png", "height": null, "weight": null, "date_of_birth": null, "gender": null }, { "id": 25, "sport_id": 1, "country_id": null, "city_id": null, "common_name": "Mark Clattenburg", "firstname": null, "lastname": null, "name": "Mark Clattenburg", "display_name": "Mark Clattenburg", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": null, "gender": null }, { "id": 28, "sport_id": 1, "country_id": 38, "city_id": null, "common_name": "Bjorn Kuipers", "firstname": "Björn", "lastname": "Kuipers", "name": "Bjorn Kuipers", "display_name": "Bjorn Kuipers", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": null, "gender": null } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/referees?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all referees available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/referees/get-all-referees\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/referees/get-all-referees)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/referees/get-all-referees", "description": "Sportmonks docs" } } }, "/football/referees/{refereeId}": { "get": { "operationId": "getRefereeById", "summary": "Referee by ID", "tags": [ "Referees" ], "parameters": [ { "name": "refereeId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the referee you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, nationality, statistics, city. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "nationality", "statistics", "city" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, nationality_id, city_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: refereestatisticdetailTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics on a selection of type ids separated by a comma.", "example": "&include=statistics.details&filters=refereestatisticdetailTypes:typeIDs &include=statistics.details&filters=refereestatisticdetailTypes:188" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&refereeCountries:CountryIDs &refereeCountries:44" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics on a selection of type ids separated by a comma.", "example": "&include=statistics.details&filters=refereestatisticdetailTypes:typeIDs &include=statistics.details&filters=refereestatisticdetailTypes:188", "name": "refereestatisticdetailTypes", "names": [ "refereestatisticdetailTypes", "refereestatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&refereeCountries:CountryIDs &refereeCountries:44" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Referee" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 811, "sport_id": 1, "country_id": null, "city_id": null, "common_name": "Dean Whitestone", "firstname": null, "lastname": null, "name": "Dean Whitestone", "display_name": "Dean Whitestone", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": null, "gender": null }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns referee information from your requested referee ID. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/referees/get-referee-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/referees/get-referee-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/referees/get-referee-by-id", "description": "Sportmonks docs" } } }, "/football/referees/countries/{countryId}": { "get": { "operationId": "getRefereesByCountryId", "summary": "Referees by Country ID", "tags": [ "Referees" ], "parameters": [ { "name": "countryId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the country you want to retrieve referees from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, nationality, statistics, city. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "nationality", "statistics", "city" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, nationality_id, city_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: refereestatisticdetailTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics on a selection of type ids separated by a comma.", "example": "&include=statistics.details&filters=refereestatisticdetailTypes:typeIDs &include=statistics.details&filters=refereestatisticdetailTypes:188" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&refereeCountries:CountryIDs &refereeCountries:44" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics on a selection of type ids separated by a comma.", "example": "&include=statistics.details&filters=refereestatisticdetailTypes:typeIDs &include=statistics.details&filters=refereestatisticdetailTypes:188", "name": "refereestatisticdetailTypes", "names": [ "refereestatisticdetailTypes", "refereestatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&refereeCountries:CountryIDs &refereeCountries:44" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns referees ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Referee" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 14430, "sport_id": 1, "country_id": 2, "city_id": null, "common_name": "T. Musial", "firstname": "Tomasz", "lastname": "Musial", "name": "Tomasz Musial", "display_name": "Tomasz Musial", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": null, "gender": null }, { "id": 14431, "sport_id": 1, "country_id": 2, "city_id": null, "common_name": "R. Siejka", "firstname": "Radoslav", "lastname": "Siejka", "name": "Radoslav Siejka", "display_name": "Radoslav Siejka", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": null, "gender": null }, { "id": 14432, "sport_id": 1, "country_id": 2, "city_id": null, "common_name": "J. Ślusarski", "firstname": "Jakub", "lastname": "Ślusarski", "name": "Jakub Ślusarski", "display_name": "Jakub Ślusarski", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": null, "gender": null } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/referees/countries/2?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns referee information from your requested country ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/referees/get-referees-by-country-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/referees/get-referees-by-country-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/referees/get-referees-by-country-id", "description": "Sportmonks docs" } } }, "/football/referees/seasons/{seasonId}": { "get": { "operationId": "getRefereesBySeasonId", "summary": "Referees by Season ID", "tags": [ "Referees" ], "parameters": [ { "name": "seasonId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the season you want to retrieve referees from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, nationality, statistics, city. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "nationality", "statistics", "city" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, nationality_id, city_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: refereestatisticdetailTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics on a selection of type ids separated by a comma.", "example": "&include=statistics.details&filters=refereestatisticdetailTypes:typeIDs &include=statistics.details&filters=refereestatisticdetailTypes:188" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&refereeCountries:CountryIDs &refereeCountries:44" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics on a selection of type ids separated by a comma.", "example": "&include=statistics.details&filters=refereestatisticdetailTypes:typeIDs &include=statistics.details&filters=refereestatisticdetailTypes:188", "name": "refereestatisticdetailTypes", "names": [ "refereestatisticdetailTypes", "refereestatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&refereeCountries:CountryIDs &refereeCountries:44" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns referees ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Referee" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 811, "sport_id": 1, "country_id": null, "city_id": null, "common_name": "Dean Whitestone", "firstname": null, "lastname": null, "name": "Dean Whitestone", "display_name": "Dean Whitestone", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": null, "gender": null }, { "id": 1407, "sport_id": 1, "country_id": null, "city_id": null, "common_name": "James Linington", "firstname": null, "lastname": null, "name": "James Linington", "display_name": "James Linington", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": null, "gender": null }, { "id": 12018, "sport_id": 1, "country_id": 462, "city_id": null, "common_name": "M. Scholes", "firstname": "Mark", "lastname": "Scholes", "name": "Mark Scholes", "display_name": "Mark Scholes", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": null, "gender": null } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/referees/seasons/25583?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns referee information from your requested season ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/referees/get-referees-by-season-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/referees/get-referees-by-season-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/referees/get-referees-by-season-id", "description": "Sportmonks docs" } } }, "/football/referees/search/{name}": { "get": { "operationId": "getRefereesSearchByName", "summary": "Referees Search by Name", "tags": [ "Referees" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name you want to search on." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, nationality, statistics, city. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "nationality", "statistics", "city" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, nationality_id, city_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: refereestatisticdetailTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics on a selection of type ids separated by a comma.", "example": "&include=statistics.details&filters=refereestatisticdetailTypes:typeIDs &include=statistics.details&filters=refereestatisticdetailTypes:188" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&refereeCountries:CountryIDs &refereeCountries:44" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics on a selection of type ids separated by a comma.", "example": "&include=statistics.details&filters=refereestatisticdetailTypes:typeIDs &include=statistics.details&filters=refereestatisticdetailTypes:188", "name": "refereestatisticdetailTypes", "names": [ "refereestatisticdetailTypes", "refereestatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&refereeCountries:CountryIDs &refereeCountries:44" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns referees ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Referee" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 11616, "sport_id": 1, "country_id": 11, "city_id": null, "common_name": "O. Lossius", "firstname": "Oliver", "lastname": "Lossius", "name": "Oliver Lossius", "display_name": "Oliver Lossius", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": null, "gender": null }, { "id": 13536, "sport_id": 1, "country_id": 462, "city_id": null, "common_name": "O. Bickle", "firstname": "Oliver", "lastname": "Bickle", "name": "Oliver Bickle", "display_name": "Oliver Bickle", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": null, "gender": null }, { "id": 14659, "sport_id": 1, "country_id": 462, "city_id": null, "common_name": "O. Langford", "firstname": "Oliver", "lastname": "Langford", "name": "Oliver Langford", "display_name": "Oliver Langford", "image_path": "https://cdn.sportmonks.com/images/soccer/placeholder.png", "height": null, "weight": null, "date_of_birth": null, "gender": null } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/referees/search/Oliver?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the referees that match your search query. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/referees/get-referees-search-by-name\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/referees/get-referees-search-by-name)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/referees/get-referees-search-by-name", "description": "Sportmonks docs" } } }, "/football/rivals": { "get": { "operationId": "getAllRivals", "summary": "All Rivals", "tags": [ "Rivals" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: team, rival. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=team;rival`.", "schema": { "type": "string" }, "x-includes": [ "team", "rival" ], "x-include-depth-max": 1, "example": "team;rival" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: sport_id, team_id, rival_id. Pass as a comma-separated list, e.g. `select=sport_id,team_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "sport_id", "team_id", "rival_id" ] } }, "style": "form", "explode": false, "x-select-fields": [ "sport_id", "team_id", "rival_id" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "All", "description": "Filter all fixtures starting from a certain rivals id. Handy when you are only interested in the most recent fixtures.", "example": "&filters=IdAfter:rivalID &filters=IdAfter:18535487" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all fixtures starting from a certain rivals id. Handy when you are only interested in the most recent fixtures.", "example": "&filters=IdAfter:rivalID &filters=IdAfter:18535487" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns rivals ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Rival" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "sport_id": 1, "team_id": 2706, "rival_id": 1020, "id": 1 }, { "sport_id": 1, "team_id": 290, "rival_id": 393, "id": 2 }, { "sport_id": 1, "team_id": 1646, "rival_id": 2619, "id": 3 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/rivals?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns all the teams within your subscription with the rivals information (if available). For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rivals/get-all-rivals\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rivals/get-all-rivals)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rivals/get-all-rivals", "description": "Sportmonks docs" } } }, "/football/rivals/teams/{teamId}": { "get": { "operationId": "getRivalsByTeamId", "summary": "Rivals by Team ID", "tags": [ "Rivals" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the team you want to retrieve rivals from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: team, rival. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=team;rival`.", "schema": { "type": "string" }, "x-includes": [ "team", "rival" ], "x-include-depth-max": 1, "example": "team;rival" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: sport_id, team_id, rival_id. Pass as a comma-separated list, e.g. `select=sport_id,team_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "sport_id", "team_id", "rival_id" ] } }, "style": "form", "explode": false, "x-select-fields": [ "sport_id", "team_id", "rival_id" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Rival" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "sport_id": 1, "team_id": 8, "rival_id": 14, "id": 1246 } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns the rivals of your requested team ID (if available). For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rivals/get-rivals-by-team-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rivals/get-rivals-by-team-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rivals/get-rivals-by-team-id", "description": "Sportmonks docs" } } }, "/football/rounds": { "get": { "operationId": "getAllRounds", "summary": "All Rounds", "tags": [ "Rounds" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, league, season, stage, fixtures, statistics. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;league`.", "schema": { "type": "string" }, "x-includes": [ "sport", "league", "season", "stage", "fixtures", "statistics" ], "x-include-depth-max": 4, "example": "sport;league" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, group_id, name, finished, pending, is_current, starting_at, ending_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "group_id", "name", "finished", "pending", "is_current", "starting_at", "ending_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "group_id", "name", "finished", "pending", "is_current", "starting_at", "ending_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, roundLeagues, roundSeasons, roundStages. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "GET All Rounds", "description": "Filter all rounds starting from a certain round ID. Handy if you're doing an import for all rounds and want to continue from a certain ID.", "example": "&filters=IdAfter:roundID &filters=IdAfter:1100" } ], "x-filters-dynamic": [ { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter rounds based on leagues.", "example": "&include=league &filters=roundLeagues:leagueIDS &include=league &filters=roundLeagues:501" }, { "entity": "seasons", "use": "Check this endpoint for all possibilities.", "description": "Filter rounds based on seasons.", "example": "&include=season &filters=roundSeasons:seasonIDS &include=season &filters=roundSeasons:19735" }, { "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter rounds based on stage IDs", "example": "&include=stage &filters=roundStages:stageIDS &include= &filters=roundStages:77457866" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "GET All Rounds", "description": "Filter all rounds starting from a certain round ID. Handy if you're doing an import for all rounds and want to continue from a certain ID.", "example": "&filters=IdAfter:roundID &filters=IdAfter:1100" }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter rounds based on leagues.", "example": "&include=league &filters=roundLeagues:leagueIDS &include=league &filters=roundLeagues:501", "name": "roundLeagues", "names": [ "roundLeagues", "roundLeagues" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Check this endpoint for all possibilities.", "description": "Filter rounds based on seasons.", "example": "&include=season &filters=roundSeasons:seasonIDS &include=season &filters=roundSeasons:19735", "name": "roundSeasons", "names": [ "roundSeasons", "roundSeasons" ] }, { "kind": "dynamic", "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter rounds based on stage IDs", "example": "&include=stage &filters=roundStages:stageIDS &include= &filters=roundStages:77457866", "name": "roundStages", "names": [ "roundStages", "roundStages" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns rounds ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Round" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "sport_id": 1, "league_id": 66, "season_id": 1, "stage_id": 1, "name": "1", "finished": true, "is_current": false, "starting_at": null, "ending_at": null, "games_in_current_week": false }, { "id": 2, "sport_id": 1, "league_id": 66, "season_id": 1, "stage_id": 1, "name": "2", "finished": true, "is_current": false, "starting_at": null, "ending_at": null, "games_in_current_week": false }, { "id": 3, "sport_id": 1, "league_id": 66, "season_id": 1, "stage_id": 1, "name": "3", "finished": false, "is_current": false, "starting_at": "2025-10-23", "ending_at": "2025-10-23", "games_in_current_week": false } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/rounds?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the rounds available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rounds/get-all-rounds\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rounds/get-all-rounds)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rounds/get-all-rounds", "description": "Sportmonks docs" } } }, "/football/rounds/{roundId}": { "get": { "operationId": "getRoundById", "summary": "Round by ID", "tags": [ "Rounds" ], "parameters": [ { "name": "roundId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the round you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, league, season, stage, fixtures, statistics. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;league`.", "schema": { "type": "string" }, "x-includes": [ "sport", "league", "season", "stage", "fixtures", "statistics" ], "x-include-depth-max": 4, "example": "sport;league" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, group_id, name, finished, pending, is_current, starting_at, ending_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "group_id", "name", "finished", "pending", "is_current", "starting_at", "ending_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "group_id", "name", "finished", "pending", "is_current", "starting_at", "ending_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Round" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 372150, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "name": "34", "finished": true, "is_current": false, "starting_at": "2026-04-21", "ending_at": "2026-04-27", "games_in_current_week": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns round information from your requested round ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rounds/get-round-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rounds/get-round-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rounds/get-round-by-id", "description": "Sportmonks docs" } } }, "/football/rounds/search/{name}": { "get": { "operationId": "getRoundsBySearchByName", "summary": "Rounds by Search by Name", "tags": [ "Rounds" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name you want to search on." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, league, season, stage, fixtures, statistics. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;league`.", "schema": { "type": "string" }, "x-includes": [ "sport", "league", "season", "stage", "fixtures", "statistics" ], "x-include-depth-max": 4, "example": "sport;league" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, group_id, name, finished, pending, is_current, starting_at, ending_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "group_id", "name", "finished", "pending", "is_current", "starting_at", "ending_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "group_id", "name", "finished", "pending", "is_current", "starting_at", "ending_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: roundLeagues, roundSeasons, roundStages. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter rounds based on leagues.", "example": "&include=league &filters=roundLeagues:leagueIDS &include=league &filters=roundLeagues:501" }, { "entity": "seasons", "use": "Check this endpoint for all possibilities.", "description": "Filter rounds based on seasons.", "example": "&include=season &filters=roundSeasons:seasonIDS &include=season &filters=roundSeasons:19735" }, { "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter rounds based on stage IDs", "example": "&include=stage &filters=roundStages:stageIDS &include= &filters=roundStages:77457866" } ], "x-filters": [ { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter rounds based on leagues.", "example": "&include=league &filters=roundLeagues:leagueIDS &include=league &filters=roundLeagues:501", "name": "roundLeagues", "names": [ "roundLeagues", "roundLeagues" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Check this endpoint for all possibilities.", "description": "Filter rounds based on seasons.", "example": "&include=season &filters=roundSeasons:seasonIDS &include=season &filters=roundSeasons:19735", "name": "roundSeasons", "names": [ "roundSeasons", "roundSeasons" ] }, { "kind": "dynamic", "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter rounds based on stage IDs", "example": "&include=stage &filters=roundStages:stageIDS &include= &filters=roundStages:77457866", "name": "roundStages", "names": [ "roundStages", "roundStages" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns rounds ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Round" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "sport_id": 1, "league_id": 66, "season_id": 1, "stage_id": 1, "name": "1", "finished": true, "is_current": false, "starting_at": null, "ending_at": null, "games_in_current_week": false }, { "id": 10, "sport_id": 1, "league_id": 66, "season_id": 1, "stage_id": 1, "name": "10", "finished": true, "is_current": false, "starting_at": null, "ending_at": null, "games_in_current_week": false }, { "id": 11, "sport_id": 1, "league_id": 66, "season_id": 1, "stage_id": 1, "name": "11", "finished": true, "is_current": false, "starting_at": null, "ending_at": null, "games_in_current_week": false } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/rounds/search/1?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all rounds that matches your search query. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rounds/get-rounds-by-search-by-name\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rounds/get-rounds-by-search-by-name)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rounds/get-rounds-by-search-by-name", "description": "Sportmonks docs" } } }, "/football/rounds/seasons/{seasonId}": { "get": { "operationId": "getRoundsBySeasonId", "summary": "Rounds by Season ID", "tags": [ "Rounds" ], "parameters": [ { "name": "seasonId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the season you want to retrieve rounds from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, league, season, stage, fixtures, statistics. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;league`.", "schema": { "type": "string" }, "x-includes": [ "sport", "league", "season", "stage", "fixtures", "statistics" ], "x-include-depth-max": 4, "example": "sport;league" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .", "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: roundStages. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter rounds based on stage IDs", "example": "&include=stage &filters=roundStages:stageIDS &include= &filters=roundStages:77457866" } ], "x-filters": [ { "kind": "dynamic", "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter rounds based on stage IDs", "example": "&include=stage &filters=roundStages:stageIDS &include= &filters=roundStages:77457866", "name": "roundStages", "names": [ "roundStages", "roundStages" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Round" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 372195, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "name": "1", "finished": true, "is_current": false, "starting_at": "2025-08-15", "ending_at": "2025-08-18", "games_in_current_week": false }, { "id": 372204, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "name": "10", "finished": true, "is_current": false, "starting_at": "2025-11-01", "ending_at": "2025-11-03", "games_in_current_week": false }, { "id": 372205, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "name": "11", "finished": true, "is_current": false, "starting_at": "2025-11-08", "ending_at": "2025-11-09", "games_in_current_week": false } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns round information from your requested season ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rounds/get-rounds-by-season-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rounds/get-rounds-by-season-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/rounds/get-rounds-by-season-id", "description": "Sportmonks docs" } } }, "/football/schedules/seasons/{seasonId}": { "get": { "operationId": "getSchedulesBySeasonId", "summary": "Schedules by Season ID", "tags": [ "Schedules" ], "parameters": [ { "name": "seasonId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the season you want to retrieve the schedule from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, type_id, name, sort_order, finished, pending, is_current, starting_at, ending_at, group_id, stage_id, aggregate_id, state_id, round_id, venue_id, home_score, away_score, … (4 more). Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "type_id", "name", "sort_order", "finished", "pending", "is_current", "starting_at", "ending_at", "group_id", "stage_id", "aggregate_id", "state_id", "round_id", "venue_id", "home_score", "away_score", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "type_id", "name", "sort_order", "finished", "pending", "is_current", "starting_at", "ending_at", "group_id", "stage_id", "aggregate_id", "state_id", "round_id", "venue_id", "home_score", "away_score", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StageRoundFixtures" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 77476879, "sport_id": 1, "league_id": 8, "season_id": 25583, "type_id": 223, "name": "Regular Season", "sort_order": 1, "finished": false, "is_current": true, "starting_at": "2025-08-15", "ending_at": "2026-05-24", "games_in_current_week": false, "tie_breaker_rule_id": null, "rounds": [ { "id": 372195, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "name": "1", "finished": true, "is_current": false, "starting_at": "2025-08-15", "ending_at": "2025-08-18", "games_in_current_week": false, "fixtures": [ { "id": 19427459, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "aggregate_id": null, "round_id": 372195, "state_id": 5, "venue_id": 212, "name": "Sunderland vs West Ham United", "starting_at": "2025-08-16 14:00:00", "result_info": "Sunderland won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1755352800, "participants": [ { "id": 1, "sport_id": 1, "country_id": 462, "venue_id": 214, "gender": "male", "name": "West Ham United", "short_code": "WHU", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/1/1.png", "founded": 1895, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-02 14:00:00", "meta": { "location": "away", "winner": false, "position": 16 } }, { "id": 3, "sport_id": 1, "country_id": 462, "venue_id": 212, "gender": "male", "name": "Sunderland", "short_code": "SUN", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/3/3.png", "founded": 1879, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-02 14:00:00", "meta": { "location": "home", "winner": true, "position": 2 } } ], "scores": [ { "id": 16788425, "fixture_id": 19427459, "type_id": 2, "participant_id": 3, "score": { "goals": 3, "participant": "home" }, "description": "2ND_HALF" }, { "id": 16788421, "fixture_id": 19427459, "type_id": 1, "participant_id": 1, "score": { "goals": 0, "participant": "away" }, "description": "1ST_HALF" } ] }, { "id": 19427462, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "aggregate_id": null, "round_id": 372195, "state_id": 5, "venue_id": 321614, "name": "Chelsea vs Crystal Palace", "starting_at": "2025-08-17 13:00:00", "result_info": "Game ended in draw.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1755435600, "participants": [ { "id": 18, "sport_id": 1, "country_id": 462, "venue_id": 321614, "gender": "male", "name": "Chelsea", "short_code": "CHE", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/18/18.png", "founded": 1905, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-04 14:00:00", "meta": { "location": "home", "winner": false, "position": 12 } }, { "id": 51, "sport_id": 1, "country_id": 462, "venue_id": 201, "gender": "male", "name": "Crystal Palace", "short_code": "CRY", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/19/51.png", "founded": 1905, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-03 13:00:00", "meta": { "location": "away", "winner": false, "position": 14 } } ], "scores": [ { "id": 16799098, "fixture_id": 19427462, "type_id": 1, "participant_id": 18, "score": { "goals": 0, "participant": "home" }, "description": "1ST_HALF" }, { "id": 16800778, "fixture_id": 19427462, "type_id": 48996, "participant_id": 18, "score": { "goals": 0, "participant": "home" }, "description": "2ND_HALF_ONLY" } ] } ] }, { "id": 372196, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "name": "2", "finished": true, "is_current": false, "starting_at": "2025-08-22", "ending_at": "2025-08-25", "games_in_current_week": false, "fixtures": [ { "id": 19427471, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "aggregate_id": null, "round_id": 372196, "state_id": 5, "venue_id": 485, "name": "Fulham vs Manchester United", "starting_at": "2025-08-24 15:30:00", "result_info": "Game ended in draw.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1756049400, "participants": [ { "id": 14, "sport_id": 1, "country_id": 462, "venue_id": 206, "gender": "male", "name": "Manchester United", "short_code": "MUN", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/14/14.png", "founded": 1878, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-03 14:30:00", "meta": { "location": "away", "winner": false, "position": 18 } }, { "id": 11, "sport_id": 1, "country_id": 462, "venue_id": 485, "gender": "male", "name": "Fulham", "short_code": "FUL", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/11/11.png", "founded": 1879, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-02 16:30:00", "meta": { "location": "home", "winner": false, "position": 14 } } ], "scores": [ { "id": 16841884, "fixture_id": 19427471, "type_id": 48996, "participant_id": 11, "score": { "goals": 1, "participant": "home" }, "description": "2ND_HALF_ONLY" }, { "id": 16841885, "fixture_id": 19427471, "type_id": 48996, "participant_id": 14, "score": { "goals": 1, "participant": "away" }, "description": "2ND_HALF_ONLY" } ] }, { "id": 19427472, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "aggregate_id": null, "round_id": 372196, "state_id": 5, "venue_id": 151, "name": "Manchester City vs Tottenham Hotspur", "starting_at": "2025-08-23 11:30:00", "result_info": "Tottenham Hotspur won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1755948600, "participants": [ { "id": 9, "sport_id": 1, "country_id": 462, "venue_id": 151, "gender": "male", "name": "Manchester City", "short_code": "MCI", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/9/9.png", "founded": 1880, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-04 19:00:00", "meta": { "location": "home", "winner": false, "position": 2 } }, { "id": 6, "sport_id": 1, "country_id": 462, "venue_id": 281313, "gender": "male", "name": "Tottenham Hotspur", "short_code": "TOT", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/6/6.png", "founded": 1882, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-03 18:00:00", "meta": { "location": "away", "winner": true, "position": 4 } } ], "scores": [ { "id": 16824710, "fixture_id": 19427472, "type_id": 48996, "participant_id": 9, "score": { "goals": 0, "participant": "home" }, "description": "2ND_HALF_ONLY" }, { "id": 16824711, "fixture_id": 19427472, "type_id": 48996, "participant_id": 6, "score": { "goals": 0, "participant": "away" }, "description": "2ND_HALF_ONLY" } ] } ] } ], "aggregates": [] } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the complete season schedule from your requested season ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/schedules/get-schedules-by-season-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/schedules/get-schedules-by-season-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/schedules/get-schedules-by-season-id", "description": "Sportmonks docs" } } }, "/football/schedules/seasons/{seasonId}/teams/{teamId}": { "get": { "operationId": "getSchedulesBySeasonIdAndTeamId", "summary": "Schedules by Season ID and Team ID", "tags": [ "Schedules" ], "parameters": [ { "name": "seasonId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the season you want to retrieve the schedule from." }, { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the team you want to retrieve the schedule from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, continues_from_id, sport_id, league_id, season_id, type_id, name, sort_order, finished, pending, is_current, starting_at, ending_at, group_id, stage_id, aggregate_id, state_id, round_id, venue_id, home_score, … (5 more). Pass as a comma-separated list, e.g. `select=id,continues_from_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "continues_from_id", "sport_id", "league_id", "season_id", "type_id", "name", "sort_order", "finished", "pending", "is_current", "starting_at", "ending_at", "group_id", "stage_id", "aggregate_id", "state_id", "round_id", "venue_id", "home_score", "away_score", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "continues_from_id", "sport_id", "league_id", "season_id", "type_id", "name", "sort_order", "finished", "pending", "is_current", "starting_at", "ending_at", "group_id", "stage_id", "aggregate_id", "state_id", "round_id", "venue_id", "home_score", "away_score", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StageRoundFixtures" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 77476879, "sport_id": 1, "league_id": 8, "season_id": 25583, "type_id": 223, "name": "Regular Season", "sort_order": 1, "finished": false, "is_current": true, "starting_at": "2025-08-15", "ending_at": "2026-05-24", "games_in_current_week": false, "tie_breaker_rule_id": null, "aggregates": [], "rounds": [ { "id": 372144, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "name": "27", "finished": true, "is_current": false, "starting_at": "2026-02-21", "ending_at": "2026-02-23", "games_in_current_week": false, "fixtures": [ { "id": 19427151, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "aggregate_id": null, "round_id": 372144, "state_id": 5, "venue_id": 542, "name": "Nottingham Forest vs Liverpool", "starting_at": "2026-02-22 14:00:00", "result_info": "Liverpool won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1771768800, "participants": [ { "id": 63, "sport_id": 1, "country_id": 462, "venue_id": 542, "gender": "male", "name": "Nottingham Forest", "short_code": "NFO", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/31/63.png", "founded": 1865, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-04 14:00:00", "meta": { "location": "home", "winner": false, "position": 17 } }, { "id": 8, "sport_id": 1, "country_id": 462, "venue_id": 230, "gender": "male", "name": "Liverpool", "short_code": "LIV", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/8/8.png", "founded": 1892, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-03 14:30:00", "meta": { "location": "away", "winner": true, "position": 6 } } ], "scores": [ { "id": 19460899, "fixture_id": 19427151, "type_id": 1, "participant_id": 8, "score": { "goals": 0, "participant": "away" }, "description": "1ST_HALF" }, { "id": 19460898, "fixture_id": 19427151, "type_id": 1, "participant_id": 63, "score": { "goals": 0, "participant": "home" }, "description": "1ST_HALF" } ] } ] }, { "id": 372197, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "name": "3", "finished": true, "is_current": false, "starting_at": "2025-08-30", "ending_at": "2025-08-31", "games_in_current_week": false, "fixtures": [ { "id": 19427479, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "aggregate_id": null, "round_id": 372197, "state_id": 5, "venue_id": 230, "name": "Liverpool vs Arsenal", "starting_at": "2025-08-31 15:30:00", "result_info": "Liverpool won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1756654200, "participants": [ { "id": 8, "sport_id": 1, "country_id": 462, "venue_id": 230, "gender": "male", "name": "Liverpool", "short_code": "LIV", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/8/8.png", "founded": 1892, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-03 14:30:00", "meta": { "location": "home", "winner": true, "position": 4 } }, { "id": 19, "sport_id": 1, "country_id": 462, "venue_id": 204, "gender": "male", "name": "Arsenal", "short_code": "ARS", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/19/19.png", "founded": 1886, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-05 19:00:00", "meta": { "location": "away", "winner": false, "position": 2 } } ], "scores": [ { "id": 16883430, "fixture_id": 19427479, "type_id": 1, "participant_id": 19, "score": { "goals": 0, "participant": "away" }, "description": "1ST_HALF" }, { "id": 16883431, "fixture_id": 19427479, "type_id": 2, "participant_id": 8, "score": { "goals": 1, "participant": "home" }, "description": "2ND_HALF" } ] } ] } ] } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the complete season schedule for one specific team from your requested season ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/schedules/get-schedules-by-season-id-and-team-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/schedules/get-schedules-by-season-id-and-team-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/schedules/get-schedules-by-season-id-and-team-id", "description": "Sportmonks docs" } } }, "/football/schedules/teams/{teamId}": { "get": { "operationId": "getSchedulesByTeamId", "summary": "Schedules by Team ID", "tags": [ "Schedules" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the team you want to retrieve the schedule from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, continues_from_id, sport_id, league_id, season_id, type_id, name, sort_order, finished, pending, is_current, starting_at, ending_at, group_id, stage_id, aggregate_id, state_id, round_id, venue_id, home_score, … (5 more). Pass as a comma-separated list, e.g. `select=id,continues_from_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "continues_from_id", "sport_id", "league_id", "season_id", "type_id", "name", "sort_order", "finished", "pending", "is_current", "starting_at", "ending_at", "group_id", "stage_id", "aggregate_id", "state_id", "round_id", "venue_id", "home_score", "away_score", "result_info", "leg", "details", "length" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "continues_from_id", "sport_id", "league_id", "season_id", "type_id", "name", "sort_order", "finished", "pending", "is_current", "starting_at", "ending_at", "group_id", "stage_id", "aggregate_id", "state_id", "round_id", "venue_id", "home_score", "away_score", "result_info", "leg", "details", "length" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StageRoundFixtures" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 77479438, "sport_id": 1, "league_id": 1101, "season_id": 26738, "type_id": 225, "name": "Regular Season", "sort_order": 1, "finished": false, "is_current": true, "starting_at": "2026-01-05", "ending_at": "2026-08-12", "games_in_current_week": false, "tie_breaker_rule_id": null, "fixtures": [ { "id": 19686573, "sport_id": 1, "league_id": 1101, "season_id": 26738, "stage_id": 77479438, "group_id": null, "aggregate_id": null, "round_id": null, "state_id": 1, "venue_id": 230, "name": "Liverpool vs Wrexham", "starting_at": "2026-07-29 00:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 1785283200, "participants": [ { "id": 8, "sport_id": 1, "country_id": 462, "venue_id": 230, "gender": "male", "name": "Liverpool", "short_code": "LIV", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/8/8.png", "founded": 1892, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-03 14:30:00", "meta": { "location": "home", "winner": null, "position": null } }, { "id": 283, "sport_id": 1, "country_id": 462, "venue_id": 871, "gender": "male", "name": "Wrexham", "short_code": "WXH", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/27/283.png", "founded": 1872, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-02 11:30:00", "meta": { "location": "away", "winner": null, "position": null } } ], "scores": [] }, { "id": 19686574, "sport_id": 1, "league_id": 1101, "season_id": 26738, "stage_id": 77479438, "group_id": null, "aggregate_id": null, "round_id": null, "state_id": 1, "venue_id": 230, "name": "Liverpool vs Leeds United", "starting_at": "2026-08-02 00:00:00", "result_info": null, "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": false, "has_premium_odds": false, "starting_at_timestamp": 1785628800, "participants": [ { "id": 8, "sport_id": 1, "country_id": 462, "venue_id": 230, "gender": "male", "name": "Liverpool", "short_code": "LIV", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/8/8.png", "founded": 1892, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-03 14:30:00", "meta": { "location": "home", "winner": null, "position": null } }, { "id": 71, "sport_id": 1, "country_id": 462, "venue_id": 488, "gender": "male", "name": "Leeds United", "short_code": "LEE", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/7/71.png", "founded": 1919, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-01 19:00:00", "meta": { "location": "away", "winner": null, "position": null } } ], "scores": [] } ], "rounds": [] }, { "id": 77476879, "sport_id": 1, "league_id": 8, "season_id": 25583, "type_id": 223, "name": "Regular Season", "sort_order": 1, "finished": false, "is_current": true, "starting_at": "2025-08-15", "ending_at": "2026-05-24", "games_in_current_week": false, "tie_breaker_rule_id": null, "aggregates": [], "rounds": [ { "id": 372144, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "name": "27", "finished": true, "is_current": false, "starting_at": "2026-02-21", "ending_at": "2026-02-23", "games_in_current_week": false, "fixtures": [ { "id": 19427151, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "aggregate_id": null, "round_id": 372144, "state_id": 5, "venue_id": 542, "name": "Nottingham Forest vs Liverpool", "starting_at": "2026-02-22 14:00:00", "result_info": "Liverpool won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1771768800, "participants": [ { "id": 63, "sport_id": 1, "country_id": 462, "venue_id": 542, "gender": "male", "name": "Nottingham Forest", "short_code": "NFO", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/31/63.png", "founded": 1865, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-04 14:00:00", "meta": { "location": "home", "winner": false, "position": 17 } }, { "id": 8, "sport_id": 1, "country_id": 462, "venue_id": 230, "gender": "male", "name": "Liverpool", "short_code": "LIV", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/8/8.png", "founded": 1892, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-03 14:30:00", "meta": { "location": "away", "winner": true, "position": 6 } } ], "scores": [ { "id": 19460899, "fixture_id": 19427151, "type_id": 1, "participant_id": 8, "score": { "goals": 0, "participant": "away" }, "description": "1ST_HALF" }, { "id": 19460898, "fixture_id": 19427151, "type_id": 1, "participant_id": 63, "score": { "goals": 0, "participant": "home" }, "description": "1ST_HALF" } ] } ] }, { "id": 372197, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "name": "3", "finished": true, "is_current": false, "starting_at": "2025-08-30", "ending_at": "2025-08-31", "games_in_current_week": false, "fixtures": [ { "id": 19427479, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "aggregate_id": null, "round_id": 372197, "state_id": 5, "venue_id": 230, "name": "Liverpool vs Arsenal", "starting_at": "2025-08-31 15:30:00", "result_info": "Liverpool won after full-time.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1756654200, "participants": [ { "id": 8, "sport_id": 1, "country_id": 462, "venue_id": 230, "gender": "male", "name": "Liverpool", "short_code": "LIV", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/8/8.png", "founded": 1892, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-03 14:30:00", "meta": { "location": "home", "winner": true, "position": 4 } }, { "id": 19, "sport_id": 1, "country_id": 462, "venue_id": 204, "gender": "male", "name": "Arsenal", "short_code": "ARS", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/19/19.png", "founded": 1886, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-05 19:00:00", "meta": { "location": "away", "winner": false, "position": 2 } } ], "scores": [ { "id": 16883430, "fixture_id": 19427479, "type_id": 1, "participant_id": 19, "score": { "goals": 0, "participant": "away" }, "description": "1ST_HALF" }, { "id": 16883431, "fixture_id": 19427479, "type_id": 2, "participant_id": 8, "score": { "goals": 1, "participant": "home" }, "description": "2ND_HALF" } ] } ] } ] }, { "id": 77477153, "sport_id": 1, "league_id": 23, "season_id": 25863, "type_id": 224, "name": "Final", "sort_order": 1, "finished": true, "is_current": false, "starting_at": "2025-08-10", "ending_at": "2025-08-10", "games_in_current_week": false, "tie_breaker_rule_id": null, "fixtures": [ { "id": 19464492, "sport_id": 1, "league_id": 23, "season_id": 25863, "stage_id": 77477153, "group_id": null, "aggregate_id": null, "round_id": null, "state_id": 8, "venue_id": 1315, "name": "Crystal Palace vs Liverpool", "starting_at": "2025-08-10 14:00:00", "result_info": "Crystal Palace won after penalties.", "leg": "1/1", "details": null, "length": 90, "placeholder": false, "has_odds": true, "has_premium_odds": true, "starting_at_timestamp": 1754834400, "participants": [ { "id": 51, "sport_id": 1, "country_id": 462, "venue_id": 201, "gender": "male", "name": "Crystal Palace", "short_code": "CRY", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/19/51.png", "founded": 1905, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-03 13:00:00", "meta": { "location": "home", "winner": true, "position": 1 } }, { "id": 8, "sport_id": 1, "country_id": 462, "venue_id": 230, "gender": "male", "name": "Liverpool", "short_code": "LIV", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/8/8.png", "founded": 1892, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-03 14:30:00", "meta": { "location": "away", "winner": false, "position": 2 } } ], "scores": [ { "id": 16768152, "fixture_id": 19464492, "type_id": 48996, "participant_id": 51, "score": { "goals": 1, "participant": "home" }, "description": "2ND_HALF_ONLY" }, { "id": 16768153, "fixture_id": 19464492, "type_id": 48996, "participant_id": 8, "score": { "goals": 0, "participant": "away" }, "description": "2ND_HALF_ONLY" } ] } ], "rounds": [] } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the complete schedule for the active seasons from your requested team ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/schedules/get-schedules-by-team-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/schedules/get-schedules-by-team-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/schedules/get-schedules-by-team-id", "description": "Sportmonks docs" } } }, "/football/seasons": { "get": { "operationId": "getAllSeasons", "summary": "All Seasons", "tags": [ "Seasons" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, league, teams, stages, currentStage, fixtures, groups, statistics, topscorers. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;league`.", "schema": { "type": "string" }, "x-includes": [ "sport", "league", "teams", "stages", "currentStage", "fixtures", "groups", "statistics", "topscorers" ], "x-include-depth-max": 3, "example": "sport;league" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, tie_breaker_rule_id, name, finished, pending, is_current, standing_method, starting_at, ending_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "tie_breaker_rule_id", "name", "finished", "pending", "is_current", "standing_method", "starting_at", "ending_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "tie_breaker_rule_id", "name", "finished", "pending", "is_current", "standing_method", "starting_at", "ending_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, seasonstatisticTypes, seasonLeagues, stageStages, roundRounds, seasonTopscorerTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "All", "description": "Filter all seasons starting from a certain season ID.", "example": "&filters=IdAfter:seasonId &filters=IdAfter:18017" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the season statistics on a selection of types separated by a comma.", "example": "&include=statistics&filters=seasonstatisticTypes:TypeIDs &include=statistics&filters=seasonstatisticTypes:52,88" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the seasons based on leagues.", "example": "&include=league&&filters=seasonLeagues:leagueIDs &include=league&&filters=seasonLeagues:2,8" }, { "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter season stages based on stage IDs", "example": "&filters=stageStages:stageIDS &filters=stageStages:77457866" }, { "entity": "rounds", "use": "Check this endpoint for all possibilities.", "description": "Filter season rounds based on round IDs", "example": "&filters=roundRounds:roundIDS &filters=roundRounds:290018" }, { "entity": "topscorers", "use": "Check this endpoint for all possibilities.", "description": "Filter season topscorers based on type IDs", "example": "&include=topscorers&filters=seasonTopscorerTypes:TypeIDs &include=topscorers&filters=seasonTopscorerTypes:208" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all seasons starting from a certain season ID.", "example": "&filters=IdAfter:seasonId &filters=IdAfter:18017" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the season statistics on a selection of types separated by a comma.", "example": "&include=statistics&filters=seasonstatisticTypes:TypeIDs &include=statistics&filters=seasonstatisticTypes:52,88", "name": "seasonstatisticTypes", "names": [ "seasonstatisticTypes", "seasonstatisticTypes" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the seasons based on leagues.", "example": "&include=league&&filters=seasonLeagues:leagueIDs &include=league&&filters=seasonLeagues:2,8", "name": "seasonLeagues", "names": [ "seasonLeagues", "seasonLeagues" ] }, { "kind": "dynamic", "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter season stages based on stage IDs", "example": "&filters=stageStages:stageIDS &filters=stageStages:77457866", "name": "stageStages", "names": [ "stageStages", "stageStages" ] }, { "kind": "dynamic", "entity": "rounds", "use": "Check this endpoint for all possibilities.", "description": "Filter season rounds based on round IDs", "example": "&filters=roundRounds:roundIDS &filters=roundRounds:290018", "name": "roundRounds", "names": [ "roundRounds", "roundRounds" ] }, { "kind": "dynamic", "entity": "topscorers", "use": "Check this endpoint for all possibilities.", "description": "Filter season topscorers based on type IDs", "example": "&include=topscorers&filters=seasonTopscorerTypes:TypeIDs &include=topscorers&filters=seasonTopscorerTypes:208", "name": "seasonTopscorerTypes", "names": [ "seasonTopscorerTypes", "seasonTopscorerTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns seasons ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Season" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "sport_id": 1, "league_id": 66, "tie_breaker_rule_id": 169, "name": "2013/2014", "finished": true, "pending": false, "is_current": false, "starting_at": "2013-08-10", "ending_at": "2014-05-05", "standings_recalculated_at": "2025-11-03 21:49:21", "games_in_current_week": false }, { "id": 2, "sport_id": 1, "league_id": 8, "tie_breaker_rule_id": 1526, "name": "2010/2011", "finished": true, "pending": false, "is_current": false, "starting_at": "2010-08-14", "ending_at": "2011-05-22", "standings_recalculated_at": "2023-05-24 08:28:07", "games_in_current_week": false }, { "id": 3, "sport_id": 1, "league_id": 8, "tie_breaker_rule_id": 1526, "name": "2013/2014", "finished": true, "pending": false, "is_current": false, "starting_at": "2013-08-17", "ending_at": "2014-05-11", "standings_recalculated_at": "2023-05-24 08:28:09", "games_in_current_week": false } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/seasons?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the seasons available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/seasons/get-all-seasons\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/seasons/get-all-seasons)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/seasons/get-all-seasons", "description": "Sportmonks docs" } } }, "/football/seasons/{seasonId}": { "get": { "operationId": "getSeasonsById", "summary": "Seasons by ID", "tags": [ "Seasons" ], "parameters": [ { "name": "seasonId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the season you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, league, teams, stages, currentStage, fixtures, groups, statistics, topscorers. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;league`.", "schema": { "type": "string" }, "x-includes": [ "sport", "league", "teams", "stages", "currentStage", "fixtures", "groups", "statistics", "topscorers" ], "x-include-depth-max": 3, "example": "sport;league" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, tie_breaker_rule_id, name, finished, pending, is_current, standing_method, starting_at, ending_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "tie_breaker_rule_id", "name", "finished", "pending", "is_current", "standing_method", "starting_at", "ending_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "tie_breaker_rule_id", "name", "finished", "pending", "is_current", "standing_method", "starting_at", "ending_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: seasonstatisticTypes, stageStages, roundRounds, seasonTopscorerTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the season statistics on a selection of types separated by a comma.", "example": "&include=statistics&filters=seasonstatisticTypes:TypeIDs &include=statistics&filters=seasonstatisticTypes:52,88" }, { "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter season stages based on stage IDs", "example": "&filters=stageStages:stageIDS &filters=stageStages:77457866" }, { "entity": "rounds", "use": "Check this endpoint for all possibilities.", "description": "Filter season rounds based on round IDs", "example": "&filters=roundRounds:roundIDS &filters=roundRounds:290018" }, { "entity": "topscorers", "use": "Check this endpoint for all possibilities.", "description": "Filter season topscorers based on type IDs", "example": "&include=topscorers&filters=seasonTopscorerTypes:TypeIDs &include=topscorers&filters=seasonTopscorerTypes:208" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the season statistics on a selection of types separated by a comma.", "example": "&include=statistics&filters=seasonstatisticTypes:TypeIDs &include=statistics&filters=seasonstatisticTypes:52,88", "name": "seasonstatisticTypes", "names": [ "seasonstatisticTypes", "seasonstatisticTypes" ] }, { "kind": "dynamic", "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter season stages based on stage IDs", "example": "&filters=stageStages:stageIDS &filters=stageStages:77457866", "name": "stageStages", "names": [ "stageStages", "stageStages" ] }, { "kind": "dynamic", "entity": "rounds", "use": "Check this endpoint for all possibilities.", "description": "Filter season rounds based on round IDs", "example": "&filters=roundRounds:roundIDS &filters=roundRounds:290018", "name": "roundRounds", "names": [ "roundRounds", "roundRounds" ] }, { "kind": "dynamic", "entity": "topscorers", "use": "Check this endpoint for all possibilities.", "description": "Filter season topscorers based on type IDs", "example": "&include=topscorers&filters=seasonTopscorerTypes:TypeIDs &include=topscorers&filters=seasonTopscorerTypes:208", "name": "seasonTopscorerTypes", "names": [ "seasonTopscorerTypes", "seasonTopscorerTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Season" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 25583, "sport_id": 1, "league_id": 8, "tie_breaker_rule_id": 1526, "name": "2025/2026", "finished": false, "pending": false, "is_current": true, "starting_at": "2025-08-15", "ending_at": "2026-05-24", "standings_recalculated_at": "2026-05-05 20:03:45", "games_in_current_week": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the season you requested by ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/seasons/get-seasons-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/seasons/get-seasons-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/seasons/get-seasons-by-id", "description": "Sportmonks docs" } } }, "/football/seasons/search/{name}": { "get": { "operationId": "getSeasonsBySearchByName", "summary": "Seasons by Search by Name", "tags": [ "Seasons" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name you want to search on." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, league, teams, stages, currentStage, fixtures, groups, statistics, topscorers. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;league`.", "schema": { "type": "string" }, "x-includes": [ "sport", "league", "teams", "stages", "currentStage", "fixtures", "groups", "statistics", "topscorers" ], "x-include-depth-max": 3, "example": "sport;league" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, tie_breaker_rule_id, name, finished, pending, is_current, standing_method, starting_at, ending_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "tie_breaker_rule_id", "name", "finished", "pending", "is_current", "standing_method", "starting_at", "ending_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "tie_breaker_rule_id", "name", "finished", "pending", "is_current", "standing_method", "starting_at", "ending_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: seasonstatisticTypes, seasonLeagues, stageStages, roundRounds, seasonTopscorerTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the season statistics on a selection of types separated by a comma.", "example": "&include=statistics&filters=seasonstatisticTypes:TypeIDs &include=statistics&filters=seasonstatisticTypes:52,88" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the seasons based on leagues.", "example": "&include=league&&filters=seasonLeagues:leagueIDs &include=league&&filters=seasonLeagues:2,8" }, { "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter season stages based on stage IDs", "example": "&filters=stageStages:stageIDS &filters=stageStages:77457866" }, { "entity": "rounds", "use": "Check this endpoint for all possibilities.", "description": "Filter season rounds based on round IDs", "example": "&filters=roundRounds:roundIDS &filters=roundRounds:290018" }, { "entity": "topscorers", "use": "Check this endpoint for all possibilities.", "description": "Filter season topscorers based on type IDs", "example": "&include=topscorers&filters=seasonTopscorerTypes:TypeIDs &include=topscorers&filters=seasonTopscorerTypes:208" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the season statistics on a selection of types separated by a comma.", "example": "&include=statistics&filters=seasonstatisticTypes:TypeIDs &include=statistics&filters=seasonstatisticTypes:52,88", "name": "seasonstatisticTypes", "names": [ "seasonstatisticTypes", "seasonstatisticTypes" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the seasons based on leagues.", "example": "&include=league&&filters=seasonLeagues:leagueIDs &include=league&&filters=seasonLeagues:2,8", "name": "seasonLeagues", "names": [ "seasonLeagues", "seasonLeagues" ] }, { "kind": "dynamic", "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter season stages based on stage IDs", "example": "&filters=stageStages:stageIDS &filters=stageStages:77457866", "name": "stageStages", "names": [ "stageStages", "stageStages" ] }, { "kind": "dynamic", "entity": "rounds", "use": "Check this endpoint for all possibilities.", "description": "Filter season rounds based on round IDs", "example": "&filters=roundRounds:roundIDS &filters=roundRounds:290018", "name": "roundRounds", "names": [ "roundRounds", "roundRounds" ] }, { "kind": "dynamic", "entity": "topscorers", "use": "Check this endpoint for all possibilities.", "description": "Filter season topscorers based on type IDs", "example": "&include=topscorers&filters=seasonTopscorerTypes:TypeIDs &include=topscorers&filters=seasonTopscorerTypes:208", "name": "seasonTopscorerTypes", "names": [ "seasonTopscorerTypes", "seasonTopscorerTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns seasons ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Season" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 16947, "sport_id": 1, "league_id": 1784, "tie_breaker_rule_id": 169, "name": "2024", "finished": true, "pending": false, "is_current": false, "starting_at": "2024-01-20", "ending_at": "2024-02-12", "standings_recalculated_at": "2024-05-08 21:15:35", "games_in_current_week": false }, { "id": 19129, "sport_id": 1, "league_id": 2433, "tie_breaker_rule_id": 169, "name": "2024", "finished": true, "pending": false, "is_current": false, "starting_at": "2024-02-23", "ending_at": "2024-03-03", "standings_recalculated_at": "2024-03-03 19:22:16", "games_in_current_week": false }, { "id": 20810, "sport_id": 1, "league_id": 1325, "tie_breaker_rule_id": 171, "name": "2024", "finished": true, "pending": false, "is_current": false, "starting_at": "2023-03-23", "ending_at": "2024-03-26", "standings_recalculated_at": "2025-12-11 14:44:12", "games_in_current_week": false } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/seasons/search/2024?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the seasons that match your search query. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/seasons/get-seasons-by-search-by-name\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/seasons/get-seasons-by-search-by-name)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/seasons/get-seasons-by-search-by-name", "description": "Sportmonks docs" } } }, "/football/seasons/teams/{teamId}": { "get": { "operationId": "getSeasonsByTeamId", "summary": "Seasons by Team ID", "tags": [ "Seasons" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the team you want to retrieve seasons from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, league, teams, stages, currentStage, fixtures, groups, statistics, topscorers. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;league`.", "schema": { "type": "string" }, "x-includes": [ "sport", "league", "teams", "stages", "currentStage", "fixtures", "groups", "statistics", "topscorers" ], "x-include-depth-max": 3, "example": "sport;league" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, tie_breaker_rule_id, name, finished, pending, is_current, standing_method, starting_at, ending_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "tie_breaker_rule_id", "name", "finished", "pending", "is_current", "standing_method", "starting_at", "ending_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "tie_breaker_rule_id", "name", "finished", "pending", "is_current", "standing_method", "starting_at", "ending_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: seasonstatisticTypes, stageStages, roundRounds, seasonTopscorerTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the season statistics on a selection of types separated by a comma.", "example": "&include=statistics&filters=seasonstatisticTypes:TypeIDs &include=statistics&filters=seasonstatisticTypes:52,88" }, { "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter season stages based on stage IDs", "example": "&filters=stageStages:stageIDS &filters=stageStages:77457866" }, { "entity": "rounds", "use": "Check this endpoint for all possibilities.", "description": "Filter season rounds based on round IDs", "example": "&filters=roundRounds:roundIDS &filters=roundRounds:290018" }, { "entity": "topscorers", "use": "Check this endpoint for all possibilities.", "description": "Filter season topscorers based on type IDs", "example": "&include=topscorers&filters=seasonTopscorerTypes:TypeIDs &include=topscorers&filters=seasonTopscorerTypes:208" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the season statistics on a selection of types separated by a comma.", "example": "&include=statistics&filters=seasonstatisticTypes:TypeIDs &include=statistics&filters=seasonstatisticTypes:52,88", "name": "seasonstatisticTypes", "names": [ "seasonstatisticTypes", "seasonstatisticTypes" ] }, { "kind": "dynamic", "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter season stages based on stage IDs", "example": "&filters=stageStages:stageIDS &filters=stageStages:77457866", "name": "stageStages", "names": [ "stageStages", "stageStages" ] }, { "kind": "dynamic", "entity": "rounds", "use": "Check this endpoint for all possibilities.", "description": "Filter season rounds based on round IDs", "example": "&filters=roundRounds:roundIDS &filters=roundRounds:290018", "name": "roundRounds", "names": [ "roundRounds", "roundRounds" ] }, { "kind": "dynamic", "entity": "topscorers", "use": "Check this endpoint for all possibilities.", "description": "Filter season topscorers based on type IDs", "example": "&include=topscorers&filters=seasonTopscorerTypes:TypeIDs &include=topscorers&filters=seasonTopscorerTypes:208", "name": "seasonTopscorerTypes", "names": [ "seasonTopscorerTypes", "seasonTopscorerTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Season" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 8, "sport_id": 1, "league_id": 8, "tie_breaker_rule_id": 1526, "name": "2006/2007", "finished": true, "pending": false, "is_current": false, "starting_at": "2006-08-19", "ending_at": "2007-05-13", "standings_recalculated_at": "2023-05-24 08:28:14", "games_in_current_week": false }, { "id": 24214, "sport_id": 1, "league_id": 2, "tie_breaker_rule_id": 170, "name": "2004/2005", "finished": true, "pending": false, "is_current": false, "starting_at": "2004-07-13", "ending_at": "2005-05-25", "standings_recalculated_at": "2024-08-07 10:22:38", "games_in_current_week": false }, { "id": 16029, "sport_id": 1, "league_id": 2, "tie_breaker_rule_id": 170, "name": "2019/2020", "finished": true, "pending": false, "is_current": false, "starting_at": "2019-06-25", "ending_at": "2020-08-23", "standings_recalculated_at": "2023-11-30 15:03:46", "games_in_current_week": false } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns seasons by team ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/seasons/get-seasons-by-team-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/seasons/get-seasons-by-team-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/seasons/get-seasons-by-team-id", "description": "Sportmonks docs" } } }, "/football/squads/teams/{teamId}/extended": { "get": { "operationId": "getExtendedTeamSquadByTeamId", "summary": "Extended Team Squad by Team ID", "tags": [ "Squads" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the team you want to retrieve squads from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, city, nationality, transfers, pendingTransfers, teams, statistics, latest, position, detailedPosition, lineups, trophies, metadata. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "city", "nationality", "transfers", "pendingTransfers", "teams", "statistics", "latest", "position", "detailedPosition", "lineups", "trophies", "metadata" ], "x-include-depth-max": 2, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, nationality_id, city_id, position_id, detailed_position_id, type_id, common_name, firstname, lastname, name, display_name, image_path, height, weight, date_of_birth, gender, in_squad. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "position_id", "detailed_position_id", "type_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender", "in_squad" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "nationality_id", "city_id", "position_id", "detailed_position_id", "type_id", "common_name", "firstname", "lastname", "name", "display_name", "image_path", "height", "weight", "date_of_birth", "gender", "in_squad" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: playerstatisticdetailTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the player statistics only on the types you're interested in.", "example": "&include=details&filters=playerstatisticdetailTypes:TypeIDS &include=details&filters=playerstatisticdetailTypes:80" } ], "x-filters": [ { "kind": "dynamic", "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the player statistics only on the types you're interested in.", "example": "&include=details&filters=playerstatisticdetailTypes:TypeIDS &include=details&filters=playerstatisticdetailTypes:80", "name": "playerstatisticdetailTypes", "names": [ "playerstatisticdetailTypes", "playerstatisticdetailTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Player" } }, "considered_season_ids": { "type": "array", "items": { "type": "integer" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "considered_season_ids", "data", "timezone" ] }, "example": { "data": [ { "id": 1078, "sport_id": 1, "country_id": 1161, "nationality_id": 1161, "city_id": 32192, "position_id": 25, "detailed_position_id": 155, "type_id": 25, "common_name": "A. Robertson", "firstname": "Andrew", "lastname": "Robertson", "name": "Andrew Robertson", "display_name": "Andrew Robertson", "image_path": "https://cdn.sportmonks.com/images/soccer/players/22/1078.png", "height": 178, "weight": 64, "date_of_birth": "1994-03-11", "gender": "male", "in_squad": true }, { "id": 1453, "sport_id": 1, "country_id": 462, "nationality_id": 462, "city_id": 51663, "position_id": 25, "detailed_position_id": 148, "type_id": 25, "common_name": "J. Gomez", "firstname": "Joe", "lastname": "Gomez", "name": "Joe Gomez", "display_name": "Joe Gomez", "image_path": "https://cdn.sportmonks.com/images/soccer/players/13/1453.png", "height": 188, "weight": 80, "date_of_birth": "1997-05-23", "gender": "male", "in_squad": true }, { "id": 1743, "sport_id": 1, "country_id": 38, "nationality_id": 38, "city_id": 11824, "position_id": 25, "detailed_position_id": 148, "type_id": 25, "common_name": "V. van Dijk", "firstname": "Virgil", "lastname": "van Dijk", "name": "Virgil van Dijk", "display_name": "Virgil van Dijk ", "image_path": "https://cdn.sportmonks.com/images/soccer/players/15/1743.png", "height": 195, "weight": 92, "date_of_birth": "1991-07-08", "gender": "male", "in_squad": true } ], "considered_season_ids": [ 25583, 26738, 25580, 25863, 25654, 25919 ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all squad entries for a team, based on current seasons. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-squads/get-extended-team-squad-by-team-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-squads/get-extended-team-squad-by-team-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-squads/get-extended-team-squad-by-team-id", "description": "Sportmonks docs" } } }, "/football/squads/seasons/{seasonId}/teams/{teamId}": { "get": { "operationId": "getTeamSquadBySeasonAndTeamId", "summary": "Team Squad by Season and Team ID", "tags": [ "Squads" ], "parameters": [ { "name": "seasonId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the season you want to retrieve squads from." }, { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the team you want to retrieve squads from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: player, team, season, details, position. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=player;team`.", "schema": { "type": "string" }, "x-includes": [ "player", "team", "season", "details", "position" ], "x-include-depth-max": 2, "example": "player;team" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, player_id, team_id, jersey_number, season_id. Pass as a comma-separated list, e.g. `select=id,player_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "player_id", "team_id", "jersey_number", "season_id" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "player_id", "team_id", "jersey_number", "season_id" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: playerstatisticdetailTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the player statistics only on the types you're interested in.", "example": "&include=details&filters=playerstatisticdetailTypes:TypeIDS &include=details&filters=playerstatisticdetailTypes:80" } ], "x-filters": [ { "kind": "dynamic", "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the player statistics only on the types you're interested in.", "example": "&include=details&filters=playerstatisticdetailTypes:TypeIDS &include=details&filters=playerstatisticdetailTypes:80", "name": "playerstatisticdetailTypes", "names": [ "playerstatisticdetailTypes", "playerstatisticdetailTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerStatistic" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1861444462, "player_id": 37581734, "team_id": 8, "season_id": 25583, "has_values": true, "position_id": 25, "jersey_number": 92 }, { "id": 1856584880, "player_id": 37260590, "team_id": 8, "season_id": 25583, "has_values": true, "position_id": 25, "jersey_number": 47 }, { "id": 1851688907, "player_id": 37600791, "team_id": 8, "season_id": 25583, "has_values": true, "position_id": 24, "jersey_number": 41 } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns (historical) squads from your requested season ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-squads/get-team-squad-by-team-and-season-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-squads/get-team-squad-by-team-and-season-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-squads/get-team-squad-by-team-and-season-id", "description": "Sportmonks docs" } } }, "/football/squads/teams/{teamId}": { "get": { "operationId": "getTeamSquadByTeamId", "summary": "Team Squad by Team ID", "tags": [ "Squads" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the team you want to retrieve squads from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: team, player, position, detailedPosition, transfer. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=team;player`.", "schema": { "type": "string" }, "x-includes": [ "team", "player", "position", "detailedPosition", "transfer" ], "x-include-depth-max": 4, "example": "team;player" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, transfer_id, player_id, team_id, position_id, detailed_position_id, jersey_number, start, end. Pass as a comma-separated list, e.g. `select=id,transfer_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "transfer_id", "player_id", "team_id", "position_id", "detailed_position_id", "jersey_number", "start", "end" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "transfer_id", "player_id", "team_id", "position_id", "detailed_position_id", "jersey_number", "start", "end" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TeamSquads" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1518331, "transfer_id": null, "player_id": 37260590, "team_id": 8, "position_id": 25, "detailed_position_id": 154, "start": "2025-07-01", "end": "2027-06-30", "captain": false, "jersey_number": 47 }, { "id": 1259611, "transfer_id": 509424, "player_id": 37669492, "team_id": 8, "position_id": 26, "detailed_position_id": 153, "start": "2025-07-01", "end": "2030-06-30", "captain": false, "jersey_number": 42 }, { "id": 1317708, "transfer_id": null, "player_id": 34053, "team_id": 8, "position_id": 27, "detailed_position_id": 151, "start": "2025-09-01", "end": "2031-06-30", "captain": false, "jersey_number": 9 } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the current domestic squad from your requested team ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-squads/get-team-squad-by-team-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-squads/get-team-squad-by-team-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-squads/get-team-squad-by-team-id", "description": "Sportmonks docs" } } }, "/football/stages": { "get": { "operationId": "getAllStages", "summary": "All Stages", "tags": [ "Stages" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: league, season, type, sport, rounds, currentRound, groups, fixtures, aggregates, topscorers, statistics. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=league;season`.", "schema": { "type": "string" }, "x-includes": [ "league", "season", "type", "sport", "rounds", "currentRound", "groups", "fixtures", "aggregates", "topscorers", "statistics" ], "x-include-depth-max": 4, "example": "league;season" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, type_id, name, sort_order, finished, pending, is_current, starting_at, ending_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "type_id", "name", "sort_order", "finished", "pending", "is_current", "starting_at", "ending_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "type_id", "name", "sort_order", "finished", "pending", "is_current", "starting_at", "ending_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, stageTypes, stageLeagues, stageSeasons, ParticipantSearch, fixtureStages. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "GET All Stages", "description": "Filter all stages starting from a certain stage ID. Handy if you're doing an import for all stages and want to continue from a certain ID.", "example": "&filters=IdAfter:stageID &filters=IdAfter:1100" } ], "x-filters-dynamic": [ { "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the stages on a selection of type IDs separated by a comma.", "example": "&include=type&filters=stageTypes:typeIDS &include=type&filters=stageTypes:223" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter stages and more based on leagues.", "example": "&filters=stageLeagues:leagueIDS &filters=stageLeagues:501" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter stages based on seasons.", "example": "&filters=stageSeasons:seasonIDS &filters=stageSeasons:19735" }, { "entity": "ParticipantSearch", "use": "Using the fixtures include? Check the fixture endpoint for all possible filters.", "description": "Filter the fixtures of certain participants", "example": "&include=fixtures&filters=ParticipantSearch:search_query &include=fixtures&filters=ParticipantSearch:Celtic" }, { "entity": "fixtureStages", "use": "Check this endpoint for all possibilities.", "description": "Include the fixtures and only filter the fixtures based on stage IDs", "example": "&include=fixtures&filters=fixtureStages:stageIDS &include=fixtures&filters=fixtureStages:1100" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "GET All Stages", "description": "Filter all stages starting from a certain stage ID. Handy if you're doing an import for all stages and want to continue from a certain ID.", "example": "&filters=IdAfter:stageID &filters=IdAfter:1100" }, { "kind": "dynamic", "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the stages on a selection of type IDs separated by a comma.", "example": "&include=type&filters=stageTypes:typeIDS &include=type&filters=stageTypes:223", "name": "stageTypes", "names": [ "stageTypes", "stageTypes" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter stages and more based on leagues.", "example": "&filters=stageLeagues:leagueIDS &filters=stageLeagues:501", "name": "stageLeagues", "names": [ "stageLeagues", "stageLeagues" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter stages based on seasons.", "example": "&filters=stageSeasons:seasonIDS &filters=stageSeasons:19735", "name": "stageSeasons", "names": [ "stageSeasons", "stageSeasons" ] }, { "kind": "dynamic", "entity": "ParticipantSearch", "use": "Using the fixtures include? Check the fixture endpoint for all possible filters.", "description": "Filter the fixtures of certain participants", "example": "&include=fixtures&filters=ParticipantSearch:search_query &include=fixtures&filters=ParticipantSearch:Celtic", "name": "ParticipantSearch", "names": [ "ParticipantSearch", "ParticipantSearch" ] }, { "kind": "dynamic", "entity": "fixtureStages", "use": "Check this endpoint for all possibilities.", "description": "Include the fixtures and only filter the fixtures based on stage IDs", "example": "&include=fixtures&filters=fixtureStages:stageIDS &include=fixtures&filters=fixtureStages:1100", "name": "fixtureStages", "names": [ "fixtureStages", "fixtureStages" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns stages ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Stage" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "sport_id": 1, "league_id": 66, "season_id": 1, "type_id": 223, "name": "Regular Season", "sort_order": 1, "finished": true, "is_current": false, "starting_at": "2013-08-17", "ending_at": "2014-04-26", "games_in_current_week": false, "tie_breaker_rule_id": null }, { "id": 2, "sport_id": 1, "league_id": 8, "season_id": 2, "type_id": 223, "name": "Regular Season", "sort_order": 1, "finished": true, "is_current": false, "starting_at": "2010-08-14", "ending_at": "2011-05-22", "games_in_current_week": false, "tie_breaker_rule_id": null }, { "id": 3, "sport_id": 1, "league_id": 8, "season_id": 3, "type_id": 223, "name": "Regular Season", "sort_order": 1, "finished": true, "is_current": false, "starting_at": "2013-08-17", "ending_at": "2014-05-11", "games_in_current_week": false, "tie_breaker_rule_id": null } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/stages?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all stages available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/stages/get-all-stages\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/stages/get-all-stages)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/stages/get-all-stages", "description": "Sportmonks docs" } } }, "/football/stages/{stageId}": { "get": { "operationId": "getStageById", "summary": "Stage by ID", "tags": [ "Stages" ], "parameters": [ { "name": "stageId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the stage you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: league, season, type, sport, rounds, currentRound, groups, fixtures, aggregates, topscorers, statistics. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=league;season`.", "schema": { "type": "string" }, "x-includes": [ "league", "season", "type", "sport", "rounds", "currentRound", "groups", "fixtures", "aggregates", "topscorers", "statistics" ], "x-include-depth-max": 4, "example": "league;season" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, type_id, name, sort_order, finished, pending, is_current, starting_at, ending_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "type_id", "name", "sort_order", "finished", "pending", "is_current", "starting_at", "ending_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "type_id", "name", "sort_order", "finished", "pending", "is_current", "starting_at", "ending_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: stageTypes, ParticipantSearch, fixturestatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the stages on a selection of type IDs separated by a comma.", "example": "&include=type&filters=stageTypes:typeIDS &include=type&filters=stageTypes:223" }, { "entity": "ParticipantSearch", "use": "Using the fixtures include? Check the fixture endpoint for all possible filters.", "description": "Filter the fixtures of certain participants", "example": "&include=fixtures&filters=ParticipantSearch:search_query &include=fixtures&filters=ParticipantSearch:Celtic" }, { "entity": "Fixture statistics", "use": "Check this endpoint for all possibilities.", "description": "Include the fixtures and only filter on the statistics you're interested in.", "example": "&include=fixtures&filters=fixturestatisticTypes:typeIDS &include=fixtures&filters=fixturestatisticTypes:84" } ], "x-filters": [ { "kind": "dynamic", "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the stages on a selection of type IDs separated by a comma.", "example": "&include=type&filters=stageTypes:typeIDS &include=type&filters=stageTypes:223", "name": "stageTypes", "names": [ "stageTypes", "stageTypes" ] }, { "kind": "dynamic", "entity": "ParticipantSearch", "use": "Using the fixtures include? Check the fixture endpoint for all possible filters.", "description": "Filter the fixtures of certain participants", "example": "&include=fixtures&filters=ParticipantSearch:search_query &include=fixtures&filters=ParticipantSearch:Celtic", "name": "ParticipantSearch", "names": [ "ParticipantSearch", "ParticipantSearch" ] }, { "kind": "dynamic", "entity": "Fixture statistics", "use": "Check this endpoint for all possibilities.", "description": "Include the fixtures and only filter on the statistics you're interested in.", "example": "&include=fixtures&filters=fixturestatisticTypes:typeIDS &include=fixtures&filters=fixturestatisticTypes:84", "name": "fixturestatisticTypes", "names": [ "fixturestatisticTypes", "fixturestatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Stage" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 77476879, "sport_id": 1, "league_id": 8, "season_id": 25583, "type_id": 223, "name": "Regular Season", "sort_order": 1, "finished": false, "is_current": true, "starting_at": "2025-08-15", "ending_at": "2026-05-24", "games_in_current_week": false, "tie_breaker_rule_id": null }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns stage information from your requested stage ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/stages/get-stage-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/stages/get-stage-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/stages/get-stage-by-id", "description": "Sportmonks docs" } } }, "/football/stages/search/{name}": { "get": { "operationId": "getStagesBySearchByName", "summary": "Stages by Search by Name", "tags": [ "Stages" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name you want to search on." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: league, season, type, sport, rounds, currentRound, groups, fixtures, aggregates, topscorers, statistics. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=league;season`.", "schema": { "type": "string" }, "x-includes": [ "league", "season", "type", "sport", "rounds", "currentRound", "groups", "fixtures", "aggregates", "topscorers", "statistics" ], "x-include-depth-max": 4, "example": "league;season" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, type_id, name, sort_order, finished, pending, is_current, starting_at, ending_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "type_id", "name", "sort_order", "finished", "pending", "is_current", "starting_at", "ending_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "type_id", "name", "sort_order", "finished", "pending", "is_current", "starting_at", "ending_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: stageTypes, ParticipantSearch, fixturestatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the stages on a selection of type IDs separated by a comma.", "example": "&include=type&filters=stageTypes:typeIDS &include=type&filters=stageTypes:223" }, { "entity": "ParticipantSearch", "use": "Using the fixtures include? Check the fixture endpoint for all possible filters.", "description": "Filter the fixtures of certain participants", "example": "&include=fixtures&filters=ParticipantSearch:search_query &include=fixtures&filters=ParticipantSearch:Celtic" }, { "entity": "Fixture statistics", "use": "Check this endpoint for all possibilities.", "description": "Include the fixtures and only filter on the statistics you're interested in.", "example": "&include=fixtures&filters=fixturestatisticTypes:typeIDS &include=fixtures&filters=fixturestatisticTypes:84" } ], "x-filters": [ { "kind": "dynamic", "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the stages on a selection of type IDs separated by a comma.", "example": "&include=type&filters=stageTypes:typeIDS &include=type&filters=stageTypes:223", "name": "stageTypes", "names": [ "stageTypes", "stageTypes" ] }, { "kind": "dynamic", "entity": "ParticipantSearch", "use": "Using the fixtures include? Check the fixture endpoint for all possible filters.", "description": "Filter the fixtures of certain participants", "example": "&include=fixtures&filters=ParticipantSearch:search_query &include=fixtures&filters=ParticipantSearch:Celtic", "name": "ParticipantSearch", "names": [ "ParticipantSearch", "ParticipantSearch" ] }, { "kind": "dynamic", "entity": "Fixture statistics", "use": "Check this endpoint for all possibilities.", "description": "Include the fixtures and only filter on the statistics you're interested in.", "example": "&include=fixtures&filters=fixturestatisticTypes:typeIDS &include=fixtures&filters=fixturestatisticTypes:84", "name": "fixturestatisticTypes", "names": [ "fixturestatisticTypes", "fixturestatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns stages ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Stage" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "sport_id": 1, "league_id": 66, "season_id": 1, "type_id": 223, "name": "Regular Season", "sort_order": 1, "finished": true, "is_current": false, "starting_at": "2013-08-17", "ending_at": "2014-04-26", "games_in_current_week": false, "tie_breaker_rule_id": null }, { "id": 2, "sport_id": 1, "league_id": 8, "season_id": 2, "type_id": 223, "name": "Regular Season", "sort_order": 1, "finished": true, "is_current": false, "starting_at": "2010-08-14", "ending_at": "2011-05-22", "games_in_current_week": false, "tie_breaker_rule_id": null }, { "id": 3, "sport_id": 1, "league_id": 8, "season_id": 3, "type_id": 223, "name": "Regular Season", "sort_order": 1, "finished": true, "is_current": false, "starting_at": "2013-08-17", "ending_at": "2014-05-11", "games_in_current_week": false, "tie_breaker_rule_id": null } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/stages/search/Regular?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all stages that matches your search query. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/stages/get-stages-by-search-by-name\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/stages/get-stages-by-search-by-name)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/stages/get-stages-by-search-by-name", "description": "Sportmonks docs" } } }, "/football/stages/seasons/{seasonId}": { "get": { "operationId": "getStagesBySeasonId", "summary": "Stages by Season ID", "tags": [ "Stages" ], "parameters": [ { "name": "seasonId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the season you want to retrieve stages from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: league, season, type, sport, rounds, currentRound, groups, fixtures, aggregates, topscorers, statistics. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=league;season`.", "schema": { "type": "string" }, "x-includes": [ "league", "season", "type", "sport", "rounds", "currentRound", "groups", "fixtures", "aggregates", "topscorers", "statistics" ], "x-include-depth-max": 4, "example": "league;season" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, league_id, season_id, type_id, name, sort_order, finished, pending, is_current, starting_at, ending_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "league_id", "season_id", "type_id", "name", "sort_order", "finished", "pending", "is_current", "starting_at", "ending_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "league_id", "season_id", "type_id", "name", "sort_order", "finished", "pending", "is_current", "starting_at", "ending_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: stageTypes, ParticipantSearch, fixturestatisticTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the stages on a selection of type IDs separated by a comma.", "example": "&include=type&filters=stageTypes:typeIDS &include=type&filters=stageTypes:223" }, { "entity": "ParticipantSearch", "use": "Using the fixtures include? Check the fixture endpoint for all possible filters.", "description": "Filter the fixtures of certain participants", "example": "&include=fixtures&filters=ParticipantSearch:search_query &include=fixtures&filters=ParticipantSearch:Celtic" }, { "entity": "Fixture statistics", "use": "Check this endpoint for all possibilities.", "description": "Include the fixtures and only filter on the statistics you're interested in.", "example": "&include=fixtures&filters=fixturestatisticTypes:typeIDS &include=fixtures&filters=fixturestatisticTypes:84" } ], "x-filters": [ { "kind": "dynamic", "entity": "Types", "use": "Statistics, Events, Lineup, Stages and way more. Check this endpoint for all possibilities.", "description": "Filter the stages on a selection of type IDs separated by a comma.", "example": "&include=type&filters=stageTypes:typeIDS &include=type&filters=stageTypes:223", "name": "stageTypes", "names": [ "stageTypes", "stageTypes" ] }, { "kind": "dynamic", "entity": "ParticipantSearch", "use": "Using the fixtures include? Check the fixture endpoint for all possible filters.", "description": "Filter the fixtures of certain participants", "example": "&include=fixtures&filters=ParticipantSearch:search_query &include=fixtures&filters=ParticipantSearch:Celtic", "name": "ParticipantSearch", "names": [ "ParticipantSearch", "ParticipantSearch" ] }, { "kind": "dynamic", "entity": "Fixture statistics", "use": "Check this endpoint for all possibilities.", "description": "Include the fixtures and only filter on the statistics you're interested in.", "example": "&include=fixtures&filters=fixturestatisticTypes:typeIDS &include=fixtures&filters=fixturestatisticTypes:84", "name": "fixturestatisticTypes", "names": [ "fixturestatisticTypes", "fixturestatisticTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Stage" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 77476879, "sport_id": 1, "league_id": 8, "season_id": 25583, "type_id": 223, "name": "Regular Season", "sort_order": 1, "finished": false, "is_current": true, "starting_at": "2025-08-15", "ending_at": "2026-05-24", "games_in_current_week": false, "tie_breaker_rule_id": null } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns stage information from your requested season ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/stages/get-stages-by-season-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/stages/get-stages-by-season-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/stages/get-stages-by-season-id", "description": "Sportmonks docs" } } }, "/football/standings": { "get": { "operationId": "getAllStandings", "summary": "All Standings", "tags": [ "Standings" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: participant, season, league, stage, group, round, rule, details, form, sport. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=participant;season`.", "schema": { "type": "string" }, "x-includes": [ "participant", "season", "league", "stage", "group", "round", "rule", "details", "form", "sport" ], "x-include-depth-max": 2, "example": "participant;season" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, participant_id, sport_id, league_id, season_id, stage_id, group_id, round_id, standing_rule_id, position, result, points. Pass as a comma-separated list, e.g. `select=id,participant_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "participant_id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "round_id", "standing_rule_id", "position", "result", "points" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "participant_id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "round_id", "standing_rule_id", "position", "result", "points" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, standingdetailTypes, standingLeagues, standingGroups, standingSeasons, standingStages. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "GET All endpoints", "description": "Filter all standings starting from a certain standing ID. Handy if you're doing an import for all standings and want to continue from a certain ID.", "example": "&filters=IdAfter:standingID &filters=IdAfter:10210" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Standingdetails , standingrule . Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of certain standing rules, or standing details.", "example": "&include=details.type&filters=standingdetailTypes:TypeIDs &include=details.type&filters=standingdetailTypes:129" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the standings based on leagues.", "example": "&filters=standingLeagues:leagueIDs &filters=standingLeagues:501,271" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the standings based on groups.", "example": "&include=group&filters=standingGroups:groupIDs &include=group&filters=standingGroups:243691" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the standings on seasons.", "example": "&include=season&filters=standingSeasons:seasonIDS &include=season&filters=standingSeasons:18334" }, { "entity": "stages", "use": "Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the standings on stages.", "example": "&include=stage&filters=standingStages:stageIDS &include=stage&filters=standingStages:77453568" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "GET All endpoints", "description": "Filter all standings starting from a certain standing ID. Handy if you're doing an import for all standings and want to continue from a certain ID.", "example": "&filters=IdAfter:standingID &filters=IdAfter:10210" }, { "kind": "dynamic", "entity": "types", "use": "Standingdetails , standingrule . Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of certain standing rules, or standing details.", "example": "&include=details.type&filters=standingdetailTypes:TypeIDs &include=details.type&filters=standingdetailTypes:129", "name": "standingdetailTypes", "names": [ "standingdetailTypes", "standingdetailTypes" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the standings based on leagues.", "example": "&filters=standingLeagues:leagueIDs &filters=standingLeagues:501,271", "name": "standingLeagues", "names": [ "standingLeagues", "standingLeagues" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the standings based on groups.", "example": "&include=group&filters=standingGroups:groupIDs &include=group&filters=standingGroups:243691", "name": "standingGroups", "names": [ "standingGroups", "standingGroups" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the standings on seasons.", "example": "&include=season&filters=standingSeasons:seasonIDS &include=season&filters=standingSeasons:18334", "name": "standingSeasons", "names": [ "standingSeasons", "standingSeasons" ] }, { "kind": "dynamic", "entity": "stages", "use": "Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the standings on stages.", "example": "&include=stage&filters=standingStages:stageIDS &include=stage&filters=standingStages:77453568", "name": "standingStages", "names": [ "standingStages", "standingStages" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns standings ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Standing" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "participant_id": 18708, "sport_id": 1, "league_id": 1538, "season_id": 12944, "stage_id": 7743431, "group_id": 86004, "round_id": 153982, "standing_rule_id": 49265, "position": 1, "result": "equal", "points": 9 }, { "id": 2, "participant_id": 18743, "sport_id": 1, "league_id": 1538, "season_id": 12944, "stage_id": 7743431, "group_id": 86004, "round_id": 153982, "standing_rule_id": null, "position": 2, "result": "equal", "points": 9 }, { "id": 3, "participant_id": 18645, "sport_id": 1, "league_id": 1538, "season_id": 12944, "stage_id": 7743431, "group_id": 86006, "round_id": 153982, "standing_rule_id": 49265, "position": 1, "result": "equal", "points": 7 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/standings?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the full league standing table from your requested season ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standings/get-all-standings\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standings/get-all-standings)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standings/get-all-standings", "description": "Sportmonks docs" } } }, "/football/standings/live/leagues/{leagueId}": { "get": { "operationId": "getLiveStandingsByLeagueId", "summary": "Live Standings by League ID", "tags": [ "Standings" ], "parameters": [ { "name": "leagueId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the league you want to retrieve live standings from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: participant, season, league, stage, group, round, rule, details, form, sport. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=participant;season`.", "schema": { "type": "string" }, "x-includes": [ "participant", "season", "league", "stage", "group", "round", "rule", "details", "form", "sport" ], "x-include-depth-max": 2, "example": "participant;season" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, participant_id, sport_id, league_id, season_id, stage_id, group_id, round_id, standing_rule_id, position, result, points. Pass as a comma-separated list, e.g. `select=id,participant_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "participant_id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "round_id", "standing_rule_id", "position", "result", "points" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "participant_id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "round_id", "standing_rule_id", "position", "result", "points" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: standingdetailTypes, standingGroups, teamstatisticSeasons. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Standingdetails , standingrule . Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of certain standing rules, or standing details.", "example": "&include=details.type&filters=standingdetailTypes:TypeIDs &include=details.type&filters=standingdetailTypes:129" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the standings based on groups.", "example": "&include=group&filters=standingGroups:groupIDs &include=group&filters=standingGroups:246697" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter on team season statistics", "example": "&include=participant.statistics&filters=teamstatisticSeasons:seasonIDS &include=participant.statistics&filters=teamstatisticSeasons:19734" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Standingdetails , standingrule . Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of certain standing rules, or standing details.", "example": "&include=details.type&filters=standingdetailTypes:TypeIDs &include=details.type&filters=standingdetailTypes:129", "name": "standingdetailTypes", "names": [ "standingdetailTypes", "standingdetailTypes" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the standings based on groups.", "example": "&include=group&filters=standingGroups:groupIDs &include=group&filters=standingGroups:246697", "name": "standingGroups", "names": [ "standingGroups", "standingGroups" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter on team season statistics", "example": "&include=participant.statistics&filters=teamstatisticSeasons:seasonIDS &include=participant.statistics&filters=teamstatisticSeasons:19734", "name": "teamstatisticSeasons", "names": [ "teamstatisticSeasons", "teamstatisticSeasons" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Standing" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 18422088, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "round_id": 372151, "participant_id": 19, "standing_rule_id": 127301, "position": 1, "points": 76, "result": "equal" }, { "id": 18422082, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "round_id": 372151, "participant_id": 9, "standing_rule_id": 127302, "position": 2, "points": 71, "result": "equal" }, { "id": 18422085, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "round_id": 372151, "participant_id": 14, "standing_rule_id": 127303, "position": 3, "points": 64, "result": "equal" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the LIVE league standing table from your requested league ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standings/get-live-standings-by-league-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standings/get-live-standings-by-league-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standings/get-live-standings-by-league-id", "description": "Sportmonks docs" } } }, "/football/standings/corrections/seasons/{seasonId}": { "get": { "operationId": "getStandingCorrectionBySeasonId", "summary": "Standing Correction by Season ID", "tags": [ "Standings" ], "parameters": [ { "name": "seasonId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the season you want to retrieve standing corrections from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: participant, season, league, stage, group. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=participant;season`.", "schema": { "type": "string" }, "x-includes": [ "participant", "season", "league", "stage", "group" ], "x-include-depth-max": 2, "example": "participant;season" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, participant_id, sport_id, league_id, season_id, stage_id, group_id, round_id, standing_rule_id, position, result, points. Pass as a comma-separated list, e.g. `select=id,participant_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "participant_id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "round_id", "standing_rule_id", "position", "result", "points" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "participant_id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "round_id", "standing_rule_id", "position", "result", "points" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: standingdetailTypes, standingGroups, teamstatisticSeasons. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Standingdetails , standingrule . Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of certain standing rules, or standing details.", "example": "&include=details.type&filters=standingdetailTypes:TypeIDs &include=details.type&filters=standingdetailTypes:129" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the standings based on groups.", "example": "&include=group&filters=standingGroups:groupIDs &include=group&filters=standingGroups:246697" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter on team season statistics", "example": "&include=participant.statistics&filters=teamstatisticSeasons:seasonIDS &include=participant.statistics&filters=teamstatisticSeasons:19734" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Standingdetails , standingrule . Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of certain standing rules, or standing details.", "example": "&include=details.type&filters=standingdetailTypes:TypeIDs &include=details.type&filters=standingdetailTypes:129", "name": "standingdetailTypes", "names": [ "standingdetailTypes", "standingdetailTypes" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the standings based on groups.", "example": "&include=group&filters=standingGroups:groupIDs &include=group&filters=standingGroups:246697", "name": "standingGroups", "names": [ "standingGroups", "standingGroups" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter on team season statistics", "example": "&include=participant.statistics&filters=teamstatisticSeasons:seasonIDS &include=participant.statistics&filters=teamstatisticSeasons:19734", "name": "teamstatisticSeasons", "names": [ "teamstatisticSeasons", "teamstatisticSeasons" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Standing" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 5002176, "season_id": 11, "stage_id": 9, "group_id": null, "type_id": 173, "value": 9, "calc_type": "-", "participant_type": "team", "participant_id": 5, "active": true } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the standing corrections from your requested season ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standings/get-standing-correction-by-season-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standings/get-standing-correction-by-season-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standings/get-standing-correction-by-season-id", "description": "Sportmonks docs" } } }, "/football/standings/rounds/{roundId}": { "get": { "operationId": "getStandingsByRoundId", "summary": "Standings by Round ID", "tags": [ "Standings" ], "parameters": [ { "name": "roundId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the round you want to retrieve standing from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: participant, season, league, stage, group, round, rule, details, form, sport. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=participant;season`.", "schema": { "type": "string" }, "x-includes": [ "participant", "season", "league", "stage", "group", "round", "rule", "details", "form", "sport" ], "x-include-depth-max": 2, "example": "participant;season" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, participant_id, sport_id, league_id, season_id, stage_id, group_id, round_id, standing_rule_id, position, result, points. Pass as a comma-separated list, e.g. `select=id,participant_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "participant_id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "round_id", "standing_rule_id", "position", "result", "points" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "participant_id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "round_id", "standing_rule_id", "position", "result", "points" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: standingdetailTypes, standingGroups, teamstatisticSeasons. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Standingdetails , standingrule . Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of certain standing rules, or standing details.", "example": "&include=details.type&filters=standingdetailTypes:TypeIDs &include=details.type&filters=standingdetailTypes:129" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the standings based on groups.", "example": "&include=group&filters=standingGroups:groupIDs &include=group&filters=standingGroups:246697" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter on team season statistics", "example": "&include=participant.statistics&filters=teamstatisticSeasons:seasonIDS &include=participant.statistics&filters=teamstatisticSeasons:19734" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Standingdetails , standingrule . Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of certain standing rules, or standing details.", "example": "&include=details.type&filters=standingdetailTypes:TypeIDs &include=details.type&filters=standingdetailTypes:129", "name": "standingdetailTypes", "names": [ "standingdetailTypes", "standingdetailTypes" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the standings based on groups.", "example": "&include=group&filters=standingGroups:groupIDs &include=group&filters=standingGroups:246697", "name": "standingGroups", "names": [ "standingGroups", "standingGroups" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter on team season statistics", "example": "&include=participant.statistics&filters=teamstatisticSeasons:seasonIDS &include=participant.statistics&filters=teamstatisticSeasons:19734", "name": "teamstatisticSeasons", "names": [ "teamstatisticSeasons", "teamstatisticSeasons" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Standing" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 5986064, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "round_id": 372150, "participant_id": 19, "standing_rule_id": 127301, "position": 1, "points": 73, "result": "equal" }, { "id": 5986340, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "round_id": 372150, "participant_id": 9, "standing_rule_id": 127302, "position": 2, "points": 70, "result": "equal" }, { "id": 5986227, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "round_id": 372150, "participant_id": 14, "standing_rule_id": 127303, "position": 3, "points": 61, "result": "equal" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the full league standing table from your requested round ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standings/get-standings-by-round-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standings/get-standings-by-round-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standings/get-standings-by-round-id", "description": "Sportmonks docs" } } }, "/football/standings/seasons/{seasonId}": { "get": { "operationId": "getStandingsBySeasonId", "summary": "Standings by Season ID", "tags": [ "Standings" ], "parameters": [ { "name": "seasonId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the season you want to retrieve standing from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: participant, season, league, stage, group, round, rule, details, form, sport. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=participant;season`.", "schema": { "type": "string" }, "x-includes": [ "participant", "season", "league", "stage", "group", "round", "rule", "details", "form", "sport" ], "x-include-depth-max": 2, "example": "participant;season" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, participant_id, sport_id, league_id, season_id, stage_id, group_id, round_id, standing_rule_id, position, result, points. Pass as a comma-separated list, e.g. `select=id,participant_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "participant_id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "round_id", "standing_rule_id", "position", "result", "points" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "participant_id", "sport_id", "league_id", "season_id", "stage_id", "group_id", "round_id", "standing_rule_id", "position", "result", "points" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: standingruleTypes, standingGroups, standingStages. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Standingdetails , standingrule . Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of certrain standing rules, or standing details.", "example": "&include=rule&filters=standingruleTypes:TypeIDs &include=rule&filters=standingruleTypes:184" }, { "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the standings based on groups.", "example": "&include=group&filters=standingGroups:groupIDs &include=group&filters=standingGroups:243691" }, { "entity": "stages", "use": "Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the standings on stages.", "example": "&include=stage&filters=standingStages:stageIDs &include=stage&filters=standingStages:77453568" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Standingdetails , standingrule . Check this endpoint for all possibilities.", "description": "Filter the Types on a selection of certrain standing rules, or standing details.", "example": "&include=rule&filters=standingruleTypes:TypeIDs &include=rule&filters=standingruleTypes:184", "name": "standingruleTypes", "names": [ "standingruleTypes", "standingruleTypes" ] }, { "kind": "dynamic", "entity": "groups", "use": "Fixtures, Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the standings based on groups.", "example": "&include=group&filters=standingGroups:groupIDs &include=group&filters=standingGroups:243691", "name": "standingGroups", "names": [ "standingGroups", "standingGroups" ] }, { "kind": "dynamic", "entity": "stages", "use": "Standing, and more. Check this endpoint for all possibilities.", "description": "Filter the standings on stages.", "example": "&include=stage&filters=standingStages:stageIDs &include=stage&filters=standingStages:77453568", "name": "standingStages", "names": [ "standingStages", "standingStages" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Standing" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 258296, "participant_id": 19, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "round_id": 372151, "standing_rule_id": 127301, "position": 1, "result": "equal", "points": 76 }, { "id": 258307, "participant_id": 9, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "round_id": 372151, "standing_rule_id": 127302, "position": 2, "result": "equal", "points": 71 }, { "id": 258308, "participant_id": 14, "sport_id": 1, "league_id": 8, "season_id": 25583, "stage_id": 77476879, "group_id": null, "round_id": 372151, "standing_rule_id": 127303, "position": 3, "result": "equal", "points": 64 } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the full league standing table from your requested season ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standings/get-standings-by-season-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standings/get-standings-by-season-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standings/get-standings-by-season-id", "description": "Sportmonks docs" } } }, "/football/states": { "get": { "operationId": "getAllStates", "summary": "All States", "tags": [ "States" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: none. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=none`.", "schema": { "type": "string" }, "x-includes": [ "none" ], "example": "none" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, state, name, short_name, developer_name. Pass as a comma-separated list, e.g. `select=id,state`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "state", "name", "short_name", "developer_name" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "state", "name", "short_name", "developer_name" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns states ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/State" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "state": "NS", "name": "Not Started", "short_name": "NS", "developer_name": "NS" }, { "id": 2, "state": "INPLAY_1ST_HALF", "name": "1st Half", "short_name": "1st", "developer_name": "INPLAY_1ST_HALF" }, { "id": 3, "state": "HT", "name": "Half Time", "short_name": "HT", "developer_name": "HT" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all states available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/states/get-all-states\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/states/get-all-states)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/states/get-all-states", "description": "Sportmonks docs" } } }, "/football/states/{stateId}": { "get": { "operationId": "getStatesById", "summary": "States by ID", "tags": [ "States" ], "parameters": [ { "name": "stateId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the state you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: none. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=none`.", "schema": { "type": "string" }, "x-includes": [ "none" ], "example": "none" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, state, name, short_name. Pass as a comma-separated list, e.g. `select=id,state`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "state", "name", "short_name" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "state", "name", "short_name" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/State" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 1, "state": "NS", "name": "Not Started", "short_name": "NS", "developer_name": "NS" }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns state information from your requested state ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/states/get-state-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/states/get-state-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/states/get-state-by-id", "description": "Sportmonks docs" } } }, "/football/statistics/rounds/{roundId}": { "get": { "operationId": "getRoundStatisticsById", "summary": "Round Statistics by ID", "tags": [ "Statistics" ], "parameters": [ { "name": "roundId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The id of the rounds you want statistics from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: participant. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=participant`.", "schema": { "type": "string" }, "x-includes": [ "participant" ], "x-include-depth-max": 3, "example": "participant" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .", "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, seasonstatisticTypes, seasonLeagues, stageStages, roundRounds, seasonTopscorerTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "All", "description": "Filter all seasons starting from a certain season ID.", "example": "&filters=IdAfter:seasonId &filters=IdAfter:18017" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the season statistics on a selection of types separated by a comma.", "example": "&include=statistics&filters=seasonstatisticTypes:TypeIDs &include=statistics&filters=seasonstatisticTypes:52,88" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the seasons based on leagues.", "example": "&include=league&&filters=seasonLeagues:leagueIDs &include=league&&filters=seasonLeagues:2,8" }, { "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter season stages based on stage IDs", "example": "&filters=stageStages:stageIDS &filters=stageStages:77457866" }, { "entity": "rounds", "use": "Check this endpoint for all possibilities.", "description": "Filter season rounds based on round IDs", "example": "&filters=roundRounds:roundIDS &filters=roundRounds:290018" }, { "entity": "topscorers", "use": "Check this endpoint for all possibilities.", "description": "Filter season topscorers based on type IDs", "example": "&include=topscorers&filters=seasonTopscorerTypes:TypeIDs &include=topscorers&filters=seasonTopscorerTypes:208" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all seasons starting from a certain season ID.", "example": "&filters=IdAfter:seasonId &filters=IdAfter:18017" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the season statistics on a selection of types separated by a comma.", "example": "&include=statistics&filters=seasonstatisticTypes:TypeIDs &include=statistics&filters=seasonstatisticTypes:52,88", "name": "seasonstatisticTypes", "names": [ "seasonstatisticTypes", "seasonstatisticTypes" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the seasons based on leagues.", "example": "&include=league&&filters=seasonLeagues:leagueIDs &include=league&&filters=seasonLeagues:2,8", "name": "seasonLeagues", "names": [ "seasonLeagues", "seasonLeagues" ] }, { "kind": "dynamic", "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter season stages based on stage IDs", "example": "&filters=stageStages:stageIDS &filters=stageStages:77457866", "name": "stageStages", "names": [ "stageStages", "stageStages" ] }, { "kind": "dynamic", "entity": "rounds", "use": "Check this endpoint for all possibilities.", "description": "Filter season rounds based on round IDs", "example": "&filters=roundRounds:roundIDS &filters=roundRounds:290018", "name": "roundRounds", "names": [ "roundRounds", "roundRounds" ] }, { "kind": "dynamic", "entity": "topscorers", "use": "Check this endpoint for all possibilities.", "description": "Filter season topscorers based on type IDs", "example": "&include=topscorers&filters=seasonTopscorerTypes:TypeIDs &include=topscorers&filters=seasonTopscorerTypes:208", "name": "seasonTopscorerTypes", "names": [ "seasonTopscorerTypes", "seasonTopscorerTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns seasons ordered by id ( asc or desc ). Defaults to desc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "asc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Round" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 5999272, "model_id": 372150, "type_id": 190, "relation_id": null, "value": { "count": 1, "percentage": 10 } }, { "id": 5999271, "model_id": 372150, "type_id": 203, "relation_id": null, "value": { "all": 10 } }, { "id": 5999270, "model_id": 372150, "type_id": 192, "relation_id": null, "value": { "count": 4, "percentage": 40 } } ], "pagination": { "count": 21, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the available statistics for the requested round. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/statistics/get-round-statistics-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/statistics/get-round-statistics-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/statistics/get-round-statistics-by-id", "description": "Sportmonks docs" } } }, "/football/statistics/seasons/{participant}/{participantId}": { "get": { "operationId": "getSeasonStatisticsByParticipantId", "summary": "Season Statistics by Participant ID", "tags": [ "Statistics" ], "parameters": [ { "name": "participant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The participant type you want statistics from. Supported participants are: players, teams, coaches and referees." }, { "name": "participantId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The id of the particpant you want statistics from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: player, season, coach, team, referee, position. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=player;season`.", "schema": { "type": "string" }, "x-includes": [ "player", "season", "coach", "team", "referee", "position" ], "x-include-depth-max": 3, "example": "player;season" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .", "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, teamstatisticdetailTypes, seasonLeagues, stageStages, seasonTopscorerTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "All", "description": "Filter all seasons starting from a certain season ID.", "example": "&filters=IdAfter:seasonId &filters=IdAfter:18017" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the season statistics on a selection of types separated by a comma.", "example": "&filters=teamstatisticdetailTypes:TypeIDs &filters=teamstatisticdetailTypes:52,88" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the seasons based on leagues.", "example": "&include=league&&filters=seasonLeagues:leagueIDs &include=league&&filters=seasonLeagues:2,8" }, { "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter season stages based on stage IDs", "example": "&filters=stageStages:stageIDS &filters=stageStages:77457866" }, { "entity": "topscorers", "use": "Check this endpoint for all possibilities.", "description": "Filter season topscorers based on type IDs", "example": "&include=topscorers&filters=seasonTopscorerTypes:TypeIDs &include=topscorers&filters=seasonTopscorerTypes:208" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all seasons starting from a certain season ID.", "example": "&filters=IdAfter:seasonId &filters=IdAfter:18017" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the season statistics on a selection of types separated by a comma.", "example": "&filters=teamstatisticdetailTypes:TypeIDs &filters=teamstatisticdetailTypes:52,88", "name": "teamstatisticdetailTypes", "names": [ "teamstatisticdetailTypes", "teamstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the seasons based on leagues.", "example": "&include=league&&filters=seasonLeagues:leagueIDs &include=league&&filters=seasonLeagues:2,8", "name": "seasonLeagues", "names": [ "seasonLeagues", "seasonLeagues" ] }, { "kind": "dynamic", "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter season stages based on stage IDs", "example": "&filters=stageStages:stageIDS &filters=stageStages:77457866", "name": "stageStages", "names": [ "stageStages", "stageStages" ] }, { "kind": "dynamic", "entity": "topscorers", "use": "Check this endpoint for all possibilities.", "description": "Filter season topscorers based on type IDs", "example": "&include=topscorers&filters=seasonTopscorerTypes:TypeIDs &include=topscorers&filters=seasonTopscorerTypes:208", "name": "seasonTopscorerTypes", "names": [ "seasonTopscorerTypes", "seasonTopscorerTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns seasons ordered by season_id ( asc or desc ). Defaults to desc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "asc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Statistic" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 427435, "team_id": 8, "season_id": 25919, "has_values": true, "details": [ { "id": 6099892, "team_statistic_id": 427435, "type_id": 9672, "value": { "avg_defender_height": 183.29, "avg_midfielder_height": 180.25, "avg_goalkeeper_height": 192.67, "avg_attacker_height": 180.6, "avg_total_height": 182.87 } }, { "id": 6099890, "team_statistic_id": 427435, "type_id": 43, "value": { "count": 449, "average": 112.25 } } ] }, { "id": 403514, "team_id": 8, "season_id": 25863, "has_values": true, "details": [ { "id": 5586327, "team_statistic_id": 403514, "type_id": 9672, "value": { "avg_defender_height": 183.8, "avg_midfielder_height": 180.11, "avg_goalkeeper_height": 195, "avg_attacker_height": 179.33, "avg_total_height": 182.53 } }, { "id": 5586328, "team_statistic_id": 403514, "type_id": 118, "value": { "value": "7.10" } } ] }, { "id": 400183, "team_id": 8, "season_id": 25655, "has_values": true, "details": [ { "id": 5449420, "team_statistic_id": 400183, "type_id": 9672, "value": { "avg_defender_height": 179.67, "avg_midfielder_height": 182.5, "avg_goalkeeper_height": 192.5, "avg_attacker_height": 182, "avg_total_height": 182.56 } }, { "id": 5449430, "team_statistic_id": 400183, "type_id": 215, "value": { "all": { "count": 0, "percentage": 0 }, "home": { "count": 0, "percentage": 0 }, "away": { "count": 0, "percentage": 0 } } } ] } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/statistics/seasons/teams/8?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the available season statistics for the participant. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/statistics/get-season-statistics-by-participant\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/statistics/get-season-statistics-by-participant)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/statistics/get-season-statistics-by-participant", "description": "Sportmonks docs" } } }, "/football/statistics/stages/{stageId}": { "get": { "operationId": "getStageStatisticsByStageId", "summary": "Stage Statistics by Stage ID", "tags": [ "Statistics" ], "parameters": [ { "name": "stageId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The id of the stages you want statistics from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: participant. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=participant`.", "schema": { "type": "string" }, "x-includes": [ "participant" ], "x-include-depth-max": 3, "example": "participant" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .", "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, seasonstatisticTypes, seasonLeagues, stageStages, roundRounds, seasonTopscorerTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "All", "description": "Filter all seasons starting from a certain season ID.", "example": "&filters=IdAfter:seasonId &filters=IdAfter:18017" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the season statistics on a selection of types separated by a comma.", "example": "&include=statistics&filters=seasonstatisticTypes:TypeIDs &include=statistics&filters=seasonstatisticTypes:52,88" }, { "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the seasons based on leagues.", "example": "&include=league&&filters=seasonLeagues:leagueIDs &include=league&&filters=seasonLeagues:2,8" }, { "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter season stages based on stage IDs", "example": "&filters=stageStages:stageIDS &filters=stageStages:77457866" }, { "entity": "rounds", "use": "Check this endpoint for all possibilities.", "description": "Filter season rounds based on round IDs", "example": "&filters=roundRounds:roundIDS &filters=roundRounds:290018" }, { "entity": "topscorers", "use": "Check this endpoint for all possibilities.", "description": "Filter season topscorers based on type IDs", "example": "&include=topscorers&filters=seasonTopscorerTypes:TypeIDs &include=topscorers&filters=seasonTopscorerTypes:208" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all seasons starting from a certain season ID.", "example": "&filters=IdAfter:seasonId &filters=IdAfter:18017" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the season statistics on a selection of types separated by a comma.", "example": "&include=statistics&filters=seasonstatisticTypes:TypeIDs &include=statistics&filters=seasonstatisticTypes:52,88", "name": "seasonstatisticTypes", "names": [ "seasonstatisticTypes", "seasonstatisticTypes" ] }, { "kind": "dynamic", "entity": "leagues", "use": "Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter the seasons based on leagues.", "example": "&include=league&&filters=seasonLeagues:leagueIDs &include=league&&filters=seasonLeagues:2,8", "name": "seasonLeagues", "names": [ "seasonLeagues", "seasonLeagues" ] }, { "kind": "dynamic", "entity": "stages", "use": "Check this endpoint for all possibilities.", "description": "Filter season stages based on stage IDs", "example": "&filters=stageStages:stageIDS &filters=stageStages:77457866", "name": "stageStages", "names": [ "stageStages", "stageStages" ] }, { "kind": "dynamic", "entity": "rounds", "use": "Check this endpoint for all possibilities.", "description": "Filter season rounds based on round IDs", "example": "&filters=roundRounds:roundIDS &filters=roundRounds:290018", "name": "roundRounds", "names": [ "roundRounds", "roundRounds" ] }, { "kind": "dynamic", "entity": "topscorers", "use": "Check this endpoint for all possibilities.", "description": "Filter season topscorers based on type IDs", "example": "&include=topscorers&filters=seasonTopscorerTypes:TypeIDs &include=topscorers&filters=seasonTopscorerTypes:208", "name": "seasonTopscorerTypes", "names": [ "seasonTopscorerTypes", "seasonTopscorerTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns seasons ordered by id ( asc or desc ). Defaults to desc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "asc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Stage" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 941056, "model_id": 77476879, "type_id": 190, "relation_id": null, "value": { "count": 92, "percentage": 26.36 } }, { "id": 941055, "model_id": 77476879, "type_id": 195, "relation_id": 3130, "value": { "count": 17, "home": 10, "away": 7, "percentage": 48.57, "total_games": 35, "player_id": 3130, "player_name": "David Raya" } }, { "id": 941054, "model_id": 77476879, "type_id": 575, "relation_id": 51, "value": { "count": 26, "percentage": 7.45, "participant_id": 51, "participant_name": "Crystal Palace", "participant_count": 6 } } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/statistics/stages/77476879?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the available statistics for the requested stage. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/statistics/get-stage-statistics-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/statistics/get-stage-statistics-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/statistics/get-stage-statistics-by-id", "description": "Sportmonks docs" } } }, "/football/tv-stations": { "get": { "operationId": "getAllTvStations", "summary": "All TV Stations", "tags": [ "TV Stations" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, name, url, image_path. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "url", "image_path" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name", "url", "image_path" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, fixturetvstationCountries. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "Tv Station", "description": "Filter all tv stations starting from a certain tv station ID. Handy if you're doing an import for all tv stations and want to continue from a certain ID.", "example": "&filters=IdAfter:tvStationID &filters=IdAfter:370" } ], "x-filters-dynamic": [ { "entity": "countries", "use": "Check this endpoint for all possibilities.", "description": "Filter the TV Station fixtures on countries.", "example": "&include=fixtures&filters=fixturetvstationCountries:CountryIDs &include=fixtures&filters=fixturetvstationCountries:462" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "Tv Station", "description": "Filter all tv stations starting from a certain tv station ID. Handy if you're doing an import for all tv stations and want to continue from a certain ID.", "example": "&filters=IdAfter:tvStationID &filters=IdAfter:370" }, { "kind": "dynamic", "entity": "countries", "use": "Check this endpoint for all possibilities.", "description": "Filter the TV Station fixtures on countries.", "example": "&include=fixtures&filters=fixturetvstationCountries:CountryIDs &include=fixtures&filters=fixturetvstationCountries:462", "name": "fixturetvstationCountries", "names": [ "fixturetvstationCountries", "fixturetvstationCountries" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns TV stations ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TvStation" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 33, "name": "Star+", "url": "https://www.starplus.com/", "image_path": "https://cdn.sportmonks.com/images/core/tvstations/1/33.png", "type": "tv", "related_id": null }, { "id": 34, "name": "Viaplay", "url": "https://www.viaplay.com", "image_path": "https://cdn.sportmonks.com/images/core/tvstations/2/34.png", "type": "tv", "related_id": null }, { "id": 36, "name": "beIN Sports 1", "url": "http://www.beinsports.com", "image_path": "https://cdn.sportmonks.com/images/core/tvstations/4/36.png", "type": "tv", "related_id": null } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/tv-stations?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the TV Stations available. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/tv-stations/get-all-tv-stations\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/tv-stations/get-all-tv-stations)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/tv-stations/get-all-tv-stations", "description": "Sportmonks docs" } } }, "/football/tv-stations/fixtures/{fixtureId}": { "get": { "operationId": "getTvStationsByFixtureId", "summary": "TV Stations by Fixture ID", "tags": [ "TV Stations" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the fixture you want to retrieve tv-stations from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, name, url, image_path. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "url", "image_path" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name", "url", "image_path" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: fixturetvstationCountries. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "countries", "use": "Check this endpoint for all possibilities.", "description": "Filter the TV Station fixtures on countries.", "example": "&include=fixtures&filters=fixturetvstationCountries:CountryIDs &include=fixtures&filters=fixturetvstationCountries:462" } ], "x-filters": [ { "kind": "dynamic", "entity": "countries", "use": "Check this endpoint for all possibilities.", "description": "Filter the TV Station fixtures on countries.", "example": "&include=fixtures&filters=fixturetvstationCountries:CountryIDs &include=fixtures&filters=fixturetvstationCountries:462", "name": "fixturetvstationCountries", "names": [ "fixturetvstationCountries", "fixturetvstationCountries" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TvStation" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 62, "name": "ESPN 3", "url": "https://www.espn.com", "image_path": "https://cdn.sportmonks.com/images/core/tvstations/30/62.png", "type": "channel", "related_id": 37 }, { "id": 73, "name": "Sky Sports Main Event", "url": "https://www.skysports.com/", "image_path": "https://cdn.sportmonks.com/images/core/tvstations/9/73.png", "type": "channel", "related_id": 45 }, { "id": 70, "name": "Sky Ultra HD", "url": "https://www.livesoccertv.com/channels/sky-ultra-hd/www.sky.com", "image_path": "https://cdn.sportmonks.com/images/core/tvstations/6/70.png", "type": "channel", "related_id": 45 } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the TV Stations available for your requested fixture ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/tv-stations/get-tv-stations-by-fixture-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/tv-stations/get-tv-stations-by-fixture-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/tv-stations/get-tv-stations-by-fixture-id", "description": "Sportmonks docs" } } }, "/football/tv-stations/{tvStationId}": { "get": { "operationId": "getTvStationsById", "summary": "TV Stations by ID", "tags": [ "TV Stations" ], "parameters": [ { "name": "tvStationId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the tv station you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, name, url, image_path. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "url", "image_path" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name", "url", "image_path" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: fixturetvstationCountries. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "countries", "use": "Check this endpoint for all possibilities.", "description": "Filter the TV Station fixtures on countries.", "example": "&include=fixtures&filters=fixturetvstationCountries:CountryIDs &include=fixtures&filters=fixturetvstationCountries:462" } ], "x-filters": [ { "kind": "dynamic", "entity": "countries", "use": "Check this endpoint for all possibilities.", "description": "Filter the TV Station fixtures on countries.", "example": "&include=fixtures&filters=fixturetvstationCountries:CountryIDs &include=fixtures&filters=fixturetvstationCountries:462", "name": "fixturetvstationCountries", "names": [ "fixturetvstationCountries", "fixturetvstationCountries" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TvStation" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 33, "name": "Star+", "url": "https://www.starplus.com/", "image_path": "https://cdn.sportmonks.com/images/core/tvstations/1/33.png", "type": "tv", "related_id": null }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the TV Stations available for your requested fixture ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/tv-stations/get-tv-station-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/tv-stations/get-tv-station-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/tv-stations/get-tv-station-by-id", "description": "Sportmonks docs" } } }, "/football/team-of-the-week": { "get": { "operationId": "getAllAvailableTotws", "summary": "All available TOTWs", "tags": [ "Team Of the Week (ToTW) - beta" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=fixture;player;team\n\nAllowed values: fixture, team, player, round. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=fixture;team`.", "schema": { "type": "string" }, "x-includes": [ "fixture", "team", "player", "round" ], "x-include-depth-max": 3, "example": "fixture;team" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, player_id, fixture_id, round_id, team_id, rating, formation_position, formation. Pass as a comma-separated list, e.g. `select=id,player_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "player_id", "fixture_id", "round_id", "team_id", "rating", "formation_position", "formation" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "player_id", "fixture_id", "round_id", "team_id", "rating", "formation_position", "formation" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "player_id", "fixture_id", "round_id", "team_id", "rating", "formation_position", "formation" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "player_id", "fixture_id", "round_id", "team_id", "rating", "formation_position", "formation" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TeamOfTheWeek" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "player_id": 455900, "fixture_id": 18946393, "round_id": 318161, "team_id": 18644, "rating": "7.45", "formation_position": 2, "formation": "4-3-3" }, { "id": 2, "player_id": 333731, "fixture_id": 18946393, "round_id": 318161, "team_id": 18644, "rating": "8.06", "formation_position": 3, "formation": "4-3-3" }, { "id": 3, "player_id": 12393419, "fixture_id": 18946393, "round_id": 318161, "team_id": 18573, "rating": "7.65", "formation_position": 4, "formation": "4-3-3" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/team-of-the-week?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all TOTW data available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-of-the-week-totw-beta/get-all-available-totws\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-of-the-week-totw-beta/get-all-available-totws)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-of-the-week-totw-beta/get-all-available-totws", "description": "Sportmonks docs" } } }, "/football/team-of-the-week/leagues/{leagueId}/latest": { "get": { "operationId": "getLatestTotwByLeagueId", "summary": "Latest TOTW by League ID", "tags": [ "Team Of the Week (ToTW) - beta" ], "parameters": [ { "name": "leagueId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the league you want to retrieve the TOTW from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=fixture;player;team\n\nAllowed values: fixture, team, player, round. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=fixture;team`.", "schema": { "type": "string" }, "x-includes": [ "fixture", "team", "player", "round" ], "x-include-depth-max": 3, "example": "fixture;team" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, player_id, fixture_id, round_id, team_id, rating, formation_position, formation. Pass as a comma-separated list, e.g. `select=id,player_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "player_id", "fixture_id", "round_id", "team_id", "rating", "formation_position", "formation" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "player_id", "fixture_id", "round_id", "team_id", "rating", "formation_position", "formation" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "player_id", "fixture_id", "round_id", "team_id", "rating", "formation_position", "formation" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "player_id", "fixture_id", "round_id", "team_id", "rating", "formation_position", "formation" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TeamOfTheWeek" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 31984, "player_id": 627, "fixture_id": 19427187, "round_id": 372148, "team_id": 78, "rating": "8.74", "formation_position": 10, "formation": "4-4-2" }, { "id": 31975, "player_id": 1826, "fixture_id": 19427188, "round_id": 372148, "team_id": 13, "rating": "7.65", "formation_position": 1, "formation": "4-4-2" }, { "id": 31980, "player_id": 5403, "fixture_id": 19427189, "round_id": 372148, "team_id": 11, "rating": "7.81", "formation_position": 6, "formation": "4-4-2" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the latest TOTW data for a particular league via geague ID within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-of-the-week-totw-beta/get-latest-totw\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-of-the-week-totw-beta/get-latest-totw)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-of-the-week-totw-beta/get-latest-totw", "description": "Sportmonks docs" } } }, "/football/team-of-the-week/rounds/{roundId}": { "get": { "operationId": "getTotwByRoundId", "summary": "TOTW by Round ID", "tags": [ "Team Of the Week (ToTW) - beta" ], "parameters": [ { "name": "roundId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the round you want to retrieve the TOTW from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=fixture;player;team\n\nAllowed values: fixture, team, player, round. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=fixture;team`.", "schema": { "type": "string" }, "x-includes": [ "fixture", "team", "player", "round" ], "x-include-depth-max": 3, "example": "fixture;team" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, player_id, fixture_id, round_id, team_id, rating, formation_position, formation. Pass as a comma-separated list, e.g. `select=id,player_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "player_id", "fixture_id", "round_id", "team_id", "rating", "formation_position", "formation" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "player_id", "fixture_id", "round_id", "team_id", "rating", "formation_position", "formation" ] }, { "name": "sortBy", "in": "query", "required": false, "description": "Order by specific fields on the base entity . For more information check out this page.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "player_id", "fixture_id", "round_id", "team_id", "rating", "formation_position", "formation" ] } }, "style": "form", "explode": false, "x-sort-fields": [ "id", "player_id", "fixture_id", "round_id", "team_id", "rating", "formation_position", "formation" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TeamOfTheWeek" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 36172, "player_id": 627, "fixture_id": 19427198, "round_id": 372150, "team_id": 78, "rating": "7.26", "formation_position": 9, "formation": "4-3-3" }, { "id": 36167, "player_id": 2884, "fixture_id": 19427202, "round_id": 372150, "team_id": 14, "rating": "7.9", "formation_position": 4, "formation": "4-3-3" }, { "id": 36174, "player_id": 7926, "fixture_id": 19427203, "round_id": 372150, "team_id": 63, "rating": "8.12", "formation_position": 11, "formation": "4-3-3" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns TOTW data for a particular round within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-of-the-week-totw-beta/get-totw-per-round\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-of-the-week-totw-beta/get-totw-per-round)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/team-of-the-week-totw-beta/get-totw-per-round", "description": "Sportmonks docs" } } }, "/football/teams": { "get": { "operationId": "getAllTeams", "summary": "All Teams", "tags": [ "Teams" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, venue, coaches, rivals, players.player, latest, upcoming, seasons, activeSeasons, sidelined, sidelinedHistory, statistics, trophies, socials, rankings. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "venue", "coaches", "rivals", "players.player", "latest", "upcoming", "seasons", "activeSeasons", "sidelined", "sidelinedHistory", "statistics", "trophies", "socials", "rankings" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, venue_id, gender, name, short_code, image_path, founded, type, placeholder, last_played_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "venue_id", "gender", "name", "short_code", "image_path", "founded", "type", "placeholder", "last_played_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "venue_id", "gender", "name", "short_code", "image_path", "founded", "type", "placeholder", "last_played_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, teamstatisticdetailTypes, teamCountries, teamstatisticSeasons. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "Teams", "description": "Filter all teams starting from a certain team ID. Handy if you're doing an import for all teams and want to continue from a certain ID.", "example": "&filters=IdAfter:teamID &filters=IdAfter:758" } ], "x-filters-dynamic": [ { "entity": "Types", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the team statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=teamstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=teamstatisticdetailTypes:52" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter teams and more based on countries.", "example": "&include=country&filters=teamCountries:countryIDS &include=country&filters=teamCountries:462" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter team statistics based on seasons.", "example": "&include=statistics.details.type&filters=teamstatisticSeasons:seasonIDS &include=statistics.details.type&filters=teamstatisticSeasons:19735" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "Teams", "description": "Filter all teams starting from a certain team ID. Handy if you're doing an import for all teams and want to continue from a certain ID.", "example": "&filters=IdAfter:teamID &filters=IdAfter:758" }, { "kind": "dynamic", "entity": "Types", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the team statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=teamstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=teamstatisticdetailTypes:52", "name": "teamstatisticdetailTypes", "names": [ "teamstatisticdetailTypes", "teamstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter teams and more based on countries.", "example": "&include=country&filters=teamCountries:countryIDS &include=country&filters=teamCountries:462", "name": "teamCountries", "names": [ "teamCountries", "teamCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter team statistics based on seasons.", "example": "&include=statistics.details.type&filters=teamstatisticSeasons:seasonIDS &include=statistics.details.type&filters=teamstatisticSeasons:19735", "name": "teamstatisticSeasons", "names": [ "teamstatisticSeasons", "teamstatisticSeasons" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns teams ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "sport_id": 1, "country_id": 462, "venue_id": 214, "gender": "male", "name": "West Ham United", "short_code": "WHU", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/1/1.png", "founded": 1895, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-02 14:00:00" }, { "id": 2, "sport_id": 1, "country_id": 462, "venue_id": 8, "gender": "male", "name": "Blackburn Rovers", "short_code": "BBR", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/2/2.png", "founded": 1875, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-02 11:30:00" }, { "id": 3, "sport_id": 1, "country_id": 462, "venue_id": 212, "gender": "male", "name": "Sunderland", "short_code": "SUN", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/3/3.png", "founded": 1879, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-02 14:00:00" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/teams?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the teams available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/teams/get-all-teams\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/teams/get-all-teams)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/teams/get-all-teams", "description": "Sportmonks docs" } } }, "/football/teams/countries/{countryId}": { "get": { "operationId": "getTeamsByCountryId", "summary": "Teams by Country ID", "tags": [ "Teams" ], "parameters": [ { "name": "countryId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the country you want to retrieve teams from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, venue, coaches, rivals, players.player, latest, upcoming, seasons, activeSeasons, sidelined, sidelinedHistory, statistics, trophies, socials, rankings. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "venue", "coaches", "rivals", "players.player", "latest", "upcoming", "seasons", "activeSeasons", "sidelined", "sidelinedHistory", "statistics", "trophies", "socials", "rankings" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, venue_id, gender, name, short_code, image_path, founded, type, placeholder, last_played_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "venue_id", "gender", "name", "short_code", "image_path", "founded", "type", "placeholder", "last_played_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "venue_id", "gender", "name", "short_code", "image_path", "founded", "type", "placeholder", "last_played_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: teamstatisticdetailTypes, teamstatisticSeasons. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "Types", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the team statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=teamstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=teamstatisticdetailTypes:52" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter team statistics based on seasons.", "example": "&include=statistics.details.type&filters=teamstatisticSeasons:seasonIDS &include=statistics.details.type&filters=teamstatisticSeasons:19735" } ], "x-filters": [ { "kind": "dynamic", "entity": "Types", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the team statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=teamstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=teamstatisticdetailTypes:52", "name": "teamstatisticdetailTypes", "names": [ "teamstatisticdetailTypes", "teamstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter team statistics based on seasons.", "example": "&include=statistics.details.type&filters=teamstatisticSeasons:seasonIDS &include=statistics.details.type&filters=teamstatisticSeasons:19735", "name": "teamstatisticSeasons", "names": [ "teamstatisticSeasons", "teamstatisticSeasons" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 135, "sport_id": 1, "country_id": 2, "venue_id": 8223, "gender": "male", "name": "Lechia Gdańsk", "short_code": "LGD", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/7/135.png", "founded": 1945, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-04 17:00:00" }, { "id": 171, "sport_id": 1, "country_id": 2, "venue_id": 8270, "gender": "male", "name": "Warta Poznań", "short_code": null, "image_path": "https://cdn.sportmonks.com/images/soccer/teams/11/171.png", "founded": 1912, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-03 12:30:00" }, { "id": 244, "sport_id": 1, "country_id": 2, "venue_id": 8277, "gender": "male", "name": "Miedź Legnica", "short_code": null, "image_path": "https://cdn.sportmonks.com/images/soccer/teams/20/244.png", "founded": 1971, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-02 17:30:00" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/teams/countries/2?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the teams from your requested country ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/teams/get-teams-by-country-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/teams/get-teams-by-country-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/teams/get-teams-by-country-id", "description": "Sportmonks docs" } } }, "/football/teams/{teamId}": { "get": { "operationId": "getTeamsById", "summary": "Teams by ID", "tags": [ "Teams" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the team you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, venue, coaches, rivals, players.player, latest, upcoming, seasons, activeSeasons, sidelined, sidelinedHistory, statistics, trophies, socials, rankings. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "venue", "coaches", "rivals", "players.player", "latest", "upcoming", "seasons", "activeSeasons", "sidelined", "sidelinedHistory", "statistics", "trophies", "socials", "rankings" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, venue_id, gender, name, short_code, image_path, founded, type, placeholder, last_played_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "venue_id", "gender", "name", "short_code", "image_path", "founded", "type", "placeholder", "last_played_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "venue_id", "gender", "name", "short_code", "image_path", "founded", "type", "placeholder", "last_played_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: teamstatisticdetailTypes, teamstatisticSeasons. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "Types", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the team statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=teamstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=teamstatisticdetailTypes:52" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter team statistics based on seasons.", "example": "&include=statistics.details.type&filters=teamstatisticSeasons:seasonIDS &include=statistics.details.type&filters=teamstatisticSeasons:19735" } ], "x-filters": [ { "kind": "dynamic", "entity": "Types", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the team statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=teamstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=teamstatisticdetailTypes:52", "name": "teamstatisticdetailTypes", "names": [ "teamstatisticdetailTypes", "teamstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter team statistics based on seasons.", "example": "&include=statistics.details.type&filters=teamstatisticSeasons:seasonIDS &include=statistics.details.type&filters=teamstatisticSeasons:19735", "name": "teamstatisticSeasons", "names": [ "teamstatisticSeasons", "teamstatisticSeasons" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Team" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 8, "sport_id": 1, "country_id": 462, "venue_id": 230, "gender": "male", "name": "Liverpool", "short_code": "LIV", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/8/8.png", "founded": 1892, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-03 14:30:00" }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns information from your requested team ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/teams/get-team-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/teams/get-team-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/teams/get-team-by-id", "description": "Sportmonks docs" } } }, "/football/teams/search/{name}": { "get": { "operationId": "getTeamsBySearchByName", "summary": "Teams by Search by Name", "tags": [ "Teams" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name you want to search on." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, venue, coaches, rivals, players.player, latest, upcoming, seasons, activeSeasons, sidelined, sidelinedHistory, statistics, trophies, socials, rankings. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "venue", "coaches", "rivals", "players.player", "latest", "upcoming", "seasons", "activeSeasons", "sidelined", "sidelinedHistory", "statistics", "trophies", "socials", "rankings" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, venue_id, gender, name, short_code, image_path, founded, type, placeholder, last_played_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "venue_id", "gender", "name", "short_code", "image_path", "founded", "type", "placeholder", "last_played_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "venue_id", "gender", "name", "short_code", "image_path", "founded", "type", "placeholder", "last_played_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: teamstatisticdetailTypes, teamCountries, teamstatisticSeasons. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "Types", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the team statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=teamstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=teamstatisticdetailTypes:59" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter teams and more based on countries.", "example": "&include=country&filters=teamCountries:countryIDS &include=country&filters=teamCountries:462" }, { "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter team statistics based on seasons.", "example": "&include=statistics.details.type&filters=teamstatisticSeasons:seasonIDS &include=statistics.details.type&filters=teamstatisticSeasons:19735" } ], "x-filters": [ { "kind": "dynamic", "entity": "Types", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the team statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=statistics.details.type&filters=teamstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=teamstatisticdetailTypes:59", "name": "teamstatisticdetailTypes", "names": [ "teamstatisticdetailTypes", "teamstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter teams and more based on countries.", "example": "&include=country&filters=teamCountries:countryIDS &include=country&filters=teamCountries:462", "name": "teamCountries", "names": [ "teamCountries", "teamCountries" ] }, { "kind": "dynamic", "entity": "seasons", "use": "Statistics (players, team, coaches, referees), Standings, and way more. Check this endpoint for all possibilities.", "description": "Filter team statistics based on seasons.", "example": "&include=statistics.details.type&filters=teamstatisticSeasons:seasonIDS &include=statistics.details.type&filters=teamstatisticSeasons:19735", "name": "teamstatisticSeasons", "names": [ "teamstatisticSeasons", "teamstatisticSeasons" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns teams ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 9, "sport_id": 1, "country_id": 462, "venue_id": 151, "gender": "male", "name": "Manchester City", "short_code": "MCI", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/9/9.png", "founded": 1880, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-04 19:00:00" }, { "id": 14, "sport_id": 1, "country_id": 462, "venue_id": 206, "gender": "male", "name": "Manchester United", "short_code": "MUN", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/14/14.png", "founded": 1878, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-03 14:30:00" }, { "id": 278, "sport_id": 1, "country_id": 462, "venue_id": 1125, "gender": "male", "name": "United of Manchester", "short_code": null, "image_path": "https://cdn.sportmonks.com/images/soccer/teams/22/278.png", "founded": 2005, "type": "domestic", "placeholder": false, "last_played_at": "2026-04-28 18:45:00" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/teams/search/Manchester?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the teams that match your search query. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/teams/get-teams-by-search-by-name\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/teams/get-teams-by-search-by-name)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/teams/get-teams-by-search-by-name", "description": "Sportmonks docs" } } }, "/football/teams/seasons/{seasonId}": { "get": { "operationId": "getTeamsBySeasonId", "summary": "Teams by Season ID", "tags": [ "Teams" ], "parameters": [ { "name": "seasonId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the season you want to retrieve teams from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, country, venue, coaches, rivals, players.player, latest, upcoming, seasons, activeSeasons, sidelined, sidelinedHistory, statistics, trophies, socials, rankings. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;country`.", "schema": { "type": "string" }, "x-includes": [ "sport", "country", "venue", "coaches", "rivals", "players.player", "latest", "upcoming", "seasons", "activeSeasons", "sidelined", "sidelinedHistory", "statistics", "trophies", "socials", "rankings" ], "x-include-depth-max": 3, "example": "sport;country" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, country_id, venue_id, gender, name, short_code, image_path, founded, type, placeholder, last_played_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "country_id", "venue_id", "gender", "name", "short_code", "image_path", "founded", "type", "placeholder", "last_played_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "country_id", "venue_id", "gender", "name", "short_code", "image_path", "founded", "type", "placeholder", "last_played_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: teamstatisticdetailTypes, teamCountries, teamstatisticSeasons. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "Types", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the team statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=teamstatistics.details.type&filters=teamstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=teamstatisticdetailTypes:59" }, { "entity": "Countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter teams and more based on countries.", "example": "&include=country&filters=teamCountries:countryIDS &include=country&filters=teamCountries:462" }, { "entity": "Seasons", "use": "Check this endpoint for all possibilities.", "description": "Filter the team statistics (detailTypes) on a selection of types on a specific season", "example": "&include=teamstatistics.details.type&filters=teamstatisticdetailTypes:typeIDS&filters=teamstatisticSeasons:seasonID &include=teamstatistics.details.type&filters=teamstatisticdetailTypes:59&filters=teamstatisticSeasons:23672" } ], "x-filters": [ { "kind": "dynamic", "entity": "Types", "use": "Statistics Check this endpoint for all possibilities.", "description": "Filter the team statistics (detailTypes) on a selection of types separated by a comma.", "example": "&include=teamstatistics.details.type&filters=teamstatisticdetailTypes:typeIDS &include=statistics.details.type&filters=teamstatisticdetailTypes:59", "name": "teamstatisticdetailTypes", "names": [ "teamstatisticdetailTypes", "teamstatisticdetailTypes" ] }, { "kind": "dynamic", "entity": "Countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter teams and more based on countries.", "example": "&include=country&filters=teamCountries:countryIDS &include=country&filters=teamCountries:462", "name": "teamCountries", "names": [ "teamCountries", "teamCountries" ] }, { "kind": "dynamic", "entity": "Seasons", "use": "Check this endpoint for all possibilities.", "description": "Filter the team statistics (detailTypes) on a selection of types on a specific season", "example": "&include=teamstatistics.details.type&filters=teamstatisticdetailTypes:typeIDS&filters=teamstatisticSeasons:seasonID &include=teamstatistics.details.type&filters=teamstatisticdetailTypes:59&filters=teamstatisticSeasons:23672", "name": "teamstatisticdetailTypes", "names": [ "teamstatisticdetailTypes", "teamstatisticSeasons", "teamstatisticdetailTypes", "teamstatisticSeasons" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 78, "sport_id": 1, "country_id": 462, "venue_id": 480, "gender": "male", "name": "Brighton & Hove Albion", "short_code": "BHA", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/14/78.png", "founded": 1901, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-02 14:00:00" }, { "id": 11, "sport_id": 1, "country_id": 462, "venue_id": 485, "gender": "male", "name": "Fulham", "short_code": "FUL", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/11/11.png", "founded": 1879, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-02 16:30:00" }, { "id": 8, "sport_id": 1, "country_id": 462, "venue_id": 230, "gender": "male", "name": "Liverpool", "short_code": "LIV", "image_path": "https://cdn.sportmonks.com/images/soccer/teams/8/8.png", "founded": 1892, "type": "domestic", "placeholder": false, "last_played_at": "2026-05-03 14:30:00" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the teams from your requested season ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/teams/get-teams-by-season-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/teams/get-teams-by-season-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/teams/get-teams-by-season-id", "description": "Sportmonks docs" } } }, "/football/topscorers/seasons/{seasonId}": { "get": { "operationId": "getTopscorersBySeasonId", "summary": "Topscorers by Season ID", "tags": [ "Topscorers" ], "parameters": [ { "name": "seasonId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the season you want to retrieve topscorers from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: season, stage, player, participant, type. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=season;stage`.", "schema": { "type": "string" }, "x-includes": [ "season", "stage", "player", "participant", "type" ], "x-include-depth-max": 4, "example": "season;stage" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: season_id, player_id, type_id, position, total. Pass as a comma-separated list, e.g. `select=season_id,player_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "season_id", "player_id", "type_id", "position", "total" ] } }, "style": "form", "explode": false, "x-select-fields": [ "season_id", "player_id", "type_id", "position", "total" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: stagetopscorerTypes, seasontopscorerTypes, playerCountries. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics on a selection of type ids separated by a comma.", "example": "&include=type&filters=stagetopscorerTypes:TypeIDs &include=type&filters=seasontopscorerTypes:208" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=player&filters=playerCountries:CountryIDs &include=player&filters=playerCountries:44" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics on a selection of type ids separated by a comma.", "example": "&include=type&filters=stagetopscorerTypes:TypeIDs &include=type&filters=seasontopscorerTypes:208", "name": "stagetopscorerTypes", "names": [ "stagetopscorerTypes", "seasontopscorerTypes" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=player&filters=playerCountries:CountryIDs &include=player&filters=playerCountries:44", "name": "playerCountries", "names": [ "playerCountries", "playerCountries" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns topscorers ordered by position ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Topscorer" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 303352032, "season_id": 25583, "player_id": 333731, "type_id": 83, "position": 1, "total": 2, "participant_id": 6 }, { "id": 298069035, "season_id": 25583, "player_id": 1030, "type_id": 83, "position": 2, "total": 1, "participant_id": 13 }, { "id": 305016796, "season_id": 25583, "player_id": 1116, "type_id": 83, "position": 3, "total": 1, "participant_id": 13 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/topscorers/seasons/25583?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns all the topscorers per stage of the requested season. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/topscorers/get-topscorers-by-season-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/topscorers/get-topscorers-by-season-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/topscorers/get-topscorers-by-season-id", "description": "Sportmonks docs" } } }, "/football/topscorers/stages/{stageId}": { "get": { "operationId": "getTopscorersByStageId", "summary": "Topscorers by Stage ID", "tags": [ "Topscorers" ], "parameters": [ { "name": "stageId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the stage you want to retrieve topscorers from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: season, stage, player, participant, type. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=season;stage`.", "schema": { "type": "string" }, "x-includes": [ "season", "stage", "player", "participant", "type" ], "x-include-depth-max": 4, "example": "season;stage" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: league_id, season_id, stage_id, player_id, team_id, type_id, position, total. Pass as a comma-separated list, e.g. `select=league_id,season_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "league_id", "season_id", "stage_id", "player_id", "team_id", "type_id", "position", "total" ] } }, "style": "form", "explode": false, "x-select-fields": [ "league_id", "season_id", "stage_id", "player_id", "team_id", "type_id", "position", "total" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: stagetopscorerTypes, playerCountries. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics on a selection of type ids separated by a comma.", "example": "&include=&include=type&filters=stagetopscorerTypes:TypeIDs &include=type&filters=stagetopscorerTypes:208" }, { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=player&filtersplayerCountries:CountryIDs &include=player&filters=playerCountries:44" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, and way more. Check this endpoint for all possibilities.", "description": "Filter the statistics on a selection of type ids separated by a comma.", "example": "&include=&include=type&filters=stagetopscorerTypes:TypeIDs &include=type&filters=stagetopscorerTypes:208", "name": "stagetopscorerTypes", "names": [ "stagetopscorerTypes", "stagetopscorerTypes" ] }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=player&filtersplayerCountries:CountryIDs &include=player&filters=playerCountries:44", "name": "playerCountries" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns topscorers ordered by postition ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Topscorer" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 242449537, "stage_id": 77476879, "player_id": 333731, "type_id": 83, "position": 1, "total": 2, "participant_type": "team", "participant_id": 6 }, { "id": 238083658, "stage_id": 77476879, "player_id": 1030, "type_id": 83, "position": 2, "total": 1, "participant_type": "team", "participant_id": 13 }, { "id": 244032132, "stage_id": 77476879, "player_id": 1116, "type_id": 83, "position": 3, "total": 1, "participant_type": "team", "participant_id": 13 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/topscorers/stages/77476879?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns all the topscorers per stage of the requested season. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/topscorers/get-topscorers-by-season-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/v3/endpoints-and-entities/endpoints/topscorers/get-topscorers-by-stage-id)", "externalDocs": { "url": "https://docs.sportmonks.com/v3/endpoints-and-entities/endpoints/topscorers/get-topscorers-by-stage-id", "description": "Sportmonks docs" } } }, "/football/transfer-rumours": { "get": { "operationId": "getAllTransferRumours", "summary": "All Transfer Rumours", "tags": [ "Transfer Rumours" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, player, type, fromTeam, toTeam, position, detailedPosition. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;player`.", "schema": { "type": "string" }, "x-includes": [ "sport", "player", "type", "fromTeam", "toTeam", "position", "detailedPosition" ], "x-include-depth-max": 1, "example": "sport;player" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, player_id, position_id, from_team_id, to_team_id, transfer_fee_id, probability, source_name, source_url, amount, currency, date, type_id. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "player_id", "position_id", "from_team_id", "to_team_id", "transfer_fee_id", "probability", "source_name", "source_url", "amount", "currency", "date", "type_id" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "player_id", "position_id", "from_team_id", "to_team_id", "transfer_fee_id", "probability", "source_name", "source_url", "amount", "currency", "date", "type_id" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, transferTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "GET All Transfers", "description": "Filter all transfers starting from a certain transfer ID. Handy if you're doing an import for all transfers and want to continue from a certain ID.", "example": "&filters=IdAfter:transferID &filters=IdAfter:1100" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "GET All Transfers", "description": "Filter all transfers starting from a certain transfer ID. Handy if you're doing an import for all transfers and want to continue from a certain ID.", "example": "&filters=IdAfter:transferID &filters=IdAfter:1100" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220", "name": "transferTypes", "names": [ "transferTypes", "transferTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns transfers ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TransferRumour" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 5, "sport_id": 1, "player_id": 34053, "position_id": 27, "from_team_id": 20, "to_team_id": 8, "transfer_fee_id": 78365, "probability": "HIGH", "source_name": "The Guardian", "source_url": "http://www.theguardian.com/football/2025/sep/01/liverpool-agree-125m-deal-to-sign-alexander-isak-from-newcastle-on-deadline-day", "amount": 144000000, "currency": "EUR", "from_league_id": 8, "to_league_id": 8, "status_id": 90319, "date": "2025-06-23", "type_id": 219 }, { "id": 6, "sport_id": 1, "player_id": 7643, "position_id": 26, "from_team_id": 51, "to_team_id": 14, "transfer_fee_id": 78367, "probability": "LOW", "source_name": "ESPN", "source_url": "http://www.espn.co.uk/football/story/_/id/45502047/debunking-man-united-tax-myth-stop-overpaying-transfers", "amount": 60000000, "currency": "EUR", "from_league_id": 8, "to_league_id": 8, "status_id": 90320, "date": "2025-06-23", "type_id": 219 }, { "id": 7, "sport_id": 1, "player_id": 160072, "position_id": 26, "from_team_id": 503, "to_team_id": 6, "transfer_fee_id": 78368, "probability": "LOW", "source_name": "The Athletic", "source_url": "http://www.nytimes.com/athletic/6508273/2025/07/31/joao-palhinha-tottenham-loan-bayern/", "amount": null, "currency": null, "from_league_id": 82, "to_league_id": 8, "status_id": 90319, "date": "2025-07-21", "type_id": 83609 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/transfer-rumours?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all transfer rumours available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfer-rumours/get-all-transfers-rumours\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfer-rumours/get-all-transfers-rumours)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfer-rumours/get-all-transfers-rumours", "description": "Sportmonks docs" } } }, "/football/transfer-rumours/{transferRumourId}": { "get": { "operationId": "getTransferRumoursById", "summary": "Transfer Rumours by ID", "tags": [ "Transfer Rumours" ], "parameters": [ { "name": "transferRumourId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the transfer rumour you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, player, type, fromTeam, toTeam, position, detailedPosition. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;player`.", "schema": { "type": "string" }, "x-includes": [ "sport", "player", "type", "fromTeam", "toTeam", "position", "detailedPosition" ], "x-include-depth-max": 1, "example": "sport;player" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, player_id, position_id, from_team_id, to_team_id, transfer_fee_id, probability, source_name, source_url, amount, currency, date, type_id. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "player_id", "position_id", "from_team_id", "to_team_id", "transfer_fee_id", "probability", "source_name", "source_url", "amount", "currency", "date", "type_id" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "player_id", "position_id", "from_team_id", "to_team_id", "transfer_fee_id", "probability", "source_name", "source_url", "amount", "currency", "date", "type_id" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: transferTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220", "name": "transferTypes", "names": [ "transferTypes", "transferTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TransferRumour" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 5, "sport_id": 1, "player_id": 34053, "position_id": 27, "from_team_id": 20, "to_team_id": 8, "transfer_fee_id": 78365, "probability": "HIGH", "source_name": "The Guardian", "source_url": "http://www.theguardian.com/football/2025/sep/01/liverpool-agree-125m-deal-to-sign-alexander-isak-from-newcastle-on-deadline-day", "amount": 144000000, "currency": "EUR", "from_league_id": 8, "to_league_id": 8, "status_id": 90319, "date": "2025-06-23", "type_id": 219 }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns transfer information from your requested transfer rumour ID. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfer-rumours/get-transfer-rumours-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfer-rumours/get-transfer-rumours-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfer-rumours/get-transfer-rumours-by-id", "description": "Sportmonks docs" } } }, "/football/transfer-rumours/players/{playerId}": { "get": { "operationId": "getTransferRumoursByPlayerId", "summary": "Transfer Rumours by Player ID", "tags": [ "Transfer Rumours" ], "parameters": [ { "name": "playerId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the player you want to retrieve transfer rumours from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, player, type, fromTeam, toTeam, position, detailedPosition. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;player`.", "schema": { "type": "string" }, "x-includes": [ "sport", "player", "type", "fromTeam", "toTeam", "position", "detailedPosition" ], "x-include-depth-max": 1, "example": "sport;player" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, player_id, position_id, from_team_id, to_team_id, transfer_fee_id, probability, source_name, source_url, amount, currency, date, type_id. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "player_id", "position_id", "from_team_id", "to_team_id", "transfer_fee_id", "probability", "source_name", "source_url", "amount", "currency", "date", "type_id" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "player_id", "position_id", "from_team_id", "to_team_id", "transfer_fee_id", "probability", "source_name", "source_url", "amount", "currency", "date", "type_id" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: transferTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220", "name": "transferTypes", "names": [ "transferTypes", "transferTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns latest updated transfers (order asc or desc ). Defaults to desc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TransferRumour" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 535, "sport_id": 1, "player_id": 34053, "position_id": 27, "from_team_id": 20, "to_team_id": 7011, "transfer_fee_id": 78365, "probability": "LOW", "source_name": "talkSPORT", "source_url": "http://talksport.com/football/3410050/alexander-isak-transfer-request-liverpool-newcastle-pre-season-tour/", "amount": 150000000, "currency": "EUR", "from_league_id": 8, "to_league_id": 944, "status_id": 90320, "date": "2025-07-25", "type_id": 219 }, { "id": 5, "sport_id": 1, "player_id": 34053, "position_id": 27, "from_team_id": 20, "to_team_id": 8, "transfer_fee_id": 78365, "probability": "HIGH", "source_name": "The Guardian", "source_url": "http://www.theguardian.com/football/2025/sep/01/liverpool-agree-125m-deal-to-sign-alexander-isak-from-newcastle-on-deadline-day", "amount": 144000000, "currency": "EUR", "from_league_id": 8, "to_league_id": 8, "status_id": 90319, "date": "2025-06-23", "type_id": 219 } ], "pagination": { "count": 2, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the transfers from your requested player ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfer-rumours/get-transfer-rumours-by-player-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfer-rumours/get-transfer-rumours-by-player-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfer-rumours/get-transfer-rumours-by-player-id", "description": "Sportmonks docs" } } }, "/football/transfer-rumours/teams/{teamId}": { "get": { "operationId": "getTransferRumoursByTeamId", "summary": "Transfer Rumours by Team ID", "tags": [ "Transfer Rumours" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the team you want to retrieve transfer rumours for." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, player, type, fromTeam, toTeam, position, detailedPosition. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;player`.", "schema": { "type": "string" }, "x-includes": [ "sport", "player", "type", "fromTeam", "toTeam", "position", "detailedPosition" ], "x-include-depth-max": 1, "example": "sport;player" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, player_id, position_id, from_team_id, to_team_id, transfer_fee_id, probability, source_name, source_url, amount, currency, date, type_id. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "player_id", "position_id", "from_team_id", "to_team_id", "transfer_fee_id", "probability", "source_name", "source_url", "amount", "currency", "date", "type_id" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "player_id", "position_id", "from_team_id", "to_team_id", "transfer_fee_id", "probability", "source_name", "source_url", "amount", "currency", "date", "type_id" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: transferTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220", "name": "transferTypes", "names": [ "transferTypes", "transferTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns latest updated transfers (order asc or desc ). Defaults to desc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TransferRumour" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1912, "sport_id": 1, "player_id": 129820, "position_id": 24, "from_team_id": 8, "to_team_id": 625, "transfer_fee_id": 78367, "probability": "LOW", "source_name": "footballinsider247", "source_url": "http://www.footballinsider247.com/sources-liverpool-to-block-alisson-joining-new-club-after-complication/", "amount": 17000000, "currency": "EUR", "from_league_id": 8, "to_league_id": 384, "status_id": 90321, "date": "2026-03-01", "type_id": 219 }, { "id": 1776, "sport_id": 1, "player_id": 1078, "position_id": 25, "from_team_id": 8, "to_team_id": 6, "transfer_fee_id": 78366, "probability": "LOW", "source_name": "Daily Record", "source_url": "http://www.dailyrecord.co.uk/sport/football/football-transfer-news/andy-robertson-atletico-madrid-transfer-37071586", "amount": null, "currency": null, "from_league_id": 8, "to_league_id": 8, "status_id": 90321, "date": "2026-01-26", "type_id": 219 }, { "id": 70, "sport_id": 1, "player_id": 1078, "position_id": 25, "from_team_id": 8, "to_team_id": 7980, "transfer_fee_id": 78366, "probability": "LOW", "source_name": "Daily Record", "source_url": "http://www.dailyrecord.co.uk/sport/football/football-transfer-news/andy-robertson-atletico-madrid-transfer-37071586", "amount": null, "currency": null, "from_league_id": 8, "to_league_id": 564, "status_id": 90321, "date": "2025-07-21", "type_id": 219 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/transfer-rumours/teams/8?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the transfer rumours from your requested team ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfer-rumours/get-transfer-rumours-by-team-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfer-rumours/get-transfer-rumours-by-team-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfer-rumours/get-transfer-rumours-by-team-id", "description": "Sportmonks docs" } } }, "/football/transfer-rumours/between/{startDate}/{endDate}": { "get": { "operationId": "getTransfersRumoursBetweenDateRange", "summary": "Transfers Rumours Between Date Range", "tags": [ "Transfer Rumours" ], "parameters": [ { "name": "startDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "The start date you want to retrieve transfer rumours from." }, { "name": "endDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "The end date you want to retrieve transfer rumours from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, player, type, fromTeam, toTeam, position, detailedPosition. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;player`.", "schema": { "type": "string" }, "x-includes": [ "sport", "player", "type", "fromTeam", "toTeam", "position", "detailedPosition" ], "x-include-depth-max": 1, "example": "sport;player" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, player_id, position_id, from_team_id, to_team_id, transfer_fee_id, probability, source_name, source_url, amount, currency, date, type_id. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "player_id", "position_id", "from_team_id", "to_team_id", "transfer_fee_id", "probability", "source_name", "source_url", "amount", "currency", "date", "type_id" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "player_id", "position_id", "from_team_id", "to_team_id", "transfer_fee_id", "probability", "source_name", "source_url", "amount", "currency", "date", "type_id" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: transferTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220", "name": "transferTypes", "names": [ "transferTypes", "transferTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TransferRumour" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 2049, "sport_id": 1, "player_id": 4545513, "position_id": 26, "from_team_id": 8, "to_team_id": 15, "transfer_fee_id": 78367, "probability": "LOW", "source_name": "TEAMtalk.com", "source_url": "http://www.teamtalk.com/liverpool/aston-villa-plan-concrete-move-for-liverpool-midfielder-whos-ready-to-leave", "amount": 38000000, "currency": "EUR", "from_league_id": 8, "to_league_id": 8, "status_id": 90322, "date": "2026-04-21", "type_id": 219 }, { "id": 2051, "sport_id": 1, "player_id": 4592198, "position_id": 26, "from_team_id": 15, "to_team_id": 503, "transfer_fee_id": 78367, "probability": "LOW", "source_name": "footballinsider247", "source_url": "http://www.footballinsider247.com/morgan-rogers-bayern-munich-hold-concrete-interest-in-aston-villa-star/", "amount": 71000000, "currency": "EUR", "from_league_id": 8, "to_league_id": 82, "status_id": 90322, "date": "2026-04-21", "type_id": 219 }, { "id": 2064, "sport_id": 1, "player_id": 25188269, "position_id": 26, "from_team_id": 7, "to_team_id": 63, "transfer_fee_id": 78367, "probability": "LOW", "source_name": "The Sun", "source_url": "http://www.thesun.co.uk/sport/38932730/man-utd-city-battle-elliot-anderson-hayden-hackney-middlesbrough/", "amount": 30000000, "currency": "EUR", "from_league_id": 8, "to_league_id": 12, "status_id": 90323, "date": "2026-04-29", "type_id": 219 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/transfer-rumours/between/2026-04-01/2026-04-30?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the transfer rumours between the requested date range. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfer-rumours/get-transfers-rumours-between-date-range\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfer-rumours/get-transfers-rumours-between-date-range)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfer-rumours/get-transfers-rumours-between-date-range", "description": "Sportmonks docs" } } }, "/football/transfers": { "get": { "operationId": "getAllTransfers", "summary": "All Transfers", "tags": [ "Transfers" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, player, type, fromTeam, toTeam, position, detailedPosition. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;player`.", "schema": { "type": "string" }, "x-includes": [ "sport", "player", "type", "fromTeam", "toTeam", "position", "detailedPosition" ], "x-include-depth-max": 1, "example": "sport;player" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, player_id, type_id, from_team_id, to_team_id, position_id, detailed_position_id, date, career_ended, amount, completed, completed_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "player_id", "type_id", "from_team_id", "to_team_id", "position_id", "detailed_position_id", "date", "career_ended", "amount", "completed", "completed_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "player_id", "type_id", "from_team_id", "to_team_id", "position_id", "detailed_position_id", "date", "career_ended", "amount", "completed", "completed_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, transferTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "GET All Transfers", "description": "Filter all transfers starting from a certain transfer ID. Handy if you're doing an import for all transfers and want to continue from a certain ID.", "example": "&filters=IdAfter:transferID &filters=IdAfter:1100" } ], "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "GET All Transfers", "description": "Filter all transfers starting from a certain transfer ID. Handy if you're doing an import for all transfers and want to continue from a certain ID.", "example": "&filters=IdAfter:transferID &filters=IdAfter:1100" }, { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220", "name": "transferTypes", "names": [ "transferTypes", "transferTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns transfers ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Transfer" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "sport_id": 1, "player_id": 6983809, "type_id": 218, "from_team_id": 794, "to_team_id": 999, "position_id": 26, "detailed_position_id": 153, "date": "2025-01-30", "career_ended": false, "completed": true, "amount": null }, { "id": 2, "sport_id": 1, "player_id": 37642394, "type_id": 218, "from_team_id": 1947, "to_team_id": 5931, "position_id": 27, "detailed_position_id": 151, "date": "2025-01-30", "career_ended": false, "completed": true, "amount": null }, { "id": 3, "sport_id": 1, "player_id": 37356319, "type_id": 219, "from_team_id": 6392, "to_team_id": 3161, "position_id": 26, "detailed_position_id": 153, "date": "2025-01-30", "career_ended": false, "completed": true, "amount": 800000 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/transfers?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all transfers available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-all-transfers\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-all-transfers)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-all-transfers", "description": "Sportmonks docs" } } }, "/football/transfers/latest": { "get": { "operationId": "getLatestTransfers", "summary": "Latest Transfers", "tags": [ "Transfers" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, player, type, fromTeam, toTeam, position, detailedPosition. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;player`.", "schema": { "type": "string" }, "x-includes": [ "sport", "player", "type", "fromTeam", "toTeam", "position", "detailedPosition" ], "x-include-depth-max": 1, "example": "sport;player" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, player_id, type_id, from_team_id, to_team_id, position_id, detailed_position_id, date, career_ended, amount, completed, completed_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "player_id", "type_id", "from_team_id", "to_team_id", "position_id", "detailed_position_id", "date", "career_ended", "amount", "completed", "completed_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "player_id", "type_id", "from_team_id", "to_team_id", "position_id", "detailed_position_id", "date", "career_ended", "amount", "completed", "completed_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: transferTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220", "name": "transferTypes", "names": [ "transferTypes", "transferTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns latest updated transfers (order asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Transfer" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 479543, "sport_id": null, "player_id": 14685113, "type_id": 9688, "from_team_id": 8295, "to_team_id": 13363, "position_id": null, "detailed_position_id": null, "date": "2026-06-30", "career_ended": false, "completed": false, "amount": null }, { "id": 507992, "sport_id": null, "player_id": 37619832, "type_id": 219, "from_team_id": 8295, "to_team_id": 13363, "position_id": null, "detailed_position_id": null, "date": "2026-06-30", "career_ended": false, "completed": false, "amount": null }, { "id": 510301, "sport_id": null, "player_id": 37700378, "type_id": 219, "from_team_id": 8295, "to_team_id": 13363, "position_id": null, "detailed_position_id": null, "date": "2026-06-30", "career_ended": false, "completed": false, "amount": null } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/transfers/latest?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the latest transfers available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-latest-transfers\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-latest-transfers)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-latest-transfers", "description": "Sportmonks docs" } } }, "/football/transfers/between/{startDate}/{endDate}": { "get": { "operationId": "getTransfersBetweenDateRange", "summary": "Transfers Between Date Range", "tags": [ "Transfers" ], "parameters": [ { "name": "startDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "The start date you want to retrieve transfers from." }, { "name": "endDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "The end date you want to retrieve transfers from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, player, type, fromTeam, toTeam, position, detailedPosition. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;player`.", "schema": { "type": "string" }, "x-includes": [ "sport", "player", "type", "fromTeam", "toTeam", "position", "detailedPosition" ], "x-include-depth-max": 1, "example": "sport;player" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, player_id, type_id, from_team_id, to_team_id, position_id, detailed_position_id, date, career_ended, amount, completed, completed_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "player_id", "type_id", "from_team_id", "to_team_id", "position_id", "detailed_position_id", "date", "career_ended", "amount", "completed", "completed_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "player_id", "type_id", "from_team_id", "to_team_id", "position_id", "detailed_position_id", "date", "career_ended", "amount", "completed", "completed_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: transferTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220", "name": "transferTypes", "names": [ "transferTypes", "transferTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Transfer" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 479676, "sport_id": 1, "player_id": 18235922, "type_id": 9688, "from_team_id": 7788, "to_team_id": 6921, "position_id": 27, "detailed_position_id": null, "date": "2026-04-30", "career_ended": false, "completed": true, "amount": null }, { "id": 479892, "sport_id": 1, "player_id": 22159012, "type_id": 9688, "from_team_id": 6036, "to_team_id": 3440, "position_id": 26, "detailed_position_id": null, "date": "2026-04-30", "career_ended": false, "completed": true, "amount": null }, { "id": 502609, "sport_id": 1, "player_id": 10990840, "type_id": 9688, "from_team_id": 11126, "to_team_id": 3621, "position_id": 25, "detailed_position_id": null, "date": "2026-04-30", "career_ended": false, "completed": true, "amount": null } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/transfers/between/2026-04-01/2026-04-30?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the transfers between the requested date range. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-transfers-between-date-range\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-transfers-between-date-range)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-transfers-between-date-range", "description": "Sportmonks docs" } } }, "/football/transfers/{transferId}": { "get": { "operationId": "getTransfersById", "summary": "Transfers by ID", "tags": [ "Transfers" ], "parameters": [ { "name": "transferId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the transfer you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, player, type, fromTeam, toTeam, position, detailedPosition. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;player`.", "schema": { "type": "string" }, "x-includes": [ "sport", "player", "type", "fromTeam", "toTeam", "position", "detailedPosition" ], "x-include-depth-max": 1, "example": "sport;player" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, sport_id, player_id, type_id, from_team_id, to_team_id, position_id, detailed_position_id, date, career_ended, amount, completed, completed_at. Pass as a comma-separated list, e.g. `select=id,sport_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "sport_id", "player_id", "type_id", "from_team_id", "to_team_id", "position_id", "detailed_position_id", "date", "career_ended", "amount", "completed", "completed_at" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "sport_id", "player_id", "type_id", "from_team_id", "to_team_id", "position_id", "detailed_position_id", "date", "career_ended", "amount", "completed", "completed_at" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: transferTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220", "name": "transferTypes", "names": [ "transferTypes", "transferTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Transfer" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 479543, "sport_id": null, "player_id": 14685113, "type_id": 9688, "from_team_id": 8295, "to_team_id": 13363, "position_id": null, "detailed_position_id": null, "date": "2026-06-30", "career_ended": false, "completed": false, "amount": null }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns transfer information from your requested transfer ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-transfer-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-transfer-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-transfer-by-id", "description": "Sportmonks docs" } } }, "/football/transfers/players/{playerId}": { "get": { "operationId": "getTransfersByPlayerId", "summary": "Transfers by Player ID", "tags": [ "Transfers" ], "parameters": [ { "name": "playerId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the player you want to retrieve transfers from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, player, type, fromTeam, toTeam, position, detailedPosition. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;player`.", "schema": { "type": "string" }, "x-includes": [ "sport", "player", "type", "fromTeam", "toTeam", "position", "detailedPosition" ], "x-include-depth-max": 1, "example": "sport;player" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .", "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: transferTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220", "name": "transferTypes", "names": [ "transferTypes", "transferTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns latest updated transfers (order asc or desc ). Defaults to desc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Transfer" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 528668, "sport_id": 1, "player_id": 1743, "type_id": 219, "from_team_id": 265420, "to_team_id": 2345, "position_id": 25, "detailed_position_id": null, "date": "2011-07-01", "career_ended": false, "completed": true, "amount": null }, { "id": 528674, "sport_id": 1, "player_id": 1743, "type_id": 220, "from_team_id": 274370, "to_team_id": 265420, "position_id": 25, "detailed_position_id": null, "date": "2010-07-01", "career_ended": false, "completed": true, "amount": null }, { "id": 19923, "sport_id": 1, "player_id": 1743, "type_id": 219, "from_team_id": 53, "to_team_id": 65, "position_id": 25, "detailed_position_id": 148, "date": "2015-09-01", "career_ended": false, "completed": true, "amount": 15700000 } ], "pagination": { "count": 5, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the transfers from your requested player ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-transfers-by-player-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-transfers-by-player-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-transfers-by-player-id", "description": "Sportmonks docs" } } }, "/football/transfers/teams/{teamId}": { "get": { "operationId": "getTransfersByTeamId", "summary": "Transfers by Team ID", "tags": [ "Transfers" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the team you want to retrieve transfers from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: sport, player, type, fromTeam, toTeam, position, detailedPosition. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=sport;player`.", "schema": { "type": "string" }, "x-includes": [ "sport", "player", "type", "fromTeam", "toTeam", "position", "detailedPosition" ], "x-include-depth-max": 1, "example": "sport;player" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .", "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: transferTypes. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220" } ], "x-filters": [ { "kind": "dynamic", "entity": "types", "use": "Statistics, Events, Lineup, Transfers and way more. Check this endpoint for all filter possibilities.", "description": "Filter the transfers on a selection of type ids separated by a comma.", "example": "&include=type&filters=transferTypes:TypeIDs &include=type&filters=transferTypes:219,220", "name": "transferTypes", "names": [ "transferTypes", "transferTypes" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns latest updated transfers (order asc or desc ). Defaults to desc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Transfer" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 560570, "sport_id": 1, "player_id": 37631909, "type_id": 219, "from_team_id": 598, "to_team_id": 8, "position_id": 25, "detailed_position_id": 148, "date": "2026-07-01", "career_ended": false, "completed": false, "amount": 63600000 }, { "id": 560550, "sport_id": 1, "player_id": 4125, "type_id": 219, "from_team_id": 8, "to_team_id": 260131, "position_id": 27, "detailed_position_id": 156, "date": "2026-07-01", "career_ended": false, "completed": false, "amount": null }, { "id": 560530, "sport_id": 1, "player_id": 1078, "type_id": 219, "from_team_id": 8, "to_team_id": 260131, "position_id": 25, "detailed_position_id": 155, "date": "2026-07-01", "career_ended": false, "completed": false, "amount": null } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/transfers/teams/8?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the transfers from your requested team ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-transfers-by-team-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-transfers-by-team-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/transfers/get-transfers-by-team-id", "description": "Sportmonks docs" } } }, "/football/venues": { "get": { "operationId": "getAllVenues", "summary": "All Venues", "tags": [ "Venues" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: country, city, fixtures. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=country;city`.", "schema": { "type": "string" }, "x-includes": [ "country", "city", "fixtures" ], "x-include-depth-max": 2, "example": "country;city" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, country_id, name, address, zipcode, state, latitude, longitude, capacity, image_path, city_name, surface, national_team. Pass as a comma-separated list, e.g. `select=id,country_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "country_id", "name", "address", "zipcode", "state", "latitude", "longitude", "capacity", "image_path", "city_name", "surface", "national_team" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "country_id", "name", "address", "zipcode", "state", "latitude", "longitude", "capacity", "image_path", "city_name", "surface", "national_team" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, venueCountries. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "All", "description": "Filter all fixtures starting from a certain fixture ID. Handy when you are only interested in the most recent fixtures.", "example": "&filters=IdAfter:venueID &filters=IdAfter:8914" } ], "x-filters-dynamic": [ { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=fixtures;country&filters=venueCountries:CountryIDs &include=fixtures;country&filters=venueCountries:98" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all fixtures starting from a certain fixture ID. Handy when you are only interested in the most recent fixtures.", "example": "&filters=IdAfter:venueID &filters=IdAfter:8914" }, { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=fixtures;country&filters=venueCountries:CountryIDs &include=fixtures;country&filters=venueCountries:98", "name": "venueCountries", "names": [ "venueCountries", "venueCountries" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns venues ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Venue" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "country_id": 462, "city_id": 24161, "name": "Meadowbank Dorking", "address": "Mill Ln", "zipcode": "RH4 1DX", "latitude": "51.23448", "longitude": "-0.33329", "capacity": 30000, "image_path": "https://cdn.sportmonks.com/images/core/venues/1/1.png", "city_name": "Dorking", "surface": "artificial turf", "national_team": false }, { "id": 2, "country_id": 462, "city_id": 82625, "name": "Bramall Lane", "address": "Highfield Sheffield S2 4SU", "zipcode": null, "latitude": "53.370278", "longitude": "-1.470833", "capacity": 32702, "image_path": "https://cdn.sportmonks.com/images/core/venues/2/2.png", "city_name": "Sheffield", "surface": "grass", "national_team": false }, { "id": 4, "country_id": 462, "city_id": 51663, "name": "Boleyn Ground", "address": "Upton Park London, E13 England", "zipcode": null, "latitude": "51.509865", "longitude": "-0.118092", "capacity": 35016, "image_path": "https://cdn.sportmonks.com/images/core/venues/4/4.png", "city_name": "London", "surface": "grass", "national_team": false } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/venues?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the venues available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/venues/get-all-venues\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/venues/get-all-venues)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/venues/get-all-venues", "description": "Sportmonks docs" } } }, "/football/venues/{venueId}": { "get": { "operationId": "getVenueById", "summary": "Venue by ID", "tags": [ "Venues" ], "parameters": [ { "name": "venueId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the venue you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: country, city, fixtures. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=country;city`.", "schema": { "type": "string" }, "x-includes": [ "country", "city", "fixtures" ], "x-include-depth-max": 2, "example": "country;city" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, country_id, name, address, zipcode, state, latitude, longitude, capacity, image_path, city_name, surface, national_team. Pass as a comma-separated list, e.g. `select=id,country_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "country_id", "name", "address", "zipcode", "state", "latitude", "longitude", "capacity", "image_path", "city_name", "surface", "national_team" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "country_id", "name", "address", "zipcode", "state", "latitude", "longitude", "capacity", "image_path", "city_name", "surface", "national_team" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: venueCountries. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=fixtures;country&filters=venueCountries:CountryIDs &include=fixtures;country&filters=venueCountries:98" } ], "x-filters": [ { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=fixtures;country&filters=venueCountries:CountryIDs &include=fixtures;country&filters=venueCountries:98", "name": "venueCountries", "names": [ "venueCountries", "venueCountries" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Venue" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 230, "country_id": 462, "city_id": 51090, "name": "Anfield", "address": "Anfield Road", "zipcode": null, "latitude": "53.430833", "longitude": "-2.960833", "capacity": 61276, "image_path": "https://cdn.sportmonks.com/images/soccer/venues/6/230.png", "city_name": "Liverpool", "surface": "grass", "national_team": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns venue information from your requested venue ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/venues/get-venue-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/venues/get-venue-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/venues/get-venue-by-id", "description": "Sportmonks docs" } } }, "/football/venues/search/{name}": { "get": { "operationId": "getVenuesBySearchByName", "summary": "Venues by Search by Name", "tags": [ "Venues" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name you want to search on." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: country, city, fixtures. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=country;city`.", "schema": { "type": "string" }, "x-includes": [ "country", "city", "fixtures" ], "x-include-depth-max": 2, "example": "country;city" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, country_id, name, address, zipcode, state, latitude, longitude, capacity, image_path, city_name, surface, national_team. Pass as a comma-separated list, e.g. `select=id,country_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "country_id", "name", "address", "zipcode", "state", "latitude", "longitude", "capacity", "image_path", "city_name", "surface", "national_team" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "country_id", "name", "address", "zipcode", "state", "latitude", "longitude", "capacity", "image_path", "city_name", "surface", "national_team" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: venueCountries. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=fixtures;country&filters=venueCountries:CountryIDs &include=fixtures;country&filters=venueCountries:98" } ], "x-filters": [ { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=fixtures;country&filters=venueCountries:CountryIDs &include=fixtures;country&filters=venueCountries:98", "name": "venueCountries", "names": [ "venueCountries", "venueCountries" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns venues ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Venue" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 206, "country_id": 462, "city_id": 53964, "name": "Old Trafford", "address": "Sir Matt Busby Way", "zipcode": null, "latitude": "53.463056", "longitude": "-2.291389", "capacity": 74879, "image_path": "https://cdn.sportmonks.com/images/soccer/venues/14/206.png", "city_name": "Manchester", "surface": "grass", "national_team": false } ], "pagination": { "count": 1, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all venues that match your search query. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/venues/get-venues-by-search-by-name\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/venues/get-venues-by-search-by-name)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/venues/get-venues-by-search-by-name", "description": "Sportmonks docs" } } }, "/football/venues/seasons/{seasonId}": { "get": { "operationId": "getVenuesBySeasonId", "summary": "Venues by Season ID", "tags": [ "Venues" ], "parameters": [ { "name": "seasonId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the season you want to retrieve venues from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: country, city, fixtures. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=country;city`.", "schema": { "type": "string" }, "x-includes": [ "country", "city", "fixtures" ], "x-include-depth-max": 2, "example": "country;city" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, country_id, name, address, zipcode, state, latitude, longitude, capacity, image_path, city_name, surface, national_team. Pass as a comma-separated list, e.g. `select=id,country_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "country_id", "name", "address", "zipcode", "state", "latitude", "longitude", "capacity", "image_path", "city_name", "surface", "national_team" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "country_id", "name", "address", "zipcode", "state", "latitude", "longitude", "capacity", "image_path", "city_name", "surface", "national_team" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: venueCountries. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-dynamic": [ { "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=fixtures;country&filters=venueCountries:CountryIDs &include=fixtures;country&filters=venueCountries:98" } ], "x-filters": [ { "kind": "dynamic", "entity": "countries", "use": "Coaches, Leagues, Players, Teams, and way more. Check this endpoint for all possibilities.", "description": "Filter the coaches, leagues, players and more based on countries.", "example": "&include=fixtures;country&filters=venueCountries:CountryIDs &include=fixtures;country&filters=venueCountries:98", "name": "venueCountries", "names": [ "venueCountries", "venueCountries" ] } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Venue" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 5, "country_id": 462, "city_id": 9576, "name": "Villa Park", "address": "Trinity Road, Birmingham B6 6HE", "zipcode": null, "latitude": "52.509167", "longitude": "-1.884722", "capacity": 42640, "image_path": "https://cdn.sportmonks.com/images/core/venues/5/5.png", "city_name": "Birmingham", "surface": "grass", "national_team": false }, { "id": 146, "country_id": 462, "city_id": 11311, "name": "Vitality Stadium", "address": "Dean Court, Kings Park", "zipcode": null, "latitude": "50.7352", "longitude": "-1.83833", "capacity": 11700, "image_path": "https://cdn.sportmonks.com/images/soccer/venues/18/146.png", "city_name": "Bournemouth", "surface": "grass", "national_team": false }, { "id": 151, "country_id": 462, "city_id": 53964, "name": "Etihad Stadium", "address": "Etihad Campus Manchester M11 3FF", "zipcode": null, "latitude": "53.483056", "longitude": "-2.200278", "capacity": 53400, "image_path": "https://cdn.sportmonks.com/images/soccer/venues/23/151.png", "city_name": "Manchester", "surface": "grass", "national_team": false } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns venue information from your requested season ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/venues/get-venues-by-season-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/venues/get-venues-by-season-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/venues/get-venues-by-season-id", "description": "Sportmonks docs" } } }, "/my/enrichments": { "get": { "operationId": "getMyEnrichments", "summary": "My Enrichments", "tags": [ "MySportmonks" ], "parameters": [], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MyEnrichment" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 140, "name": "Access Premium Odds" }, { "id": 90, "name": "Access odds" }, { "id": 91, "name": "Access fixtures" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all enrichments available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/core-api/my-sportmonks/get-my-enrichments\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/my-sportmonks/get-my-enrichments)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/my-sportmonks/get-my-enrichments", "description": "Sportmonks docs" } } }, "/my/leagues": { "get": { "operationId": "getMyLeagues", "summary": "My Leagues", "tags": [ "MySportmonks" ], "parameters": [], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/League" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 2, "sport_id": 1, "country_id": 41, "name": "Champions League", "active": true, "short_code": "UEFA CL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/2.png", "type": "league", "sub_type": "cup_international", "last_played_at": "2026-05-05 19:00:00", "category": 1, "has_jerseys": false, "sport": { "id": 1, "name": "Football" } }, { "id": 5, "sport_id": 1, "country_id": 41, "name": "Europa League", "active": true, "short_code": "UEFA EL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/5/5.png", "type": "league", "sub_type": "cup_international", "last_played_at": "2026-04-30 19:00:00", "category": 1, "has_jerseys": false, "sport": { "id": 1, "name": "Football" } }, { "id": 8, "sport_id": 1, "country_id": 462, "name": "Premier League", "active": true, "short_code": "UK PL", "image_path": "https://cdn.sportmonks.com/images/soccer/leagues/8/8.png", "type": "league", "sub_type": "domestic", "last_played_at": "2026-05-04 19:00:00", "category": 1, "has_jerseys": false, "sport": { "id": 1, "name": "Football" } } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all leagues available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/core-api/my-sportmonks/get-my-leagues\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/my-sportmonks/get-my-leagues)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/my-sportmonks/get-my-leagues", "description": "Sportmonks docs" } } }, "/my/resources": { "get": { "operationId": "getMyResources", "summary": "My Resources", "tags": [ "MySportmonks" ], "parameters": [], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MyResource" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 244, "description": "Types by Entity" }, { "id": 102, "description": "Continent By Id" }, { "id": 103, "description": "All Countries" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all resources available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/core-api/my-sportmonks/get-my-resources\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/core-api/my-sportmonks/get-my-resources)", "externalDocs": { "url": "https://docs.sportmonks.com/football/core-api/my-sportmonks/get-my-resources", "description": "Sportmonks docs" } } }, "/my/usage": { "get": { "operationId": "getMyUsage", "summary": "My Usage", "tags": [ "MySportmonks" ], "parameters": [ { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UsageRecord" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 2425426850, "endpoint": "api.sports.rounds.search", "count": 1, "entity": "round", "remaining_requests": 4985, "period_start": 1778070600, "period_end": 1778070900 }, { "id": 2425426887, "endpoint": "api.sports.standings.round", "count": 1, "entity": "standing", "remaining_requests": 4986, "period_start": 1778070600, "period_end": 1778070900 }, { "id": 2425426875, "endpoint": "api.sports.stages.search", "count": 1, "entity": "stage", "remaining_requests": 4976, "period_start": 1778070600, "period_end": 1778070900 } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/my/usage?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns you API usage aggregated per 5 minutes.\n\n[Sportmonks documentation](https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-usage)", "externalDocs": { "url": "https://docs.sportmonks.com/v3/core-api/my-sportmonks/get-my-usage", "description": "Sportmonks docs" } } }, "/odds/bookmakers": { "get": { "operationId": "getAllBookmakers", "summary": "All Bookmakers", "tags": [ "Bookmakers" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, name. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, bookmakers. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "All", "description": "Filter all bookmakers starting from a certain bookmaker ID. Handy if you're doing an import for all pre-match odds and want to continue from a certain ID.", "example": "&filters=IdAfter:bookmakerID &filters=IdAfter:70" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the bookmakers on a selection of bookmakers separated by a comma.", "example": "&filters=bookmakers:bookmakerID &filters=bookmakers:1,70" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all bookmakers starting from a certain bookmaker ID. Handy if you're doing an import for all pre-match odds and want to continue from a certain ID.", "example": "&filters=IdAfter:bookmakerID &filters=IdAfter:70" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the bookmakers on a selection of bookmakers separated by a comma.", "example": "&filters=bookmakers:bookmakerID &filters=bookmakers:1,70" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns bookmakers ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bookmaker" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "legacy_id": 1, "name": "10Bet" }, { "id": 2, "legacy_id": 2, "name": "bet365" }, { "id": 3, "legacy_id": 3, "name": "188Bet" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/odds/bookmakers?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns all available bookmakers within your subscription. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-all-bookmakers\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-all-bookmakers)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-all-bookmakers", "description": "Sportmonks docs" } } }, "/odds/bookmakers/premium": { "get": { "operationId": "getAllPremiumBookmakers", "summary": "All Premium Bookmakers", "tags": [ "Bookmakers" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, name. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, bookmakers. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "All", "description": "Filter all bookmakers starting from a certain bookmaker ID. Handy if you're doing an import for all pre-match odds and want to continue from a certain ID.", "example": "&filters=IdAfter:bookmakerID &filters=IdAfter:70" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the bookmakers on a selection of bookmakers separated by a comma.", "example": "&filters=bookmakers:bookmakerID &filters=bookmakers:1,70" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all bookmakers starting from a certain bookmaker ID. Handy if you're doing an import for all pre-match odds and want to continue from a certain ID.", "example": "&filters=IdAfter:bookmakerID &filters=IdAfter:70" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the bookmakers on a selection of bookmakers separated by a comma.", "example": "&filters=bookmakers:bookmakerID &filters=bookmakers:1,70" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns bookmakers ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bookmaker" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "legacy_id": 1, "name": "10Bet" }, { "id": 2, "legacy_id": 2, "name": "bet365" }, { "id": 3, "legacy_id": 3, "name": "188Bet" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/odds/bookmakers/premium?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the bookmakers that are available in the Premium feed. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-all-premium-bookmakers\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-all-premium-bookmakers)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-all-premium-bookmakers", "description": "Sportmonks docs" } } }, "/odds/bookmakers/fixtures/{fixtureId}": { "get": { "operationId": "getBookmakerByFixtureId", "summary": "Bookmaker by Fixture ID", "tags": [ "Bookmakers" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The fixture ID you want to retrieve the bookmakers from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, name. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: bookmakers. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "bookmakers", "use": "Odds", "description": "Filter the bookmakers on a selection of bookmakers separated by a comma.", "example": "&filters=bookmakers:bookmakerID &filters=markets:12,14" } ], "x-filters": [ { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the bookmakers on a selection of bookmakers separated by a comma.", "example": "&filters=bookmakers:bookmakerID &filters=markets:12,14" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bookmaker" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "legacy_id": 1, "name": "10Bet" }, { "id": 2, "legacy_id": 2, "name": "bet365" }, { "id": 5, "legacy_id": 7, "name": "888Sport" } ], "pagination": { "count": 21, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the bookmakers for the requested fixture ID. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-bookmaker-by-fixture-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-bookmaker-by-fixture-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-bookmaker-by-fixture-id", "description": "Sportmonks docs" } } }, "/odds/bookmakers/{bookmakerId}": { "get": { "operationId": "getBookmakerById", "summary": "Bookmaker by ID", "tags": [ "Bookmakers" ], "parameters": [ { "name": "bookmakerId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the bookmaker you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, name. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: bookmakers. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "bookmakers", "use": "Odds", "description": "Filter the bookmakers on a selection of bookmakers separated by a comma.", "example": "&filters=bookmakers:bookmakerID &filters=markets:12,14" } ], "x-filters": [ { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the bookmakers on a selection of bookmakers separated by a comma.", "example": "&filters=bookmakers:bookmakerID &filters=markets:12,14" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Bookmaker" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 2, "legacy_id": 2, "name": "bet365" }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the bookmaker for the requested bookmaker ID. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-bookmaker-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-bookmaker-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-bookmaker-by-id", "description": "Sportmonks docs" } } }, "/odds/bookmakers/search/{name}": { "get": { "operationId": "getBookmakerBySearch", "summary": "Bookmaker by Search", "tags": [ "Bookmakers" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name of the bookmaker you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, name. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bookmaker" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 2, "legacy_id": 2, "name": "bet365" } ], "pagination": { "count": 1, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all bookmakers that match your search query. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-bookmaker-by-search\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-bookmaker-by-search)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-bookmaker-by-search", "description": "Sportmonks docs" } } }, "/odds/bookmakers/fixtures/{fixtureId}/mapping": { "get": { "operationId": "getBookmakerMappingByFixtureId", "summary": "Bookmaker Mapping by Fixture ID", "tags": [ "Bookmakers" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The fixtureId you want to retrieve the bookmaker mapping from." }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: fixture_id, bookmaker_id, bookmaker_name, bookmaker_event_id, bookmaker_event_url. Pass as a comma-separated list, e.g. `select=fixture_id,bookmaker_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "fixture_id", "bookmaker_id", "bookmaker_name", "bookmaker_event_id", "bookmaker_event_url" ] } }, "style": "form", "explode": false, "x-select-fields": [ "fixture_id", "bookmaker_id", "bookmaker_name", "bookmaker_event_id", "bookmaker_event_url" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: bookmakers. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "bookmakers", "use": "Odds", "description": "Filter the bookmakers on a selection of bookmakers separated by a comma.", "example": "&filters=bookmakers:bookmakerID" } ], "x-filters": [ { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the bookmakers on a selection of bookmakers separated by a comma.", "example": "&filters=bookmakers:bookmakerID" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BookmakerMapping" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "fixture_id": 19427201, "bookmaker_id": 2, "bookmaker_name": "bet365", "bookmaker_event_id": "192501021", "bookmaker_event_url": null } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the mapping for bookmakers for the requested fixture ID. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-bookmaker-match-id-mappings-by-fixture-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-bookmaker-match-id-mappings-by-fixture-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/bookmakers/get-bookmaker-match-id-mappings-by-fixture-id", "description": "Sportmonks docs" } } }, "/odds/markets": { "get": { "operationId": "getAllMarkets", "summary": "All Markets", "tags": [ "Markets" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, name, developer_name, has_winning_calculations. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "developer_name", "has_winning_calculations" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name", "developer_name", "has_winning_calculations" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, markets. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "All", "description": "Filter all markets starting from a certain market ID. Handy if you're doing an import for all pre-match odds and want to continue from a certain ID.", "example": "&filters=IdAfter:marketID &filters=IdAfter:12" }, { "name": "markets", "use": "Odds", "description": "Filter the markets on a selection of markets separated by a comma.", "example": "&filters=markets:marketIDs &filters=markets:12,14" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all markets starting from a certain market ID. Handy if you're doing an import for all pre-match odds and want to continue from a certain ID.", "example": "&filters=IdAfter:marketID &filters=IdAfter:12" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the markets on a selection of markets separated by a comma.", "example": "&filters=markets:marketIDs &filters=markets:12,14" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns markets ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Market" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "legacy_id": 1, "name": "Fulltime Result", "developer_name": "FULLTIME_RESULT", "has_winning_calculations": true }, { "id": 2, "legacy_id": 63, "name": "Double Chance", "developer_name": "DOUBLE_CHANCE", "has_winning_calculations": false }, { "id": 3, "legacy_id": null, "name": "X Goal", "developer_name": "X_GOAL", "has_winning_calculations": false } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/odds/markets?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "This endpoint returns all available markets within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/markets/get-all-markets\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/markets/get-all-markets)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/markets/get-all-markets", "description": "Sportmonks docs" } } }, "/odds/markets/premium": { "get": { "operationId": "getAllPremiumMarkets", "summary": "All Premium Markets", "tags": [ "Markets" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, name, developer_name. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "developer_name" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name", "developer_name" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, markets. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "All", "description": "Filter all markets starting from a certain market ID. Handy if you're doing an import for all pre-match odds and want to continue from a certain ID.", "example": "&filters=IdAfter:marketID &filters=IdAfter:12" }, { "name": "markets", "use": "Odds", "description": "Filter the markets on a selection of markets separated by a comma.", "example": "&filters=markets:marketIDs &filters=markets:12,14" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all markets starting from a certain market ID. Handy if you're doing an import for all pre-match odds and want to continue from a certain ID.", "example": "&filters=IdAfter:marketID &filters=IdAfter:12" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the markets on a selection of markets separated by a comma.", "example": "&filters=markets:marketIDs &filters=markets:12,14" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns markets ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Market" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 303, "legacy_id": null, "name": "2nd Half Asian Handicap", "developer_name": "2ND_HALF_ASIAN_HANDICAP", "has_winning_calculations": false }, { "id": 304, "legacy_id": null, "name": "Odd/Even 2nd Half", "developer_name": "ODD_EVEN_2ND_HALF", "has_winning_calculations": false }, { "id": 305, "legacy_id": null, "name": "Draw No Bet 1st Half", "developer_name": "DRAW_NO_BET_1ST_HALF", "has_winning_calculations": false } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/odds/markets/premium?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the markets that are available in the Premium Feed. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/markets/get-all-premium-markets\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/markets/get-all-premium-markets)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/markets/get-all-premium-markets", "description": "Sportmonks docs" } } }, "/odds/markets/{marketId}": { "get": { "operationId": "getMarketById", "summary": "Market by ID", "tags": [ "Markets" ], "parameters": [ { "name": "marketId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the market you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, name, developer_name, has_winning_calculations. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "developer_name", "has_winning_calculations" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name", "developer_name", "has_winning_calculations" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: markets. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "markets", "use": "Odds", "description": "Filter the markets on a selection of markets separated by a comma.", "example": "&filters=markets:marketIDs &filters=markets:12,14" } ], "x-filters": [ { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the markets on a selection of markets separated by a comma.", "example": "&filters=markets:marketIDs &filters=markets:12,14" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Market" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": { "id": 1, "legacy_id": 1, "name": "Fulltime Result", "developer_name": "FULLTIME_RESULT", "has_winning_calculations": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the market for the requested market ID. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/markets/get-market-by-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/markets/get-market-by-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/markets/get-market-by-id", "description": "Sportmonks docs" } } }, "/odds/markets/search/{name}": { "get": { "operationId": "getMarketBySearch", "summary": "Market by Search", "tags": [ "Markets" ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name of the market you want to retrieve." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events", "schema": { "type": "string" } }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, name, developer_name, has_winning_calculations. Pass as a comma-separated list, e.g. `select=id,name`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "developer_name", "has_winning_calculations" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "name", "developer_name", "has_winning_calculations" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Result ordering (asc or desc). Defaults to asc.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page (max 50). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 } }, { "name": "page", "in": "query", "required": false, "description": "Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Market" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "legacy_id": 1, "name": "Fulltime Result", "developer_name": "FULLTIME_RESULT", "has_winning_calculations": true } ], "pagination": { "count": 1, "per_page": 25, "current_page": 1, "next_page": null, "has_more": false }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all markets that match your search query. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/markets/get-market-by-search\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/markets/get-market-by-search)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/markets/get-market-by-search", "description": "Sportmonks docs" } } }, "/football/odds/premium/history": { "get": { "operationId": "getAllHistoricalOdds", "summary": "All Historical Odds", "tags": [ "Premium Odds Feed" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=fixture;bookmaker;market\n\nAllowed values: odd. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=odd`.", "schema": { "type": "string" }, "x-includes": [ "odd" ], "x-include-depth-max": 1, "example": "odd" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, odd_id, value, probability, dp3, fractional, american, bookmaker_update. Pass as a comma-separated list, e.g. `select=id,odd_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "odd_id", "value", "probability", "dp3", "fractional", "american", "bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "odd_id", "value", "probability", "dp3", "fractional", "american", "bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: winningOdds. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "winningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&filters=winningOdds" } ], "x-filters": [ { "kind": "static", "name": "winningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&filters=winningOdds" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns odds ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "asc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PremiumOdd" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 11399353727, "odd_id": 16466704204, "value": "2.00", "probability": "50%", "dp3": "2.000", "fractional": "1/1", "american": "100", "bookmaker_update": "2026-05-06 12:40:09" }, { "id": 11399353726, "odd_id": 16468027065, "value": "1.76", "probability": "56.82%", "dp3": "1.760", "fractional": "19/25", "american": "76", "bookmaker_update": "2026-05-06 12:40:12" }, { "id": 11399353725, "odd_id": 16468027064, "value": "1.83", "probability": "54.64%", "dp3": "1.830", "fractional": "83/100", "american": "83", "bookmaker_update": "2026-05-06 12:40:12" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/odds/premium/history?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the historical (premium) pre-match odds available in your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-all-historical-odds\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-all-historical-odds)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-all-historical-odds", "description": "Sportmonks docs" } } }, "/football/odds/premium": { "get": { "operationId": "getAllPremiumOdds", "summary": "All Premium Odds", "tags": [ "Premium Odds Feed" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=bookmaker;fixture\n\nAllowed values: market, bookmaker, fixture, history. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=market;bookmaker`.", "schema": { "type": "string" }, "x-includes": [ "market", "bookmaker", "fixture", "history" ], "x-include-depth-max": 1, "example": "market;bookmaker" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, market_id, bookmaker_id, label, value, name, market_description, probability, dp3, fractional, american, stopped, total, handicap, created_at, updated_at, latest_bookmaker_update. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "created_at", "updated_at", "latest_bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "created_at", "updated_at", "latest_bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, deleted, markets, bookmakers. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "All", "description": "Filter all pre-match odds starting from a certain pre-match odd ID. Handy if you're doing an import for all pre-match odds and want to continue from a certain ID.", "example": "&filters=IdAfter:prematchoddID &filters=IdAfter:4430465" }, { "name": "deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&include=fixtures&filters=deleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all pre-match odds starting from a certain pre-match odd ID. Handy if you're doing an import for all pre-match odds and want to continue from a certain ID.", "example": "&filters=IdAfter:prematchoddID &filters=IdAfter:4430465" }, { "kind": "static", "name": "deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&include=fixtures&filters=deleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns odds ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PremiumOdd" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 16011908338, "fixture_id": 19687869, "market_id": 1, "bookmaker_id": 7, "label": "Home", "value": "2.80", "name": "Home", "sort_order": 1, "market_description": "Fulltime Result", "probability": "35.71%", "dp3": "2.800", "fractional": "9/5", "american": "180", "stopped": false, "total": null, "handicap": null, "created_at": "2026-04-09T00:14:08.000000Z", "latest_bookmaker_update": "2026-04-29 10:56:59" }, { "id": 16011908339, "fixture_id": 19687869, "market_id": 1, "bookmaker_id": 7, "label": "Draw", "value": "3.25", "name": "Draw", "sort_order": 2, "market_description": "Fulltime Result", "probability": "30.77%", "dp3": "3.250", "fractional": "9/4", "american": "225", "stopped": false, "total": null, "handicap": null, "created_at": "2026-04-09T00:14:08.000000Z", "latest_bookmaker_update": "2026-04-29 10:56:59" }, { "id": 16011908340, "fixture_id": 19687869, "market_id": 1, "bookmaker_id": 7, "label": "Away", "value": "2.15", "name": "Away", "sort_order": 3, "market_description": "Fulltime Result", "probability": "46.51%", "dp3": "2.150", "fractional": "23/20", "american": "115", "stopped": false, "total": null, "handicap": null, "created_at": "2026-04-09T00:14:08.000000Z", "latest_bookmaker_update": "2026-04-29 10:56:59" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/odds/premium?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all the premium odd records that are available within your subscription. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-all-premium-odds\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-all-premium-odds)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-all-premium-odds", "description": "Sportmonks docs" } } }, "/football/odds/premium/fixtures/{fixtureId}/bookmakers/{bookmakerId}": { "get": { "operationId": "getPremiumOddsByFixtureAndBookmakerId", "summary": "Premium Odds by Fixture and Bookmaker ID", "tags": [ "Premium Odds Feed" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the fixture you want to retrieve in-play odds from." }, { "name": "bookmakerId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the bookmaker you want to retrieve in-play odds from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=market\n\nAllowed values: market, bookmaker, fixture, history. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=market;bookmaker`.", "schema": { "type": "string" }, "x-includes": [ "market", "bookmaker", "fixture", "history" ], "x-include-depth-max": 1, "example": "market;bookmaker" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, market_id, bookmaker_id, label, value, name, market_description, probability, dp3, fractional, american, stopped, total, handicap, created_at, updated_at, latest_bookmaker_update. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "created_at", "updated_at", "latest_bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "created_at", "updated_at", "latest_bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: markets. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" } ], "x-filters": [ { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PremiumOdd" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 16011908340, "fixture_id": 19687869, "market_id": 1, "bookmaker_id": 7, "label": "Away", "value": "2.15", "name": "Away", "sort_order": 3, "market_description": "Fulltime Result", "probability": "46.51%", "dp3": "2.150", "fractional": "23/20", "american": "115", "stopped": false, "total": null, "handicap": null, "created_at": "2026-04-09T00:14:08.000000Z", "latest_bookmaker_update": "2026-04-29 10:56:59" }, { "id": 16011908339, "fixture_id": 19687869, "market_id": 1, "bookmaker_id": 7, "label": "Draw", "value": "3.25", "name": "Draw", "sort_order": 2, "market_description": "Fulltime Result", "probability": "30.77%", "dp3": "3.250", "fractional": "9/4", "american": "225", "stopped": false, "total": null, "handicap": null, "created_at": "2026-04-09T00:14:08.000000Z", "latest_bookmaker_update": "2026-04-29 10:56:59" }, { "id": 16011908338, "fixture_id": 19687869, "market_id": 1, "bookmaker_id": 7, "label": "Home", "value": "2.80", "name": "Home", "sort_order": 1, "market_description": "Fulltime Result", "probability": "35.71%", "dp3": "2.800", "fractional": "9/5", "american": "180", "stopped": false, "total": null, "handicap": null, "created_at": "2026-04-09T00:14:08.000000Z", "latest_bookmaker_update": "2026-04-29 10:56:59" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the premium odds for the requested fixture ID and bookmaker ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-premium-odds-by-fixture-id-and-bookmaker-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-premium-odds-by-fixture-id-and-bookmaker-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-premium-odds-by-fixture-id-and-bookmaker-id", "description": "Sportmonks docs" } } }, "/football/odds/premium/fixtures/{fixtureId}/markets/{marketId}": { "get": { "operationId": "getPremiumOddsByFixtureAndMarketId", "summary": "Premium Odds by Fixture and Market ID", "tags": [ "Premium Odds Feed" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the fixture you want to retrieve in-play odds from." }, { "name": "marketId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the market you want to retrieve in-play odds from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=bookmaker\n\nAllowed values: market, bookmaker, fixture, history. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=market;bookmaker`.", "schema": { "type": "string" }, "x-includes": [ "market", "bookmaker", "fixture", "history" ], "x-include-depth-max": 1, "example": "market;bookmaker" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, market_id, bookmaker_id, label, value, name, market_description, probability, dp3, fractional, american, stopped, total, handicap, created_at, updated_at, latest_bookmaker_update. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "created_at", "updated_at", "latest_bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "created_at", "updated_at", "latest_bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: bookmakers. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" } ], "x-filters": [ { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PremiumOdd" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 16359928921, "fixture_id": 19687869, "market_id": 1, "bookmaker_id": 168, "label": "Draw", "value": "3.10", "name": "Draw", "sort_order": 2, "market_description": "Fulltime Result", "probability": "32.26%", "dp3": "3.100", "fractional": "21/10", "american": "210", "stopped": false, "total": null, "handicap": null, "created_at": "2026-04-29T08:39:06.000000Z", "latest_bookmaker_update": "2026-04-29 10:58:10" }, { "id": 16359928922, "fixture_id": 19687869, "market_id": 1, "bookmaker_id": 168, "label": "Away", "value": "2.07", "name": "Away", "sort_order": 3, "market_description": "Fulltime Result", "probability": "48.31%", "dp3": "2.070", "fractional": "107/100", "american": "107", "stopped": false, "total": null, "handicap": null, "created_at": "2026-04-29T08:39:06.000000Z", "latest_bookmaker_update": "2026-04-29 10:58:10" }, { "id": 16348904765, "fixture_id": 19687869, "market_id": 1, "bookmaker_id": 74, "label": "Home", "value": "2.95", "name": "Home", "sort_order": 1, "market_description": "Fulltime Result", "probability": "33.9%", "dp3": "2.950", "fractional": "39/20", "american": "195", "stopped": false, "total": null, "handicap": null, "created_at": "2026-04-28T12:16:06.000000Z", "latest_bookmaker_update": "2026-04-29 10:57:34" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the premium odds for the requested fixture ID and market ID. For more information, please visit: https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-premium-odds-by-fixture-id-and-market-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-premium-odds-by-fixture-id-and-market-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-premium-odds-by-fixture-id-and-market-id", "description": "Sportmonks docs" } } }, "/football/odds/premium/fixtures/{fixtureId}": { "get": { "operationId": "getPremiumOddsByFixtureId", "summary": "Premium Odds by Fixture ID", "tags": [ "Premium Odds Feed" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the fixture you want to retrieve in-play odds from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=bookmaker;market\n\nAllowed values: market, bookmaker, fixture, history. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=market;bookmaker`.", "schema": { "type": "string" }, "x-includes": [ "market", "bookmaker", "fixture", "history" ], "x-include-depth-max": 1, "example": "market;bookmaker" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, market_id, bookmaker_id, label, value, name, market_description, probability, dp3, fractional, american, stopped, total, handicap, created_at, updated_at, latest_bookmaker_update. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "created_at", "updated_at", "latest_bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "created_at", "updated_at", "latest_bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: markets, bookmakers. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" } ], "x-filters": [ { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PremiumOdd" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 16011908340, "fixture_id": 19687869, "market_id": 1, "bookmaker_id": 7, "label": "Away", "value": "2.15", "name": "Away", "sort_order": 3, "market_description": "Fulltime Result", "probability": "46.51%", "dp3": "2.150", "fractional": "23/20", "american": "115", "stopped": false, "total": null, "handicap": null, "created_at": "2026-04-09T00:14:08.000000Z", "latest_bookmaker_update": "2026-04-29 10:56:59" }, { "id": 16011908339, "fixture_id": 19687869, "market_id": 1, "bookmaker_id": 7, "label": "Draw", "value": "3.25", "name": "Draw", "sort_order": 2, "market_description": "Fulltime Result", "probability": "30.77%", "dp3": "3.250", "fractional": "9/4", "american": "225", "stopped": false, "total": null, "handicap": null, "created_at": "2026-04-09T00:14:08.000000Z", "latest_bookmaker_update": "2026-04-29 10:56:59" }, { "id": 16011908338, "fixture_id": 19687869, "market_id": 1, "bookmaker_id": 7, "label": "Home", "value": "2.80", "name": "Home", "sort_order": 1, "market_description": "Fulltime Result", "probability": "35.71%", "dp3": "2.800", "fractional": "9/5", "american": "180", "stopped": false, "total": null, "handicap": null, "created_at": "2026-04-09T00:14:08.000000Z", "latest_bookmaker_update": "2026-04-29 10:56:59" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the premium odds for the requested fixture ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-premium-odds-by-fixture-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-premium-odds-by-fixture-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-premium-odds-by-fixture-id", "description": "Sportmonks docs" } } }, "/football/odds/premium/history/updated/between/{from}/{to}": { "get": { "operationId": "getUpdatedHistoricalOddsBetweenTimeRange", "summary": "Updated Historical Odds Between Time Range", "tags": [ "Premium Odds Feed" ], "parameters": [ { "name": "from", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "description": "Starting range timestamp." }, { "name": "to", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "description": "Ending range timestamp." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=fixture;bookmaker;market\n\nAllowed values: odd. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=odd`.", "schema": { "type": "string" }, "x-includes": [ "odd" ], "x-include-depth-max": 1, "example": "odd" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, odd_id, value, probability, dp3, fractional, american, bookmaker_update. Pass as a comma-separated list, e.g. `select=id,odd_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "odd_id", "value", "probability", "dp3", "fractional", "american", "bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "odd_id", "value", "probability", "dp3", "fractional", "american", "bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: winningOdds. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "winningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&filters=winningOdds" } ], "x-filters": [ { "kind": "static", "name": "winningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&filters=winningOdds" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns odds ordered by bookmaker_update ( asc or desc ). Defaults to desc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "asc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PremiumOdd" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 11399353703, "odd_id": 16379177380, "value": "1.63", "probability": "61.35%", "dp3": "1.630", "fractional": "63/100", "american": "63", "bookmaker_update": "2026-05-06 12:40:26" }, { "id": 11399353702, "odd_id": 16379177379, "value": "2.10", "probability": "47.62%", "dp3": "2.100", "fractional": "11/10", "american": "110", "bookmaker_update": "2026-05-06 12:40:26" }, { "id": 11399353701, "odd_id": 16379177378, "value": "1.80", "probability": "55.56%", "dp3": "1.800", "fractional": "4/5", "american": "80", "bookmaker_update": "2026-05-06 12:40:26" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/odds/premium/history/updated/between/1778070926/1778071226?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the historical (premium) pre-match odds updated between a range of timestamps. The maximum time range is 5 minutes. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-updated-historical-odds-between-time-range\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-updated-historical-odds-between-time-range)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-updated-historical-odds-between-time-range", "description": "Sportmonks docs" } } }, "/football/odds/premium/updated/between/{from}/{to}": { "get": { "operationId": "getUpdatedPremiumOddsBetweenTimeRange", "summary": "Updated Premium Odds Between Time Range", "tags": [ "Premium Odds Feed" ], "parameters": [ { "name": "from", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "description": "Starting range timestamp." }, { "name": "to", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "description": "Ending range timestamp." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=fixture;bookmaker;market\n\nAllowed values: market, bookmaker, fixture, history. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=market;bookmaker`.", "schema": { "type": "string" }, "x-includes": [ "market", "bookmaker", "fixture", "history" ], "x-include-depth-max": 1, "example": "market;bookmaker" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, market_id, bookmaker_id, label, value, name, market_description, probability, dp3, fractional, american, stopped, total, handicap, created_at, updated_at, latest_bookmaker_update. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "created_at", "updated_at", "latest_bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "created_at", "updated_at", "latest_bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: markets, bookmakers. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" } ], "x-filters": [ { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns odds ordered by latest_bookmaker_update ( asc or desc ). Defaults to desc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "asc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PremiumOdd" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 16464729285, "fixture_id": 19668015, "market_id": 1, "bookmaker_id": 28, "label": "Away", "value": "1.52", "name": "Away", "sort_order": 3, "market_description": "Fulltime Result", "probability": "65.79%", "dp3": "1.520", "fractional": "13/25", "american": "52", "stopped": false, "total": null, "handicap": null, "created_at": "2026-05-06T00:31:05.000000Z", "latest_bookmaker_update": "2026-05-06 12:40:26" }, { "id": 16464729797, "fixture_id": 19668015, "market_id": 2, "bookmaker_id": 28, "label": "Home/Draw", "value": "2.35", "name": "Home/Draw", "sort_order": 1, "market_description": "Double Chance", "probability": "42.55%", "dp3": "2.350", "fractional": "27/20", "american": "135", "stopped": false, "total": null, "handicap": null, "created_at": "2026-05-06T00:31:05.000000Z", "latest_bookmaker_update": "2026-05-06 12:40:26" }, { "id": 16464730641, "fixture_id": 19668015, "market_id": 45, "bookmaker_id": 28, "label": "Even", "value": "1.82", "name": "Even", "sort_order": 2, "market_description": "Odd/Even 1st Half", "probability": "54.95%", "dp3": "1.820", "fractional": "41/50", "american": "82", "stopped": false, "total": null, "handicap": null, "created_at": "2026-05-06T00:31:07.000000Z", "latest_bookmaker_update": "2026-05-06 12:40:26" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/odds/premium/updated/between/1778070926/1778071226?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the pre-match odds updated between a range of timestamps. The maximum time range is 5 minutes. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-updated-premium-odds-between-time-range\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-updated-premium-odds-between-time-range)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/premium-odds-feed/premium-pre-match-odds/get-updated-premium-odds-between-time-range", "description": "Sportmonks docs" } } }, "/football/odds/inplay": { "get": { "operationId": "getAllInplayOdds", "summary": "All Inplay Odds", "tags": [ "Standard Odds Feed" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: market, bookmaker, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=market;bookmaker`.", "schema": { "type": "string" }, "x-includes": [ "market", "bookmaker", "fixture" ], "x-include-depth-max": 1, "example": "market;bookmaker" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, market_id, bookmaker_id, label, value, name, market_description, probability, dp3, fractional, american, stopped, total, handicap, participants, latest_bookmaker_update. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, deleted, markets, bookmakers. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "All", "description": "Filter all pre-match odds starting from a certain pre-match odd ID. Handy if you're doing an import for all pre-match odds and want to continue from a certain ID.", "example": "&filters=IdAfter:prematchoddID &filters=IdAfter:4430465" }, { "name": "deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&include=fixtures&filters=deleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &bookmaker&filters=bookmakers:2,14" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all pre-match odds starting from a certain pre-match odd ID. Handy if you're doing an import for all pre-match odds and want to continue from a certain ID.", "example": "&filters=IdAfter:prematchoddID &filters=IdAfter:4430465" }, { "kind": "static", "name": "deleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&include=fixtures&filters=deleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &bookmaker&filters=bookmakers:2,14" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns Inplay Odds ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StandardOddsFeed" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "fixture_id": 18476561, "market_id": 1, "bookmaker_id": 2, "label": "1", "value": "1.00", "name": "Bucheon FC 1995", "sort_order": 0, "market_description": "Fulltime Result", "probability": "100%", "dp3": "1.00", "fractional": "1/500", "american": "-100", "winning": false, "suspended": true, "stopped": true, "total": null, "handicap": null, "participants": "7361|7361", "created_at": "2022-08-01T10:36:46.000000Z", "latest_bookmaker_update": null }, { "id": 2, "fixture_id": 18476561, "market_id": 1, "bookmaker_id": 2, "label": "X", "value": "51.00", "name": "Draw", "sort_order": 1, "market_description": "Fulltime Result", "probability": "1.96%", "dp3": "51.00", "fractional": "50/1", "american": "5000", "winning": false, "suspended": true, "stopped": true, "total": null, "handicap": null, "participants": null, "created_at": "2022-08-01T10:36:46.000000Z", "latest_bookmaker_update": null }, { "id": 3, "fixture_id": 18476561, "market_id": 1, "bookmaker_id": 2, "label": "2", "value": "451.00", "name": "Gyeongnam FC", "sort_order": 2, "market_description": "Fulltime Result", "probability": "0.22%", "dp3": "451.00", "fractional": "450/1", "american": "45000", "winning": false, "suspended": true, "stopped": true, "total": null, "handicap": null, "participants": "7983", "created_at": "2022-08-01T10:36:46.000000Z", "latest_bookmaker_update": null } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/odds/inplay?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all available inplay odds. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/inplay-odds/get-all-inplay-odds\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/inplay-odds/get-all-inplay-odds)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/inplay-odds/get-all-inplay-odds", "description": "Sportmonks docs" } } }, "/football/odds/pre-match": { "get": { "operationId": "getAllPreMatchOdds", "summary": "All Pre-match Odds", "tags": [ "Standard Odds Feed" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: market, bookmaker, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=market;bookmaker`.", "schema": { "type": "string" }, "x-includes": [ "market", "bookmaker", "fixture" ], "x-include-depth-max": 1, "example": "market;bookmaker" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, market_id, bookmaker_id, label, value, name, market_description, probability, dp3, fractional, american, winning, stopped, total, handicap, participants, latest_bookmaker_update. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "winning", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "winning", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: IdAfter, d eleted, markets, bookmakers, WinningOdds. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "IdAfter", "use": "All", "description": "Filter all pre-match odds starting from a certain pre-match odd ID. Handy if you're doing an import for all pre-match odds and want to continue from a certain ID.", "example": "&filters=IdAfter:prematchoddID &filters=IdAfter:4430465" }, { "name": "d eleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&include=fixtures&filters=deleted" }, { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&filters=markets:marketIDs &filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&filters=bookmakers:bookmakerIDs &filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&filters=winningOdds" } ], "x-filters": [ { "kind": "static", "name": "IdAfter", "use": "All", "description": "Filter all pre-match odds starting from a certain pre-match odd ID. Handy if you're doing an import for all pre-match odds and want to continue from a certain ID.", "example": "&filters=IdAfter:prematchoddID &filters=IdAfter:4430465" }, { "kind": "static", "name": "d eleted", "use": "Fixture", "description": "Filter on deleted fixtures only. This filter helps to keep your database in sync.", "example": "&include=fixtures&filters=deleted" }, { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&filters=markets:marketIDs &filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&filters=bookmakers:bookmakerIDs &filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&filters=winningOdds" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Returns odds ordered by id ( asc or desc ). Defaults to asc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "example": "desc" }, { "name": "per_page", "in": "query", "required": false, "description": "The amount of results to return per page (max 50.). Defaults to 25.", "schema": { "type": "integer", "maximum": 50, "default": 25 }, "example": "30" }, { "name": "page", "in": "query", "required": false, "description": "You can paginate using the has_more parameter to determine if you can still propagate through the results.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": "2" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Odd" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 1, "fixture_id": 18533878, "market_id": 1, "bookmaker_id": 34, "label": "Home", "value": "1.48", "name": "Home", "sort_order": null, "market_description": "Match Winner", "probability": "67.57%", "dp3": "1.480", "fractional": "37/25", "american": "-209", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": null, "created_at": "2023-01-11T14:40:25.000000Z", "original_label": null, "latest_bookmaker_update": "2023-01-11 14:40:25" }, { "id": 2, "fixture_id": 18533878, "market_id": 80, "bookmaker_id": 34, "label": "Over", "value": "1.85", "name": "Over", "sort_order": null, "market_description": "Goals Over/Under", "probability": "54.05%", "dp3": "1.850", "fractional": "37/20", "american": "-118", "winning": false, "stopped": false, "total": "2.75", "handicap": null, "participants": null, "created_at": "2023-01-11T14:40:25.000000Z", "original_label": null, "latest_bookmaker_update": "2023-01-11 14:40:25" }, { "id": 3, "fixture_id": 18533878, "market_id": 80, "bookmaker_id": 34, "label": "Under", "value": "2.01", "name": "Under", "sort_order": null, "market_description": "Goals Over/Under", "probability": "49.75%", "dp3": "2.010", "fractional": "169/84", "american": "100", "winning": false, "stopped": false, "total": "2.75", "handicap": null, "participants": null, "created_at": "2023-01-11T14:40:25.000000Z", "original_label": null, "latest_bookmaker_update": "2023-01-11 14:40:25" } ], "pagination": { "count": 25, "per_page": 25, "current_page": 1, "next_page": "https://api.sportmonks.com/v3/football/odds/pre-match?page=2", "has_more": true }, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all available Pre-match odds. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/pre-match-odds/get-all-odds\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/pre-match-odds/get-all-odds)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/pre-match-odds/get-all-odds", "description": "Sportmonks docs" } } }, "/football/odds/inplay/fixtures/{fixtureId}/bookmakers/{bookmakerId}": { "get": { "operationId": "getInplayOddsByFixtureAndBookmakerId", "summary": "Inplay Odds by Fixture and Bookmaker ID", "tags": [ "Standard Odds Feed" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the fixture you want to retrieve in-play odds from." }, { "name": "bookmakerId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the bookmaker you want to retrieve in-play odds from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: market, bookmaker, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=market;bookmaker`.", "schema": { "type": "string" }, "x-includes": [ "market", "bookmaker", "fixture" ], "x-include-depth-max": 1, "example": "market;bookmaker" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, market_id, bookmaker_id, label, value, name, market_description, probability, dp3, fractional, american, stopped, total, handicap, participants, latest_bookmaker_update. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: markets. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" } ], "x-filters": [ { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StandardOddsFeed" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 71032017224, "fixture_id": 19427201, "market_id": 90, "bookmaker_id": 2, "label": "Anytime", "value": "4.50", "name": "Mohamed Salah", "sort_order": 1, "market_description": "Goalscorers", "probability": "22.22%", "dp3": "4.500", "fractional": "7/2", "american": "350", "winning": false, "suspended": true, "stopped": true, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-25T14:01:24.000000Z", "latest_bookmaker_update": "2026-04-25 15:20:20" }, { "id": 71032017231, "fixture_id": 19427201, "market_id": 90, "bookmaker_id": 2, "label": "Anytime", "value": "9.50", "name": "Brennan Johnson", "sort_order": 7, "market_description": "Goalscorers", "probability": "10.53%", "dp3": "9.500", "fractional": "17/2", "american": "850", "winning": false, "suspended": true, "stopped": true, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-25T14:01:24.000000Z", "latest_bookmaker_update": "2026-04-25 15:20:20" }, { "id": 71032017245, "fixture_id": 19427201, "market_id": 100, "bookmaker_id": 2, "label": "2 or More", "value": "34.00", "name": "Mohamed Salah", "sort_order": 3, "market_description": "Multi Scorers", "probability": "2.94%", "dp3": "34.000", "fractional": "33/1", "american": "3300", "winning": false, "suspended": true, "stopped": true, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-25T14:01:24.000000Z", "latest_bookmaker_update": "2026-04-25 15:20:20" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all available inplay odds for the requested fixture ID and bookmaker ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/inplay-odds/get-inplay-odds-by-fixture-id-and-bookmaker-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/inplay-odds/get-inplay-odds-by-fixture-id-and-bookmaker-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/inplay-odds/get-inplay-odds-by-fixture-id-and-bookmaker-id", "description": "Sportmonks docs" } } }, "/football/odds/inplay/fixtures/{fixtureId}/markets/{marketId}": { "get": { "operationId": "getInplayOddsByFixtureAndMarketId", "summary": "Inplay Odds by Fixture and Market ID", "tags": [ "Standard Odds Feed" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the fixture you want to retrieve in-play odds from." }, { "name": "marketId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the market you want to retrieve in-play odds from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: market, bookmaker, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=market;bookmaker`.", "schema": { "type": "string" }, "x-includes": [ "market", "bookmaker", "fixture" ], "x-include-depth-max": 1, "example": "market;bookmaker" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, market_id, bookmaker_id, label, value, name, market_description, probability, dp3, fractional, american, stopped, total, handicap, participants, latest_bookmaker_update. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: bookmakers. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" } ], "x-filters": [ { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StandardOddsFeed" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 71032016966, "fixture_id": 19427201, "market_id": 1, "bookmaker_id": 2, "label": "1", "value": "1.03", "name": "Liverpool", "sort_order": 0, "market_description": "Fulltime Result", "probability": "96.53%", "dp3": "1.036", "fractional": "1/28", "american": "-2778", "winning": false, "suspended": true, "stopped": true, "total": null, "handicap": null, "participants": "8", "created_at": "2026-04-25T14:01:24.000000Z", "latest_bookmaker_update": "2026-04-25 15:54:24" }, { "id": 71032016968, "fixture_id": 19427201, "market_id": 1, "bookmaker_id": 2, "label": "2", "value": "301.00", "name": "Crystal Palace", "sort_order": 2, "market_description": "Fulltime Result", "probability": "0.33%", "dp3": "301.000", "fractional": "300/1", "american": "30000", "winning": false, "suspended": true, "stopped": true, "total": null, "handicap": null, "participants": "51", "created_at": "2026-04-25T14:01:24.000000Z", "latest_bookmaker_update": "2026-04-25 15:54:24" }, { "id": 71032016967, "fixture_id": 19427201, "market_id": 1, "bookmaker_id": 2, "label": "X", "value": "13.00", "name": "Draw", "sort_order": 1, "market_description": "Fulltime Result", "probability": "7.69%", "dp3": "13.000", "fractional": "12/1", "american": "1200", "winning": false, "suspended": true, "stopped": true, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-25T14:01:24.000000Z", "latest_bookmaker_update": "2026-04-25 15:54:24" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all available inplay odds for the requested fixture ID and market ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/inplay-odds/get-inplay-odds-by-fixture-id-and-market-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/inplay-odds/get-inplay-odds-by-fixture-id-and-market-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/inplay-odds/get-inplay-odds-by-fixture-id-and-market-id", "description": "Sportmonks docs" } } }, "/football/odds/inplay/fixtures/{fixtureId}": { "get": { "operationId": "getInplayOddsByFixtureId", "summary": "Inplay Odds by Fixture ID", "tags": [ "Standard Odds Feed" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the fixture you want to retrieve in-play odds from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: market, bookmaker, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=market;bookmaker`.", "schema": { "type": "string" }, "x-includes": [ "market", "bookmaker", "fixture" ], "x-include-depth-max": 1, "example": "market;bookmaker" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, market_id, bookmaker_id, label, value, name, market_description, probability, dp3, fractional, american, stopped, total, handicap, participants, latest_bookmaker_update. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: markets, bookmakers. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" } ], "x-filters": [ { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StandardOddsFeed" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 71032017224, "fixture_id": 19427201, "market_id": 90, "bookmaker_id": 2, "label": "Anytime", "value": "4.50", "name": "Mohamed Salah", "sort_order": 1, "market_description": "Goalscorers", "probability": "22.22%", "dp3": "4.500", "fractional": "7/2", "american": "350", "winning": false, "suspended": true, "stopped": true, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-25T14:01:24.000000Z", "latest_bookmaker_update": "2026-04-25 15:20:20" }, { "id": 71032017231, "fixture_id": 19427201, "market_id": 90, "bookmaker_id": 2, "label": "Anytime", "value": "9.50", "name": "Brennan Johnson", "sort_order": 7, "market_description": "Goalscorers", "probability": "10.53%", "dp3": "9.500", "fractional": "17/2", "american": "850", "winning": false, "suspended": true, "stopped": true, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-25T14:01:24.000000Z", "latest_bookmaker_update": "2026-04-25 15:20:20" }, { "id": 71032017245, "fixture_id": 19427201, "market_id": 100, "bookmaker_id": 2, "label": "2 or More", "value": "34.00", "name": "Mohamed Salah", "sort_order": 3, "market_description": "Multi Scorers", "probability": "2.94%", "dp3": "34.000", "fractional": "33/1", "american": "3300", "winning": false, "suspended": true, "stopped": true, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-25T14:01:24.000000Z", "latest_bookmaker_update": "2026-04-25 15:20:20" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns all available inplay odds for the requested fixture ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/inplay-odds/get-inplay-odds-by-fixture-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/inplay-odds/get-inplay-odds-by-fixture-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/inplay-odds/get-inplay-odds-by-fixture-id", "description": "Sportmonks docs" } } }, "/football/odds/pre-match/latest": { "get": { "operationId": "getLastUpdatedPreMatchOdds", "summary": "Last Updated Pre-match Odds", "tags": [ "Standard Odds Feed" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: market, bookmaker, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=market;bookmaker`.", "schema": { "type": "string" }, "x-includes": [ "market", "bookmaker", "fixture" ], "x-include-depth-max": 1, "example": "market;bookmaker" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, market_id, bookmaker_id, label, value, name, market_description, probability, dp3, fractional, american, winning, stopped, total, handicap, participants, latest_bookmaker_update. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "winning", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "winning", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: markets, bookmakers, WinningOdds. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&filters=winningOdds" } ], "x-filters": [ { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&filters=winningOdds" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Odd" } }, "timestamp": { "type": "integer" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timestamp", "timezone" ] }, "example": { "data": [ { "id": 233812193102, "fixture_id": 19693484, "market_id": 336, "bookmaker_id": 2, "label": "3.5", "value": "21.00", "name": "Jhojan Torres", "sort_order": 180, "market_description": "Player Shots", "probability": "4.76%", "dp3": "21.000", "fractional": "21", "american": "2000", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": null, "created_at": "2026-05-04T02:40:11.000000Z", "original_label": null, "latest_bookmaker_update": "2026-05-06 12:41:21" }, { "id": 233812193097, "fixture_id": 19693484, "market_id": 336, "bookmaker_id": 2, "label": "3.5", "value": "21.00", "name": "Ewil Murillo", "sort_order": 175, "market_description": "Player Shots", "probability": "4.76%", "dp3": "21.000", "fractional": "21", "american": "2000", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": null, "created_at": "2026-05-04T02:40:11.000000Z", "original_label": null, "latest_bookmaker_update": "2026-05-06 12:41:21" }, { "id": 233340944384, "fixture_id": 19693484, "market_id": 99, "bookmaker_id": 2, "label": "1", "value": "1.83", "name": null, "sort_order": 0, "market_description": "Time of 1st Team Goal", "probability": "54.56%", "dp3": "1.833", "fractional": "11/6", "american": "-121", "winning": false, "stopped": false, "total": null, "handicap": "Goal Before 66:00", "participants": null, "created_at": "2026-05-01T03:37:41.000000Z", "original_label": "Goal Before 66:00", "latest_bookmaker_update": "2026-05-06 12:41:21" } ], "timestamp": 1778071282, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the pre-match odds updated in the last 10 seconds. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/pre-match-odds/get-last-updated-odds\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/pre-match-odds/get-last-updated-odds)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/pre-match-odds/get-last-updated-odds", "description": "Sportmonks docs" } } }, "/football/odds/inplay/latest": { "get": { "operationId": "getLatestUpdatedInplayOdds", "summary": "Latest Updated Inplay Odds", "tags": [ "Standard Odds Feed" ], "parameters": [ { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: market, bookmaker, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=market;bookmaker`.", "schema": { "type": "string" }, "x-includes": [ "market", "bookmaker", "fixture" ], "x-include-depth-max": 1, "example": "market;bookmaker" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, market_id, bookmaker_id, label, value, name, market_description, probability, dp3, fractional, american, stopped, total, handicap, participants, latest_bookmaker_update. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: markets, bookmakers. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" } ], "x-filters": [ { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StandardOddsFeed" } }, "timestamp": { "type": "integer" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timestamp", "timezone" ] }, "example": { "data": [ { "id": 71863329017, "fixture_id": 19650299, "market_id": 6, "bookmaker_id": 2, "label": "2", "value": "1.72", "name": "Aragvi Dusheti", "sort_order": 0, "market_description": "Asian Handicap (2-0)", "probability": "57.97%", "dp3": "1.725", "fractional": "29/40", "american": "-138", "winning": false, "suspended": true, "stopped": true, "total": null, "handicap": "+0.25", "participants": "232423", "created_at": "2026-05-06T12:13:05.000000Z", "latest_bookmaker_update": "2026-05-06 12:41:03" }, { "id": 71863329016, "fixture_id": 19650299, "market_id": 6, "bookmaker_id": 2, "label": "1", "value": "2.07", "name": "FC Samtredia", "sort_order": 0, "market_description": "Asian Handicap (2-0)", "probability": "48.19%", "dp3": "2.075", "fractional": "43/40", "american": "107", "winning": false, "suspended": true, "stopped": true, "total": null, "handicap": "-0.25", "participants": "5489", "created_at": "2026-05-06T12:13:05.000000Z", "latest_bookmaker_update": "2026-05-06 12:41:03" }, { "id": 71865005241, "fixture_id": 19650299, "market_id": 7, "bookmaker_id": 2, "label": "Over", "value": "2.00", "name": null, "sort_order": 0, "market_description": "Goal Line (2-0)", "probability": "50%", "dp3": "2.000", "fractional": "1/1", "american": "100", "winning": false, "suspended": true, "stopped": true, "total": "3.75", "handicap": null, "participants": null, "created_at": "2026-05-06T12:38:10.000000Z", "latest_bookmaker_update": "2026-05-06 12:41:03" } ], "timestamp": 1778071290, "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the inplay odds updated in the last 10 seconds. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/inplay-odds/get-last-updated-inplay-odds\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/inplay-odds/get-last-updated-inplay-odds)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/inplay-odds/get-last-updated-inplay-odds", "description": "Sportmonks docs" } } }, "/football/odds/pre-match/fixtures/{fixtureId}/bookmakers/{bookmakerId}": { "get": { "operationId": "getPreMatchOddsByFixtureAndBookmakerId", "summary": "Pre-match Odds by Fixture and Bookmaker ID", "tags": [ "Standard Odds Feed" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the fixture you want to retrieve pre-match odds from." }, { "name": "bookmakerId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the bookmaker you want to retrieve pre-match odds from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: market, bookmaker, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=market;bookmaker`.", "schema": { "type": "string" }, "x-includes": [ "market", "bookmaker", "fixture" ], "x-include-depth-max": 1, "example": "market;bookmaker" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, market_id, bookmaker_id, label, value, name, market_description, probability, dp3, fractional, american, winning, stopped, total, handicap, participants, latest_bookmaker_update. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "winning", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "winning", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: markets, WinningOdds. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&filters=winningOdds" } ], "x-filters": [ { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&filters=winningOdds" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Odd" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 229756966622, "fixture_id": 19427201, "market_id": 1, "bookmaker_id": 2, "label": "Away", "value": "5.00", "name": null, "sort_order": 2, "market_description": "Full Time Result", "probability": "20%", "dp3": "5.000", "fractional": "5", "american": "400", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-11T18:12:09.000000Z", "original_label": "2", "latest_bookmaker_update": "2026-04-25 14:15:58" }, { "id": 229756966621, "fixture_id": 19427201, "market_id": 1, "bookmaker_id": 2, "label": "Draw", "value": "4.50", "name": null, "sort_order": 1, "market_description": "Full Time Result", "probability": "22.22%", "dp3": "4.500", "fractional": "9/2", "american": "350", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-11T18:12:09.000000Z", "original_label": "Draw", "latest_bookmaker_update": "2026-04-25 14:15:58" }, { "id": 229756966620, "fixture_id": 19427201, "market_id": 1, "bookmaker_id": 2, "label": "Home", "value": "1.60", "name": null, "sort_order": 0, "market_description": "Full Time Result", "probability": "62.5%", "dp3": "1.600", "fractional": "8/5", "american": "-167", "winning": true, "stopped": false, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-11T18:12:09.000000Z", "original_label": "1", "latest_bookmaker_update": "2026-04-25 14:15:58" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the Pre-match odds by Fixture and Bookmaker ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/pre-match-odds/get-odds-by-fixture-id-and-bookmaker-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/pre-match-odds/get-odds-by-fixture-id-and-bookmaker-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/pre-match-odds/get-odds-by-fixture-id-and-bookmaker-id", "description": "Sportmonks docs" } } }, "/football/odds/pre-match/fixtures/{fixtureId}/markets/{marketId}": { "get": { "operationId": "getPreMatchOddsByFixtureAndMarketId", "summary": "Pre-match Odds by Fixture and Market ID", "tags": [ "Standard Odds Feed" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the fixture you want to retrieve pre-match odds from." }, { "name": "marketId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the market you want to retrieve pre-match odds from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: market, bookmaker, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=market;bookmaker`.", "schema": { "type": "string" }, "x-includes": [ "market", "bookmaker", "fixture" ], "x-include-depth-max": 1, "example": "market;bookmaker" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, market_id, bookmaker_id, label, value, name, market_description, probability, dp3, fractional, american, winning, stopped, total, handicap, participants, latest_bookmaker_update. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "winning", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "winning", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: bookmakers, WinningOdds. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&filters=winningOdds" } ], "x-filters": [ { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &include=bookmaker&filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&filters=winningOdds" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Odd" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 231124061582, "fixture_id": 19427201, "market_id": 1, "bookmaker_id": 1, "label": "Away", "value": "4.90", "name": "Away", "sort_order": 3, "market_description": "Match Winner", "probability": "20.41%", "dp3": "4.900", "fractional": "49/10", "american": "390", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-19T00:45:18.000000Z", "original_label": null, "latest_bookmaker_update": "2026-04-25 05:20:50" }, { "id": 231124061580, "fixture_id": 19427201, "market_id": 1, "bookmaker_id": 1, "label": "Draw", "value": "4.40", "name": "Draw", "sort_order": 2, "market_description": "Match Winner", "probability": "22.73%", "dp3": "4.400", "fractional": "22/5", "american": "340", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-19T00:45:18.000000Z", "original_label": null, "latest_bookmaker_update": "2026-04-25 05:20:50" }, { "id": 231124061577, "fixture_id": 19427201, "market_id": 1, "bookmaker_id": 1, "label": "Home", "value": "1.56", "name": "Home", "sort_order": 1, "market_description": "Match Winner", "probability": "64.1%", "dp3": "1.560", "fractional": "39/25", "american": "-179", "winning": true, "stopped": false, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-19T00:45:18.000000Z", "original_label": null, "latest_bookmaker_update": "2026-04-25 05:20:50" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the Pre-match odds by Fixture and Market ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/pre-match-odds/get-odds-by-fixture-id-and-market-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/pre-match-odds/get-odds-by-fixture-id-and-market-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/pre-match-odds/get-odds-by-fixture-id-and-market-id", "description": "Sportmonks docs" } } }, "/football/odds/pre-match/fixtures/{fixtureId}": { "get": { "operationId": "getPreMatchOddsByFixtureId", "summary": "Pre-match Odds by Fixture ID", "tags": [ "Standard Odds Feed" ], "parameters": [ { "name": "fixtureId", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID of the fixture you want to retrieve pre-match odds from." }, { "name": "include", "in": "query", "required": false, "description": "Enrich the API response with more data by using includes. Ex. &include=participants;events\n\nAllowed values: market, bookmaker, fixture. Pass as a **semicolon**-separated list (the API rejects comma here), e.g. `include=market;bookmaker`.", "schema": { "type": "string" }, "x-includes": [ "market", "bookmaker", "fixture" ], "x-include-depth-max": 1, "example": "market;bookmaker" }, { "name": "select", "in": "query", "required": false, "description": "Select specific fields on the base entity . Read how to select fields in our tutorial .\n\nSelectable fields: id, fixture_id, market_id, bookmaker_id, label, value, name, market_description, probability, dp3, fractional, american, winning, stopped, total, handicap, participants, latest_bookmaker_update. Pass as a comma-separated list, e.g. `select=id,fixture_id`.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "winning", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] } }, "style": "form", "explode": false, "x-select-fields": [ "id", "fixture_id", "market_id", "bookmaker_id", "label", "value", "name", "market_description", "probability", "dp3", "fractional", "american", "winning", "stopped", "total", "handicap", "participants", "latest_bookmaker_update" ] }, { "name": "filters", "in": "query", "required": false, "description": "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.\n\nComposable filter expression in the form `name1:value1,value2;name2:value3`. Available filter names: markets, bookmakers, WinningOdds. Pass as a single string — the API rejects the bare comma-joined value codegen tools emit when this is modeled as an array.", "schema": { "type": "string" }, "x-filters-static": [ { "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &filters=bookmakers:2,14" }, { "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&filters=winningOdds" } ], "x-filters": [ { "kind": "static", "name": "markets", "use": "Odds", "description": "Filter the odds on a selection of markets separated by a comma.", "example": "&include=market&filters=markets:marketIDs &include=market&filters=markets:12,14" }, { "kind": "static", "name": "bookmakers", "use": "Odds", "description": "Filter the odds on a selection of bookmakers separated by a comma. (e.g: 2,14).", "example": "&include=bookmaker&filters=bookmakers:bookmakerIDs &filters=bookmakers:2,14" }, { "kind": "static", "name": "WinningOdds", "use": "Odds", "description": "Filter all winning odds.", "example": "&filters=winningOdds" } ] }, { "name": "locale", "in": "query", "required": false, "description": "Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page .", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Odd" } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "rate_limit": { "$ref": "#/components/schemas/RateLimit" }, "timezone": { "type": "string" } }, "required": [ "data", "timezone" ] }, "example": { "data": [ { "id": 229760013571, "fixture_id": 19427201, "market_id": 1, "bookmaker_id": 38, "label": "Away", "value": "11.71", "name": "Away", "sort_order": 3, "market_description": "Fulltime Result", "probability": "8.54%", "dp3": "11.714", "fractional": "82/7", "american": "1071", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-11T18:37:45.000000Z", "original_label": "", "latest_bookmaker_update": "2026-04-25 14:41:37" }, { "id": 231478168177, "fixture_id": 19427201, "market_id": 336, "bookmaker_id": 2, "label": "2.5", "value": "3.75", "name": "Brennan Johnson", "sort_order": 97, "market_description": "Player Shots", "probability": "26.67%", "dp3": "3.750", "fractional": "15/4", "american": "275", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-21T00:12:55.000000Z", "original_label": null, "latest_bookmaker_update": "2026-04-25 14:15:58" }, { "id": 231478168203, "fixture_id": 19427201, "market_id": 336, "bookmaker_id": 2, "label": "2.5", "value": "2.50", "name": "Evann Guessand", "sort_order": 103, "market_description": "Player Shots", "probability": "40%", "dp3": "2.500", "fractional": "5/2", "american": "150", "winning": false, "stopped": false, "total": null, "handicap": null, "participants": null, "created_at": "2026-04-21T00:12:55.000000Z", "original_label": null, "latest_bookmaker_update": "2026-04-25 14:15:58" } ], "subscription": [ { "meta": { "current_timestamp": 0, "next_billing_cycle": "YYYY-MM-DDTHH:MM:SS UTC" }, "plans": [], "add_ons": [], "widgets": [] } ], "rate_limit": { "resets_in_seconds": 0, "remaining": 0, "requested_entity": "" }, "timezone": "UTC" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "description": "Returns the Pre-match odds for the requested Fixture ID. For more information, please visit:https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/pre-match-odds/get-odds-by-fixture-id\n\n[Sportmonks documentation](https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/pre-match-odds/get-odds-by-fixture-id)", "externalDocs": { "url": "https://docs.sportmonks.com/football/endpoints-and-entities/endpoints/standard-odds-feed/pre-match-odds/get-odds-by-fixture-id", "description": "Sportmonks docs" } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "query", "name": "api_token", "description": "Sportmonks API token passed as the `api_token` query parameter." }, "ApiKeyHeaderAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Sportmonks API token passed as a raw `Authorization` header value (no `Bearer ` prefix). Equivalent to the query-string scheme — clients may use either." } }, "schemas": { "Pagination": { "type": "object", "description": "Pagination metadata returned with collection responses.", "properties": { "count": { "type": "integer", "description": "Number of items in the current page." }, "per_page": { "type": "integer", "description": "Maximum items per page." }, "current_page": { "type": "integer", "description": "Current page number." }, "next_page": { "type": [ "string", "null" ], "description": "URL of the next page, when available." }, "has_more": { "type": "boolean", "description": "True when more pages are available." } } }, "RateLimit": { "type": "object", "description": "Rate-limit window metadata returned with every successful response.", "properties": { "resets_in_seconds": { "type": "integer" }, "remaining": { "type": "integer" }, "requested_entity": { "type": "string" } } }, "SubscriptionMeta": { "type": "object", "properties": { "trial_ends_at": { "type": [ "string", "null" ], "format": "date-time" }, "ends_at": { "type": [ "string", "null" ], "format": "date-time" }, "current_timestamp": { "type": "integer" }, "next_billing_cycle": { "type": [ "string", "null" ] } } }, "SubscriptionPlan": { "type": "object", "properties": { "plan": { "type": "string" }, "sport": { "type": "string" }, "category": { "type": "string" } } }, "SubscriptionAddOn": { "type": "object", "description": "An add-on or trialing feature attached to the account (Predictions, Team Rankings, Extra API Calls, …).", "properties": { "add_on": { "type": "string", "description": "Add-on name; may include a trial-end suffix like ' - Trialing until 2026-05-31 13:19:52'." }, "sport": { "type": "string" }, "category": { "type": "string", "description": "Add-on category (Predictions, Team rankings, Calls, …)." } } }, "SubscriptionWidget": { "type": "object", "description": "A widget entitlement attached to the account. Shape derived from Postman example responses.", "properties": { "widget": { "type": "string", "description": "Widget name (e.g. 'Wesley van Rooij Widgets All')." }, "sport": { "type": "string", "description": "Sport scope of the widget (e.g. 'Football')." } } }, "SubscriptionInfo": { "type": "object", "description": "Subscription metadata block. Returned as a single-element array on every response.", "properties": { "meta": { "$ref": "#/components/schemas/SubscriptionMeta" }, "plans": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlan" } }, "add_ons": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionAddOn" }, "description": "Add-ons / trialing features for this account. Empty when none are attached." }, "widgets": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionWidget" }, "description": "Widget entitlements for this account. Empty when none are attached." } } }, "ApiError": { "type": "object", "description": "Generic error envelope. `message` is always present; some statuses add additional fields (see typed *Error schemas).", "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, "ApiErrorCode": { "type": "integer", "description": "Sportmonks-defined error code returned in the body of certain non-2xx responses. Known values:\n\n- **5000** (include — Include not allowed): This include is not allowed on this entity. Remove it from the request or pick an include the endpoint supports.\n- **5001** (include — Include not found): This include is not available in the API. Check the docs for the requested entity to see all valid includes.\n- **5002** (other — Subscription required (include)): Your subscription does not cover this include. Upgrade your subscription or contact support.\n- **5003** (other — Pagination limit): The page you requested does not exist. Adjust the &page= attribute.\n- **5004** (filter — Query complexity): The combination of includes/filters is too complex for the server. Reduce the surface and retry.\n- **5005** (other — Rate limit): Hourly rate limit hit. Wait for the reset, raise your plan, or add API calls at my.sportmonks.com.\n- **5006** (filter — Invalid query parameter): An unsupported query parameter was supplied. Remove it before retrying.\n- **5007** (other — Insufficient resources): Your subscription does not cover this resource. Upgrade or contact support.\n- **5008** (include — Include depth): Nested-include depth limit hit. Drop the deepest include or split into multiple calls.\n- **5010** (filter — Inapplicable filter): This filter cannot be applied on this request. Remove or correct the filter.\n- **5013** (include — Include unavailable on entity): The requested include is not available on this entity. Check the entity's docs page for valid includes.\n\nSource: https://docs.sportmonks.com/v3/api/error-codes/. The list above is known as of spec build; the API may emit codes not yet enumerated.", "enum": [ 5000, 5001, 5002, 5003, 5004, 5005, 5006, 5007, 5008, 5010, 5013 ] }, "BadRequestError": { "type": "object", "description": "400 Bad Request — typically a malformed filter syntax or unsupported parameter. May carry a `code` (e.g. 5003 for pagination limits, 5006 for invalid query parameters).", "properties": { "message": { "type": "string" }, "link": { "type": "string", "format": "uri" }, "code": { "$ref": "#/components/schemas/ApiErrorCode" } }, "required": [ "message" ] }, "ForbiddenError": { "type": "object", "description": "403 Forbidden — the endpoint or resource is gated by subscription tier or add-on. Carries a numeric `code` (typically 5002 or 5007) and a `link` to the documentation explaining the restriction.", "properties": { "message": { "type": "string" }, "link": { "type": "string", "format": "uri" }, "code": { "$ref": "#/components/schemas/ApiErrorCode" } }, "required": [ "message" ] }, "ValidationErrorBody": { "type": "object", "description": "422 Validation Error — request parameters are present but fail constraints. `errors` maps each offending parameter name to a list of human-readable failure reasons. `link` may point to the relevant documentation section. `code` may carry an include/filter exception value (5000, 5001, 5004, 5006, 5008, 5010, 5013).", "properties": { "message": { "type": "string" }, "link": { "type": "string", "format": "uri" }, "code": { "$ref": "#/components/schemas/ApiErrorCode" }, "errors": { "type": "object", "description": "Per-parameter validation failures. Keys are parameter names; values are lists of error strings.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message" ] }, "RateLimitError": { "type": "object", "description": "429 Too Many Requests — the per-entity hourly bucket is exhausted. `reset_code` is an opaque token returned by the API for support correlation; do not parse or compare its value. The API does not send a `Retry-After` or `X-RateLimit-*` header on 429 responses, so clients should infer reset timing from the `rate_limit.resets_in_seconds` field returned on the most recent successful response.", "properties": { "message": { "type": "string" }, "link": { "type": "string", "format": "uri" }, "reset_code": { "type": "string", "description": "Opaque correlation token. Forward to Sportmonks support when filing a ticket; do not parse or compare." } }, "required": [ "message" ] }, "InternalServerErrorBody": { "type": "object", "description": "500 Internal Server Error — an unexpected server-side failure. Sportmonks logs these for inspection.", "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, "Statistic": { "type": "object", "properties": { "id": { "type": "integer" }, "team_id": { "type": "integer" }, "season_id": { "type": "integer" }, "has_values": { "type": "boolean" }, "details": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "team_statistic_id": { "type": "integer" }, "type_id": { "type": "integer" }, "value": { "type": "object", "properties": { "avg_defender_height": { "type": "number" }, "avg_midfielder_height": { "type": "number" }, "avg_goalkeeper_height": { "type": "number" }, "avg_attacker_height": { "type": "number" }, "avg_total_height": { "type": "number" }, "count": { "type": "integer" }, "average": { "type": "number" }, "all": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" }, "average": { "type": "number" }, "first": { "type": [ "integer", "null" ] }, "first_goal": { "type": [ "integer", "null" ] } } }, "home": { "anyOf": [ { "type": "integer" }, { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" }, "overall_percentage": { "type": "number" }, "average": { "type": "number" }, "first": { "type": [ "integer", "null" ] }, "first_goal": { "type": [ "integer", "null" ] } } } ] }, "away": { "anyOf": [ { "type": "integer" }, { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" }, "overall_percentage": { "type": "number" }, "average": { "type": "number" }, "first": { "type": [ "integer", "null" ] }, "first_goal": { "type": [ "integer", "null" ] } } } ] }, "total": { "type": "integer" }, "gf_over_0_5": { "type": "integer" }, "gf_over_1_5": { "type": "integer" }, "gf_over_2_5": { "type": "integer" }, "gf_over_3_5": { "type": "integer" }, "gf_over_4_5": { "type": "integer" }, "ga_over_0_5": { "type": "integer" }, "ga_over_1_5": { "type": "integer" }, "ga_over_2_5": { "type": "integer" }, "ga_over_3_5": { "type": "integer" }, "ga_over_4_5": { "type": "integer" }, "most_frequent_scoring_minute": { "type": "integer" }, "amount_of_goals": { "type": "integer" }, "0-15": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "15-30": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "30-45": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "45-60": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "60-75": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "75-90": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "won_both_halves": { "type": "integer" }, "scored_both_halves": { "type": "integer" }, "comebacks": { "type": "integer" }, "passes_per_game": { "type": "number" }, "passes_per_goal": { "type": "number" }, "total_passes": { "type": "integer" }, "passes_per_shot": { "type": "number" }, "left": { "type": "integer" }, "right": { "type": "integer" }, "unknown": { "type": "integer" }, "on_target": { "type": "integer" }, "on_target_pct": { "type": "null" }, "off_target": { "type": "integer" }, "inside_box": { "type": [ "integer", "null" ] }, "outside_box": { "type": [ "integer", "null" ] }, "blocked": { "type": "integer" }, "shot_frequency": { "type": "null" }, "shot_conversion_rate_pct": { "type": "integer" }, "minutes_per_assist": { "type": "number" }, "assists_per_game": { "type": "number" }, "total_assists": { "type": "integer" }, "scoring_frequency": { "type": "number" }, "value": { "type": "string" }, "most_injured_players": { "type": "array", "items": { "type": "object", "properties": { "player_id": { "type": "integer" }, "total": { "type": "integer" } } } }, "total_interceptions": { "type": "integer" }, "interceptions_per_game": { "type": "number" }, "most_scored_half": { "type": "string" }, "most_scored_half_goals": { "type": "integer" }, "details": { "type": "object", "properties": { "2nd-half": { "type": "object", "properties": { "period": { "type": "string" }, "total": { "type": "integer" } } }, "1st-half": { "type": "object", "properties": { "period": { "type": "string" }, "total": { "type": "integer" } } } } }, "player_id": { "type": [ "integer", "null" ] }, "player_name": { "type": [ "null", "string" ] }, "coach": { "type": "integer" }, "coach_average": { "type": "number" }, "tackles_per_foul": { "type": "number" }, "tackles_per_card": { "type": "number" }, "total_minutes_played": { "type": "integer" }, "scored": { "type": "integer" }, "missed": { "type": "integer" }, "conversion_rate": { "type": "number" }, "over_0_5": { "type": "object", "properties": { "matches": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "team": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } } } }, "over_1_5": { "type": "object", "properties": { "matches": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "team": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } } } }, "over_2_5": { "type": "object", "properties": { "matches": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "team": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } } } }, "over_3_5": { "type": "object", "properties": { "matches": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "team": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } } } }, "over_4_5": { "type": "object", "properties": { "matches": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "team": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } } } }, "over_5_5": { "type": "object", "properties": { "matches": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "team": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } } } }, "most_appearing_players": { "type": "array", "items": { "type": "object", "properties": { "player_id": { "type": "integer" }, "matches": { "type": "integer" }, "minutes": { "type": "integer" } } } }, "longest_appearing_players": { "type": "array", "items": { "type": "object", "properties": { "player_id": { "type": "integer" }, "minutes": { "type": "integer" } } } }, "fouls_per_card": { "type": "string" }, "cards_per_foul": { "type": "string" }, "most_substituted_players": { "type": "array", "items": { "type": "object", "properties": { "player_id": { "type": "integer" }, "in": { "type": "integer" }, "out": { "type": "integer" }, "total": { "type": "integer" } } } }, "rating": { "type": "number" }, "national_team_players": { "type": "array", "items": { "type": "object", "properties": { "team": { "type": "string" }, "player": { "type": "integer" } } } }, "conversion_rate_pct": { "type": "string" }, "average_points_per_game": { "type": "integer" } } } } } } } }, "TimeZone": { "type": "string", "description": "IANA time-zone identifier (e.g. \"UTC\", \"Europe/Amsterdam\"). Returned in the data array of /v3/core/timezones." }, "City": { "type": "object", "properties": { "id": { "type": "integer" }, "country_id": { "type": "integer" }, "region_id": { "type": "integer" }, "name": { "type": "string" }, "latitude": { "type": [ "null", "string" ] }, "longitude": { "type": [ "null", "string" ] } } }, "Continent": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" } } }, "Country": { "type": "object", "properties": { "id": { "type": "integer" }, "continent_id": { "type": "integer" }, "name": { "type": "string" }, "official_name": { "type": "string" }, "fifa_name": { "type": [ "null", "string" ] }, "iso2": { "type": [ "null", "string" ] }, "iso3": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "string" ] }, "longitude": { "type": [ "null", "string" ] }, "borders": { "type": "array", "items": { "type": "string" } }, "image_path": { "type": "string" } } }, "Region": { "type": "object", "properties": { "id": { "type": "integer" }, "country_id": { "type": "integer" }, "name": { "type": "string" } } }, "Type": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "developer_name": { "type": "string" }, "model_type": { "type": "string" }, "stat_group": { "type": "null" } } }, "Coach": { "type": "object", "properties": { "id": { "type": "integer" }, "player_id": { "type": [ "integer", "null" ] }, "sport_id": { "type": "integer" }, "country_id": { "type": "integer" }, "nationality_id": { "type": [ "integer", "null" ] }, "city_id": { "type": [ "integer", "null" ] }, "common_name": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "name": { "type": "string" }, "display_name": { "type": "string" }, "image_path": { "type": "string" }, "height": { "type": [ "integer", "null" ] }, "weight": { "type": [ "integer", "null" ] }, "date_of_birth": { "type": [ "null", "string" ] }, "gender": { "type": "string" } } }, "Commentary": { "type": "object", "properties": { "id": { "type": "integer" }, "fixture_id": { "type": "integer" }, "comment": { "type": "string" }, "minute": { "type": [ "integer", "null" ] }, "extra_minute": { "type": [ "integer", "null" ] }, "is_goal": { "type": "boolean" }, "is_important": { "type": "boolean" }, "order": { "type": "integer" } } }, "Expected": { "type": "object", "properties": { "id": { "type": "integer" }, "fixture_id": { "type": "integer" }, "player_id": { "type": [ "integer", "null" ] }, "team_id": { "type": "integer" }, "lineup_id": { "type": "integer" }, "type_id": { "type": "integer" }, "data": { "type": "object", "properties": { "value": { "type": "number" } } }, "participant_id": { "type": "integer" }, "location": { "type": "string" } } }, "Fixture": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "league_id": { "type": "integer" }, "season_id": { "type": "integer" }, "stage_id": { "type": "integer" }, "group_id": { "type": [ "integer", "null" ] }, "aggregate_id": { "type": [ "integer", "null" ] }, "round_id": { "type": [ "integer", "null" ] }, "state_id": { "type": "integer" }, "venue_id": { "type": [ "integer", "null" ] }, "name": { "type": "string" }, "starting_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "result_info": { "type": [ "null", "string" ] }, "leg": { "type": "string" }, "details": { "type": "null" }, "length": { "type": "integer" }, "placeholder": { "type": "boolean" }, "has_odds": { "type": "boolean" }, "has_premium_odds": { "type": "boolean" }, "starting_at_timestamp": { "type": "integer" } } }, "League": { "type": "object", "properties": { "id": { "description": "Refers to the unique id of th league", "type": "integer" }, "sport_id": { "description": "Refers to the sport of the league", "type": "integer" }, "country_id": { "description": "Refers to the country of the league", "type": "integer" }, "name": { "description": "The name of the league", "type": "string" }, "active": { "anyOf": [ { "type": "boolean" }, { "description": "Indicates if the league is active or inactive", "type": "integer" } ] }, "short_code": { "anyOf": [ { "type": "null" }, { "description": "The short code of the league", "type": "string" } ] }, "image_path": { "description": "Image path to the league logo", "type": "string" }, "type": { "description": "Indicates the type of the league", "type": "string" }, "sub_type": { "description": "Indicates the subtype of the league", "type": "string" }, "last_played_at": { "anyOf": [ { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "null" } ] }, "category": { "anyOf": [ { "type": "null" }, { "description": "Indicates the category of the league", "type": "integer" } ] }, "has_jerseys": { "type": "boolean" }, "sport": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } }, "Livescore": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "league_id": { "type": "integer" }, "season_id": { "type": "integer" }, "stage_id": { "type": "integer" }, "group_id": { "type": [ "integer", "null" ] }, "aggregate_id": { "type": "null" }, "round_id": { "type": [ "integer", "null" ] }, "state_id": { "type": "integer" }, "venue_id": { "type": [ "integer", "null" ] }, "name": { "type": "string" }, "starting_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "result_info": { "type": [ "null", "string" ] }, "leg": { "type": "string" }, "details": { "type": "null" }, "length": { "type": "integer" }, "placeholder": { "type": "boolean" }, "has_odds": { "type": "boolean" }, "has_premium_odds": { "type": "boolean" }, "starting_at_timestamp": { "type": "integer" } } }, "MatchFactCatalog": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "fixture_id": { "type": "integer" }, "type_id": { "type": "integer" }, "participant": { "type": "string" }, "basis": { "type": "string" }, "data": { "type": "object", "properties": { "all": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" }, "average": { "type": "number" } } }, "home": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" }, "average": { "type": "number" } } }, "away": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" }, "average": { "type": "number" } } } } }, "natural_language": { "type": "string" }, "category": { "type": "string" }, "scope": { "type": "string" } } }, "MatchFact": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "fixture_id": { "type": "integer" }, "type_id": { "type": "integer" }, "participant": { "type": "string" }, "basis": { "type": "string" }, "data": { "type": "object", "properties": { "win": { "type": "object", "properties": { "all": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "home": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "away": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "context": { "type": "object", "properties": { "n_match_checked": { "type": "integer" }, "similar_matches": { "type": "integer" }, "first_match": { "type": "string" } } } } }, "loss": { "type": "object", "properties": { "all": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "home": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "away": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "context": { "type": "object", "properties": { "n_match_checked": { "type": "integer" }, "similar_matches": { "type": "integer" }, "first_match": { "type": "string" } } } } }, "draw": { "type": "object", "properties": { "all": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "home": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "away": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "context": { "type": "object", "properties": { "n_match_checked": { "type": "integer" }, "similar_matches": { "type": "integer" }, "first_match": { "type": "string" } } } } }, "all": { "type": "object", "properties": { "streak": { "type": "integer" }, "matches": { "type": "integer" }, "count": { "type": "integer" }, "percentage": { "type": "number" }, "average": { "type": "number" } } }, "home": { "type": "object", "properties": { "streak": { "type": "integer" }, "matches": { "type": "integer" }, "count": { "type": "integer" }, "percentage": { "type": "number" }, "average": { "type": "number" } } }, "away": { "type": "object", "properties": { "streak": { "type": "integer" }, "matches": { "type": "integer" }, "count": { "type": "integer" }, "percentage": { "type": "number" }, "average": { "type": "number" } } }, "count": { "type": "integer" }, "streak": { "type": "integer" }, "matches": { "type": "integer" }, "0-0": { "type": "integer" }, "0-1": { "type": "integer" }, "0-2": { "type": "integer" }, "0-3": { "type": "integer" }, "0-7": { "type": "integer" }, "1-0": { "type": "integer" }, "1-1": { "type": "integer" }, "1-2": { "type": "integer" }, "1-3": { "type": "integer" }, "2-0": { "type": "integer" }, "2-1": { "type": "integer" }, "2-4": { "type": "integer" }, "3-0": { "type": "integer" }, "3-1": { "type": "integer" }, "3-3": { "type": "integer" }, "4-0": { "type": "integer" }, "4-3": { "type": "integer" }, "4-2": { "type": "integer" } } }, "natural_language": { "type": [ "null", "string" ] }, "category": { "type": "string" }, "scope": { "type": "string" } } }, "News": { "type": "object", "properties": { "id": { "type": "integer" }, "fixture_id": { "type": "integer" }, "league_id": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string" } } }, "Player": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "country_id": { "type": "integer" }, "nationality_id": { "type": [ "integer", "null" ] }, "city_id": { "type": [ "integer", "null" ] }, "position_id": { "type": [ "integer", "null" ] }, "detailed_position_id": { "type": [ "integer", "null" ] }, "type_id": { "type": [ "integer", "null" ] }, "common_name": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "name": { "type": "string" }, "display_name": { "type": "string" }, "image_path": { "type": "string" }, "height": { "type": [ "integer", "null" ] }, "weight": { "type": [ "integer", "null" ] }, "date_of_birth": { "type": [ "null", "string" ] }, "gender": { "type": "string" }, "in_squad": { "type": "boolean" } } }, "Prediction": { "type": "object", "properties": { "id": { "type": "integer" }, "fixture_id": { "type": "integer" }, "predictions": { "type": "object", "properties": { "bet": { "type": "string" }, "bookmaker": { "type": "string" }, "fair_odd": { "type": "number" }, "odd": { "type": "number" }, "stake": { "type": "number" }, "is_value": { "type": "boolean" }, "home": { "type": "number" }, "away": { "type": "number" }, "draw": { "type": "number" }, "yes": { "type": "number" }, "no": { "type": "number" }, "home_home": { "type": "number" }, "home_away": { "type": "number" }, "home_draw": { "type": "number" }, "away_home": { "type": "number" }, "away_away": { "type": "number" }, "away_draw": { "type": "number" }, "draw_draw": { "type": "number" }, "draw_home": { "type": "number" }, "draw_away": { "type": "number" }, "scores": { "type": "object", "properties": { "0-0": { "type": "number" }, "0-1": { "type": "number" }, "0-2": { "type": "number" }, "0-3": { "type": "number" }, "Other_1": { "type": "number" }, "1-0": { "type": "number" }, "1-1": { "type": "number" }, "1-2": { "type": "number" }, "1-3": { "type": "number" }, "Other_2": { "type": "number" }, "2-0": { "type": "number" }, "2-1": { "type": "number" }, "2-2": { "type": "number" }, "2-3": { "type": "number" }, "3-0": { "type": "number" }, "3-1": { "type": "number" }, "3-2": { "type": "number" }, "3-3": { "type": "number" }, "Other_X": { "type": "number" } } }, "score": { "type": "object", "properties": { "0_0": { "type": "number" }, "0_1": { "type": "number" }, "0_2": { "type": "number" }, "0_3": { "type": "number" }, "other_1": { "type": "number" }, "1_0": { "type": "number" }, "1_1": { "type": "number" }, "1_2": { "type": "number" }, "1_3": { "type": "number" }, "other_2": { "type": "number" }, "2_0": { "type": "number" }, "2_1": { "type": "number" }, "2_2": { "type": "number" }, "2_3": { "type": "number" }, "3_0": { "type": "number" }, "3_1": { "type": "number" }, "3_2": { "type": "number" }, "3_3": { "type": "number" }, "other_x": { "type": "number" } } }, "equal": { "type": "number" } } }, "type_id": { "type": "integer" } } }, "Probability": { "type": "object", "properties": { "id": { "type": "integer" }, "league_id": { "type": "integer" }, "type_id": { "type": "integer" }, "data": { "type": "object", "properties": { "fulltime_result": { "type": [ "number", "string" ] }, "away_over_under_0_5": { "type": [ "number", "string" ] }, "away_over_under_1_5": { "type": [ "number", "string" ] }, "both_teams_to_score": { "type": [ "number", "string" ] }, "team_to_score_first": { "type": [ "number", "string" ] }, "home_over_under_0_5": { "type": [ "number", "string" ] }, "home_over_under_1_5": { "type": [ "number", "string" ] }, "over_under_1_5": { "type": [ "number", "string" ] }, "over_under_2_5": { "type": [ "number", "string" ] }, "over_under_3_5": { "type": [ "number", "string" ] }, "correct_score": { "type": [ "number", "string" ] }, "ht_ft": { "type": [ "number", "string" ] }, "fulltime_result_1st_half": { "type": [ "number", "string" ] } } } } }, "ExpectedLineup": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "fixture_id": { "type": "integer" }, "player_id": { "type": "integer" }, "team_id": { "type": "integer" }, "formation_field": { "type": [ "null", "string" ] }, "position_id": { "type": [ "integer", "null" ] }, "detailed_position_id": { "type": [ "integer", "null" ] }, "type_id": { "type": "integer" }, "formation_position": { "type": [ "integer", "null" ] }, "player_name": { "type": "string" }, "jersey_number": { "type": "integer" } } }, "Referee": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "country_id": { "type": [ "integer", "null" ] }, "city_id": { "type": "null" }, "common_name": { "type": "string" }, "firstname": { "type": [ "null", "string" ] }, "lastname": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "display_name": { "type": "string" }, "image_path": { "type": "string" }, "height": { "type": "null" }, "weight": { "type": "null" }, "date_of_birth": { "type": "null" }, "gender": { "type": "null" } } }, "Rival": { "type": "object", "properties": { "sport_id": { "type": "integer" }, "team_id": { "type": "integer" }, "rival_id": { "type": "integer" }, "id": { "type": "integer" } } }, "Round": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "league_id": { "type": "integer" }, "season_id": { "type": "integer" }, "stage_id": { "type": "integer" }, "name": { "type": "string" }, "finished": { "type": "boolean" }, "is_current": { "type": "boolean" }, "starting_at": { "anyOf": [ { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "null" }, { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" } ] }, "ending_at": { "anyOf": [ { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "null" }, { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" } ] }, "games_in_current_week": { "type": "boolean" }, "model_id": { "type": "integer" }, "type_id": { "type": "integer" }, "relation_id": { "type": [ "integer", "null" ] }, "value": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" }, "all": { "type": "integer" }, "home": { "anyOf": [ { "type": "integer" }, { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" }, "average": { "type": "number" } } } ] }, "away": { "anyOf": [ { "type": "integer" }, { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" }, "average": { "type": "number" } } } ] }, "total": { "type": "integer" }, "on_target": { "type": "integer" }, "off_target": { "type": "integer" }, "inside_box": { "type": "integer" }, "outside_box": { "type": "integer" }, "blocked": { "type": "integer" }, "average": { "type": "number" }, "0-15": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "15-30": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "30-45": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "45-60": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "60-75": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "75-90": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "participant_id": { "type": "integer" }, "participant_name": { "type": "string" }, "avg_min_per_goal": { "type": "integer" }, "rating": { "type": "number" }, "team_id": { "type": "integer" }, "team_name": { "type": "string" }, "player_id": { "type": "integer" }, "player_name": { "type": "string" }, "avg_per_match": { "type": "number" }, "team_most_corners_id": { "type": "integer" }, "team_most_corners_name": { "type": "string" }, "yellowcards": { "type": "integer" }, "redcards": { "type": "integer" }, "yellowredcards": { "type": "integer" }, "average_yellowcards": { "type": "number" }, "average_redcards": { "type": "integer" }, "average_yellowredcards": { "type": "integer" }, "over": { "type": "object", "properties": { "0_5": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "1_5": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "2_5": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "3_5": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "4_5": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "5_5": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "6_5": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } } } }, "under": { "type": "object", "properties": { "0_5": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "1_5": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "2_5": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "3_5": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "4_5": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "5_5": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } }, "6_5": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "integer" } } } } }, "countries": { "type": "integer" }, "played": { "type": "integer" } } } } }, "StageRoundFixtures": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "league_id": { "type": "integer" }, "season_id": { "type": "integer" }, "type_id": { "type": "integer" }, "name": { "type": "string" }, "sort_order": { "type": "integer" }, "finished": { "type": "boolean" }, "is_current": { "type": "boolean" }, "starting_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "ending_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "games_in_current_week": { "type": "boolean" }, "tie_breaker_rule_id": { "type": "null" }, "rounds": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "league_id": { "type": "integer" }, "season_id": { "type": "integer" }, "stage_id": { "type": "integer" }, "name": { "type": "string" }, "finished": { "type": "boolean" }, "is_current": { "type": "boolean" }, "starting_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "ending_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "games_in_current_week": { "type": "boolean" }, "fixtures": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "league_id": { "type": "integer" }, "season_id": { "type": "integer" }, "stage_id": { "type": "integer" }, "group_id": { "type": "null" }, "aggregate_id": { "type": "null" }, "round_id": { "type": "integer" }, "state_id": { "type": "integer" }, "venue_id": { "type": "integer" }, "name": { "type": "string" }, "starting_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "result_info": { "type": [ "null", "string" ] }, "leg": { "type": "string" }, "details": { "type": "null" }, "length": { "type": "integer" }, "placeholder": { "type": "boolean" }, "has_odds": { "type": "boolean" }, "has_premium_odds": { "type": "boolean" }, "starting_at_timestamp": { "type": "integer" }, "participants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "country_id": { "type": "integer" }, "venue_id": { "type": "integer" }, "gender": { "type": "string" }, "name": { "type": "string" }, "short_code": { "type": "string" }, "image_path": { "type": "string" }, "founded": { "type": "integer" }, "type": { "type": "string" }, "placeholder": { "type": "boolean" }, "last_played_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "meta": { "type": "object", "properties": { "location": { "type": "string" }, "winner": { "type": [ "boolean", "null" ] }, "position": { "type": [ "integer", "null" ] } } } } } }, "scores": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "fixture_id": { "type": "integer" }, "type_id": { "type": "integer" }, "participant_id": { "type": "integer" }, "score": { "type": "object", "properties": { "goals": { "type": "integer" }, "participant": { "type": "string" } } }, "description": { "type": "string" } } } } } } } } } }, "aggregates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "league_id": { "type": "integer" }, "season_id": { "type": "integer" }, "stage_id": { "type": "integer" }, "name": { "type": "string" }, "fixture_ids": { "type": "array", "items": { "type": "integer" } }, "result": { "type": "string" }, "detail": { "type": "string" }, "winner_participant_id": { "type": "integer" }, "fixtures": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "league_id": { "type": "integer" }, "season_id": { "type": "integer" }, "stage_id": { "type": "integer" }, "group_id": { "type": "null" }, "aggregate_id": { "type": "integer" }, "round_id": { "type": "null" }, "state_id": { "type": "integer" }, "venue_id": { "type": "integer" }, "name": { "type": "string" }, "starting_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "result_info": { "type": "string" }, "leg": { "type": "string" }, "details": { "type": "null" }, "length": { "type": "integer" }, "placeholder": { "type": "boolean" }, "has_odds": { "type": "boolean" }, "has_premium_odds": { "type": "boolean" }, "starting_at_timestamp": { "type": "integer" }, "participants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "country_id": { "type": "integer" }, "venue_id": { "type": "integer" }, "gender": { "type": "string" }, "name": { "type": "string" }, "short_code": { "type": "string" }, "image_path": { "type": "string" }, "founded": { "type": "integer" }, "type": { "type": "string" }, "placeholder": { "type": "boolean" }, "last_played_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "meta": { "type": "object", "properties": { "location": { "type": "string" }, "winner": { "type": "boolean" }, "position": { "type": "integer" } } } } } }, "scores": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "fixture_id": { "type": "integer" }, "type_id": { "type": "integer" }, "participant_id": { "type": "integer" }, "score": { "type": "object", "properties": { "goals": { "type": "integer" }, "participant": { "type": "string" } } }, "description": { "type": "string" } } } } } } } } } }, "fixtures": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "league_id": { "type": "integer" }, "season_id": { "type": "integer" }, "stage_id": { "type": "integer" }, "group_id": { "type": "null" }, "aggregate_id": { "type": "null" }, "round_id": { "type": "null" }, "state_id": { "type": "integer" }, "venue_id": { "type": "integer" }, "name": { "type": "string" }, "starting_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "result_info": { "type": [ "null", "string" ] }, "leg": { "type": "string" }, "details": { "type": "null" }, "length": { "type": "integer" }, "placeholder": { "type": "boolean" }, "has_odds": { "type": "boolean" }, "has_premium_odds": { "type": "boolean" }, "starting_at_timestamp": { "type": "integer" }, "participants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "country_id": { "type": "integer" }, "venue_id": { "type": "integer" }, "gender": { "type": "string" }, "name": { "type": "string" }, "short_code": { "type": "string" }, "image_path": { "type": "string" }, "founded": { "type": "integer" }, "type": { "type": "string" }, "placeholder": { "type": "boolean" }, "last_played_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "meta": { "type": "object", "properties": { "location": { "type": "string" }, "winner": { "type": [ "boolean", "null" ] }, "position": { "type": [ "integer", "null" ] } } } } } }, "scores": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "fixture_id": { "type": "integer" }, "type_id": { "type": "integer" }, "participant_id": { "type": "integer" }, "score": { "type": "object", "properties": { "goals": { "type": "integer" }, "participant": { "type": "string" } } }, "description": { "type": "string" } } } } } } } } }, "Season": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "league_id": { "type": "integer" }, "tie_breaker_rule_id": { "type": "integer" }, "name": { "type": "string" }, "finished": { "type": "boolean" }, "pending": { "type": "boolean" }, "is_current": { "type": "boolean" }, "starting_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "ending_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "standings_recalculated_at": { "anyOf": [ { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "null" } ] }, "games_in_current_week": { "type": "boolean" } } }, "PlayerStatistic": { "type": "object", "properties": { "id": { "type": "integer" }, "player_id": { "type": "integer" }, "team_id": { "type": "integer" }, "season_id": { "type": "integer" }, "has_values": { "type": "boolean" }, "position_id": { "type": "integer" }, "jersey_number": { "type": "integer" } } }, "TeamSquads": { "type": "object", "properties": { "id": { "type": "integer" }, "transfer_id": { "type": [ "integer", "null" ] }, "player_id": { "type": "integer" }, "team_id": { "type": "integer" }, "position_id": { "type": "integer" }, "detailed_position_id": { "type": "integer" }, "start": { "type": "string" }, "end": { "type": [ "null", "string" ] }, "captain": { "type": "boolean" }, "jersey_number": { "type": "integer" } } }, "Stage": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "league_id": { "type": "integer" }, "season_id": { "type": "integer" }, "type_id": { "type": "integer" }, "name": { "type": "string" }, "sort_order": { "type": "integer" }, "finished": { "type": "boolean" }, "is_current": { "type": "boolean" }, "starting_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "ending_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "games_in_current_week": { "type": "boolean" }, "tie_breaker_rule_id": { "type": "null" }, "model_id": { "type": "integer" }, "relation_id": { "type": [ "integer", "null" ] }, "value": { "type": "object", "properties": { "count": { "type": "number" }, "percentage": { "type": "number" }, "home": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" }, "average": { "type": "number" } } } ] }, "away": { "anyOf": [ { "type": "number" }, { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" }, "average": { "type": "number" } } } ] }, "total_games": { "type": "integer" }, "player_id": { "type": "integer" }, "player_name": { "type": "string" }, "participant_id": { "type": "integer" }, "participant_name": { "type": "string" }, "participant_count": { "type": "integer" }, "all": { "type": "number" }, "total": { "type": "integer" }, "on_target": { "type": "integer" }, "off_target": { "type": "integer" }, "inside_box": { "type": "integer" }, "outside_box": { "type": "integer" }, "blocked": { "type": "integer" }, "average": { "type": "number" }, "0-15": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "15-30": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "30-45": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "45-60": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "60-75": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "75-90": { "type": "object", "properties": { "count": { "type": "integer" }, "percentage": { "type": "number" } } }, "home_adv_percentage": { "type": "number" }, "avg_min_per_goal": { "type": "integer" }, "rating": { "type": "number" }, "team_id": { "type": "integer" }, "team_name": { "type": "string" }, "avg_per_match": { "type": "number" }, "team_most_corners_id": { "type": "integer" }, "team_most_corners_name": { "type": "string" }, "yellowcards": { "type": "integer" }, "redcards": { "type": "integer" }, "yellowredcards": { "type": "integer" }, "average_yellowcards": { "type": "number" }, "average_redcards": { "type": "number" }, "average_yellowredcards": { "type": "number" } } } } }, "Standing": { "type": "object", "properties": { "id": { "type": "integer" }, "participant_id": { "type": "integer" }, "sport_id": { "type": "integer" }, "league_id": { "type": "integer" }, "season_id": { "type": "integer" }, "stage_id": { "type": "integer" }, "group_id": { "type": [ "integer", "null" ] }, "round_id": { "type": [ "integer", "null" ] }, "standing_rule_id": { "type": [ "integer", "null" ] }, "position": { "type": "integer" }, "result": { "type": "string" }, "points": { "type": "integer" }, "type_id": { "type": "integer" }, "value": { "type": "integer" }, "calc_type": { "type": "string" }, "participant_type": { "type": "string" }, "active": { "type": "boolean" } } }, "State": { "type": "object", "properties": { "id": { "type": "integer" }, "state": { "type": "string" }, "name": { "type": "string" }, "short_name": { "type": "string" }, "developer_name": { "type": "string" } } }, "TvStation": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": [ "null", "string" ] }, "image_path": { "type": [ "null", "string" ] }, "type": { "type": "string" }, "related_id": { "type": [ "integer", "null" ] } } }, "TeamOfTheWeek": { "type": "object", "properties": { "id": { "type": "integer" }, "player_id": { "type": "integer" }, "fixture_id": { "type": "integer" }, "round_id": { "type": "integer" }, "team_id": { "type": "integer" }, "rating": { "type": "string" }, "formation_position": { "type": "integer" }, "formation": { "type": "string" } } }, "Team": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "country_id": { "type": "integer" }, "venue_id": { "type": [ "integer", "null" ] }, "gender": { "type": "string" }, "name": { "type": "string" }, "short_code": { "type": [ "null", "string" ] }, "image_path": { "type": "string" }, "founded": { "type": [ "integer", "null" ] }, "type": { "type": "string" }, "placeholder": { "type": "boolean" }, "last_played_at": { "anyOf": [ { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "null" } ] } } }, "Topscorer": { "type": "object", "properties": { "id": { "type": "integer" }, "season_id": { "type": "integer" }, "player_id": { "type": "integer" }, "type_id": { "type": "integer" }, "position": { "type": "integer" }, "total": { "type": "integer" }, "participant_id": { "type": "integer" }, "stage_id": { "type": "integer" }, "participant_type": { "type": "string" } } }, "TransferRumour": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": "integer" }, "player_id": { "type": "integer" }, "position_id": { "type": "integer" }, "from_team_id": { "type": "integer" }, "to_team_id": { "type": "integer" }, "transfer_fee_id": { "type": [ "integer", "null" ] }, "probability": { "type": "string" }, "source_name": { "type": "string" }, "source_url": { "type": "string" }, "amount": { "type": [ "integer", "null" ] }, "currency": { "type": [ "null", "string" ] }, "from_league_id": { "type": "integer" }, "to_league_id": { "type": "integer" }, "status_id": { "type": "integer" }, "date": { "type": "string" }, "type_id": { "type": "integer" } } }, "Transfer": { "type": "object", "properties": { "id": { "type": "integer" }, "sport_id": { "type": [ "integer", "null" ] }, "player_id": { "type": "integer" }, "type_id": { "type": "integer" }, "from_team_id": { "type": "integer" }, "to_team_id": { "type": "integer" }, "position_id": { "type": [ "integer", "null" ] }, "detailed_position_id": { "type": [ "integer", "null" ] }, "date": { "type": "string" }, "career_ended": { "type": "boolean" }, "completed": { "type": "boolean" }, "amount": { "type": [ "integer", "null" ] } } }, "Venue": { "type": "object", "properties": { "id": { "type": "integer" }, "country_id": { "type": [ "integer", "null" ] }, "city_id": { "type": [ "integer", "null" ] }, "name": { "type": "string" }, "address": { "type": [ "null", "string" ] }, "zipcode": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "string" ] }, "longitude": { "type": [ "null", "string" ] }, "capacity": { "type": [ "integer", "null" ] }, "image_path": { "type": [ "null", "string" ] }, "city_name": { "type": [ "null", "string" ] }, "surface": { "type": [ "null", "string" ] }, "national_team": { "type": "boolean" } } }, "MyEnrichment": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "MyResource": { "type": "object", "properties": { "id": { "type": "integer" }, "description": { "type": "string" } } }, "UsageRecord": { "type": "object", "properties": { "id": { "type": "integer" }, "endpoint": { "type": "string" }, "count": { "type": "integer" }, "entity": { "type": "string" }, "remaining_requests": { "type": "integer" }, "period_start": { "type": "integer" }, "period_end": { "type": "integer" } } }, "Bookmaker": { "type": "object", "properties": { "id": { "type": "integer" }, "legacy_id": { "type": [ "integer", "null" ] }, "name": { "type": "string" } } }, "BookmakerMapping": { "type": "object", "properties": { "fixture_id": { "type": "integer" }, "bookmaker_id": { "type": "integer" }, "bookmaker_name": { "type": "string" }, "bookmaker_event_id": { "type": "string" }, "bookmaker_event_url": { "type": "null" } } }, "Market": { "type": "object", "properties": { "id": { "type": "integer" }, "legacy_id": { "type": [ "integer", "null" ] }, "name": { "type": "string" }, "developer_name": { "type": "string" }, "has_winning_calculations": { "type": "boolean" } } }, "PremiumOdd": { "type": "object", "properties": { "id": { "type": "integer" }, "odd_id": { "type": "integer" }, "value": { "type": "string" }, "probability": { "type": "string" }, "dp3": { "type": "string" }, "fractional": { "type": "string" }, "american": { "type": "string" }, "bookmaker_update": { "type": "string" }, "fixture_id": { "type": "integer" }, "market_id": { "type": "integer" }, "bookmaker_id": { "type": "integer" }, "label": { "type": "string" }, "name": { "type": "string" }, "sort_order": { "type": "integer" }, "market_description": { "type": "string" }, "stopped": { "type": "boolean" }, "total": { "type": [ "null", "string" ] }, "handicap": { "type": [ "null", "string" ] }, "created_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "latest_bookmaker_update": { "type": "string" } } }, "StandardOddsFeed": { "type": "object", "properties": { "id": { "type": "integer" }, "fixture_id": { "type": "integer" }, "market_id": { "type": "integer" }, "bookmaker_id": { "type": "integer" }, "label": { "type": "string" }, "value": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "sort_order": { "type": "integer" }, "market_description": { "type": "string" }, "probability": { "type": "string" }, "dp3": { "type": "string" }, "fractional": { "type": "string" }, "american": { "type": "string" }, "winning": { "type": "boolean" }, "suspended": { "type": "boolean" }, "stopped": { "type": "boolean" }, "total": { "type": [ "null", "string" ] }, "handicap": { "type": [ "null", "string" ] }, "participants": { "type": [ "null", "string" ] }, "created_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "latest_bookmaker_update": { "type": [ "null", "string" ] } } }, "Odd": { "type": "object", "properties": { "id": { "type": "integer" }, "fixture_id": { "type": "integer" }, "market_id": { "type": "integer" }, "bookmaker_id": { "type": "integer" }, "label": { "type": "string" }, "value": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "sort_order": { "type": [ "integer", "null" ] }, "market_description": { "type": "string" }, "probability": { "type": "string" }, "dp3": { "type": "string" }, "fractional": { "type": "string" }, "american": { "type": "string" }, "winning": { "type": "boolean" }, "stopped": { "type": "boolean" }, "total": { "type": [ "null", "string" ] }, "handicap": { "type": [ "null", "string" ] }, "participants": { "type": "null" }, "created_at": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "description": "Timestamp in `YYYY-MM-DD HH:MM:SS` UTC format (not ISO 8601).", "type": "string" }, "original_label": { "type": [ "null", "string" ] }, "latest_bookmaker_update": { "type": "string" } } } }, "responses": { "BadRequest": { "description": "Bad Request. Some part of the request is malformed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } } }, "Unauthorized": { "description": "Unauthorized. The request is not authenticated (missing or invalid api_token).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "Forbidden": { "description": "Forbidden. The endpoint or resource is not accessible from your subscription.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "NotFound": { "description": "Not Found. The endpoint or resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "ValidationError": { "description": "Validation Error. Required parameters missing or malformed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorBody" } } } }, "TooManyRequests": { "description": "Too Many Requests. Hourly request limit exceeded — see RateLimit metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } }, "InternalServerError": { "description": "Internal Server Error. An internal error has been logged for inspection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorBody" } } } } } } }