SPsportmonks
Regions

Regions by Search

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

Sportmonks documentation

get/core/regions/search/{name}

Request

  • Base URL
    https://api.sportmonks.com/v3
  • Auth
    • API key in query parameter api_token
    • or API key in header Authorization

Path parameters

namestring required

The name you want to search on.

Query parameters

includestring

Enrich the API with more data by using includes

Allowed values: country, cities. Pass as a semicolon-separated list (the API rejects comma here), e.g. include=country;cities.

selectstring[]

Select specific fields on the base entity

Selectable fields: id, country_id, name. Pass as a comma-separated list, e.g. select=id,country_id.

filtersstring

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.

Composable 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.

order'asc' | 'desc'

Result ordering (asc or desc). Defaults to asc.

per_pageinteger

Items per page (max 50). Defaults to 25.

pageinteger

Page number to fetch. Defaults to 1; pair with response.pagination.has_more to drive iteration.

Response

Success.

timezonestring required

Changes

No recorded changes to this operation across all 1 revision of this API.