Get the projected state of charge of a virtual asset.

curl --request GET \
  --url https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/state-of-charge \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "stateOfChargeProfile": [
    {
      "stateOfChargePercentage": 50,
      "time": "2023-11-11T14:30:00Z"
    }
  ]
}

virtual-assets

Get the projected state of charge of a virtual asset.

deprecated

DEPRECATED: This endpoint is deprecated and will be removed in a future version. To retrieve state of charge values, use the operational endpoint GET /organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational.

Get the projected state of charge of a virtual asset as a timeseries.

Returns a timeseries of the projected state of charge of a virtual asset as JSON. This timeseries is right-aligned relative to the 15-minute power trading windows. e.g. "time": "2023-11-11T14:30:00Z" and "stateOfChargePercentage": 23.5 mean that the virtual asset is projected to reach a state of charge of 23.5% at the end of the 15-minute window starting at 2023-11-11T14:30:00Z, i.e. at 2023-11-11T14:45:00Z.

The timeseries will cover the parsed start and end times. If none are provided, then the timeseries will cover a window of 72 hours, with up to 3 days in the past and 4 days into the future.

Projected values are only guaranteed for up to 48h into the future.

GET

organisations

{organisationID}

virtual-assets

{virtualAssetID}

state-of-charge

Get the projected state of charge of a virtual asset.

curl --request GET \
  --url https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/state-of-charge \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "stateOfChargeProfile": [
    {
      "stateOfChargePercentage": 50,
      "time": "2023-11-11T14:30:00Z"
    }
  ]
}

Headers

Authorization

string

default:Bearer <access token value>

required

Access token

Path Parameters

organisationID

string

required

Organisation ID

virtualAssetID

string

required

Virtual Asset ID

Query Parameters

start

string

required

Query start time

end

string

required

Query end time

Body

application/json

The body is of type object.

Response

stateOfChargeProfile

object[]

required

Hide child attributes

stateOfChargeProfile.stateOfChargePercentage

number

required

Example:

50

stateOfChargeProfile.time

string<dateTime>

required

Example:

"2023-11-11T14:30:00Z"

Last modified on June 30, 2026

Gets the most recent operational data values for a virtual-asset.Get the latest state of charge of a virtual asset.

⌘I