Readings

The Reading API lets you get readings data from the network. You can read data from any Asset object in the network using its readings property.

Return value

These values of type AssetReadings are automatically refreshed every few minutes and contain the readings for the current network time sampled with a 15 minute resolution.

readings: AssetReadings & { latest, forRange }

Examples

TypeScript

const asset = sdk.network.getAsset('Nellybay')
console.log(asset.readings)
// {
//   level: {
//     date: Date;
//     value: number
//   }
// }

Python

from js import JSON

asset = sdk.network.get_asset('Nellybay')
print(JSON.stringify(asset.readings))
# {
#   level: {
#     date: Date;
#     value: number
#   }
# }

Query methods

forPeriod()

Returns the cached readings in the current 24 hour period.

Method signature

TypeScript

forPeriod(): AssetReadingsCollection

Python

forPeriod() -> AssetReadingsCollection

Parameters

None.

Returns

Return type is AssetReadingsCollection. An array with the readings cached in the 24 hour period, sampled with a 15 minute resolution.

latest()

Retrieves the latest reading for an asset.

Method signature

TypeScript

latest(): Promise<AssetReadings>

Python

async forPeriod() -> AssetReadings

Parameters

None.

Returns

A promise that will resolve when the latest available readings are available in an AssetReadings object.

Examples

TypeScript

const asset = sdk.network.getAsset('Nellybay')
asset.readings.latest().then((reading) => {
  console.log(reading)
})

Python

asset = sdk.network.get_asset('Nellybay')
reading = await asset.readings.latest()

forRange()

Caution

At the moment, readings.forRange() is not available in the Python SDK

Retrieves readings for an asset between two dates.

Method signature

forRange(start: Date, end: Date): Promise<AssetReadings>

Parameters

• start: Start date
• end: End date

Returns

A promise that will resolve when the readings are available in an AssetReadings object.

Examples

Get readings for 24 hours for an asset.

const sdk = window.qatium
const network = sdk.network

const asset = network.getAsset('Nellybay')
asset.readings.forRange(new Date("2024-01-01"), new Date("2024-01-02")).then((readings) => {
  readings.level.forEach((reading) => {
    console.log(reading)
  })
})