Equipment Data

You can find more information on how to use this API

Authenticate on the API

POSThttps://api.hiboo.io/login

Body

application/json

namestring

Example: "api_company"

apiKeystring

Example: "2ddd4027-c779-4b7c-80fe-8661c92c35ff"

Response

200401

Token to use in the other API calls

Body

application/json

idinteger

Example: 42

emailstring

Example: "[e-mail]"

adminboolean

Example: false

firstNamestring

Example: "John"

lastNamestring

Example: "Doe"

tokenstring

Example: "eyJhbGciOiJIfkdFVHUREIsInR5cCI6IkpXVCJ9.xxXxXXX6OXXxXxxxx3XxXXXXXx6XxXxXxxxxXX6XXX3Xxx2XxX5OXwiXXxxXxxxXXx0XxX2Xxx4xX.Ylm61gfwIgGx2bQLjtq4UkqF1MOak9y8REsVfn1GtoQ"

Request

JavaScriptCurlPython

const response = await fetch('https://api.hiboo.io/login', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": 42,
  "email": "[e-mail]",
  "admin": false,
  "firstName": "John",
  "lastName": "Doe",
  "token": "eyJhbGciOiJIfkdFVHUREIsInR5cCI6IkpXVCJ9.xxXxXXX6OXXxXxxxx3XxXXXXXx6XxXxXxxxxXX6XXX3Xxx2XxX5OXwiXXxxXxxxXXx0XxX2Xxx4xX.Ylm61gfwIgGx2bQLjtq4UkqF1MOak9y8REsVfn1GtoQ"
}

Fleet

Returns the list of all equipments and their identity

GEThttps://api.hiboo.io/v2/fleet/equipments

Query parameters

Response

200401

List of equipment

Body

application/json

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.hiboo.io/v2/fleet/equipments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": {
    "total": 1,
    "rows": [
      {
        "id": 1,
        "name": "D8000-1",
        "make": "Caterpillar",
        "model": "8000",
        "serialNumber": "YVR001988",
        "workspaces": [
          [
            "Workspace 1",
            "Workspace 2"
          ]
        ],
        "customFields": [
          {
            "name": "Custom Field 1",
            "value": "Value 1"
          }
        ]
      }
    ]
  }
}

Equipment Daily History

Returns the details of single machine and its history (positions, daily usages, fault codes)

GEThttps://api.hiboo.io/v2/fleet/equipments/{id}/history

Path parameters

id*integer (int64)

ID of the equipment

Query parameters

Response

200401

Specific equipment details with its history

Body

application/json

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.hiboo.io/v2/fleet/equipments/{id}/history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": {
    "id": 1,
    "name": "D8000-1",
    "make": "Caterpillar",
    "model": "8000",
    "serialNumber": "YVR001988",
    "positions": {
      "total": 1,
      "rows": [
        {
          "latitude": 48.858269,
          "longitude": 2.29447,
          "date": "2024-10-22T00:32:57.229Z"
        }
      ]
    },
    "faultCodes": {
      "total": 1,
      "rows": [
        {
          "levelLabel": "unknown",
          "severity": -1,
          "identifier": "text",
          "description": "text",
          "date": "2024-10-22T00:32:57.229Z"
        }
      ]
    },
    "fuelRemainings": {
      "total": 1,
      "rows": [
        {
          "percent": 88.24,
          "date": "2024-10-22T00:32:57.229Z"
        }
      ]
    },
    "engineConditions": {
      "total": 1,
      "rows": [
        {
          "running": false,
          "date": "2024-10-22T00:32:57.229Z"
        }
      ]
    },
    "dailyUsages": {
      "total": 1,
      "rows": [
        {
          "date": "2024-10-22T00:32:57.229Z",
          "operatingHours": {
            "hour": 8.3
          },
          "idleHours": {
            "hour": 1.5
          },
          "workingHours": {
            "hour": 6.8
          },
          "fuelUsed": {
            "fuelUsed": 99.7,
            "unit": "L"
          },
          "dailyDistance": {
            "odometer": 54.2,
            "unit": "km"
          },
          "cumulativeIdleHours": {
            "hour": 1064.6
          },
          "cumulativeOperatingHours": {
            "hour": 1064.6
          },
          "cumulativeFuelUsed": {
            "fuelUsed": 9520.5,
            "unit": "L"
          },
          "cumulativeDistance": {
            "odometer": 5423.9,
            "unit": "km"
          },
          "cumulativeLoadCount": {
            "count": 13569
          },
          "cumulativePayloadTotal": {
            "payload": 447839.9,
            "payloadUnit": "tonnes"
          },
          "cumulativeActiveRegenerationHours": {
            "hour": 10.92
          },
          "cumulativePowerTakeOffHours": {
            "hour": 31.21
          },
          "peakDailySpeed": {
            "speed": 14.91,
            "speedUnit": "km/h"
          },
          "averageDailyEngineLoadFactor": {
            "percent": 35.9
          },
          "DEFRemainingRatio": {
            "percent": 62,
            "tankCapacity": 41,
            "tankCapacityUnit": "L"
          },
          "co2": {
            "weight": 123,
            "unit": "kg"
          }
        }
      ]
    }
  }
}

Fleet

Returns the last information available for all data kinds for the fleet

GEThttps://api.hiboo.io/v2/fleet/equipments/snapshot

Query parameters

Response

200401

Snapshot of all devices

Body

application/json

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.hiboo.io/v2/fleet/equipments/snapshot', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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": "2024-10-22T00:32:57.229Z",
          "percent": 88.24
        },
        "DEFRemainingRatio": {
          "date": "2024-10-22T00:32:57.229Z",
          "percent": 58.24
        },
        "cumulativeIdleHours": {
          "date": "2024-10-22T00:32:57.229Z",
          "hours": 12
        }
      }
    ]
  }
}

Equipment

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

GEThttps://api.hiboo.io/v2/fleet/equipments/{id}/snapshot

Path parameters

id*integer (int64)

ID of the equipment

Response

200401

JSON object containing the snapshot of the equipment

Body

application/json

object

SnapshotOfSpecificEquipment (object)SnapshotOfTheEquipmentForSpecificDate (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.hiboo.io/v2/fleet/equipments/{id}/snapshot', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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": "2024-10-22T00:32:57.229Z",
      "percent": 88.24
    },
    "DEFRemainingRatio": {
      "date": "2024-10-22T00:32:57.229Z",
      "percent": 58.24
    },
    "cumulativeIdleHours": {
      "date": "2024-10-22T00:32:57.229Z",
      "hours": 12
    },
    "fuelRemaining": {
      "date": "2019-11-06T00:00:00Z",
      "percent": 65.5
    },
    "engineCondition": {
      "date": "2019-11-06T00:00:00Z",
      "running": true
    }
  }
}

History of a data kind for a specific equipment

Returns all data available for one dataKind for specific equipment. It's the time series mindset of the ISO/AEMP standard.

GEThttps://api.hiboo.io/v2/fleet/equipments/{id}/{dataKind}

Path parameters

id*integer (int64)

ID of the equipment

dataKind*string

Any of data kinds (positions, cumulativeDistance, cumulativeOperatingHours, dailyUsages, cumulativeIdleHours, cumulativeLoadCount, cumulativePayloadTotal, averageDailyEngineLoadFactor, cumulativePowerTakeOffHours, cumulativeActiveRegenerationHours, engineCondition, activities, peakDailySpeed, cumulativeFuel, defRemainingRatio, fuelRemaining, faults, dailyCO2, engineCoolantTemperature, engineLoadPercentage, sensorBoolean)

Query parameters

Response

200401

Snapshot of all devices

Body

application/json

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.hiboo.io/v2/fleet/equipments/{id}/{dataKind}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": {
    "total": 1,
    "rows": [
      {
        "percent": 88.24,
        "date": "2024-10-22T00:32:57.229Z"
      }
    ],
    "id": 1,
    "serialNumber": "YVR001988",
    "since": "2019-11-06T00:00:00Z",
    "until": "2019-11-20T23:59:59Z"
  }
}