Skip to content

Latest commit

 

History

History
39 lines (23 loc) · 990 Bytes

README.md

File metadata and controls

39 lines (23 loc) · 990 Bytes

F1 API SDK

This is a simple SDK created to help developers to use f1api.dev api in their projects. Compatible with ES6 and CommonJS.

F1 API is a free and open source API that provides data about Formula 1 races, drivers, teams, and circuits.

Installation

You can use npm, pnpm, yarn or bun to install this package. npm package

npm install @f1api/sdk

Usage

Initialize the SDK

You can use coommonjs or ES6 import to initialize the SDK.

import F1Api from "@f1api/sdk"

const f1Api = new F1Api()

Use any method to retrieve endpoint data

const drivers = await f1Api.getDrivers()

Endpoints

You can find all the available endpoints in the docs section of the website.

Contributing

Contributions are welcome! Also you can give a star to this repository if you like it. Or in the F1 API GitHub repo.