@apicity/openf1
OpenF1 API provider for Formula 1 historical and authenticated live REST data.
Runtime dependencies:
zod@^4.6.6— request schemas attached to OpenF1 endpoint methods as.schema
Installation
npm install @apicity/openf1
# or
pnpm add @apicity/openf1
Quick Start
import { createOpenF1 } from "@apicity/openf1";
const openf1 = createOpenF1();
REST Examples
OpenF1 historical REST data is public and does not require an API key.
import { createOpenF1 } from "@apicity/openf1";
const openf1 = createOpenF1();
const meetings = await openf1.v1.meetings({
year: 2024,
country_name: ["Singapore", "Monaco"],
});
const recentMeetings = await openf1.v1.meetings({
filters: [
{ field: "date_start", op: ">=", value: "2024-01-01T00:00:00Z" },
],
});
Use arrays for repeated equality filters and filters for OpenF1
comparison operators such as >=, <, and >.
Authenticated REST
OpenF1 live REST access uses the same /v1/{collection} endpoints with
a Bearer token. See the OpenF1 auth guide
for the upstream token contract.
import { createOpenF1 } from "@apicity/openf1";
const openf1 = createOpenF1();
const token = await openf1.token({
username: "[email protected]",
password: "placeholder-password",
});
const liveOpenF1 = createOpenF1({
accessToken: token.access_token,
});
const liveSessions = await liveOpenF1.v1.sessions({
session_key: "latest",
});
For refreshable tokens, provide a tokenProvider. The provider is called
for REST reads and this package does not store credentials or tokens
outside the client instance.
declare function fetchTokenSomewhereElse(): Promise<{ access_token: string }>;
const openf1 = createOpenF1({
tokenProvider: async () => {
const token = await fetchTokenSomewhereElse();
return token.access_token;
},
});
API Reference
19 endpoints across 19 groups. Each method mirrors an upstream URL path.
carData
GET openf1.v1.carData
GET https://api.openf1.org/v1/car_data{query}
Cost tier: cheap
const res = await openf1.v1.carData({ /* ... */ });
championshipDrivers
GET openf1.v1.championshipDrivers
GET https://api.openf1.org/v1/championship_drivers{query}
Cost tier: cheap
const res = await openf1.v1.championshipDrivers({ /* ... */ });
championshipTeams
GET openf1.v1.championshipTeams
GET https://api.openf1.org/v1/championship_teams{query}
Cost tier: cheap
const res = await openf1.v1.championshipTeams({ /* ... */ });
drivers
GET openf1.v1.drivers
GET https://api.openf1.org/v1/drivers{query}
Cost tier: cheap
const res = await openf1.v1.drivers({ /* ... */ });
intervals
GET openf1.v1.intervals
GET https://api.openf1.org/v1/intervals{query}
Cost tier: cheap
const res = await openf1.v1.intervals({ /* ... */ });
laps
GET openf1.v1.laps
GET https://api.openf1.org/v1/laps{query}
Cost tier: cheap
const res = await openf1.v1.laps({ /* ... */ });
location
GET openf1.v1.location
GET https://api.openf1.org/v1/location{query}
Cost tier: cheap
const res = await openf1.v1.location({ /* ... */ });
meetings
GET openf1.v1.meetings
GET https://api.openf1.org/v1/meetings{query}
Cost tier: cheap
const res = await openf1.v1.meetings({ /* ... */ });
overtakes
GET openf1.v1.overtakes
GET https://api.openf1.org/v1/overtakes{query}
Cost tier: cheap
const res = await openf1.v1.overtakes({ /* ... */ });
pit
GET openf1.v1.pit
GET https://api.openf1.org/v1/pit{query}
Cost tier: cheap
const res = await openf1.v1.pit({ /* ... */ });
position
GET openf1.v1.position
GET https://api.openf1.org/v1/position{query}
Cost tier: cheap
const res = await openf1.v1.position({ /* ... */ });
raceControl
GET openf1.v1.raceControl
GET https://api.openf1.org/v1/race_control{query}
Cost tier: cheap
const res = await openf1.v1.raceControl({ /* ... */ });
sessionResult
GET openf1.v1.sessionResult
GET https://api.openf1.org/v1/session_result{query}
Cost tier: cheap
const res = await openf1.v1.sessionResult({ /* ... */ });
sessions
GET openf1.v1.sessions
GET https://api.openf1.org/v1/sessions{query}
Cost tier: cheap
const res = await openf1.v1.sessions({ /* ... */ });
startingGrid
GET openf1.v1.startingGrid
GET https://api.openf1.org/v1/starting_grid{query}
Cost tier: cheap
const res = await openf1.v1.startingGrid({ /* ... */ });
stints
GET openf1.v1.stints
GET https://api.openf1.org/v1/stints{query}
Cost tier: cheap
const res = await openf1.v1.stints({ /* ... */ });
teamRadio
GET openf1.v1.teamRadio
GET https://api.openf1.org/v1/team_radio{query}
Cost tier: cheap
const res = await openf1.v1.teamRadio({ /* ... */ });
token
POST openf1.token
POST https://api.openf1.org/token
Cost tier: cheap
const token = await openf1.token({
username: "[email protected]",
password: "placeholder-password",
});
weather
GET openf1.v1.weather
GET https://api.openf1.org/v1/weather{query}
Cost tier: cheap
const res = await openf1.v1.weather({ /* ... */ });
Part of the apicity monorepo.
License
MIT — see LICENSE.