API Documentation

Integrate ABRP's powerful EV routing and planning capabilities into your platform. Our comprehensive API suite enables seamless integration of vehicle-aware routing, telemetry, and deep linking features.

APIs & Integration

Access our suite of APIs to integrate EV routing, telemetry, and deep linking into your platform.

Planning API

v2 - Recommended

v1 - Legacy

Vehicle-aware routing with comprehensive EV planning capabilities

Our Planning API provides sophisticated route planning that evolves with ABRP's continuous improvements. Features include energy consumption modeling, charging optimization, real-time traffic integration, and weather-aware planning.

The API uses a REST architecture with JSON output and supports both legacy (v1) and modern (v2) endpoints. Setup costs and per-plan pricing vary based on your integration needs and usage volume.

v2 Planning Documentation v1 Planning Documentation (Legacy)

Telemetry API

Real-time vehicle data for live tracking and car modeling

The Telemetry API enables real-time vehicle data transmission for live journey tracking, consumption analysis, and continuous improvement of our car models. This helps us refine energy predictions and routing accuracy.

Free API keys are available for integration. User tokens are required for data submission and can be obtained either through our OAuth2 flow (recommended) or manual token retrieval for testing and development.

Telemetry Documentation

OAuth2 API

Secure user authentication and authorization

OAuth2 provides a secure and convenient way to identify and authenticate users with Iternio. To set up OAuth2, you'll need an API key and must provide a redirect URL and application name.

Authorization Flow

The first call returns an HTML page where users can log in and approve your application. If opened in the user's default browser, their login may be cached to simplify the process.

https://abetterrouteplanner.com/oauth/auth?client_id=<your_client_id>&scope=<requested_scope>&response_type=code&redirect_uri=<your_redirect_uri>

Allowed scopes:

get_telemetry: Retrieve user's latest telemetry
set_telemetry: Push new telemetry updates to the vehicle
get_plan: Get the latest plan in condensed form (contact us for details)
vehicle_history: Retrieve historic drives and charging sessions (contact us for details)

Response at your redirect URI:

https://your_redirect_uri?state=<state_provided>&auth_code=<returned_auth_code>

Token Retrieval

Once you receive an authorization code, retrieve the token which can be stored and reused as needed.

https://api.iternio.com/1/oauth/token?client_id=<your_client_id>&client_secret=<your_api_key>&code=<auth_code>

Response format:

{
  "access_token": "<the created token>",
  "token_type": "bearer",
  "state": "<your supplied state>"
}

User Information

After obtaining the token, use the "me" endpoint to retrieve user information:

https://api.iternio.com/1/oauth/me?access_token=<the user token>&api_key=<your api key>

Response format:

{
  "user_id": <the numeric ID of the user>,
  "full_name": "<Full name of the user>",
  "email": "<Email of user>",
  "vehicle_id": <The numeric ID of the vehicle, if part of the scope>,
  "vehicle_name": "<The vehicle name>",
  "vehicle_typecode": "<The vehicle typecode>"
}

Deep Links

URL-based integration for pre-configured route planning

Create custom URLs that launch ABRP with pre-configured routes, vehicle selections, and planning parameters. Perfect for embedding in apps, websites, or navigation systems without API integration.

Deep links support a wide range of URL parameters including origin/destination coordinates, waypoints, car models, state of charge, and user preferences. Base URL: https://abetterrouteplanner.com

Deep Links Documentation