> For the complete documentation index, see [llms.txt](https://docs.hiboo.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hiboo.io/rest-api-reference/mixed-fleet-data/snapshot.md).

# Snapshot

The following endpoints allow you to retrieve the last information available for all data kinds for a specific equipment or the entire fleet.

## Fleet

> Returns the last information available for all data kinds for the fleet. This endpoint is paginated.

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Snapshot","description":"The following endpoints allow you to retrieve the last information available for all data kinds for a specific equipment or the entire fleet."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"parameters":{"limit":{"name":"limit","in":"query","description":"The numbers of items to return","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":50}},"offset":{"name":"offset","in":"query","description":"The number of items to skip before starting to collect the result set","required":false,"schema":{"type":"integer","format":"int32","default":0}},"FilterByInProgressSharing":{"name":"filterByInProgressSharing","in":"query","description":"This parameter allows filtering the equipments based on whether the equipment is currently involved in an in-progress sharing process or not.","required":false,"schema":{"type":"integer"}}},"responses":{"SnapshotOfAllEquipments":{"description":"Snapshot of all devices","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"make":{"type":"string"},"model":{"type":"string"},"serialNumber":{"type":"string"},"pin":{"type":"string","nullable":true,"description":"Product Identification Number"},"vin":{"type":"string","nullable":true,"description":"Vehicle Identification Number"},"cumulativeDistance":{"type":"object","properties":{"date":{"format":"date-time","nullable":true,"type":"string"},"odometer":{"format":"float","nullable":true,"type":"number"}}},"cumulativeFuelUsed":{"type":"object","properties":{"date":{"type":"string","format":"date-time","nullable":true},"fuelUsed":{"type":"number","format":"float"}}},"fuelRemaining":{"type":"object","properties":{"date":{"type":"string","format":"date-time","nullable":true},"percent":{"type":"number","format":"float"}}},"cumulativeOperatingHours":{"type":"object","properties":{"date":{"format":"date-time","nullable":true,"type":"string"},"hour":{"format":"float","nullable":true,"type":"number"},"usageHours":{"description":"deprecated, is the same as hour.","format":"float","nullable":true,"type":"number"}}},"lastPosition":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date of the last position"},"latitude":{"type":"number","format":"float"},"longitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float","nullable":true,"description":"Altitude in meters above sea level"},"speed":{"type":"number","format":"float","nullable":true,"description":"Speed in kilometers per hour"},"heading":{"type":"number","format":"float","nullable":true,"description":"Heading/direction in degrees (0-360)"}}},"cumulativeLoadCount":{"type":"object","nullable":true,"properties":{"count":{"type":"integer","format":"int64"},"date":{"type":"string","format":"date-time"}}},"cumulativePayloadTotal":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"payload":{"type":"integer","format":"int64"}}},"cumulativeActiveRegenerationHours":{"type":"object","nullable":true,"properties":{"date":{"format":"date-time","nullable":true,"type":"string"},"hours":{"format":"int64","nullable":true,"type":"integer"}}},"cumulativePowerTakeOffHours":{"type":"object","nullable":true,"properties":{"date":{"format":"date-time","nullable":true,"type":"string"},"hours":{"format":"int64","nullable":true,"type":"integer"}}},"peakDailySpeed":{"type":"object","nullable":true,"properties":{"date":{"format":"date-time","nullable":true,"type":"string"},"speed":{"format":"float","nullable":true,"type":"number"}}},"averageDailyEngineLoadFactor":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"percent":{"type":"number","format":"float"}}},"DEFRemainingRatio":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"percent":{"type":"number","format":"float"}}},"cumulativeIdleHours":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"hours":{"format":"int64","nullable":true,"type":"integer"}}}}}}}}}}}}},"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}},"schemas":{"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}}}},"paths":{"/v2/fleet/equipments/snapshot":{"get":{"operationId":"getFleetEquipmentsSnapshot","summary":"Fleet","description":"Returns the last information available for all data kinds for the fleet. This endpoint is paginated.","tags":["Snapshot"],"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"name":"search","in":"query","description":"Optional - if provided it will return the equipment with a fleet number or serialNumber matching the parameter","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/FilterByInProgressSharing"}],"responses":{"200":{"$ref":"#/components/responses/SnapshotOfAllEquipments"},"401":{"$ref":"#/components/responses/401Error"}}}}}}
```

## Fleet following ISO 15143-3 (AEMP)

> Returns the list of all equipments and their latest data. This endpoint is paginated.

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Snapshot","description":"The following endpoints allow you to retrieve the last information available for all data kinds for a specific equipment or the entire fleet."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"parameters":{"FilterByInProgressSharing":{"name":"filterByInProgressSharing","in":"query","description":"This parameter allows filtering the equipments based on whether the equipment is currently involved in an in-progress sharing process or not.","required":false,"schema":{"type":"integer"}}},"responses":{"EquipmentsISO15143":{"description":"ISO 15143-3 Fleet Snapshot Response","content":{"application/json":{"schema":{"type":"object","required":["Equipment","Links","snapshotTime","version"],"properties":{"Equipment":{"type":"array","items":{"type":"object","properties":{"EquipmentHeader":{"type":"object","required":["SerialNumber"],"properties":{"UnitInstallDateTime":{"type":"string","nullable":true,"format":"date-time"},"OEMName":{"type":"string"},"Model":{"type":"string"},"EquipmentID":{"type":"string","nullable":true},"SerialNumber":{"type":"string"},"PIN":{"type":"string","nullable":true},"VIN":{"type":"string","nullable":true},"HibooID":{"type":"string"}}},"AverageLoadFactorLast24":{"type":"object","nullable":true,"properties":{"datetime":{"type":"string","format":"date-time"},"Percent":{"type":"number"}}},"Location":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time"},"Latitude":{"type":"number"},"Longitude":{"type":"number"},"Altitude":{"type":"number"},"AltitudeUnits":{"type":"string"}}},"CumulativeActiveRegenerationHours":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time"},"Hour":{"type":"number"}}},"CumulativeIdleHours":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time"},"Hour":{"type":"number"}}},"CumulativeIdleNonOperatingHours":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time"},"Hour":{"type":"number"}}},"CumulativeLoadCount":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time"},"Count":{"type":"number"}}},"CumulativeOperatingHours":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time"},"Hour":{"type":"number"}}},"CumulativePowerTakeOffHours":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time"},"Hour":{"type":"number"}}},"CumulativePayloadTotals":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time"},"PayloadUnits":{"type":"string"},"Payload":{"type":"number"}}},"DEFRemaining":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time"},"Percent":{"type":"number"},"DEFTankCapacityUnits":{"type":"string"},"DEFTankCapacity":{"type":"number"}}},"Distance":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time"},"OdometerUnits":{"type":"string"},"Odometer":{"type":"number"}}},"EngineStatus":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time"},"EngineNumber":{"type":"string","nullable":true},"Running":{"type":"boolean"}}},"FuelUsed":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time"},"FuelUnits":{"type":"string"},"FuelConsumed":{"type":"number"}}},"FuelUsedLast24":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time"},"FuelUnits":{"type":"string"},"FuelConsumed":{"type":"number"}}},"FuelRemaining":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time"},"Percent":{"type":"number"},"FuelTankCapacityUnits":{"type":"string"},"FuelTankCapacity":{"type":"number"}}},"MaximumSpeedLast24":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time"},"SpeedUnits":{"type":"string"},"Speed":{"type":"number"}}}}}},"Links":{"type":"array","items":{"type":"object","required":["rel","href"],"properties":{"rel":{"type":"string","enum":["self","prev","next","last"]},"href":{"type":"string","format":"uri"}}}},"snapshotTime":{"type":"string","format":"date-time"},"version":{"type":"number"}}}}}},"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}},"schemas":{"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}}}},"paths":{"/v2/iso15143-3/Fleet/{pageNumber}":{"get":{"operationId":"getFleetAEMP","summary":"Fleet following ISO 15143-3 (AEMP)","description":"Returns the list of all equipments and their latest data. This endpoint is paginated.","tags":["Snapshot"],"parameters":[{"name":"pageNumber","in":"path","description":"Page number to retrieve. The page number starts at 1.","required":true,"schema":{"type":"integer","format":"int32","default":1}},{"$ref":"#/components/parameters/FilterByInProgressSharing"}],"responses":{"200":{"$ref":"#/components/responses/EquipmentsISO15143"},"401":{"$ref":"#/components/responses/401Error"}}}}}}
```

## Equipment

> Returns the last information available for all data kinds for specific equipment

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Snapshot","description":"The following endpoints allow you to retrieve the last information available for all data kinds for a specific equipment or the entire fleet."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"responses":{"SnapshotOfSpecificEquipment":{"description":"Latest snapshot of the machine","content":{"application/json":{"schema":{"description":"Snapshot of the specified device for all kinds","properties":{"data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"make":{"type":"string"},"model":{"type":"string"},"serialNumber":{"type":"string"},"pin":{"type":"string","nullable":true,"description":"Product Identification Number"},"vin":{"type":"string","nullable":true,"description":"Vehicle Identification Number"},"lastPosition":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date of the last position"},"latitude":{"type":"number","format":"float"},"longitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float","nullable":true,"description":"Altitude in meters above sea level"},"speed":{"type":"number","format":"float","nullable":true,"description":"Speed in kilometers per hour"},"heading":{"type":"number","format":"float","nullable":true,"description":"Heading/direction in degrees (0-360)"}}},"cumulativeOperatingHours":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date of the last position","nullable":true},"hour":{"nullable":true,"type":"number","format":"float"}}},"cumulativeDistance":{"type":"object","properties":{"date":{"type":"string","format":"date-time","nullable":true},"odometer":{"nullable":true,"type":"number","format":"float"},"unit":{"type":"string"}}},"cumulativeFuelUsed":{"type":"object","properties":{"date":{"type":"string","format":"date-time","nullable":true},"fuelUsed":{"type":"number","format":"float"},"unit":{"type":"string"}}},"cumulativeLoadCount":{"type":"object","nullable":true,"properties":{"count":{"type":"integer","format":"int64"},"date":{"type":"string","format":"date-time"}}},"cumulativePayloadTotal":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"payload":{"type":"integer","format":"int64"}}},"cumulativeActiveRegenerationHours":{"type":"object","nullable":true,"properties":{"date":{"format":"date-time","nullable":true,"type":"string"},"hours":{"format":"int64","nullable":true,"type":"integer"}}},"cumulativePowerTakeOffHours":{"type":"object","nullable":true,"properties":{"date":{"format":"date-time","nullable":true,"type":"string"},"hours":{"format":"int64","nullable":true,"type":"integer"}}},"peakDailySpeed":{"type":"object","nullable":true,"properties":{"date":{"format":"date-time","nullable":true,"type":"string"},"speed":{"format":"float","nullable":true,"type":"number"}}},"averageDailyEngineLoadFactor":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"percent":{"type":"number","format":"float"}}},"DEFRemainingRatio":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"percent":{"type":"number","format":"float"}}},"cumulativeIdleHours":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"hours":{"format":"int64","nullable":true,"type":"integer"}}},"fuelRemaining":{"type":"object","properties":{"date":{"type":"string","format":"date-time","nullable":true},"percent":{"type":"number","format":"float"}}},"engineCondition":{"type":"object","properties":{"date":{"type":"string","format":"date-time","nullable":true},"running":{"type":"boolean"}}},"nextMaintenance":{"type":"object","properties":{"date":{"type":"string","format":"date-time","nullable":false},"nextMaintenanceDate":{"type":"string","format":"date-time","nullable":true},"usageHoursUntilNextMaintenance":{"type":"number","format":"float","nullable":true},"kmUntilNextMaintenance":{"type":"number","format":"float","nullable":true}}},"evBatteryLevel":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"percent":{"type":"number","format":"float"}}},"evBatteryTemperature":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"celsius":{"type":"number","format":"float"}}},"evBatteryHealth":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"percent":{"type":"number","format":"float"}}},"evBatteryVoltage":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"volts":{"type":"number","format":"float"}}},"evBatteryChargingState":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"state":{"type":"string"},"chargingMode":{"type":"string"}}},"evBatteryCurrent":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"amperes":{"type":"number","format":"float"}}},"evChargingRate":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"watts":{"type":"number","format":"float"}}},"evDischargingRate":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"watts":{"type":"number","format":"float"}}},"evBatteryChargeCyclesCount":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"count":{"type":"integer","format":"int64"}}},"evEnergyUsed":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"wattHours":{"type":"number","format":"float"}}},"evEnergyCharged":{"type":"object","nullable":true,"properties":{"date":{"type":"string","format":"date-time"},"wattHours":{"type":"number","format":"float"}}}}}}}}}},"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}},"schemas":{"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}}}},"paths":{"/v2/fleet/equipments/{id}/snapshot":{"get":{"operationId":"getFleetEquipmentSnapshotByEquipmentId","summary":"Equipment","description":"Returns the last information available for all data kinds for specific equipment","tags":["Snapshot"],"parameters":[{"name":"id","in":"path","description":"ID of the equipment","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"$ref":"#/components/responses/SnapshotOfSpecificEquipment"},"401":{"$ref":"#/components/responses/401Error"}}}}}}
```