AXaxle
5. Data

Post Readings

Changed on

Send asset readings data to Axle using the generic readings format.

This endpoint accepts compressed data using gzip encoding. Returns statuses of the processed readings, indicating whether each reading was accepted or rejected.

Direction convention: for readings that can be either positive or negative (e.g. boundary_import_kw, battery_inverter_import_kw), a positive value denotes import (power flowing in from the grid, or into the battery) and a negative value denotes export (power flowing out to the grid, or out of the battery). All other reading types are unidirectional; the required sign for each label is documented in the ReadingDataPointLabel schema below.

post/data/readings

Request

  • Base URL
    https://api-sandbox.axle.energy
  • URL
    https://api-sandbox.axle.energy/data/readings
  • Auth
    OAuth 2
    Password
    Token URL: auth/token-form

Request body

Response

Successfully recorded readings with processing summary

Changes

  • b0b07b1dbf12Revision changes
    • warning

      added the new boundary_export_energy_kwh enum value to the /// response property for the response status

    • warning

      added the new boundary_import_energy_kwh enum value to the /// response property for the response status

    • warning

      added the new heat_pump_consumption_energy_kwh enum value to the /// response property for the response status

    • warning

      added the new hot_water_tank_consumption_energy_kwh enum value to the /// response property for the response status

    • info

      added the new boundary_export_energy_kwh enum value to the request property ///

    • info

      added the new boundary_import_energy_kwh enum value to the request property ///

    • info

      added the new heat_pump_consumption_energy_kwh enum value to the request property ///

    • info

      added the new hot_water_tank_consumption_energy_kwh enum value to the request property ///