1.0.2 • Published 2 months ago

iracing-node-api v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 months ago

Iracing NodeJS Api

License npm

Coverage lines Coverage functions Coverage branches Coverage statements

Summary

A wrapper for Iracing's data api written in typescript.

Getting Started

npm install iracing-node-api

import IracingClient from 'iracing-node-api';

const client = new IRacingClient('youriracingemail', 'youriracingpassword');

Note: Intializing the instance will automatically start the login flow and authenticate using your credentials.

Examples:

Getting Car Data

import IracingClient from 'iracing-node-api';

const client = new IRacingClient('youriracingemail', 'youriracingpassword');

const carData = await client.getCarData();

Getting Track Data

import IracingClient from 'iracing-node-api';

const client = new IRacingClient('youriracingemail', 'youriracingpassword');

const carData = await client.getTrackData();

Roadmap

  • Add all available endpoints from the iracing data api
  • Add retry logic for rate-limited requests
  • Add the ability to respond with specific data points given a parameter ex: carId 123 -> getCarData()