Developers

Search

Query

Unknown

Access the complete vehicle database with the vehicleList query. By default the vehicle database uses EU naming for vehicles and plug types. Use the country parameter in combination with the region filter to return vehicles available in your region with locally known names and plug types here.

Query

Use the vehicleList to fetch all vehicles in the database. No input is required to execute this query. Use filters, search, and/or localization to narrow down and customize the results.

Arguments

filter· VehicleListFilter

How filter works

The filter argument lets you narrow down results by passing an input object with specific criteria. Each field within the filter is optional — only include the ones relevant to your query.

Filter vehicle result.
country· CountryCodeAlpha2
ISO-3166 alpha-2 country code to apply localization on vehicle data if available.
size· Int
Number of elements (count) to return.
page· Int
Page number to return.

Fields

id· ID
Vehicles unique ID.
naming· VehicleListNaming
Naming of the vehicle.
drivetrain· VehicleDrivetrain
Drivetrain of the vehicle.
connectors· VehicleConnector
Connectors available for the vehicle. Please note that for HEVs this will always be an empty array.
adapters· VehicleConnector
Adapters available for the vehicle. Please note that for HEVs this will always be an empty array.
battery· VehicleListBattery
Battery of the vehicle.
body· VehicleListBody
Body of the vehicle.
availability· VehicleListAvailability
Availability of the vehicle.
range· VehicleListRange
Range of the vehicle.
media· VehicleListMedia
Media of the vehicle.
routing· VehicleListRouting
Routing of the vehicle.
connect· Connect
Information about vehicle connectivity.
region· VehicleRegion
Regions in which the vehicle is available. Based on the continent code (CC) standard.
purpose· VehiclePurpose
Vehicle intended use. Can be passenger, cargo, or utility.
type· VehicleType
Type of vehicle.

Errors

Operations can fail. To handle all errors correctly, consider implementing the following error scenario’s.

error_forbidden_message
You are forbidden to execute this operation.
operation_not_allowed
You are not allowed to execute this operation. Enable it for the current application in the dashboard or reach out to customer support.
pagination_invalid_page
Page must be an INT value higher than 0.
pagination_invalid_size
Size must be an INT value between 1 and 1000.
rate_limit_exceeded
Rate limit exceeded.
vehicle_pagination_invalid_size
Size must be an INT value between 1 and 100.

Was this helpful?

  • Getting started

    Get started with the Chargetrip API.

  • API reference

    Browse our api and endpoints.

  • Examples

    Explore examples and start building.