Endpoints¶

Vehicles¶

Before you can manage vehicle security or access, you first need to manage the fleet's vehicle list.

Adding a vehicle¶

Submits a request to add a vehicle to the account, reviewed and carried out by Carmoove, which will provide the device suited to the request.

POST /v1/vehicle
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`plate`	String	Vehicle license plate.
`request`	String	Details on the reasons for the request (free text): device type to install (OBD / CAN), desired features (immobilization, central locking, etc.).

Response¶

Field	Type	Description
`request_id`	String	Request identifier.
`error`	String	Error code. Absent on a successful request.

Listing vehicles¶

Provides the list of vehicles for car-sharing use.

GET /v1/vehicles
x-carmoove-token: <token>

Response¶

Field	Type	Description
`id`	String	Vehicle identifier.
`builder`	String	Vehicle manufacturer.
`model`	String	Vehicle model.
`plate`	String	Vehicle license plate.
`deviceId`	String	Identifier of the device installed on the vehicle.
`deviceModel`	String	Device model identifier.
`energy`	String	Energy used by the vehicle (registration certificate nomenclature).
`bluetoothName`	String	Bluetooth name.
`seats`	Number	Number of seats.
`gearbox`	String	Gearbox type: `AUTOMATIC` / `MANUAL`.
`kind`	String	Vehicle type (registration certificate nomenclature).
`archived`	Boolean	Indicates whether the vehicle has been archived.
`accessories`	Array	Accessories installed with the device. Possible values: `TEMPERATURE-SENSOR` (temperature sensor), `CARDHOLDER` (parking / energy / other card detector), `KEY-DETECTOR` (key detector).

Viewing vehicle information¶

GET /v1/vehicle
x-carmoove-token: <token>

Option — alternative parameterless request: GET /v1/vehicle/{id}.

Parameters¶

Only one of the two parameters is needed.

Field	Type	Description
`id`	String	Vehicle identifier.
`plate`	String	Vehicle license plate.

Response¶

Field	Type	Description
`Id`	String	Vehicle identifier.
`builder`	String	Vehicle manufacturer.
`model`	String	Vehicle model.
`plate`	String	Vehicle license plate.
`energy`	String	Energy type.
`bluetoothName`	String	Bluetooth name.
`deviceId`	String	Identifier of the device installed on the vehicle.
`deviceModel`	String	Device model identifier.
`accessories`	Array	Accessories installed with the device (same values as above).
`error`	String	Error code. Absent on a successful request.

Errors¶

UNKNOWN_VEHICLE — see Errors.

Archiving a vehicle¶

Archives a vehicle: its information remains available but no further action is possible. The same call is used to reactivate an archived vehicle.

PUT /v1/vehicle
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`id`	String	Vehicle identifier.
`archived`	Boolean	Archive status to apply (`true` to archive, `false` to reactivate).

Response¶

Field	Type	Description
`id`	String	Vehicle identifier.
`archived`	String	Vehicle's archive status.
`error`	String	Error code. Absent on a successful request.

Deleting a vehicle¶

Deletes the vehicle along with all associated data.

DELETE /v1/vehicle
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`id`	String	Vehicle identifier.

Response¶

Field	Type	Description
`error`	String	Error code. Absent on a successful request.

Telematics devices¶

To manage the security or access of a vehicle, the telematics device identifier must be associated with the vehicle it is installed in.

Linking a device¶

POST /v1/device
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`vehicleId`	String	Vehicle identifier.
`deviceId`	String	Device identifier.

Response¶

Field	Type	Description
`error`	String	Error code. Absent on a successful request.

Removing a device link¶

DELETE /v1/device
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`deviceId`	String	Device identifier.

Response¶

Field	Type	Description
`error`	String	Error code.

Changing device¶

Updates the link between the vehicle and the telematics device when the device is replaced.

PUT /v1/device
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`vehicleId`	String	Identifier of the new vehicle.
`deviceId`	String	Device identifier.

Response¶

Field	Type	Description
`error`	String	Error code. Absent on a successful request.

Possible errors for the three endpoints above: UNKNOWN_DEVICE, UNKNOWN_VEHICLE, DEVICE_ALREADY_LINKED, VEHICLE_ALREADY_LINKED — see Errors.

Vehicle access (Bluetooth authorizations)¶

To connect to the vehicle over Bluetooth, an authorization token must first be requested. This token is then provided when connecting over Bluetooth to the device installed in the vehicle.

Authorization¶

POST /v1/bluetooth-token
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`vehicleId`	String	Vehicle identifier.
`userId`	String	Driver identifier.
`level`	String	Authorization level: `LOCK_UNLOCK` or `DRIVE`.
`from`	Timestamp	Authorization start date and time.
`until`	Timestamp	Authorization end date and time.

Response¶

Field	Type	Description
`token`	String	Token to use for Bluetooth communication with the device.
`key`	String	Session key for Bluetooth communication with the device.
`authorizationId`	String	Authorization identifier.
`error`	String	Error code. Absent on a successful request.

Errors¶

UNKNOWN_VEHICLE, INVALID_LEVEL, INVALID_INTERVAL, INVALID_DATE — see Errors.

Authorization status¶

GET /v1/bluetooth-token/{authorizationId}
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`authorizationId`	String	Authorization identifier.

Response¶

Field	Type	Description
`vehicleId`	String	Vehicle identifier.
`userId`	String	Driver identifier.
`from`	Timestamp	Authorization start date and time.
`until`	Timestamp	Authorization end date and time.
`token`	String	Token to use for Bluetooth communication with the device.
`key`	String	Session key for Bluetooth communication with the device.
`error`	String	Error code. Absent on a successful request.

Updating the authorization¶

POST /v1/bluetooth-token/{authorizationId}
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`authorizationId`	String	Authorization identifier.
`from`	Timestamp	Start date.
`until`	Timestamp	End date.

Response¶

Field	Type	Description
`authorizationId`	String	New authorization identifier.
`vehicleId`	String	Vehicle identifier.
`userId`	String	Driver identifier.
`from`	Timestamp	Authorization start date and time.
`until`	Timestamp	Authorization end date and time.
`token`	String	Token to use for Bluetooth communication with the device.
`key`	String	Session key for Bluetooth communication with the device.
`error`	String	Error code. Absent on a successful request.

Deleting the authorization¶

DELETE /v1/bluetooth-token
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`authorizationId`	String	Authorization identifier.

Response¶

Field	Type	Description
`error`	String	Error code. Absent on a successful request.

Errors for the three endpoints above: UNKNOWN_AUTHORIZATION — see Errors.

Temporarily suspending the authorization¶

Temporarily removes a user's access to a vehicle.

POST /v1/bluetooth-token/invalidate
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`authorizationId`	String	Authorization identifier.
`until`	String	Date and time the suspension ends.

Response¶

Field	Type	Description
`error`	String	Error code. Absent on a successful request.

Errors¶

UNKNOWN_AUTHORIZATION, INVALID_DATE, AUTHORIZATION_NOT_ACTIVE, AUTHORIZATION_EXPIRED — see Errors (the last two codes are not documented in the source PDF, found while checking v1/bluetooth.go).

Reactivating the authorization before the temporary suspension ends¶

Restores a user's access to a vehicle before their suspension ends.

POST /v1/bluetooth-token/validate
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`authorizationId`	String	Authorization identifier.

Response¶

Field	Type	Description
`error`	String	Error code. Absent on a successful request.

Errors¶

UNKNOWN_AUTHORIZATION, NOT_SUSPENDED, AUTHORIZATION_NOT_ACTIVE, AUTHORIZATION_EXPIRED — see Errors.

Vehicle actions¶

Some actions are possible remotely (without a Bluetooth connection), depending on the installed device model and its configuration.

Available actions¶

GET /v1/vehicle/actions
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`vehicleId`	String	Vehicle identifier.

Response¶

Field	Type	Description
`actions`	Array	Actions available for the vehicle. Possible values: `IMMOBILIZE`, `CENTRAL-LOCK`, `HONK`, `TURNING-LIGHTS`, `UNLOCK-TRUNK`, `CLOSE-WINDOWS`, `OPEN-WINDOWS`.
`error`	String	Error code. Absent on a successful request.

Allowing startup¶

POST /v1/vehicle/start
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`vehicleId`	String	Vehicle identifier.

Response¶

Field	Type	Description
`Status`	String	Authorization status: `LOCKED` or `UNLOCKED`.
`error`	String	Error code. Absent on a successful request.

Preventing startup¶

POST /v1/vehicle/immobilize
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`vehicleId`	String	Vehicle identifier.

Response¶

Field	Type	Description
`Status`	String	Authorization status: `LOCKED` or `UNLOCKED`.
`error`	String	Error code. Absent on a successful request.

Honking the vehicle horn¶

POST /v1/vehicle/honk
x-carmoove-token: <token>

On success, the API only returns HTTP status 200.

Parameters¶

Field	Type	Description
`vehicleId`	String	Vehicle identifier.

Response¶

Field	Type	Description
`error`	String	Error code. Absent on a successful request.

Unlocking the doors¶

Note

The doors can only be unlocked remotely or over Bluetooth if the vehicle was locked using the locking function (below) without using the vehicle's original key.

POST /v1/vehicle/unlock
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`vehicleId`	String	Vehicle identifier.

Response¶

Field	Type	Description
`Status`	String	Opening status: `OPEN` or `CLOSED`.
`error`	String	Error code. Absent on a successful request.

Locking the doors¶

Note

The lock/unlock functions must be triggered via the API or the Bluetooth connection, without using the vehicle's original key.

POST /v1/vehicle/lock
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`vehicleId`	String	Vehicle identifier.

Response¶

Field	Type	Description
`Status`	String	Opening status: `OPEN` or `CLOSED`.
`error`	String	Error code. Absent on a successful request.

Flashing the lights¶

POST /v1/vehicle/lights/on
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`vehicleId`	String	Vehicle identifier.

Response¶

Field	Type	Description
`error`	String	Error code. Absent on a successful request.

Unlocking the trunk¶

POST /v1/vehicle/trunk/unlock
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`vehicleId`	String	Vehicle identifier.

Response¶

Field	Type	Description
`error`	String	Error code. Absent on a successful request.

Opening the windows¶

Added in version 1.11.

POST /v1/vehicle/windows/open
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`vehicleId`	String	Vehicle identifier.

Response¶

Field	Type	Description
`error`	String	Error code. Absent on a successful request.

Closing the windows¶

Added in version 1.11.

POST /v1/vehicle/windows/close
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`vehicleId`	String	Vehicle identifier.

Response¶

Field	Type	Description
`error`	String	Error code. Absent on a successful request.

Errors common to the actions above: UNKNOWN_VEHICLE, COMMUNICATION_FAILED — see Errors.

Vehicle data¶

Vehicle status¶

The number of available fields depends on the vehicle model, the type of device installed, and its configuration.

GET /v1/vehicle/status
x-carmoove-token: <token>

Option — alternative parameterless request: GET /v1/vehicle/{id}/status.

Parameters¶

Only one of the two parameters is needed.

Field	Type	Description
`vehicleId`	String	Vehicle identifier.
`plate`	String	Vehicle license plate.

Response¶

Field	Type	Description
`lock`	String	Central locking status: `LOCKED` or `UNLOCKED`.
`engine`	String	Engine status: `ON` or `OFF`.
`immobilizer`	String	Vehicle immobilization status: `LOCKED` or `UNLOCKED`.
`handbrake`	String	Handbrake status: `ON` or `OFF`.
`lights`	String	Headlight status: `ON` or `OFF`.
`doors`	String	Door opening status: `OPEN` or `CLOSED`.
`windows`	String	Window opening status: `OPEN` or `CLOSED`.
`speed`	Number	Vehicle speed in km/h.
`bluetooth`	String	Bluetooth connection status: `CONNECTED` or `DISCONNECTED`.
`authenticated`	Boolean	Bluetooth authentication status. Absent if there is no Bluetooth connection.
`mileage`	Number	Vehicle mileage.
`fuel`	Number	Fuel level (liters).
`fuelRange`	Number	Fuel level (percentage).
`chargingAdapterStatus`	String	Mains adapter status: `CONNECTED` or `DISCONNECTED`.
`ChargingStatus`	String	Vehicle charging status: `CHARGING` or `NOT_CHARGING`.
`ChargingUntil`	Timestamp	Date when the battery will stop charging.
`ChargeLevel`	Number	Battery charge level, as a percentage.
`RemainingRange`	Number	Estimated remaining range, in kilometers.
`privacy`	Boolean	Location privacy status.
`position`	Object	Vehicle position: `latitude`, `longitude` (decimal degrees) and `timestamp` of the reading. May be absent if the position is not known.
`authorizations`	Object	Current authorizations linked to the vehicle: `authorizationId`, `userId`, `from`, `until` for each authorization.
`scenarii`	Object	Configuration and status of the device's scenarios: `gps_jamming` (GPS jamming), `gnss_jamming` (GNSS jamming), `towing_detection` (towing detection), `crash_detection` (crash detection). Each scenario contains `available` (Bool), `active` (Bool), `action` (String, action executed if triggered — empty if none) and `triggered` (Bool).
`cardholder`	Array	Information on the card detector. Each object contains `id` and `statut`.
`vehicleKey`	Boolean	Presence of the key in the car.
`lastMessage`	Timestamp	Date of the last message sent by the device. Added in version 1.8.
`state`	Object	Vehicle statuses (see Updating a vehicle's status): `Towing`, `Accident`, `Maintenance`, `Breakdown`, `Stolen`, `Unavailable` (Bool). Added in version 1.8.
`error`	String	Error code. Absent on a successful request.

Errors¶

UNKNOWN_VEHICLE, COMMUNICATION_FAILED — see Errors.

Vehicle location¶

GET /v1/vehicle/position
x-carmoove-token: <token>

Option — alternative parameterless request: GET /v1/vehicle/{id}/position.

Parameters¶

Only one of the two parameters is needed.

Field	Type	Description
`vehicleId`	String	Vehicle identifier.
`plate`	String	Vehicle license plate.

Response¶

Field	Type	Description
`Position`	Object	`latitude`, `longitude` (decimal degrees) and `timestamp` of the last position reading. May be absent if the position is not known.
`error`	String	Error code. Absent on a successful request.

Errors¶

UNKNOWN_VEHICLE, POSITION_UNKNOWN — see Errors.

Location privacy¶

To comply with GDPR for short- or long-term rental and sharing services, it is recommended to enable location privacy at the start of the contract/usage period, and to disable it at the end of the period to retrieve the vehicle's position.

Enabling privacy:

POST /v1/vehicle/privacy/on
x-carmoove-token: <token>

Disabling privacy:

POST /v1/vehicle/privacy/off
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`vehicleId`	String	Vehicle identifier.

Response¶

Field	Type	Description
`Privacy`	Boolean	Location privacy status.
`error`	String	Error code. Absent on a successful request.

Errors¶

UNKNOWN_VEHICLE — see Errors.

Vehicle trips¶

GET /v1/vehicle/{id}/trips?from={from}&until={until}&offset={offset}&limit={limit}
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`id`	String	Vehicle identifier.
`from`	Timestamp	Start date. Optional. Defaults to the start of the current month.
`until`	Timestamp	End date. Optional. Defaults to the date of the request.
`limit`	Numeric	Number of trips to return. Optional.
`offset`	Numeric	Number of trips to skip. Optional.

Response¶

Field	Type	Description
`trips`	Object	List of trips (`trip` object, see below).
`error`	String	Error code. Absent on a successful request.

`trip` object¶

Field name	Type	Description
`trip_id`	String	Trip identifier.
`timestamp`	Timestamp	Trip start date.
`distance`	Numeric	Distance covered during the trip.
`duration`	Numeric	Trip duration, in minutes.
`cost`	Numeric	Estimated cost of the trip.
`fuel_consumption`	Numeric	Fuel consumed, in liters, for combustion vehicles.
`fuel_consumption_100km`	Numeric	Consumption per 100 km, for combustion vehicles.
`average_speed`	Numeric	Average speed.
`electric_consumption`	Numeric	Electric consumption, for electric vehicles.
`electric_consumption_100km`	Numeric	Electric consumption per 100 km, for electric vehicles.
`first_position`	Object	Trip starting point: `latitude`, `longitude` (decimal degrees).
`last_position`	Object	Trip ending point: `latitude`, `longitude` (decimal degrees).

Errors¶

UNKNOWN_VEHICLE, NO_DATA — see Errors.

Updating a vehicle's status¶

These statuses can also be changed automatically by the platform if detected by the device (or, for maintenance, if the associated services are enabled). Added in version 1.8.

The same request pattern applies to all six statuses:

POST /v1/vehicle/{id}/towing?state={state}
POST /v1/vehicle/{id}/accident?state={state}
POST /v1/vehicle/{id}/maintenance?state={state}
POST /v1/vehicle/{id}/breakdown?state={state}
POST /v1/vehicle/{id}/stolen?state={state}
POST /v1/vehicle/{id}/unavailable?state={state}
x-carmoove-token: <token>

Status	Endpoint	Response field
Towing	`/v1/vehicle/{id}/towing`	`towing`
Accident	`/v1/vehicle/{id}/accident`	`accident`
Maintenance	`/v1/vehicle/{id}/maintenance`	`maintenance`
Breakdown	`/v1/vehicle/{id}/breakdown`	`breakdown`
Theft	`/v1/vehicle/{id}/stolen`	`stolen`
Unavailable	`/v1/vehicle/{id}/unavailable`	`unavailable`

Parameters¶

Field	Type	Description
`id`	String	Vehicle identifier.
`state`	Boolean	New state of the status concerned.

Response¶

Field	Type	Description
(see table above)	Boolean	Status of the updated state.
`error`	String	Error code. Absent on a successful request.

Errors¶

UNKNOWN_VEHICLE — see Errors.

Driver data¶

Vehicle list¶

List of vehicles a driver has been granted authorization for.

GET /v1/user/{userid}/vehicles
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`userId`	String	Driver identifier.

Response¶

Field	Type	Description
`Id`	String	Vehicle identifier.
`Builder`	String	Vehicle manufacturer.
`Model`	String	Vehicle model.
`Plate`	String	Vehicle license plate.
`deviceId`	String	Identifier of the device installed on the vehicle.
`deviceModel`	String	Device model identifier.
`Archived`	Boolean	Indicates whether the vehicle has been archived.
`authorizations`	Object	Authorizations linked to the vehicle: `authorizationId`, `from`, `until` for each authorization.

Deleting authorizations¶

Deletes all authorizations granted to a driver.

DELETE /v1/user/{userid}
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`userId`	String	Driver identifier.

Response¶

Field	Type	Description
`error`	String	Error code. Absent on a successful request.

Errors¶

NOT_ALL_AUTHORIZATIONS_REVOKED — see Errors.

Changing your password¶

See Authentication — Changing the user password (POST /v1/user/updatePassword): the source PDF documents this function in two places (authentication and driver data) for the same endpoint.

Authorization lists¶

The list of current, upcoming, or expired authorizations is accessible from several places depending on the desired context. All of them share the same response shape (authorizations, with authorizationId, from, until per authorization) and the same possible error (INTERNAL_ERROR), unless stated otherwise.

Context	Endpoint	Parameters
All current authorizations, all vehicles	`GET /v1/vehicles/authorizations/current`	—
All upcoming authorizations, all vehicles	`GET /v1/vehicles/authorizations/scheduled`	—
All expired authorizations, all vehicles	`GET /v1/vehicles/authorizations/expired`	—
Current authorizations for a vehicle	`GET /v1/vehicle/{id}/authorizations/current`	`id`, `offset`, `limit`
Upcoming authorizations for a vehicle	`GET /v1/vehicle/{id}/authorizations/scheduled`	`id`, `offset`, `limit`
Expired authorizations for a vehicle	`GET /v1/vehicle/{id}/authorizations/expired`	`id`, `offset`, `limit`
Upcoming authorizations for a driver	`GET /v1/user/{userid}/authorizations/scheduled`	`userId`
Expired authorizations for a driver	`GET /v1/user/{userid}/authorizations/expired`	`userId`

The per-vehicle endpoints accept offset (Number, authorizations to skip) and limit (Number, authorizations to return) — added in version 1.8.

x-carmoove-token: <token>

Teltonika Device-Specific Features¶

Bluetooth connection parameters¶

Provides the information needed to establish a Bluetooth connection with the device.

GET /v1/bluetooth-token/params?authorizationId={authorizationId}
x-carmoove-token: <token>

Correction made to the source PDF

The PDF documents this endpoint as POST /v1/bluetooth-token/params with authorizationId in the request body. The source code (v1/bluetooth.go) shows the handler only accepts the GET method, with authorizationId passed as a query parameter. An equivalent route GET /v1/bluetooth-token/{authorizationId}/params also exists in the router but is not documented in the PDF.

Parameters¶

Field	Type	Description
`authorizationId`	String	Authorization identifier.

Response¶

Field	Type	Description
`name`	String	Bluetooth connection name.
`pin`	String	Connection PIN code.
`error`	String	Error code. Absent on a successful request.

Errors¶

UNKNOWN_AUTHORIZATION, INVALID_DEVICE — see Errors.

Commands to send¶

Provides the commands used to control the device.

GET /v1/bluetooth-token/commands?authorizationId={authorizationId}
x-carmoove-token: <token>

Correction made to the source PDF

Same correction as above: the PDF documents POST /v1/bluetooth-token/commands, but the real handler (v1/bluetooth.go) only accepts GET, with authorizationId as a query parameter. An equivalent route GET /v1/bluetooth-token/{authorizationId}/commands also exists but is not documented in the PDF.

Parameters¶

Field	Type	Description
`authorizationId`	String	Authorization identifier.

Response¶

Field	Type	Description
`key`	String	Encryption key for commands that require it.
`immobilize`	String	Command to immobilize the vehicle.
`demobilize`	String	Command to stop immobilizing the vehicle.
`lock`	String	Command to lock the vehicle.
`unlock`	String	Command to unlock the vehicle.
`honk`	String	Command to honk the vehicle's horn.
`turningLights`	String	Command to flash the lights.
`unlockTrunk`	String	Command to unlock the trunk.
`openWindows`	String	Command to open the windows. Added in version 1.12.
`closeWindows`	String	Command to close the windows. Added in version 1.12.
`encryptImmobilize`	Boolean	`true` if the command must be encrypted before being sent to the device.
`encryptDemobilize`	Boolean	Same, for `demobilize`.
`encryptLock`	Boolean	Same, for `lock`.
`encryptUnlock`	Boolean	Same, for `unlock`.
`encryptHonk`	Boolean	Same, for `honk`.
`encryptTurningLights`	Boolean	Same, for `turningLights`.
`encryptUnlockTrunk`	Boolean	Same, for `unlockTrunk`.
`encryptOpenWindows`	Boolean	Same, for `openWindows`. Added in version 1.12.
`encryptCloseWindows`	Boolean	Same, for `closeWindows`. Added in version 1.12.
`encryptReadio`	Boolean	`true` if the command must be encrypted before being sent to the device. Added in version 1.12.
`digitalOutput`	Object	Identifier of the digital output to use for each command (Teltonika devices). Added in version 1.12.
`error`	String	Error code. Absent on a successful request.

Errors¶

UNKNOWN_AUTHORIZATION, INVALID_DEVICE — see Errors.

Booking and free-floating features¶

Added in version 1.12/1.13.

Vehicle list for free-floating¶

Vehicles available right now for free-floating.

GET /v1/vehicles?searchType=FREE_FLOATING
x-carmoove-token: <token>

Response¶

Same shape as Listing vehicles (id, builder, model, plate, deviceId, deviceModel, energy, bluetoothName, seats, gearbox, kind, archived, accessories).

Vehicle list for standard bookings¶

Vehicles available for a booking over a given period.

GET /v1/vehicles?searchType=BOOKING
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`from`	Timestamp	Start date. Required.
`until`	Timestamp	End date. Required.
`energy`	String	Energy type (registration certificate nomenclature). Optional.
`gearbox`	String	Gearbox type: `MANUAL` / `AUTOMATIC`. Optional.
`brand`	String	Vehicle brand. Optional.
`kind`	String	Vehicle type (registration certificate nomenclature). Optional.

Response¶

Same shape as Listing vehicles.

Booking a vehicle¶

Books a vehicle, in free-floating or standard booking mode.

POST /v1/vehicle/{id}/booking
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`id`	String	Vehicle identifier.
`from`	Timestamp	Start date. Required, must not be earlier than 5 minutes before the request.
`until`	Timestamp	End date. Optional.
`type`	String	Booking type: `BOOKING` or `FREE_FLOATING`.
`driver`	String	Driver identifier. Optional — if absent, the booking is recorded for the requesting user.

Response¶

Field	Type	Description
`booked`	Boolean	Booking status.
`bookingId`	String	Booking identifier.
`from`	Timestamp	Booking start date.
`until`	Timestamp	Booking end date.
`vehicleId`	String	Vehicle identifier.
`userId`	String	User identifier.
`authorizationId`	String	Identifier of the authorization linked to the booking.
`bookingType`	String	Booking type: `FREE_FLOATING` or `BOOKING`.
`authorization`	Object	Authorization information: `id`, `token`, `key`.
`commands`	Object	Commands for Teltonika devices, see Commands to send.
`error`	String	Error code. Absent on a successful request.

Errors¶

UNAUTHORIZED, DRIVER_WITHOUT_ACCOUNT, INVALID_BOOKING_TYPE, INVALID_INTERVAL, NO_DEVICE, VEHICLE_NOT_AVAILABLE, UNKNOWN_VEHICLE — see Errors.

List of a vehicle's bookings¶

GET /v1/vehicle/{id}/booking
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`id`	String	Vehicle identifier.

Response¶

Field	Type	Description
`bookings`	Array	List of the vehicle's bookings — see Booking detail.
`error`	String	Error code. Absent on a successful request.

Errors¶

UNKNOWN_VEHICLE — see Errors.

Booking detail¶

GET /v1/booking/{id}
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`id`	String	Booking identifier.

Response¶

Field	Type	Description
`id`	String	Booking identifier.
`from`	Timestamp	Booking start date.
`until`	Timestamp	Booking end date.
`vehicleId`	String	Vehicle identifier.
`authorizationId`	String	Identifier of the authorization linked to the booking.
`userId`	String	User identifier.
`bookingType`	String	Booking type: `FREE_FLOATING` or `BOOKING`.
`error`	String	Error code. Absent on a successful request.

Errors¶

NOT_FOUND — see Errors.

Updating a vehicle's booking¶

PUT /v1/booking/{id}
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`id`	String	Booking identifier.
`from`	Timestamp	Booking start date.
`until`	Timestamp	Booking end date.

Response¶

Field	Type	Description
`updated`	Boolean	`true` if the booking was successfully updated.
`authorizationId`	String	New authorization identifier.
`token`	String	Token to use for Bluetooth communication with the device.
`key`	String	Session key for Bluetooth communication with the device.
`error`	String	Error code. Absent on a successful request.

Errors¶

NOT_FOUND, BOOKING_EXPIRED, INVALID_INTERVAL — see Errors.

Deleting a vehicle's booking¶

Use this when canceling before the booking starts, or in case of a free-floating access issue.

DELETE /v1/booking/{id}
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`id`	String	Booking identifier.

Response¶

Field	Type	Description
`deleted`	Boolean	`true` if the booking was successfully deleted.
`error`	String	Error code. Absent on a successful request.

Errors¶

NOT_FOUND — see Errors.

Stopping a vehicle's booking¶

Use this to end a booking early.

POST /v1/booking/{id}/stop
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`id`	String	Booking identifier.

Response¶

Field	Type	Description
`stopped`	Boolean	`true` if the booking was successfully stopped.
`error`	String	Error code. Absent on a successful request.

Errors¶

NOT_FOUND — see Errors.

Booking list¶

List of all current bookings.

GET /v1/bookings
x-carmoove-token: <token>

Response¶

Field	Type	Description
`bookings`	Array	List of bookings — see Booking detail.
`error`	String	Error code. Absent on a successful request.

Parking Features¶

Lets you define a vehicle's parking address, useful for finding available vehicles for a booking. Added in version 1.12.

Defining a parking spot¶

POST /v1/parkings
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`name`	String	Parking spot name.
`address`	String	Parking spot address.
`address2`	String	Second address line.
`zipcode`	String	ZIP/postal code.
`city`	String	City.
`country`	String	Country.

Response¶

Field	Type	Description
`parking_id`	String	Parking spot identifier.
`error`	String	Error code. Absent on a successful request.

Correction made to the source PDF

The PDF documents this response field as parkingId (camelCase). The source code (v1/parking.go, PostParkingsResponse struct) shows the real JSON field is parking_id (snake_case).

Errors¶

MISSING_NAME, MISSING_ADDRESS, MISSING_ZIPCODE, MISSING_CITY, MISSING_COUNTRY — see Errors.

Parking list¶

GET /v1/parkings
x-carmoove-token: <token>

Response¶

Field	Type	Description
`parkings`	Array	List of parking spots — see Parking detail.
`error`	String	Error code. Absent on a successful request.

Parking detail¶

GET /v1/parkings/{id}
x-carmoove-token: <token>

Correction made to the source PDF

The PDF documents the by-id parking endpoints in the singular (/v1/parking/{id}). The real router (router.go) registers them in the plural: /v1/parkings/{id} (GET, POST, DELETE). Corrected here for the three endpoints in this section and the following two.

Parameters¶

Field	Type	Description
`id`	String	Parking spot identifier.

Response¶

Field	Type	Description
`id`	String	Parking spot identifier.
`shortId`	String	Short parking spot identifier.
`name`	String	Parking spot name.
`address`	String	Parking spot address.
`address2`	String	Second address line of the parking spot.
`zipcode`	String	ZIP/postal code.
`city`	String	City.
`country`	String	Country.

Errors¶

NOT_FOUND — see Errors.

Updating a parking spot¶

POST /v1/parkings/{id}
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`id`	String	Parking spot identifier.
`name`	String	Parking spot name.
`address`	String	Parking spot address.
`address2`	String	Second address line.
`zipcode`	String	ZIP/postal code.
`city`	String	City.
`country`	String	Country.

Response¶

Same shape as Parking detail.

Errors¶

NOT_FOUND — see Errors.

Deleting a parking spot¶

DELETE /v1/parkings/{id}
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`id`	String	Parking spot identifier.

Response¶

Field	Type	Description
`deleted`	Boolean	`true` if the parking spot was successfully deleted.
`error`	String	Error code. Absent on a successful request.

Errors¶

NOT_FOUND — see Errors.

Assigning a parking spot to a vehicle¶

POST /v1/vehicle/{id}/parking
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`id`	String	Vehicle identifier.
`parkingId`	String	Parking spot identifier.

Response¶

Field	Type	Description
`updated`	Boolean	`true` if the update was successfully recorded.
`error`	String	Error code. Absent on a successful request.

Errors¶

MISSING_PARKING, UNKNOWN_VEHICLE — see Errors.

Getting a vehicle's parking spot¶

GET /v1/vehicle/{id}/parking
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`id`	String	Vehicle identifier.

Response¶

Same shape as Parking detail.

Errors¶

NO_PARKING, UNKNOWN_VEHICLE — see Errors.

Unassigning a parking spot from a vehicle¶

DELETE /v1/vehicle/{id}/parking
x-carmoove-token: <token>

Parameters¶

Field	Type	Description
`id`	String	Vehicle identifier.

Response¶

Field	Type	Description
`deleted`	Boolean	`true` if the removal was successfully recorded.
`error`	String	Error code. Absent on a successful request.

Errors¶

UNKNOWN_VEHICLE — see Errors.

SIV Data¶

Added in version 1.13.

Getting a vehicle's SIV data¶

GET /v1/vehicle/{id}/siv
x-carmoove-token: <token>

Note

The source PDF prints this route without the / separator (GET /v1/vehicle/{id}siv); this is a layout typo, corrected here. The real router confirms /v1/vehicle/{id}/siv.

Parameters¶

Field	Type	Description
`id`	String	Vehicle identifier.

Response¶

Field	Type	Description
`certificate`	Object	Data found on the registration certificate.
`additional_information`	Object	Additional data.
`fluids`	Object	Fluid-related data.
`electric`	Object	Data for electric vehicles.
`tires`	Array	Tire fitment data.
`error`	String	Error code. May be missing on a successful request.

Unless stated otherwise, all fields may be empty (String) or 0 (Number) when information is missing. The content of these objects is identical to that of the Static Data API, which exposes the same SIV data.

`certificate` object¶

Field name	Type	Description	Registration certificate field
`plate`	String	Vehicle license plate	A
`first_registration`	String	Date of first registration	B
`brand`	String	Vehicle brand	D.1
`type_variant_version`	String	Type, version, or variant of the car model	D.2
`cnit`	String	National type identification code	D.2.1
`model`	String	Commercial name	D.3
`VIN`	String	Vehicle identification number / VIN	E
`mass_f1`	Number	Maximum technically permissible laden mass	F.1
`mass_f2`	Number	Maximum technically permissible laden mass, except for motorcycles (in kg)	F.2
`mass_f3`	Number	Maximum permissible mass of the combination in service in the member state of registration (in kg)	F.3
`mass_g`	Number	Mass of the vehicle in service with bodywork and coupling device, for tractor vehicles other than category M1 (in kg)	G
`unload_weight`	Number	National unladen weight	G.1
`category`	String	Vehicle category	J
`national_type`	String	National type	J.1
`national_bodywork`	String	Bodywork — national designation	J.3
`reception_number`	String	Type approval number	K
`Displacement`	Number	Displacement in cm3	P.1
`max_net_power`	Number	Maximum net power (in kW)	P.2
`energy`	String	Fuel type or energy source	P.3
`administrative_power`	Number	National administrative power	P.6
`power_mass_ratio`	Number	Power/mass ratio in kW/kg (motorcycles only)	Q
`seats`	Number	Number of seats, including the driver's	S.1
`standing_places`	Number	Number of standing places	S.2
`sound_level`	Number	Stationary sound level (in dB [A])	U.1
`engine_speed`	Number	Engine speed (in min-1)	U.2
`co2`	Number	CO2 (in g/km)	V.7
`environmental_class`	String	EC type-approval environmental class	V.9
`certificate_date`	String	Registration certificate date	I

`additional_information` object¶

Field name	Type	Description
`color`	String	Vehicle color
`model`	String	Model name
`generation`	String	Model generation
`additional_model`	String	Additional data on the model name
`full_version`	String	Full version
`version`	String	Version
`cylinders_in_liters`	Number	Displacement (in liters)
`injection_label`	String	Injection
`injection_type`	String	Injection type
`valves`	Number	Number of valves
`horsepower`	Number	Power (in horsepower)
`bodywork`	String	Bodywork
`commercial_start_date`	String	Start of commercial availability date
`commercial_end_date`	String	End of commercial availability date
`phase`	String	Commercial phase
`doors`	Number	Number of doors
`engine_code`	String	Engine code
`transmission_type`	String	Transmission type
`euro_standard`	String	Euro standard
`particulate_filter`	Bool	Presence of a particulate filter
`adblue`	Bool	AdBlue
`gearbox_code`	String	Gearbox code
`gearbox_type`	String	Gearbox type
`gears`	Number	Number of gears
`crit_air`	String	Crit'Air sticker (France only)
`urban_co2`	Number	CO2 in urban mode (in g/km)
`extra_urban_co2`	Number	CO2 in extra-urban mode (in g/km)
`urban_fuel_consumption`	Number	Urban fuel consumption
`extra_urban_fuel_consumption`	Number	Extra-urban fuel consumption
`combined_fuel_consumption`	Number	Combined fuel consumption
`starter_battery_power`	Number	Starter battery power
`starter_battery_capacity`	Number	Starter battery capacity
`rear_braking_system`	String	Rear braking system
`rear_trunk_capacity`	Number	Rear trunk capacity (in liters)
`extended_rear_trunk_capacity`	Number	Extended rear trunk capacity (in liters)
`max_length`	Number	Maximum length
`combined_horse_power`	Number	Combined power
`wheel_drive`	String	Drive wheels
`front_axle_type`	String	Front suspension type
`rear_axle_type`	String	Rear suspension type

`fluids` object¶

Field name	Type	Description
`fuel_tank_capacity`	Number	Fuel tank capacity
`engine_oil_standard`	String	Engine oil standard
`engine_oil_acea`	String	ACEA standard
`engine_oil_viscosity`	String	Engine oil viscosity
`engine_oil_with_filter_capacity_min`	Number	Minimum engine oil capacity
`engine_oil_with_filter_capacity_max`	Number	Maximum engine oil capacity
`brake_fluid_capacity`	Number	Brake fluid capacity
`brake_fluid_standard`	String	Brake fluid standard
`engine_coolant_capacity_min`	Number	Minimum coolant capacity
`engine_coolant_capacity_max`	Number	Maximum coolant capacity
`engine_coolant_type`	String	Coolant type
`air_conditioning_gas_capacity_min`	Number	Minimum air conditioning gas capacity
`air_conditioning_gas_capacity_max`	Number	Maximum air conditioning gas capacity
`air_conditioning_gas_standard`	String	Air conditioning gas standard
`power_steering_fluid_capacity`	Number	Power steering fluid capacity
`power_steering_fluid_standard`	String	Power steering fluid standard

`electric` object¶

Field name	Type	Description
`front_engine_type`	String	Front engine type
`front_engine_kw_power`	Number	Front engine power (in kW)
`front_engine_horsepower`	Number	Front engine power (in horsepower)
`1st_rear_engine_type`	String	1st rear engine type
`1st_rear_engine_kw_power`	Number	1st rear engine power (in kW)
`1st_rear_engine_horsepower`	Number	1st rear engine power (in horsepower)
`2nd_rear_engine_type`	String	2nd rear engine type
`2nd_rear_engine_kw_power`	Number	2nd rear engine power (in kW)
`2nd_rear_engine_horsepower`	Number	2nd rear engine power (in horsepower)
`combined_kw_power`	Number	Combined power
`engine_cooling_type`	String	Engine cooling type
`front_engine_nm_torque`	Number	Front engine torque
`1st_rear_engine_nm_torque`	Number	1st rear engine torque
`2nd_rear_engine_nm_torque`	Number	2nd rear engine torque
`combined_nm_torque`	Number	Combined torque
`battery_weight`	Number	Battery weight
`battery_layout`	String	Battery position
`battery_type`	String	Battery type
`battery_voltage`	Number	Battery voltage
`battery_kw_power`	Number	Battery power
`1st_battery_kwh_capacity`	Number	1st battery capacity
`usable_1st_battery_kwh_capacity`	Number	1st battery usable capacity
`2nd_battery_kwh_capacity`	Number	2nd battery capacity
`usable_2nd_battery_kwh_capacity`	Number	2nd battery usable capacity
`charging_plug`	String	Charging plug
`dc_charger_power_kw`	Number	DC charger power
`dc_charging_time_min`	Number	Minimum DC charging time
`ac_charger_power_kw`	Number	AC charger power
`ac_charging_time_80_home_min`	Number	Time to charge to 80% at home (in minutes)
`ac_charging_time_80_home_reinforced_min`	Number	Time to charge to 80% with reinforced home charging (in minutes)
`ac_charging_time_80_wallbox_min`	Number	Time to charge to 80% at a charging station (in minutes)
`acceleration_0_100`	Number	0 to 100 km/h time
`max_speed`	Number	Maximum speed
`wltp_combined_autonomy_summer`	Number	Summer range (combined driving)
`wltp_combined_autonomy_winter`	Number	Winter range (combined driving)
`wltp_urban_autonomy_summer`	Number	Summer range (urban driving)
`wltp_urban_autonomy_winter`	Number	Winter range (urban driving)
`wltp_highway_autonomy_summer`	Number	Summer range (highway driving)
`wltp_highway_autonomy_winter`	Number	Winter range (highway driving)
`combined_consumption_kwh_100km_summer`	Number	Consumption per 100 km in summer (combined driving)
`combined_consumption_kwh_100km_winter`	Number	Consumption per 100 km in winter (combined driving)
`urban_consumption_kwh_100km_summer`	Number	Consumption per 100 km in summer (urban driving)
`urban_consumption_kwh_100km_winter`	Number	Consumption per 100 km in winter (urban driving)
`highway_consumption_kwh_100km_summer`	Number	Consumption per 100 km in summer (highway driving)
`highway_consumption_kwh_100km_winter`	Number	Consumption per 100 km in winter (highway driving)

`tires` object¶

This object (Array) contains data on tire fitments. Each element documents the front and rear tires.

Field name	Type	Description
`front_display`	String	Front tire reference
`front_width`	Number	Front tire width
`front_ratio`	Number	Front tire aspect ratio
`front_radial`	Number	Front tire rim diameter
`front_load`	Number	Front tire load index
`front_speed`	String	Front tire speed index
`front_normal_pressure`	Number	Front tire recommended pressure
`front_highway_pressure`	Number	Front tire recommended highway pressure
`front_is_summer`	Bool	Front summer tire
`front_is_winter`	Bool	Front winter tire
`front_is_all_season`	Bool	Front all-season tire
`rear_display`	String	Rear tire reference
`rear_width`	Number	Rear tire width
`rear_ratio`	Number	Rear tire aspect ratio
`rear_radial`	Number	Rear tire rim diameter
`rear_load`	Number	Rear tire load index
`rear_speed`	String	Rear tire speed index
`rear_normal_pressure`	Number	Rear tire recommended pressure
`rear_highway_pressure`	Number	Rear tire recommended highway pressure
`rear_is_summer`	Bool	Rear summer tire
`rear_is_winter`	Bool	Rear winter tire
`rear_is_all_season`	Bool	Rear all-season tire