> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/readings.md).

# Sensor readings

The last value of every sensor, state field and counter on a tracker, in one call.

These two operations return the last value of everything a tracker measures: metering sensors, discrete inputs, state fields, virtual sensors, and counters, together in one response.

This is the broadest of the reading calls. Where `get_fuel`, `get_readings`, and `get_diagnostics` each cover one slice, `readings/list` covers all of them at once and adds virtual sensors and counters on top. Filtering by `sensor_type` narrows it to matching sensors and drops the state values and counters entirely.

Sensor types are listed under [metering sensor types](/docs/navixy-api/user-api/resources/tracking/tracker/sensor.md#metering-sensor-type-values) and [virtual sensor types](/docs/navixy-api/user-api/resources/tracking/tracker/sensor.md#virtual-sensor-type-values). For a worked example, see [how to retrieve sensor and counter data](/docs/navixy-api/user-api/guides/data-retrieval/sensor-data.md).

## Readings batch object

The `result` object of `readings/batch_list` maps each tracker ID to one readings object:

## The TrackerReadings object

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"components":{"schemas":{"TrackerReadings":{"type":"object","description":"Everything a tracker last reported: metering sensors, state fields, virtual sensors and counters.","properties":{"inputs":{"type":"array","description":"Metering sensor readings.","items":{"$ref":"#/components/schemas/SensorReading"}},"states":{"type":"array","description":"State field values.","items":{"$ref":"#/components/schemas/StateReading"}},"virtual_sensors":{"type":"array","description":"Virtual sensor readings.","items":{"$ref":"#/components/schemas/VirtualSensorReading"}},"counters":{"type":"array","description":"Counter values.","items":{"$ref":"#/components/schemas/CounterValue"}}}},"SensorReading":{"type":"object","description":"The last reading of one metering sensor.","properties":{"sensor_id":{"type":"integer","description":"Sensor ID."},"value":{"type":"number","description":"The reading."},"label":{"type":"string","description":"Sensor label."},"units":{"type":"string","description":"Units the value is measured in."},"name":{"type":"string","description":"Raw input name behind the sensor."},"type":{"type":"string","description":"Metering sensor type."},"units_type":{"type":"string","description":"Unit of measurement of the sensor input."},"update_time":{"type":"string","description":"When the value was last updated."},"min_value":{"type":"number","description":"Lower bound of the sensor range. Present for sensors that declare one."},"max_value":{"type":"number","description":"Upper bound of the sensor range. Present for sensors that declare one."},"converted_units_type":{"type":["string","null"],"description":"Units the value was converted into for the account's measurement system, or null when no conversion was needed."},"converted_value":{"type":["number","null"],"description":"The converted value, or null when no conversion was needed."},"composite_sensor_ids":{"type":"array","description":"IDs of composite sensors this one feeds into. Present only when it feeds any.","items":{"type":"integer"}}}},"StateReading":{"type":"object","description":"The last value of one state field.","properties":{"field":{"type":"string","description":"State field name."},"value":{"description":"The value. Its type follows the field and may be string, number, boolean or null."},"update_time":{"type":"string","description":"When the value was last updated."}}},"VirtualSensorReading":{"type":"object","description":"The last reading of one virtual sensor.","properties":{"sensor_id":{"type":"integer","description":"Virtual sensor ID."},"label":{"type":"string","description":"Sensor label."},"value":{"type":"string","description":"The reading, always a string for virtual sensors."},"type":{"type":"string","description":"Virtual sensor type."},"update_time":{"type":"string","description":"When the value was last updated."}}},"CounterValue":{"type":"object","description":"The last known value of one counter.","properties":{"type":{"type":"string","description":"Which counter this is.","enum":["odometer","engine_hours"]},"value":{"type":"number","description":"The counter value."},"update_time":{"type":"string","description":"When the value was last updated."}}}}}}
```

## API actions

API base path: `/tracker/readings`.

***

## Read all sensor values

> Get the last value of every sensor, state field and counter on a tracker. This is the broadest of the reading calls: unlike \`get\_fuel\`, \`get\_readings\` and \`get\_diagnostics\`, it covers CAN, OBD and fuel together and adds virtual sensors and counters. Reachable from a geo link session.\
> \
> \*\*Filtering by \`sensor\_type\` drops the state values and counters\*\* from the response, leaving only matching sensors.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Trackers","description":"Trackers, the devices the platform tracks, together with the geo links that share their live location with people outside the account. Resources under the /tracker/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"SensorReading":{"type":"object","description":"The last reading of one metering sensor.","properties":{"sensor_id":{"type":"integer","description":"Sensor ID."},"value":{"type":"number","description":"The reading."},"label":{"type":"string","description":"Sensor label."},"units":{"type":"string","description":"Units the value is measured in."},"name":{"type":"string","description":"Raw input name behind the sensor."},"type":{"type":"string","description":"Metering sensor type."},"units_type":{"type":"string","description":"Unit of measurement of the sensor input."},"update_time":{"type":"string","description":"When the value was last updated."},"min_value":{"type":"number","description":"Lower bound of the sensor range. Present for sensors that declare one."},"max_value":{"type":"number","description":"Upper bound of the sensor range. Present for sensors that declare one."},"converted_units_type":{"type":["string","null"],"description":"Units the value was converted into for the account's measurement system, or null when no conversion was needed."},"converted_value":{"type":["number","null"],"description":"The converted value, or null when no conversion was needed."},"composite_sensor_ids":{"type":"array","description":"IDs of composite sensors this one feeds into. Present only when it feeds any.","items":{"type":"integer"}}}},"StateReading":{"type":"object","description":"The last value of one state field.","properties":{"field":{"type":"string","description":"State field name."},"value":{"description":"The value. Its type follows the field and may be string, number, boolean or null."},"update_time":{"type":"string","description":"When the value was last updated."}}},"VirtualSensorReading":{"type":"object","description":"The last reading of one virtual sensor.","properties":{"sensor_id":{"type":"integer","description":"Virtual sensor ID."},"label":{"type":"string","description":"Sensor label."},"value":{"type":"string","description":"The reading, always a string for virtual sensors."},"type":{"type":"string","description":"Virtual sensor type."},"update_time":{"type":"string","description":"When the value was last updated."}}},"CounterValue":{"type":"object","description":"The last known value of one counter.","properties":{"type":{"type":"string","description":"Which counter this is.","enum":["odometer","engine_hours"]},"value":{"type":"number","description":"The counter value."},"update_time":{"type":"string","description":"When the value was last updated."}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/tracker/readings/list":{"post":{"tags":["Trackers"],"summary":"Read all sensor values","description":"Get the last value of every sensor, state field and counter on a tracker. This is the broadest of the reading calls: unlike `get_fuel`, `get_readings` and `get_diagnostics`, it covers CAN, OBD and fuel together and adds virtual sensors and counters. Reachable from a geo link session.\n\n**Filtering by `sensor_type` drops the state values and counters** from the response, leaving only matching sensors.","operationId":"trackerReadingsList","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tracker_id":{"type":"integer","description":"ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked."},"sensor_type":{"type":"string","description":"Optional. Return only sensors of this metering or virtual type. Supplying it also omits `states` and `counters`."},"include_components":{"type":"boolean","description":"Optional. Default `true`. Set `false` to leave out the parts that make up composite sensors."}},"required":["tracker_id"]}}}},"responses":{"200":{"description":"The readings","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/SensorReading"}},"states":{"type":"array","items":{"$ref":"#/components/schemas/StateReading"}},"virtual_sensors":{"type":"array","items":{"$ref":"#/components/schemas/VirtualSensorReading"}},"counters":{"type":"array","items":{"$ref":"#/components/schemas/CounterValue"}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 204: no tracker with this ID belongs to the account. Error 208: the tracker exists but is blocked, normally because its tariff ended.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 204 - No tracker with this ID belongs to the account.
* 208 - The tracker exists but is blocked, normally because its tariff ended.

***

## Read all sensor values for several trackers

> The many-tracker form of \`readings/list\`. Reachable from a geo link session.\
> \
> A tracker with nothing to report still appears in \`result\`, with empty arrays, and keys are absent rather than empty when a whole category has no data.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Trackers","description":"Trackers, the devices the platform tracks, together with the geo links that share their live location with people outside the account. Resources under the /tracker/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"TrackerReadings":{"type":"object","description":"Everything a tracker last reported: metering sensors, state fields, virtual sensors and counters.","properties":{"inputs":{"type":"array","description":"Metering sensor readings.","items":{"$ref":"#/components/schemas/SensorReading"}},"states":{"type":"array","description":"State field values.","items":{"$ref":"#/components/schemas/StateReading"}},"virtual_sensors":{"type":"array","description":"Virtual sensor readings.","items":{"$ref":"#/components/schemas/VirtualSensorReading"}},"counters":{"type":"array","description":"Counter values.","items":{"$ref":"#/components/schemas/CounterValue"}}}},"SensorReading":{"type":"object","description":"The last reading of one metering sensor.","properties":{"sensor_id":{"type":"integer","description":"Sensor ID."},"value":{"type":"number","description":"The reading."},"label":{"type":"string","description":"Sensor label."},"units":{"type":"string","description":"Units the value is measured in."},"name":{"type":"string","description":"Raw input name behind the sensor."},"type":{"type":"string","description":"Metering sensor type."},"units_type":{"type":"string","description":"Unit of measurement of the sensor input."},"update_time":{"type":"string","description":"When the value was last updated."},"min_value":{"type":"number","description":"Lower bound of the sensor range. Present for sensors that declare one."},"max_value":{"type":"number","description":"Upper bound of the sensor range. Present for sensors that declare one."},"converted_units_type":{"type":["string","null"],"description":"Units the value was converted into for the account's measurement system, or null when no conversion was needed."},"converted_value":{"type":["number","null"],"description":"The converted value, or null when no conversion was needed."},"composite_sensor_ids":{"type":"array","description":"IDs of composite sensors this one feeds into. Present only when it feeds any.","items":{"type":"integer"}}}},"StateReading":{"type":"object","description":"The last value of one state field.","properties":{"field":{"type":"string","description":"State field name."},"value":{"description":"The value. Its type follows the field and may be string, number, boolean or null."},"update_time":{"type":"string","description":"When the value was last updated."}}},"VirtualSensorReading":{"type":"object","description":"The last reading of one virtual sensor.","properties":{"sensor_id":{"type":"integer","description":"Virtual sensor ID."},"label":{"type":"string","description":"Sensor label."},"value":{"type":"string","description":"The reading, always a string for virtual sensors."},"type":{"type":"string","description":"Virtual sensor type."},"update_time":{"type":"string","description":"When the value was last updated."}}},"CounterValue":{"type":"object","description":"The last known value of one counter.","properties":{"type":{"type":"string","description":"Which counter this is.","enum":["odometer","engine_hours"]},"value":{"type":"number","description":"The counter value."},"update_time":{"type":"string","description":"When the value was last updated."}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/tracker/readings/batch_list":{"post":{"tags":["Trackers"],"summary":"Read all sensor values for several trackers","description":"The many-tracker form of `readings/list`. Reachable from a geo link session.\n\nA tracker with nothing to report still appears in `result`, with empty arrays, and keys are absent rather than empty when a whole category has no data.","operationId":"trackerReadingsBatchList","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"trackers":{"type":"array","description":"Tracker IDs.","items":{"type":"integer"}},"sensor_type":{"type":"string","description":"Optional. Return only sensors of this metering or virtual type. Supplying it also omits `states` and `counters`."},"include_components":{"type":"boolean","description":"Optional. Default `true`. Set `false` to leave out the parts that make up composite sensors."}},"required":["trackers"]}}}},"responses":{"200":{"description":"Readings per tracker","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"result":{"type":"object","description":"Readings keyed by tracker ID.","additionalProperties":{"$ref":"#/components/schemas/TrackerReadings"}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 217: the list names trackers that do not exist.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 217 - The list names trackers that do not exist.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/readings.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.