For the complete documentation index, see llms.txt. This page is also available as Markdown.

Enrich your response

By default, every endpoint returns only the fields of the base entity. Includes let you attach related data in the same request, so you can get everything you need in a single call instead of chaining multiple requests.

In this section

  • Includes - How the includes system works: syntax, nesting, field selection, and performance guidance.

  • Lineups - Driver and team assignments for a session, including driver number and grid position.

  • Results - Position, time, gap, tyre, and status data per driver. Covers both the results include and the full lineups.details alternative. See Retrieving results.

  • Laps - Lap-by-lap timing data including sector times, lap duration, and lap number.

  • Pitstops - Pit entry timestamps and stop durations per driver per session.

  • Stints - Tyre stint data including stint number and start/end lap.

How includes work

Add &include= to any request and name the include you want. Separate multiple includes with a semicolon:

https://api.sportmonks.com/v3/motorsport/fixtures/19408487
?api_token=YOUR_TOKEN
&include=lineups;results

Use dot notation to nest includes:

https://api.sportmonks.com/v3/motorsport/fixtures/19408487
?api_token=YOUR_TOKEN
&include=lineups.driver

Use a colon to select only specific fields from an include, which reduces payload size:

See Request options for the full syntax reference including field selection on the base entity (&select=).

Performance guidance

Each include increases payload size and counts against your query complexity budget. Only request includes you actually need for the current view. For reference data that changes rarely - driver names, team names, country details - fetch once at startup and cache locally rather than including on every request.

See Query complexity for how complexity is calculated and what the limits are.

Type reference

Each result type and lineup detail type has a numeric ID. When working with lineups.details, the type is not returned by default. Use lineups.details.type to include it in the response, or fetch all types once and cache them locally.

The full list of driver-level type IDs is in the Results and Live Data Type Reference. Session-level types (lap counter, fastest lap) are in the Metadata and Per-Season Data Type Reference.

Last updated

Was this helpful?