Skip to main content

Vehicle

Look up vehicles available for rental — by zone, by 4-letter code, or by id.

The vehicle model​

Vehicle endpoints respond with the model below (wrapped in a data array).

{
  "data": [
    {
      "type": "vehicle",
      "vehicle_type": "scooter",
      "id": "12345678-1337-abcd-1234-1234abcd0001",
      "attributes": {
        "batteryLevel": 95,
        "location": { "latitude": 47.213553, "longitude": 17.382606 },
        "code": "L33T",
        "zoneId": "145",
        "locked": true,
        "status": "ready",
        "maxRangeMeters": 80000
      },
      "price": { "currency": "EUR", "pricePerMinute": 15, "startPrice": 100, "vat": 0.25 }
    }
  ]
}
FieldTypeDescription
idstringThe vehicle's id (UUID v4).
typestringAlways vehicle.
vehicle_typestringscooter or bicycle.
batteryLevelintegerState of charge, in percent (0–100).
locationobjectThe vehicle's latitude/longitude.
codestringThe 4-letter alphanumeric code, shown on the vehicle and as a QR code.
zoneIdstringThe zone the vehicle operates in.
lockedbooleanLock status of the vehicle.
statusstringAvailability: ready, riding, booked or unavailable.
maxRangeMetersintegerMaximum range, in meters, for this vehicle type.
priceobjectThe vehicle's price — see below.

Price — pricePerMinute and startPrice are incl. VAT and in minor units; vat is the VAT percentage; currency is the ISO 4217 code.