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

get

https://api.hiboo.iohttps://api-sandbox.hiboo.io

/v2/fleet/equipments/snapshot

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

Authorizations

JWT

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Query parameters

limitinteger · int64 · max: 50Optional

The numbers of items to return

Default: 20

offsetinteger · int64Optional

The number of items to skip before starting to collect the result set

Default: 0

searchstringOptional

Optional - if provided it will return the equipment with a fleet number or serialNumber matching the parameter

filterByInProgressSharingintegerOptional

This parameter allows filtering the equipments based on whether the equipment is currently involved in an in-progress sharing process or not.

Example: {"value":0,"summary":"Filter by not in progress sharing"}

Responses

200

Snapshot of all devices

application/json

401

Unable to authenticate the token

application/json

get

/v2/fleet/equipments/snapshot

HTTPcURLJavaScriptPython

GET /v2/fleet/equipments/snapshot HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "data": {
    "total": 1,
    "rows": [
      {
        "id": 1,
        "name": "D8000-1",
        "make": "Caterpillar",
        "model": "8000",
        "serialNumber": "YVR001988",
        "cumulativeDistance": {
          "date": "2019-11-06T00:00:00Z",
          "odometer": 54.2
        },
        "cumulativeFuelUsed": {
          "date": "2019-11-06T00:00:00Z",
          "fuelUsed": 9520.5
        },
        "fuelRemaining": {
          "date": "2019-11-06T00:00:00Z",
          "percent": 65.5
        },
        "cumulativeOperatingHours": {
          "date": "2019-11-06T00:00:00Z",
          "hour": 1.5,
          "usageHours": 1.5
        },
        "lastPosition": {
          "date": "2019-11-06T00:00:00Z",
          "latitude": 48.858269,
          "longitude": 2.29447
        },
        "cumulativeLoadCount": {
          "count": 1,
          "date": "2019-11-06T00:00:00Z"
        },
        "cumulativePayloadTotal": {
          "date": "2019-11-06T00:00:00Z",
          "payload": 1
        },
        "cumulativeActiveRegenerationHours": {
          "date": "2019-11-06T00:00:00Z",
          "hours": 15
        },
        "cumulativePowerTakeOffHours": {
          "date": "2019-11-06T00:00:00Z",
          "hours": 12
        },
        "peakDailySpeed": {
          "date": "2019-11-06T00:00:00Z",
          "speed": 100.5
        },
        "averageDailyEngineLoadFactor": {
          "date": "2026-01-30T19:15:18.018Z",
          "percent": 88.24
        },
        "DEFRemainingRatio": {
          "date": "2026-01-30T19:15:18.018Z",
          "percent": 58.24
        },
        "cumulativeIdleHours": {
          "date": "2026-01-30T19:15:18.018Z",
          "hours": 12
        }
      }
    ]
  }
}

Fleet following ISO 15143-3 (AEMP)

get

https://api.hiboo.iohttps://api-sandbox.hiboo.io

/v2/iso15143-3/Fleet/{pageNumber}

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

Authorizations

JWT

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

pageNumberinteger · int64Required

Page number to retrieve. The page number starts at 1.

Default: 1

Query parameters

filterByInProgressSharingintegerOptional

This parameter allows filtering the equipments based on whether the equipment is currently involved in an in-progress sharing process or not.

Example: {"value":0,"summary":"Filter by not in progress sharing"}

Responses

200

ISO 15143-3 Fleet Snapshot Response

application/json

401

Unable to authenticate the token

application/json

get

/v2/iso15143-3/Fleet/{pageNumber}

HTTPcURLJavaScriptPython

GET /v2/iso15143-3/Fleet/{pageNumber} HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "Equipment": [
    {
      "EquipmentHeader": {
        "UnitInstallDateTime": "2024-01-15T10:30:00Z",
        "OEMName": "Caterpillar",
        "Model": "320D",
        "EquipmentID": "EX001",
        "SerialNumber": "ABC123456",
        "PIN": "12345678901234567",
        "VIN": "1HGBH41JXMN109186",
        "HibooID": "123"
      },
      "AverageLoadFactorLast24": {
        "datetime": "2024-01-15T10:30:00Z",
        "Percent": 75.5
      },
      "Location": {
        "datetime": "2024-01-15T10:30:00Z",
        "Latitude": 45.424721,
        "Longitude": -75.695,
        "Altitude": 100.5,
        "AltitudeUnits": "metre"
      },
      "CumulativeActiveRegenerationHours": {
        "datetime": "2024-01-15T10:30:00Z",
        "Hour": 1250.5
      },
      "CumulativeIdleHours": {
        "datetime": "2024-01-15T10:30:00Z",
        "Hour": 500.25
      },
      "CumulativeIdleNonOperatingHours": {
        "datetime": "2024-01-15T10:30:00Z",
        "Hour": 500.25
      },
      "CumulativeLoadCount": {
        "datetime": "2024-01-15T10:30:00Z",
        "Count": 1250
      },
      "CumulativeOperatingHours": {
        "datetime": "2024-01-15T10:30:00Z",
        "Hour": 2500.75
      },
      "CumulativePowerTakeOffHours": {
        "datetime": "2024-01-15T10:30:00Z",
        "Hour": 150.5
      },
      "CumulativePayloadTotals": {
        "datetime": "2024-01-15T10:30:00Z",
        "PayloadUnits": "kilogram",
        "Payload": 15000.5
      },
      "DEFRemaining": {
        "datetime": "2024-01-15T10:30:00Z",
        "Percent": 85.2,
        "DEFTankCapacityUnits": "litre",
        "DEFTankCapacity": 50
      },
      "Distance": {
        "datetime": "2024-01-15T10:30:00Z",
        "OdometerUnits": "kilometre",
        "Odometer": 125000.5
      },
      "EngineStatus": {
        "datetime": "2024-01-15T10:30:00Z",
        "EngineNumber": "ENG001",
        "Running": true
      },
      "FuelUsed": {
        "datetime": "2024-01-15T10:30:00Z",
        "FuelUnits": "litre",
        "FuelConsumed": 15000.25
      },
      "FuelUsedLast24": {
        "datetime": "2024-01-15T10:30:00Z",
        "FuelUnits": "litre",
        "FuelConsumed": 125.5
      },
      "FuelRemaining": {
        "datetime": "2024-01-15T10:30:00Z",
        "Percent": 65.8,
        "FuelTankCapacityUnits": "litre",
        "FuelTankCapacity": 500
      },
      "MaximumSpeedLast24": {
        "datetime": "2024-01-15T10:30:00Z",
        "SpeedUnits": "kilometres per hour",
        "Speed": 45.5
      }
    }
  ],
  "Links": [
    {
      "rel": "self",
      "href": "https://api.example.com/v2/iso15143-3/Fleet/1"
    }
  ],
  "snapshotTime": "2024-01-15T10:30:00Z",
  "version": 1
}

Equipment

get

https://api.hiboo.iohttps://api-sandbox.hiboo.io

/v2/fleet/equipments/{id}/snapshot

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

Authorizations

JWT

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

idinteger · int64Required

ID of the equipment

Responses

200

Latest snapshot of the machine

application/json

401

Unable to authenticate the token

application/json

get

/v2/fleet/equipments/{id}/snapshot

HTTPcURLJavaScriptPython

GET /v2/fleet/equipments/{id}/snapshot HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "name": "CAT - 5",
    "make": "Caterpillar",
    "model": "816K",
    "serialNumber": "XICWITIDLXSX",
    "lastPosition": {
      "date": "2019-11-06T00:00:00Z",
      "latitude": 48.858269,
      "longitude": 2.29447
    },
    "cumulativeOperatingHours": {
      "date": "2019-11-06T00:00:00Z",
      "hour": 1.5
    },
    "cumulativeDistance": {
      "date": "2019-11-06T00:00:00Z",
      "odometer": 54.2,
      "unit": "km"
    },
    "cumulativeFuelUsed": {
      "date": "2019-11-06T00:00:00Z",
      "fuelUsed": 9520.5,
      "unit": "L"
    },
    "cumulativeLoadCount": {
      "count": 1,
      "date": "2019-11-06T00:00:00Z"
    },
    "cumulativePayloadTotal": {
      "date": "2019-11-06T00:00:00Z",
      "payload": 1
    },
    "cumulativeActiveRegenerationHours": {
      "date": "2019-11-06T00:00:00Z",
      "hours": 15
    },
    "cumulativePowerTakeOffHours": {
      "date": "2019-11-06T00:00:00Z",
      "hours": 12
    },
    "peakDailySpeed": {
      "date": "2019-11-06T00:00:00Z",
      "speed": 100.5
    },
    "averageDailyEngineLoadFactor": {
      "date": "2026-01-30T19:15:18.018Z",
      "percent": 88.24
    },
    "DEFRemainingRatio": {
      "date": "2026-01-30T19:15:18.018Z",
      "percent": 58.24
    },
    "cumulativeIdleHours": {
      "date": "2026-01-30T19:15:18.018Z",
      "hours": 12
    },
    "fuelRemaining": {
      "date": "2019-11-06T00:00:00Z",
      "percent": 65.5
    },
    "engineCondition": {
      "date": "2019-11-06T00:00:00Z",
      "running": true
    },
    "nextMaintenance": {
      "date": "2019-11-06T00:00:00Z",
      "nextMaintenanceDate": "2019-11-06T00:00:00Z",
      "usageHoursUntilNextMaintenance": 505,
      "kmUntilNextMaintenance": 1250
    },
    "evBatteryLevel": {
      "date": "2026-01-30T19:15:18.018Z",
      "percent": 76.5
    },
    "evBatteryTemperature": {
      "date": "2026-01-30T19:15:18.018Z",
      "celsius": 35.2
    },
    "evBatteryHealth": {
      "date": "2026-01-30T19:15:18.018Z",
      "percent": 92.3
    },
    "evBatteryVoltage": {
      "date": "2026-01-30T19:15:18.018Z",
      "volts": 400.5
    },
    "evBatteryChargingState": {
      "date": "2026-01-30T19:15:18.018Z",
      "state": "charging",
      "chargingMode": "ac"
    },
    "evBatteryCurrent": {
      "date": "2026-01-30T19:15:18.018Z",
      "amperes": 150
    },
    "evBatteryChargeCyclesCount": {
      "date": "2026-01-30T19:15:18.018Z",
      "count": 250
    },
    "evEnergyUsed": {
      "date": "2026-01-30T19:15:18.018Z",
      "wattHours": 45000
    },
    "evEnergyCharged": {
      "date": "2026-01-30T19:15:18.018Z",
      "wattHours": 50000
    }
  }
}