Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

f1-api-node

Package Overview
Dependencies
Maintainers
1
Versions
16
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

f1-api-node

A simple library written in typescript to fetch Formula-1 data

  • 1.3.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
74
increased by2366.67%
Maintainers
1
Weekly downloads
 
Created
Source

Formula1 API

f1

The scraper scrapes this website: https://www.formula1.com

Installation

npm i f1-api-node

Accessing API through Docker

The docker image of the rest api can be found on Docker Hub

  • Pull the Image and start the development in no time

1. Pull from Docker Hub
docker push katheyash/f1-api-node:tagname
2. Pull from Github Container Registry
docker pull ghcr.io/yashkathe/f1-api-node:2
  • The default port is 80

docker run -p 80:80 --name f1-api-node-test-1 katheyash/f1-api-node:1
  • If .env file exists

docker run --env-file ./.env -p 3001:3001 --name f1-api-node-test-1 f1-api-node:1

Example snippet

The following function will print the current lineup of F1 drivers.

const f1Api = require('f1-api-node') 

const myFunction = async () => {
    const driverLineup = await f1Api.getDriverData()
    console.log(driverLineup)
}

myFunction()

Functions

1. getConstructorStandings

DescriptionNeeds Paramter ?Paramter DescriptionDefault Argument
Fetch Constructors standings from points tableYes - 1The year from which you want to extract points table for (1950 - current)current year

2. getDriverStandings

DescriptionNeeds Paramter ?Paramter DescriptionDefault Argument
Fetch F1 driver standings from points tableYes - 1The year from which you want to extract points table for (1950 - current)current year

3. getDriverLineup

DescriptionNeeds Paramter ?Paramter DescriptionDefault Argument
Fetch the current lineup of F1 driversNo--

4. getTeamLineup

DescriptionNeeds Paramter ?Paramter DescriptionDefault Argument
Fetch the current list of F1 teamsNo--

5. getWorldChampions

DescriptionNeeds Paramter ?Paramter DescriptionDefault Argument
Fetch all the world championsNo--

6. getRaceResults

DescriptionNeeds Paramter ?Paramter DescriptionDefault Argument
Fetch race results of all the grand prix in a given yearYes - 1The year from which you want to extract race results (1950 - current)-

7. getRaceSchedule

DescriptionNeeds Paramter ?Paramter DescriptionDefault Argument
Fetch race schedule for an entire yearYes - 1The year from which you want to extract race schedulecurrent year

Snapshots

If you want to have a look at the output from the given functions check this.

Usage

WARNING: Abusing this library may result in an IP ban from the host website.
Please use with caution and try to limit the rate and amount of your requests if you value your access to formula1.com

Report Problems

If you have any problems regarding this project, read the following disclaimer.

Keywords

FAQs

Package last updated on 31 May 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc