Class RacingEndpoint

Access the Racing API endpoints

Index

Constructors

Methods

cars carupgrades get lookup races timestamp tracks withRaceId withTrackId

Constructors

constructor

new RacingEndpoint(requester: Requester): RacingEndpoint
Parameters
- requester: Requester
Returns RacingEndpoint
- Defined in src/generated/endpoints/racing.ts:27

Methods

cars

cars(params?: { timestamp?: string }): Promise<RacingCarsResponse>
Get cars and their racing stats
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<RacingCarsResponse>
- Defined in src/generated/endpoints/racing.ts:35

carupgrades

carupgrades(params?: { timestamp?: string }): Promise<RacingCarUpgradesResponse>
Get all possible car upgrades
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<RacingCarUpgradesResponse>
- Defined in src/generated/endpoints/racing.ts:49

get

get(
    params?: {
        cat?: RaceClassEnum | RacingRaceTypeEnum;
        from?: number;
        id?: number;
        limit?: number;
        offset?: number;
        selections?: string[];
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<RacingResponse>
Get any Racing selection
Parameters
- Optionalparams: {
      cat?: RaceClassEnum | RacingRaceTypeEnum;
      from?: number;
      id?: number;
      limit?: number;
      offset?: number;
      selections?: string[];
      sort?: "ASC" | "DESC";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<RacingResponse>
- Defined in src/generated/endpoints/racing.ts:129

lookup

lookup(params?: { timestamp?: string }): Promise<RacingLookupResponse>
Get all available racing selections
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<RacingLookupResponse>
- Defined in src/generated/endpoints/racing.ts:101

races

races(
    params?: {
        cat?: RacingRaceTypeEnum;
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<PaginatedResponse<RacingRacesResponse> & RacingRacesResponse>
Get races
Parameters
- Optionalparams: {
      cat?: RacingRaceTypeEnum;
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<RacingRacesResponse> & RacingRacesResponse>
- Defined in src/generated/endpoints/racing.ts:63

timestamp

timestamp(params?: { timestamp?: string }): Promise<TimestampResponse>
Get current server time
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TimestampResponse>
- Defined in src/generated/endpoints/racing.ts:115

tracks

tracks(params?: { timestamp?: string }): Promise<RacingTracksResponse>
Get race tracks and descriptions
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<RacingTracksResponse>
- Defined in src/generated/endpoints/racing.ts:87

withRaceId

withRaceId(raceId: string | number): RacingRaceIdContext
Parameters
- raceId: string | number
  The ID for this context
Returns RacingRaceIdContext
- Defined in src/generated/endpoints/racing.ts:156

withTrackId

withTrackId(trackId: string | number): RacingTrackIdContext
Parameters
- trackId: string | number
  The ID for this context
Returns RacingTrackIdContext
- Defined in src/generated/endpoints/racing.ts:161