An open API service indexing awesome lists of open source software.

https://github.com/rafacv23/f1-api

Open and free Formula One (F1) API. Built with Next.js, Turso (SQLite) and Typescript. Tested with Playwright.
https://github.com/rafacv23/f1-api

api f1 formula1 formulaone open openapi public

Last synced: 2 months ago
JSON representation

Open and free Formula One (F1) API. Built with Next.js, Turso (SQLite) and Typescript. Tested with Playwright.

Awesome Lists containing this project

README

          

# 🏎️ F1api.dev | Your free & open source F1 api, ready for development

[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)

[![Star on GitHub](https://img.shields.io/github/stars/rafacv23/F1-api?style=social)](https://github.com/rafacv23/F1-api) [![Fork on GitHub](https://img.shields.io/github/forks/rafacv23/F1-api?style=social)](https://github.com/rafacv23/F1-api/fork)

Project made with Next.js and Turso to take all the data about the Formula 1 Championship.

[f1api.dev](https://f1api.dev)

![f1-connect-api-preview](https://i.imgur.com/BDxpw46.png)
![f1-connect-api-performance](https://i.imgur.com/9FiC5VK.png)

## 🛫 Endpoints

You can find all the available endpoints in the [docs](https://f1api.dev/docs) section of the website.

## 🪄 Official SDK to use the API

You can use the official SDK to use the API. This is not mandatory, you can simply use fetch to get the data.

[F1 API SDK GitHub](https://github.com/Rafacv23/f1api-sdk)

[F1 API SDK NPM](https://www.npmjs.com/package/@f1api/sdk)

### Installation

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

```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()
```

## ⌨️ Stack

- Next.js
- React
- Turso
- JavaScript
- TypeScript
- Tailwind
- Shadcn
- HyperUi
- Playwright

## 📱 Contact

You can contact with us [contact](https://f1api.dev/contact) section of the website.

## 👀 Be part of the project

Feel free to check my code and make comments about it. And use it in your daily work.

```
git clone https://github.com/Rafacv23/F1-api
```

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):



Artem Anisimov
Artem Anisimov

🌍 🐛
Paul
Paul

🐛
Darlann Banache
Darlann Banache

🐛
zhenghaoyang24
zhenghaoyang24

🤔
Chanzy ma
Chanzy ma

🐛
Jelger Haanstra
Jelger Haanstra

🎨

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!