KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

API-Types

★ 13 Open GitHub ↗

This is a simple TypeScript library providing type definitions for the TruckersMP API.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## Introduction

This simple TruckersMP TypeScript library provides type definitions for the TruckersMP API (and other connected
services). It should be used along an HTTP client library for actually invoking requests.

### Disclaimer

This library supports only documented properties.

## Installation

Install with npm / yarn:

```
npm install @truckersmp/api-types
yarn add @truckersmp/api-types
```

## Example

Performing a `GET` request to retrieve player's data using the built-in Fetch API:

```ts
import { APIWebRoutes, APIWebRouteBases } from '@truckersmp/api-types/v2';
import type { APIPlayer, APIResponse } from '@truckersmp/api-types/v2';

class APIManager {
  public player(id: bigint): Promise<APIResponse<APIPlayer>> {
    return fetch(`${APIWebRouteBases.api}${APIWebRoutes.player(id)}`)
      .then(response => response.json() as Promise<APIResponse<APIPlayer>>);
  }
}

async function requestPlayer(id: bigint): Promise<APIPlayer | null> {
  const api = new APIManager();
  const response = await api.player(id);
  return response.error === false ? response.response : null;
}

requestPlayer(BigInt(2)).then(data => console.log('Player data:', data));
```

Notice how we import a specific version of the API. This is not required. If the version is not specified,
the latest one will be used. However, keep in mind that new API versions may bring high impact changes.

## Support

If you have any questions about the library, you can create a topic on our
[forum](https://forum.truckersmp.com/index.php?/forum/198-developer-portal/).

## License

This package is open-source and is licensed under the [MIT license](LICENSE.md).

API-Types

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README