Sign in / Sign up
Vehicle introduction Query vehicle details

Query the vehicle list

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 vehicle list

An example that renders a list of vehicles that can be searched and filtered.

Query vehicle list

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.

  • Filtering the vehicle list

    • Use the filter argument to filter the vehicle list on availability, drivetrain, connect, region, purpose and type. For example, here is how to filter for EVs with cargo purpose: filter{drivetrain: BEV purpose: cargo}.

  • Search

    • Use the search argument to search through the vehicle names in the database. For example, searching for ID3 returns all Volkswagen ID3 editions.

  • Localization

    • Use the country argument to apply localization to the vehicleList. The naming, availability and specifications can vary across countries. For example, for PT (Portugal), the naming of the Hyundai Kona will be shown as Hyundai Kauai.

  • Unit conversion

    • Use the unit argument on applicable fields to convert the unit type. You can see which unit conversions are available on a field by looking at the unit type. For example, use kilowatt_hour to request the charge speed in kilowatt hours as opposed to the default kilometers_per_hour for connectors.

Arguments

filter • VehicleListFilter

Filter vehicle result.

country • CountryCodeAlpha2

ISO-3166 alpha-2 country code to apply localization on vehicle data if available.

Show CountryCodeAlpha2 enum values

size • Int

Number of elements (count) to return.

Default • 10

page • Int

Page number to return.

Default • 0

Frequently used fields

id • ID

Vehicles unique ID.

naming • VehicleListNaming

Naming of the vehicle.

connectors • VehicleConnector

Connectors available for the vehicle. Please note that for HEVs this will always be an empty array.

availability • VehicleListAvailability

Availability of the vehicle.

Other fields

drivetrain • VehicleDrivetrain

Drivetrain of the vehicle.

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.

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.

Show VehicleRegion enum values

purpose • VehiclePurpose

Vehicle intended use. Can be passenger, cargo, or utility.

Show VehiclePurpose enum values

type • VehicleType

Type of vehicle.

Show VehicleType enum values

Response

A response can either contain a data or an errors object. The response header will always return 200 as a status code.

Data object

When successful, a data object will be returned with the requested fields. If there are no fields present the data object will return the operation name with the appropriate return type. If the operation was a query, this output will be an object of the schema’s query root type; if the operation was a mutation, this output will be an object of the schema’s mutation root type.

Error object

If unsuccessful, an errors object will be returned with more details in the extensions object. The error object can contain any of the following objects.

Error

PAGINATION_INVALID_PAGE

Page must be an INT value higher than 0.