TruckersMP Web API (2.0)

Download OpenAPI specification:Download

Welcome!

Welcome to the TruckersMP API Documentation! If you find something that is either missing or wrong, please don't hesitate to open an Issue or Pull Request with the change on our GitHub

API SDK

We provide two different SDK libraries as of now:

Players

Fetch player information

Lookup player information

NOTE: The API will respond with a 200 instead of 404 status code, but will have the respected body.

path Parameters

id

required

integer

SteamID64 or TruckersMP ID

Responses

Response samples

200
404

Content type

application/json

{"error": false,
"response": {"id": 0,
"name": "string",
"avatar": "string",
"smallAvatar": "string",
"joinDate": "string",
"steamID64": 0,
"steamID": "string",
"discordSnowflake": "string",
"displayVTCHistory": true,
"groupName": "string",
"groupColor": "string",
"groupID": 0,
"banned": true,
"bannedUntil": "string",
"bansCount": 0,
"displayBans": true,
"patreon": {"isPatron": true,
"active": true,
"color": "string",
"tierId": 0,
"currentPledge": 0,
"lifetimePledge": 0,
"nextPledge": 0,
"hidden": true
},
"permissions": {"isStaff": true,
"isManagement": true,
"isGameAdmin": true,
"showDetailedOnWebMaps": true
},
"vtc": {"id": 0,
"name": "string",
"tag": "string",
"inVTC": true,
"memberID": 0
},
"vtcHistory": [{"id": 0,
"name": "string",
"verified": true,
"joinDate": "string",
"leftDate": "string"
}
],
"achievements": [{"id": 0,
"title": "string",
"description": "string",
"image_url": "string",
"achieved_at": "string"
}
],
"awards": [{"id": 0,
"name": "string",
"image_url": "string",
"awarded_at": "string"
}
]
}
}

Fetch player bans

Latest 5 bans for a selected user if bans are not hidden or user has no bans. Fetch the player information to check if user is currently banned

For the user to be banned the expiration date has to be passed or active has to be false.

NOTE: The API will respond with a 200 instead of 404 status code, but will have the respected body.

path Parameters

id

required

string

SteamID64 or TruckersMP ID

Responses

Response samples

200
404

Content type

application/json

{"error": false,
"response": [{"expiration": "string",
"timeAdded": "string",
"active": true,
"reason": "string",
"adminName": "string",
"adminID": 0
}
]
}

Servers

Fetch all the available servers

List of available TruckersMP servers and their status

Responses

Response samples

200

Content type

application/json

{"error": false,
"response": [{"id": 0,
"game": "ETS2",
"ip": "string",
"port": 0,
"name": "string",
"shortname": "string",
"idprefix": "string",
"online": true,
"players": 0,
"queue": 0,
"maxplayers": 0,
"mapid": 0,
"displayorder": 0,
"speedlimiter": 0,
"collisions": true,
"carsforplayers": true,
"policecarsforplayers": true,
"afkenabled": true,
"event": true,
"specialEvent": true,
"promods": true,
"syncdelay": 0,
"event_request": {"id": 0,
"event_id": 0,
"user_id": 0,
"info": "string",
"rules": "string",
"start_at": "string",
"end_at": "string",
"header_image": "string",
"event_link": "string",
"forum_link": "string"
}
}
]
}

Fetch the current in-game time

The current in-game time. Game time is expressed in minutes, where 10 real seconds is 1 minute of in-game time. It is number of minutes since 2015-25-10 15:48:32 CET.

Note: Game time may not be exact as time will drift.

Responses

Response samples

200

Content type

application/json

{"error": false,
"game_time": 0
}

Events

Fetch all the current, upcoming, and featured events

List all of the current, upcoming, and featured TruckersMP events.

Responses

Response samples

200

Content type

application/json

{"error": false,
"response": {"featured": [{"id": 0,
"event_type": {"key": "convoy",
"name": "string"
},
"name": "string",
"slug": "string",
"game": "ETS2",
"server": {"id": 0,
"name": "string"
},
"language": "string",
"departure": {"location": "string",
"city": "string"
},
"arrive": {"location": "string",
"city": "string"
},
"meetup_at": "string",
"start_at": "string",
"banner": "string",
"map": "string",
"description": "string",
"rule": "string",
"voice_link": "string",
"external_link": "string",
"featured": "Official",
"vtc": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"username": "string"
},
"attendances": {"confirmed": 0,
"unsure": 0,
"vtcs": 0
},
"dlcs": {"dlc_id": "string"
},
"url": "string",
"created_at": "string",
"updated_at": "string"
}
],
"today": [{"id": 0,
"event_type": {"key": "convoy",
"name": "string"
},
"name": "string",
"slug": "string",
"game": "ETS2",
"server": {"id": 0,
"name": "string"
},
"language": "string",
"departure": {"location": "string",
"city": "string"
},
"arrive": {"location": "string",
"city": "string"
},
"meetup_at": "string",
"start_at": "string",
"banner": "string",
"map": "string",
"description": "string",
"rule": "string",
"voice_link": "string",
"external_link": "string",
"featured": "Official",
"vtc": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"username": "string"
},
"attendances": {"confirmed": 0,
"unsure": 0,
"vtcs": 0
},
"dlcs": {"dlc_id": "string"
},
"url": "string",
"created_at": "string",
"updated_at": "string"
}
],
"now": [{"id": 0,
"event_type": {"key": "convoy",
"name": "string"
},
"name": "string",
"slug": "string",
"game": "ETS2",
"server": {"id": 0,
"name": "string"
},
"language": "string",
"departure": {"location": "string",
"city": "string"
},
"arrive": {"location": "string",
"city": "string"
},
"meetup_at": "string",
"start_at": "string",
"banner": "string",
"map": "string",
"description": "string",
"rule": "string",
"voice_link": "string",
"external_link": "string",
"featured": "Official",
"vtc": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"username": "string"
},
"attendances": {"confirmed": 0,
"unsure": 0,
"vtcs": 0
},
"dlcs": {"dlc_id": "string"
},
"url": "string",
"created_at": "string",
"updated_at": "string"
}
],
"upcoming": [{"id": 0,
"event_type": {"key": "convoy",
"name": "string"
},
"name": "string",
"slug": "string",
"game": "ETS2",
"server": {"id": 0,
"name": "string"
},
"language": "string",
"departure": {"location": "string",
"city": "string"
},
"arrive": {"location": "string",
"city": "string"
},
"meetup_at": "string",
"start_at": "string",
"banner": "string",
"map": "string",
"description": "string",
"rule": "string",
"voice_link": "string",
"external_link": "string",
"featured": "Official",
"vtc": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"username": "string"
},
"attendances": {"confirmed": 0,
"unsure": 0,
"vtcs": 0
},
"dlcs": {"dlc_id": "string"
},
"url": "string",
"created_at": "string",
"updated_at": "string"
}
]
}
}

Fetch the specified event

path Parameters

id

required

string

Event ID

Responses

Response samples

200
404

Content type

application/json

No sample

Fetch slots of the specified event

path Parameters

id

required

string

Event ID

Responses

Response samples

200
404

Content type

application/json

No sample

Fetch all the events from the specified user

path Parameters

id

required

string

User ID

Responses

Response samples

200
404

Content type

application/json

{"error": false,
"response": [{"id": 0,
"event_type": {"key": "convoy",
"name": "string"
},
"name": "string",
"slug": "string",
"game": "ETS2",
"server": {"id": 0,
"name": "string"
},
"language": "string",
"departure": {"location": "string",
"city": "string"
},
"arrive": {"location": "string",
"city": "string"
},
"meetup_at": "string",
"start_at": "string",
"banner": "string",
"map": "string",
"description": "string",
"rule": "string",
"voice_link": "string",
"external_link": "string",
"featured": "Official",
"vtc": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"username": "string"
},
"attendances": {"confirmed": 0,
"unsure": 0,
"vtcs": 0
},
"dlcs": {"dlc_id": "string"
},
"url": "string",
"created_at": "string",
"updated_at": "string"
}
]
}

Virtual Trucking Companies

Fetch all the recent, featured, and featured cover VTCs

Responses

Response samples

200

Content type

application/json

{"error": false,
"response": {"recent": [{"id": 0,
"name": "string",
"owner_id": 0,
"owner_username": "string",
"slogan": "string",
"tag": "string",
"website": "string",
"socials": {"twitter": "string",
"facebook": "string",
"twitch": "string",
"discord": "string",
"youtube": "string"
},
"games": {"ats": true,
"ets": true
},
"members_count": 0,
"recruitment": "Open",
"language": "string",
"verified": true,
"validated": true,
"created": "string"
}
],
"featured": [{"id": 0,
"name": "string",
"owner_id": 0,
"owner_username": "string",
"slogan": "string",
"tag": "string",
"website": "string",
"socials": {"twitter": "string",
"facebook": "string",
"twitch": "string",
"discord": "string",
"youtube": "string"
},
"games": {"ats": true,
"ets": true
},
"members_count": 0,
"recruitment": "Open",
"language": "string",
"verified": true,
"validated": true,
"created": "string"
}
],
"featured_cover": [{"id": 0,
"name": "string",
"owner_id": 0,
"owner_username": "string",
"slogan": "string",
"tag": "string",
"website": "string",
"socials": {"twitter": "string",
"facebook": "string",
"twitch": "string",
"discord": "string",
"youtube": "string"
},
"games": {"ats": true,
"ets": true
},
"members_count": 0,
"recruitment": "Open",
"language": "string",
"verified": true,
"validated": true,
"created": "string"
}
]
}
}

Fetch the specified VTC

path Parameters

id

required

string

VTC ID

Responses

Response samples

200
404

Content type

application/json

{"error": false,
"response": {"id": 0,
"name": "string",
"owner_id": 0,
"owner_username": "string",
"slogan": "string",
"tag": "string",
"logo": "string",
"cover": "string",
"information": "string",
"rules": "string",
"requirements": "string",
"website": "string",
"socials": {"twitter": "string",
"facebook": "string",
"twitch": "string",
"discord": "string",
"youtube": "string"
},
"games": {"ats": true,
"ets": true
},
"dlcs": {"dlc_id": "string"
},
"members_count": 0,
"recruitment": "Open",
"language": "string",
"verified": true,
"validated": true,
"created": "string"
}
}

Fetch all the news from the specified VTC

path Parameters

id

required

string

VTC ID

Responses

Response samples

200
404

Content type

application/json

{"error": false,
"response": {"news": [{"id": 0,
"title": "string",
"content_summary": "string",
"author_id": 0,
"author": "string",
"pinned": true,
"updated_at": "string",
"published_at": "string"
}
]
}
}

Fetch the specified news article from the specified VTC

path Parameters

id required	string VTC ID
news_id required	string News Article ID

Responses

Response samples

200
404

Content type

application/json

{"error": false,
"response": {"id": 0,
"title": "string",
"content_summary": "string",
"content": "string",
"author_id": 0,
"author": "string",
"pinned": true,
"updated_at": "string",
"published_at": "string"
}
}

Fetch all the roles from the specified VTC

path Parameters

id

required

string

VTC ID

Responses

Response samples

200
404

Content type

application/json

{"error": false,
"response": {"roles": [{"id": 0,
"name": "string",
"order": 0,
"color": "string",
"owner": true,
"created_at": "string",
"updated_at": "string"
}
]
}
}

Fetch the specified role from the specified VTC

path Parameters

id required	string VTC ID
role_id required	string Role ID

Responses

Response samples

200
404

Content type

application/json

{"error": false,
"response": {"id": 0,
"name": "string",
"order": 0,
"color": "string",
"owner": true,
"created_at": "string",
"updated_at": "string"
}
}

Fetch all the members from the specified VTC

path Parameters

id

required

string

VTC ID

Responses

Response samples

200
404

Content type

application/json

{"error": false,
"response": {"members": [{"id": 0,
"user_id": 0,
"username": "string",
"avatar": "string",
"steam_id": 0,
"steamID64": 0,
"steamID": "string",
"roles": [{"id": 0,
"name": "string",
"order": 0,
"color": "string",
"owner": true,
"created_at": "string",
"updated_at": "string"
}
],
"role_id": 0,
"role": "string",
"is_owner": true,
"joinDate": "string"
}
]
}
}

Fetch the specified member from the specified VTC

path Parameters

id required	string VTC ID
member_id required	string Member ID. NOTE This is the user's VTC member ID, which is different to their TruckersMP User ID. The member ID can be found by accessing the GET /vtc/{id}/members endpoint

Responses

Response samples

200
404

Content type

application/json

{"error": false,
"response": {"id": 0,
"user_id": 0,
"username": "string",
"avatar": "string",
"steam_id": 0,
"steamID64": 0,
"steamID": "string",
"roles": [{"id": 0,
"name": "string",
"order": 0,
"color": "string",
"owner": true,
"created_at": "string",
"updated_at": "string"
}
],
"role_id": 0,
"role": "string",
"is_owner": true,
"joinDate": "string"
}
}

Fetch all the events from the specified VTC

path Parameters

id

required

string

VTC ID

Responses

Response samples

200
404

Content type

application/json

{"error": false,
"response": [{"id": 0,
"event_type": {"key": "convoy",
"name": "string"
},
"name": "string",
"slug": "string",
"game": "ETS2",
"server": {"id": 0,
"name": "string"
},
"language": "string",
"departure": {"location": "string",
"city": "string"
},
"arrive": {"location": "string",
"city": "string"
},
"meetup_at": "string",
"start_at": "string",
"banner": "string",
"map": "string",
"description": "string",
"rule": "string",
"voice_link": "string",
"external_link": "string",
"featured": "Official",
"vtc": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"username": "string"
},
"attendances": {"confirmed": 0,
"unsure": 0,
"vtcs": 0
},
"dlcs": {"dlc_id": "string"
},
"url": "string",
"created_at": "string",
"updated_at": "string"
}
]
}

Fetch the specified event from the specified VTC

path Parameters

id required	string VTC ID
event_id required	string Event ID

Responses

Response samples

200
404

Content type

application/json

{"error": false,
"response": {"id": 0,
"event_type": {"key": "convoy",
"name": "string"
},
"name": "string",
"slug": "string",
"game": "ETS2",
"server": {"id": 0,
"name": "string"
},
"language": "string",
"departure": {"location": "string",
"city": "string"
},
"arrive": {"location": "string",
"city": "string"
},
"meetup_at": "string",
"start_at": "string",
"banner": "string",
"map": "string",
"description": "string",
"rule": "string",
"voice_link": "string",
"external_link": "string",
"featured": "Official",
"vtc": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"username": "string"
},
"attendances": {"confirmed": 0,
"unsure": 0,
"vtcs": 0,
"confirmed_users": [{"id": 0,
"username": "string",
"following": false,
"created_at": "string",
"updated_at": "string"
}
],
"confirmed_vtcs": [{"id": 0,
"name": "string",
"following": false,
"created_at": "string",
"updated_at": "string"
}
],
"unsure_users": [{"id": 0,
"username": "string",
"following": false,
"created_at": "string",
"updated_at": "string"
}
]
},
"dlcs": {"dlc_id": "string"
},
"url": "string",
"created_at": "string",
"updated_at": "string"
}
}

Fetch the attending events from the specified VTC

path Parameters

id

required

string

VTC ID

Responses

Response samples

200
404

Content type

application/json

{"error": false,
"response": [{"id": 0,
"event_type": {"key": "convoy",
"name": "string"
},
"name": "string",
"slug": "string",
"game": "ETS2",
"server": {"id": 0,
"name": "string"
},
"language": "string",
"departure": {"location": "string",
"city": "string"
},
"arrive": {"location": "string",
"city": "string"
},
"meetup_at": "string",
"start_at": "string",
"banner": "string",
"map": "string",
"description": "string",
"rule": "string",
"voice_link": "string",
"external_link": "string",
"featured": "Official",
"vtc": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"username": "string"
},
"attendances": {"confirmed": 0,
"unsure": 0,
"vtcs": 0
},
"dlcs": {"dlc_id": "string"
},
"url": "string",
"created_at": "string",
"updated_at": "string"
}
]
}

Fetch all the partners of the specified VTC

path Parameters

id

required

string

VTC ID

Responses

Response samples

200
404

Content type

application/json

{"error": false,
"response": [{"partners": [{"id": 0,
"status": "Accepted",
"created_at": "string",
"updated_at": "string",
"sender": { },
"receiver": { }
}
],
"pending_requests_count": 0
}
]
}

Game Information

Fetch the current TruckersMP version for ETS2 and ATS

Responses

Response samples

200

Content type

application/json

{"name": "string",
"numeric": "string",
"stage": "Alpha",
"ets2mp_checksum": {"dll": "string",
"adb": "string"
},
"atsmp_checksum": {"dll": "string",
"adb": "string"
},
"time": "string",
"supported_game_version": "string",
"supported_ats_game_version": "string"
}

Fetch the current in-game rules

Responses

Response samples

200

Content type

application/json

{"error": false,
"rules": "string",
"revision": 0
}