Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 2.68 KB

README.md

File metadata and controls

64 lines (42 loc) · 2.68 KB

jolpica-f1 Documentation

jolpica-f1 is an open-source API for querying Formula 1 data. It is the successor to the Ergast F1 API, containing backwards compatible endpoints for the soon to be deprecated API.


Important information
Rate Limits
Differences to Ergast

Endpoints and Documentation:

For any gaps found within our documentation, please check the Ergast docs here.

Endpoint Route
Circuits /ergast/f1/circuits/
Constructors /ergast/f1/constructors/
Constructor Standings /ergast/f1/{season}/constructorstandings/
Drivers /ergast/f1/drivers/
Driver Standings /ergast/f1/{season}/driverstandings/
Laps /ergast/f1/{season}/{round}/laps/
Pitstops /ergast/f1/{season}/{round}/pitstops/
Qualifying /ergast/f1/{season}/qualifying/
Races /ergast/f1/races/
Results /ergast/f1/results/
Seasons /ergast/f1/seasons/
Sprint /ergast/f1/sprint/
Status /ergast/f1/status/

Note: All endpoints should either end with a / or .json


Query Parameters

These parameters are shared between all API endpoints

limit - Maximum number of results results returned. Defaults to 30. Max is 100

offset - Allows you to offset the results by the specified number for pagination. Defaults to 0.


Common Response Fields:

These are field definitions that you will receive in the response for any call:

MRData : The root object of the json response.

MRData.series : The racing series of the results (always f1).

MRData.xmlns : Blank, provided for compatibility with legacy ergast API.

MRData.url : The API URL that the returned data was retrived from (without query paramters).

MRData.limit : The limit used for this call. May be different from the query parameter set in some cases.

MRData.offset : The result offset of this call.

MRData.total : The total number of items available from the endpoint.