TrucklineMP logo
Developer Resources

Public API

REST API for third-party integrations. Create API keys in the Developer Console.

Authentication

Public read endpoints work without authentication. Pass an API key as Authorization: Bearer tlmp_api_... for higher rate limits (default free tier: 1,000 requests/minute).

API keys provide read-only access to public data, rate-limit tiers, and usage analytics. Production integrations should use keys from the Developer Console. See our Privacy Policy for how API telemetry is stored.

Base URL

Production: https://api.trucklinemp.com

Development: https://api-dev.trucklinemp.com

Nginx maps api*.trucklinemp.com/<path> to /api/v1/<path> on the app. Do not add an extra /v1 in the hostname URL.

Local: http://localhost:3000/api/v1

OAuth 2.0

OAuth apps use authorization code flow with PKCE support. Create clients in the Developer Console and call /api/oauth/userinfo with a bearer access token.

Available scopes include profile, vtc:read, events:read, bans:read, and presence:read. The presence scope returns Redis-backed fields such as is_online and presence_checked_at.

Documentation

GET /api/v1/openapi.json
OpenAPI 3.1 spec for the public REST API.
View OpenAPI JSONOpen in Swagger UIOpen in RedocDeveloper Console Docs

Getting Started

  • Enable developer access and create a project in the Developer Console.
  • Generate an API key and try endpoints in the Playground.
  • Browse VTCs: GET /api/v1/vtcs