Vehicles

The following endpoints describe the use case of fetching vehicles that can be rented during operating hours.

Note that this endpoint still uses non-json-api compatible layout for backwards compatibility.

Vehicle Types

The TIER API version 2 provides 3 vehicle types:

escooter
emoped
ebicycle

ℹ Starting a rental with vehicle type e-moped (available on version 2) is only possible if the user has a valid driver license. You need to provide that info via a Boolean in the customerInfo. See the documentation of starting rentals for more details.

ℹ At 100% battery charge, the emoped can go ~50 km. Please keep in mind, that TIER does not allow rental starts below 10-15% to avoid deep discharge of the vehicle.

UUID and vehicle code

The UUID is identifier asserted to a variety of elements, e.g. vehicles or rentals to bind and convey information as the current location or battery level within our services. It is used for all tech-side information transfer and guaranteed to be unique.

The vehicle code on the other hand is a human readable identifier that is generated when entering a new scooter into our system. It is both mounted to the vehicle bar and inside the QR code. When retrieving a vehicle by this code, a UUID is generated for this request that does not only entail the vehicle code but also other live data.

The URL format encoded in the QR code is as follows:

https://tier.app/XXXXXXXX

with XXXXXXXX representing the vehicle type, vehicle model and vehicle code (2 letters, 4 digits).

A sample eScooter QR code URL: https://tier.app/AB246859

UUID example: 0160376e-d00a-4d47-8419-81c47c8855f3
Vehicle code example: 10050

Get All available Vehicles in a Zone

This endpoint retrieves all the vehicles which are currently available for rent. You must provide a zoneId to retrieve vehicles.

The vehicle type emoped is included in /v2/vehicle , however not in /v1/vehicle .

For v1/vehicle , please refer to the version 1 documentation.

ℹ Your API key may be limited to getting vehicles in certain zones only.

ℹ The fields hasHelmetBox and hasHelmet only contain relevant information for vehicles of the type escooter . For emopeds they are always contain the value false

HTTP Request

GET https://platform.tier-services.io/v2/vehicle?zoneId=BERLIN

Query Parameters

Parameter	Description	Property
zoneId	The Zone ID of the zone within which the vehicles are located
type	List of vehicle types to filter out vehicles. Possible values escooter, emoped

curl "https://platform.tier-services.io/v2/vehicle?zoneId=BERLIN"
  -H "x-api-key: TIER API KEY"

Click to expand JSON data response

{
    "data": [
        {
            "type": "vehicle",
            "id": "f55c8951-4c7d-40cc-9f59-6d7e3bd43025",
            "attributes": {
                "state": "ACTIVE",
                "lastLocationUpdate": "2020-06-19T11:23:06Z",
                "lastStateChange": "2020-06-12T09:32:14Z",
                "batteryLevel": 29,
                "lat": 52.548977,
                "lng": 13.437837,
                "maxSpeed": 20,
                "zoneId": "BERLIN",
                "code": 230208,
                "iotVendor": "okai",
                "licencePlate": "693WVE",
                "isRentable": true,
                "vehicleType": "escooter",
                "hasHelmetBox": false,
                "hasHelmet": false
            }
        },
				{
            "type": "vehicle",
            "id": "fb5a81ed-bd72-4c51-82f7-d03d0b17d4fe",
            "attributes": {
                "state": "ACTIVE",
                "lastLocationUpdate": "2020-06-19T11:30:41Z",
                "lastStateChange": "2020-06-07T22:48:33Z",
                "batteryLevel": 25,
                "lat": 52.550323,
                "lng": 13.435075,
                "maxSpeed": 20,
                "zoneId": "BERLIN",
                "code": 510322,
                "iotVendor": "invers",
                "licencePlate": "283JER",
                "isRentable": true,
                "vehicleType": "emoped",
                "hasHelmetBox": false,
                "hasHelmet": false
            }
        },

Get All available Vehicles within a Range

This endpoint gets vehicles by geolocation (latitude and longitude). Vehicles can be from multiple zones in this mode, so you can also filter by zone at the same time (recommended).

HTTP Request

GET https://platform.tier-services.io/v2/vehicle?lat=48.1&lng=16.3&radius=5000

Copy of Query Parameters

Parameter	Description
lat	Latitude to search for vehicles within a given radius
lng	Longitude to search for vehicles within a given radius
radius	Radius in meter
isRentable	If vehicles are possibly reserved or the rental is paused, they are temporarily not rentable

curl "https://platform.tier-services.io/v2/vehicle?lat=48.1&lng=16.3&radius=5000"
  -H "x-api-key: TIER API KEY"

Click to expand JSON data response

{
    "data": [
        {
            "type": "vehicle",
            "id": "f55c8951-4c7d-40cc-9f59-6d7e3bd43025",
            "attributes": {
                "state": "ACTIVE",
                "lastLocationUpdate": "2020-06-19T11:23:06Z",
                "lastStateChange": "2020-06-12T09:32:14Z",
                "batteryLevel": 29,
                "lat": 52.548977,
                "lng": 13.437837,
                "maxSpeed": 20,
                "zoneId": "BERLIN",
                "code": 230208,
                "iotVendor": "okai",
                "licencePlate": "693WVE",
                "isRentable": true,
                "vehicleType": "escooter",
                "hasHelmetBox": false,
                "hasHelmet": false
            }
        },
				{
            "type": "vehicle",
            "id": "fb5a81ed-bd72-4c51-82f7-d03d0b17d4fe",
            "attributes": {
                "state": "ACTIVE",
                "lastLocationUpdate": "2020-06-19T11:30:41Z",
                "lastStateChange": "2020-06-07T22:48:33Z",
                "batteryLevel": 25,
                "lat": 52.550323,
                "lng": 13.435075,
                "maxSpeed": 20,
                "zoneId": "BERLIN",
                "code": 510322,
                "iotVendor": "invers",
                "licencePlate": "283JER",
                "isRentable": true,
                "vehicleType": "emoped",
                "hasHelmetBox": false,
                "hasHelmet": false
            }
        },