API Reference

Send readings

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

Post Readings

curl --request POST \
  --url https://api-sandbox.axle.energy/data/readings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "readings": [
    {
      "asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "start_timestamp": "2023-11-07T05:31:56Z",
      "end_timestamp": "2023-11-07T05:31:56Z",
      "value": 123
    }
  ]
}
'

{
  "responses": [
    {
      "asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "start_timestamp": "2023-11-07T05:31:56Z",
      "end_timestamp": "2023-11-07T05:31:56Z",
      "accepted": true,
      "error": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Readings data for multiple assets.

readings

ReadingDataPoint · object[]

required

List of readings to be submitted

Show child attributes

Response

Successfully recorded readings with processing summary

Response model for a batch of readings submissions.

responses

ReadingResponse · object[]

required

List of responses for each reading submission

Show child attributes

OverviewMonetize flexibility while maintaining user control over charging schedules

⌘I

Post Readings

curl --request POST \
  --url https://api-sandbox.axle.energy/data/readings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "readings": [
    {
      "asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "start_timestamp": "2023-11-07T05:31:56Z",
      "end_timestamp": "2023-11-07T05:31:56Z",
      "value": 123
    }
  ]
}
'

{
  "responses": [
    {
      "asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "start_timestamp": "2023-11-07T05:31:56Z",
      "end_timestamp": "2023-11-07T05:31:56Z",
      "accepted": true,
      "error": "<string>"
    }
  ]
}