https://github.com/rafacv23/f1api-sdk
SDK for https://f1api.dev, you can download the SDK via NPM.
https://github.com/rafacv23/f1api-sdk
api f1 f1api formula1 free open public
Last synced: 7 months ago
JSON representation
SDK for https://f1api.dev, you can download the SDK via NPM.
- Host: GitHub
- URL: https://github.com/rafacv23/f1api-sdk
- Owner: Rafacv23
- License: mit
- Created: 2025-02-05T12:25:09.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-03-06T14:08:06.000Z (7 months ago)
- Last Synced: 2025-03-06T14:11:10.039Z (7 months ago)
- Topics: api, f1, f1api, formula1, free, open, public
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@f1api/sdk
- Size: 164 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# F1 API SDK
This is a simple SDK created to help developers to use [f1api.dev](https://f1api.com/) 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](https://www.npmjs.com/package/@f1api/sdk)
```bash
npm install @f1api/sdk
```
## Usage
### Initialize the SDK
You can use coommonjs or ES6 import to initialize the SDK.
```js
import F1Api from "@f1api/sdk"
const f1Api = new F1Api()
```
### Use any method to retrieve endpoint data
```js
const drivers = await f1Api.getDrivers()
```
## Endpoints
You can find all the available endpoints in the [docs](https://f1api.dev/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](https://github.com/rafacv23/f1-api).