GET Rounds by Search by Name
Returns all rounds that matches your search query
Last updated
Returns all rounds that matches your search query
Last updated
Name | Required? | Description |
---|---|---|
More information on how to use filters can be found on our tutorials on how to filter. If you want more information on which filters to use you can check out the following :
YES
Parameter | Required | Description | Example |
---|---|---|---|
You can use a total of 4
nested includes on this endpoint
sport
league
season
stage
fixtures
statistics
Get an overview and explanation of all the fields returned in the API response. The related entities for the rounds endpoints are:
We also offer detailed postman documentation with examples and a complete up-to-date version of all our endpoints. Below is a button that lets your fork the collection or import it.
Field | Description | Type |
---|---|---|
id
Refers to the unique id of the requested round
integer
sport_id
Refers to the sport id of the requested round
integer
league_id
Refers to the league id of the requested round
integer
season_id
Refers to the season id of the requested round
integer
group_id
Refers to the group id of the requested round
integer
name
Returns the name of the requested round
string
finished
Indicates if the requested round is finished or not
boolean
pending
Indicates if the requested round is finished or not
boolean
is_current
Indicates if the requested round is the current one or not
boolean
starting_at
Returns the starting date of the round
string
ending_at
Returns the ending date of the round
string
api_token
YES
Another option is to provide the API token in the header.
Your unique API token. Ex. ?api_token=YOUR_TOKEN
include
NO
Enrich the API response with more data by using includes. Ex. &include=participants;events
select
NO
Select specific fields on the base entity. Read how to select fields in our tutorial.
filters
NO
Filter the API response on multiple related entities. There are static filters and dynamic filters. Please find the possibilities in the Static and Dynamic Filter tab.
locale
NO
Translate name fields of the API Response in your selected language. Find more information and which languages are available on our translations page.
N/A
N/A
Not available for this endpoint.
N/A
leagues
Fixtures, Seasons, Standings, and way more. Check this endpoint for all possibilities.
Filter rounds based on leagues.
&include=league
&filters=roundLeagues:leagueIDS
&include=league
&filters=roundLeagues:501
seasons
Check this endpoint for all possibilities.
Filter rounds based on seasons.
&include=season&filters=roundSeasons:seasonIDS
&include=season&filters=roundSeasons:19735
stages
Check this endpoint for all possibilities.
Filter rounds based on stage IDs
&include=stage&filters=roundStages:stageIDS
&include=&filters=roundStages:77457866
order
No
Returns rounds ordered by id (asc
or desc
). Defaults to asc
&order=desc
per_page
No
The amount of results to return per page (max 50.). Defaults to 25.
&per_page=30
page
No
You can paginate using the has_more
parameter to determine if you can still propagate through the results.
&page=2