Skip to content

ConstantsApi.md

Latest commit

 

History

History
209 lines (139 loc) · 5.33 KB

ConstantsApi.md

File metadata and controls

209 lines (139 loc) · 5.33 KB

ConstantsApi

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

Method HTTP request Description
getConstantsCategories GET /data/constants/categories
getConstantsDivisions GET /data/constants/divisions
getConstantsEventTypes GET /data/constants/event_types

getConstantsCategories

IracingAPIResponse getConstantsCategories()

Constant; returned directly as an array of objects

Example

import {
  Configuration,
  ConstantsApi,
} from '@iracing-data/api-client-fetch';
import type { GetConstantsCategoriesRequest } 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 ConstantsApi(config);

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

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

Parameters

This endpoint does not need any parameter.

Return type

IracingAPIResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success * x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-reset -
401 Access token is missing or invalid. -
429 Rate limited * x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-reset -
503 Maintenance -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConstantsDivisions

IracingAPIResponse getConstantsDivisions()

Constant; returned directly as an array of objects

Example

import {
  Configuration,
  ConstantsApi,
} from '@iracing-data/api-client-fetch';
import type { GetConstantsDivisionsRequest } 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 ConstantsApi(config);

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

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

Parameters

This endpoint does not need any parameter.

Return type

IracingAPIResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success * x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-reset -
401 Access token is missing or invalid. -
429 Rate limited * x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-reset -
503 Maintenance -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getConstantsEventTypes

IracingAPIResponse getConstantsEventTypes()

Constant; returned directly as an array of objects

Example

import {
  Configuration,
  ConstantsApi,
} from '@iracing-data/api-client-fetch';
import type { GetConstantsEventTypesRequest } 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 ConstantsApi(config);

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

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

Parameters

This endpoint does not need any parameter.

Return type

IracingAPIResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success * x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-reset -
401 Access token is missing or invalid. -
429 Rate limited * x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-reset -
503 Maintenance -

[Back to top] [Back to API list] [Back to Model list] [Back to README]