Ordering and sorting

For paginated endpoints, the API supports ordering on a specific field. Read more on how to use ordering on this page.

We would love your feedback on the sorting functionality! If you have suggestions for fields to apply sorting on, or have encountered any issues, please contact support@sportmonks.com

Ordering

The order query parameter is used to specify the order in which paginated results should be returned. By default, results are returned in ascending order. However, you can use the order parameter to specify that results should be returned in descending order instead.

Using ordering allows for more convenient results to be returned, next to that it can potentially save you from making API calls as you don't have to propagate through redundant results.

Parameters

Usage

To use the order query parameter, simply include it in the request URL for paginated endpoints. For example:

https://api.sportmonks.com/v3/football/fixtures?api_token=YOUR_TOKEN&page=2&order=desc

In this example, the API will return page 2 of results for the leagues endpoint, in descending order.

The field used for ordering differs per endpoint, you should consult the endpoints documentation page to see what field the ordering applies on.

Custom sorting

You can use custom sorts on endpoints; this enables the sorting of base entities returned in the endpoint responses. This feature is designed to enhance flexibility and customisation for users interacting with the API.

Usage

This provides users with the ability to customise sorting of returned data through the use of the sortBy and order parameters. This functionality is particularly useful when retrieving lists of fixtures in football, as it allows users to organise the data based on specific criteria.

Sorting Fixtures

When querying fixtures, users can specify the field to sort by and the desired order using the following parameters:

  • sortBy: Specifies the field by which the data will be sorted. Currently supported fields include starting_at and name.

  • order: Determines the order in which the data will be sorted. Users can choose between ascending (asc) and descending (desc) orders.

Examples

Sort by starting_at: This option sorts the fixtures based on their starting date and time.

https://api.sportmonks.com/v3/football/fixtures&sortBy=starting_at&order=desc

This URL sorts the fixtures in descending order of their starting date and time.

Sort by name: This option sorts the fixtures alphabetically based on their names.

https://api.sportmonks.com/v3/football/fixtures&sortBy=name&order=asc

This URL sorts the fixtures alphabetically by their names in ascending order.

Sorting on the name field currently works for all entities with a "name" field. For Fixtures, sorting also works on the starting_at field.

If an unsupported field is passed to sort on, an error is thrown, and the request returns a 400 Bad Request HTTP code.

We want to encourage users to provide feedback on the sorting functionality. If you have suggestions for new fields or have encountered any issues, please contact support@sportmonks.com to improve and enhance the API experience.

Feel free to reach out with any questions or suggestions!

Last updated