README.md

@iracing-data/api-client-fetch@0.0.1

A TypeScript SDK client for the members-ng.iracing.com API.

Usage

First, install the SDK from npm.

npm install @iracing-data/api-client-fetch --save

Next, try it out.

import {
  Configuration,
  AuthApi,
} from '@iracing-data/api-client-fetch';
import type { PostAuthOperationRequest } from '@iracing-data/api-client-fetch';

async function example() {
  console.log("🚀 Testing @iracing-data/api-client-fetch SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearerAuth
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new AuthApi(config);

  const body = {
    // PostAuthRequest (optional)
    post_auth_request: ...,
  } satisfies PostAuthOperationRequest;

  try {
    const data = await api.postAuth(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://members-ng.iracing.com

Class	Method	HTTP request	Description
AuthApi	postAuth	POST /auth
CarApi	getCar	GET /data/car/get
CarApi	getCarAssets	GET /data/car/assets
CarclassApi	getCarClass	GET /data/carclass/get	Gets car classes.
ConstantsApi	getConstantsCategories	GET /data/constants/categories
ConstantsApi	getConstantsDivisions	GET /data/constants/divisions
ConstantsApi	getConstantsEventTypes	GET /data/constants/event_types
DocApi	getCarAssetsDocs	GET /data/doc/car/assets
DocApi	getCarClassDocs	GET /data/doc/carclass
DocApi	getCarClassGetDocs	GET /data/doc/carclass/get
DocApi	getCarDocs	GET /data/doc/car
DocApi	getCarGetDocs	GET /data/doc/car/get
DocApi	getConstantsCategoriesDocs	GET /data/doc/constants/categories
DocApi	getConstantsDivisionsDocs	GET /data/doc/constants/divisions
DocApi	getConstantsDocs	GET /data/doc/constants
DocApi	getConstantsEventTypesDocs	GET /data/doc/constants/event_types
DocApi	getDocs	GET /data/doc
DocApi	getDriverStatsByCategoryCategoryDocs	GET /data/doc/driver_stats_by_category/{category}
DocApi	getDriverStatsByCategoryDocs	GET /data/doc/driver_stats_by_category
DocApi	getHostedCombinedSessionsDocs	GET /data/doc/hosted/combined_sessions
DocApi	getHostedDocs	GET /data/doc/hosted
DocApi	getHostedSessionsDocs	GET /data/doc/hosted/sessions
DocApi	getLeagueCustomerLeagueSessionsDocs	GET /data/doc/league/cust_league_sessions
DocApi	getLeagueDirectoryDocs	GET /data/doc/league/directory
DocApi	getLeagueDocs	GET /data/doc/league
DocApi	getLeagueGetDocs	GET /data/doc/league/get
DocApi	getLeagueGetPointsSystemsDocs	GET /data/doc/league/get_points_systems
DocApi	getLeagueMembershipDocs	GET /data/doc/league/membership
DocApi	getLeagueRosterDocs	GET /data/doc/league/roster
DocApi	getLeagueSeasonSessionsDocs	GET /data/doc/league/season_sessions
DocApi	getLeagueSeasonStandingsDocs	GET /data/doc/league/season_standings
DocApi	getLeagueSeasonsDocs	GET /data/doc/league/seasons
DocApi	getLookupCountriesDocs	GET /data/doc/lookup/countries
DocApi	getLookupDocs	GET /data/doc/lookup
DocApi	getLookupDriversDocs	GET /data/doc/lookup/drivers
DocApi	getLookupFlairsDocs	GET /data/doc/lookup/flairs
DocApi	getLookupGetDocs	GET /data/doc/lookup/get
DocApi	getLookupLicensesDocs	GET /data/doc/lookup/licenses
DocApi	getMemberAwardInstancesDocs	GET /data/doc/member/award_instances
DocApi	getMemberAwardsDocs	GET /data/doc/member/awards
DocApi	getMemberChartDataDocs	GET /data/doc/member/chart_data
DocApi	getMemberDocs	GET /data/doc/member
DocApi	getMemberGetDocs	GET /data/doc/member/get
DocApi	getMemberInfoDocs	GET /data/doc/member/info
DocApi	getMemberParticipationCreditsDocs	GET /data/doc/member/participation_credits
DocApi	getMemberProfileDocs	GET /data/doc/member/profile
DocApi	getResultsDocs	GET /data/doc/results
DocApi	getResultsEventLogDocs	GET /data/doc/results/event_log
DocApi	getResultsGetDocs	GET /data/doc/results/get
DocApi	getResultsLapChartDataDocs	GET /data/doc/results/lap_chart_data
DocApi	getResultsLapDataDocs	GET /data/doc/results/lap_data
DocApi	getResultsSearchHostedDocs	GET /data/doc/results/search_hosted
DocApi	getResultsSearchSeriesDocs	GET /data/doc/results/search_series
DocApi	getResultsSeasonResultsDocs	GET /data/doc/results/season_results
DocApi	getSeasonDocs	GET /data/doc/season
DocApi	getSeasonListDocs	GET /data/doc/season/list
DocApi	getSeasonRaceGuideDocs	GET /data/doc/season/race_guide
DocApi	getSeasonSpectatorSubsessionIdsDetailDocs	GET /data/doc/season/spectator_subsessionids_detail
DocApi	getSeasonSpectatorSubsessionIdsDocs	GET /data/doc/season/spectator_subsessionids
DocApi	getSeriesAssetsDocs	GET /data/doc/series/assets
DocApi	getSeriesDocs	GET /data/doc/series
DocApi	getSeriesGetDocs	GET /data/doc/series/get
DocApi	getSeriesPastSeasonsDocs	GET /data/doc/series/past_seasons
DocApi	getSeriesSeasonListDocs	GET /data/doc/series/season_list
DocApi	getSeriesSeasonScheduleDocs	GET /data/doc/series/season_schedule
DocApi	getSeriesSeasonsDocs	GET /data/doc/series/seasons
DocApi	getSeriesStatsSeriesDocs	GET /data/doc/series/stats_series
DocApi	getStatsDocs	GET /data/doc/stats
DocApi	getStatsMemberBestsDocs	GET /data/doc/stats/member_bests
DocApi	getStatsMemberCareerDocs	GET /data/doc/stats/member_career
DocApi	getStatsMemberDivisionDocs	GET /data/doc/stats/member_division
DocApi	getStatsMemberRecapDocs	GET /data/doc/stats/member_recap
DocApi	getStatsMemberRecentRacesDocs	GET /data/doc/stats/member_recent_races
DocApi	getStatsMemberSummaryDocs	GET /data/doc/stats/member_summary
DocApi	getStatsMemberYearlyDocs	GET /data/doc/stats/member_yearly
DocApi	getStatsSeasonDriverStandingsDocs	GET /data/doc/stats/season_driver_standings
DocApi	getStatsSeasonQualifyResultsDocs	GET /data/doc/stats/season_qualify_results
DocApi	getStatsSeasonSupersessionStandingsDocs	GET /data/doc/stats/season_supersession_standings
DocApi	getStatsSeasonTTResultsDocs	GET /data/doc/stats/season_tt_results
DocApi	getStatsSeasonTTStandingsDocs	GET /data/doc/stats/season_tt_standings
DocApi	getStatsSeasonTeamStandingsDocs	GET /data/doc/stats/season_team_standings
DocApi	getStatsWorldRecordsDocs	GET /data/doc/stats/world_records
DocApi	getTeamDocs	GET /data/doc/team
DocApi	getTeamGetDocs	GET /data/doc/team/get
DocApi	getTeamMembershipDocs	GET /data/doc/team/membership
DocApi	getTimeAttackDocs	GET /data/doc/time_attack
DocApi	getTimeAttackMemberSeasonResultsDocs	GET /data/doc/time_attack/member_season_results
DocApi	getTrackAssetsDocs	GET /data/doc/track/assets
DocApi	getTrackDocs	GET /data/doc/track
DocApi	getTrackGetDocs	GET /data/doc/track/get
DriverStatsApi	getDriverStatsByCategory	GET /data/driver_stats_by_category/{category}
HostedApi	getHostedCombinedSessions	GET /data/hosted/combined_sessions
HostedApi	getHostedSessions	GET /data/hosted/sessions
LeagueApi	getLeague	GET /data/league/get
LeagueApi	getLeagueCustomerLeagueSessions	GET /data/league/cust_league_sessions
LeagueApi	getLeagueDirectory	GET /data/league/directory
LeagueApi	getLeagueMembership	GET /data/league/membership
LeagueApi	getLeaguePointsSystems	GET /data/league/get_points_systems
LeagueApi	getLeagueRoster	GET /data/league/roster
LeagueApi	getLeagueSeasonSessions	GET /data/league/season_sessions
LeagueApi	getLeagueSeasonStandings	GET /data/league/season_standings
LeagueApi	getLeagueSeasons	GET /data/league/seasons
LookupApi	getLookup	GET /data/lookup/get
LookupApi	getLookupCountries	GET /data/lookup/countries
LookupApi	getLookupDrivers	GET /data/lookup/drivers
LookupApi	getLookupFlairs	GET /data/lookup/flairs
LookupApi	getLookupLicenses	GET /data/lookup/licenses
MemberApi	getMember	GET /data/member/get
MemberApi	getMemberAwardInstances	GET /data/member/award_instances
MemberApi	getMemberAwards	GET /data/member/awards
MemberApi	getMemberChartData	GET /data/member/chart_data
MemberApi	getMemberInfo	GET /data/member/info
MemberApi	getMemberParticipationCredits	GET /data/member/participation_credits
MemberApi	getMemberProfile	GET /data/member/profile	Gets a requested user's profile.
ResultsApi	getResults	GET /data/results/get
ResultsApi	getResultsEventLog	GET /data/results/event_log
ResultsApi	getResultsLapChartData	GET /data/results/lap_chart_data
ResultsApi	getResultsLapData	GET /data/results/lap_data
ResultsApi	getResultsSearchHosted	GET /data/results/search_hosted
ResultsApi	getResultsSearchSeries	GET /data/results/search_series
ResultsApi	getResultsSeasonResults	GET /data/results/season_results
SeasonApi	getSeasonList	GET /data/season/list
SeasonApi	getSeasonRaceGuide	GET /data/season/race_guide
SeasonApi	getSeasonSpectatorSubsessionIds	GET /data/season/spectator_subsessionids
SeasonApi	getSeasonSpectatorSubsessionIdsDetail	GET /data/season/spectator_subsessionids_detail
SeriesApi	getSeries	GET /data/series/get
SeriesApi	getSeriesAssets	GET /data/series/assets
SeriesApi	getSeriesPastSeasons	GET /data/series/past_seasons
SeriesApi	getSeriesSeasonList	GET /data/series/season_list
SeriesApi	getSeriesSeasonSchedule	GET /data/series/season_schedule
SeriesApi	getSeriesSeasons	GET /data/series/seasons
SeriesApi	getSeriesStatsSeries	GET /data/series/stats_series
StatsApi	getStatsMemberBests	GET /data/stats/member_bests
StatsApi	getStatsMemberCareer	GET /data/stats/member_career
StatsApi	getStatsMemberDivision	GET /data/stats/member_division
StatsApi	getStatsMemberRecap	GET /data/stats/member_recap
StatsApi	getStatsMemberRecentRaces	GET /data/stats/member_recent_races
StatsApi	getStatsMemberSummary	GET /data/stats/member_summary
StatsApi	getStatsMemberYearly	GET /data/stats/member_yearly
StatsApi	getStatsSeasonDriverStandings	GET /data/stats/season_driver_standings
StatsApi	getStatsSeasonQualifyResults	GET /data/stats/season_qualify_results
StatsApi	getStatsSeasonSupersessionStandings	GET /data/stats/season_supersession_standings
StatsApi	getStatsSeasonTeamStandings	GET /data/stats/season_team_standings
StatsApi	getStatsSeasonTimeTrialResults	GET /data/stats/season_time_trial_results
StatsApi	getStatsSeasonTimeTrialStandings	GET /data/stats/season_time_trial_standings
StatsApi	getStatsWorldRecords	GET /data/stats/world_records
TeamApi	getTeam	GET /data/team/get
TeamApi	getTeamMembership	GET /data/team/membership
TimeAttackApi	getTimeAttackMemberSeasonResults	GET /data/time_attack/member_season_results
TrackApi	getTrack	GET /data/track/get
TrackApi	getTrackAssets	GET /data/track/assets

Models

• ErrorResponse
• IracingAPIResponse
• IracingCategory
• IracingDivision
• IracingEventType
• IracingServiceMethodDocs
• IracingServiceMethodParametersDocs
• PostAuthRequest

Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: HTTP Bearer Token authentication (JWT)

oAuth2 accessCode

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://oauth.iracing.com/oauth2/authorize
• Scopes:
  • iracing.auth: Authorization for iRacing services.
  • iracing.profile: Access to the iRacing profile.

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

• API version: 0.0.1
• Package version: 0.0.1
• Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

• Environments
  • Node.js
  • Webpack
  • Browserify
• Language levels
  • ES5 - you must have a Promises/A+ library installed
  • ES6
• Module systems
  • CommonJS
  • ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License