Get a block.

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

{
  "end": "2023-11-12T00:00:00Z",
  "id": "11111111-1111-1111-1111-111111111111",
  "powerCapacity": [
    {
      "chargePowerCapacity": 380,
      "dischargePowerCapacity": 380,
      "ratedChargePowerCapacity": 380,
      "ratedDischargePowerCapacity": 380,
      "time": "2023-11-11T14:30:00Z"
    }
  ],
  "ratedChargePower": 1000,
  "ratedDischargePower": 1000,
  "schedule": [
    {
      "power": 380,
      "time": "2023-11-11T14:30:00Z"
    }
  ],
  "start": "2023-11-11T00:00:00Z",
  "unitsPower": "kW"
}

blocks

Get a block.

Returns a JSON representation of a block. This includes the static parameters of the block, such as its maximum power capability, as well as it’s power schedule represented as an array of power-time pairs.

The powerCapacity timeseries indicates the amount of power assigned to a block (ratedChargePowerCapacity and ratedDischargePowerCapacity) and the currently available power capacity on the block (chargePowerCapacity and dischargePowerCapacity).

It is invalid to schedule a power value at a point in time greater than the corresponding power capacity. e.g., if chargePowerCapacity for a delivery period starting at time T is 400 kW and dischargePowerCapacity is 500 kW then it is only valid to schedule power for that delivery period in the range [-400, 500] kW.

The available power capacities will usually equal the rated power capacities, but may be reduced during unexpected outages.

The start and end query params specify the time interval for which to retrieve values. These values should be strings in RFC3339 format. This range is greedy, in that it will match any timeseries point included in its range, including on the boundaries. e.g., setting a start of 2025-06-17T00:00:00Z and an end of 2025-06-17T00:30:00Z would return the points at 00:00:00, 00:15:00, and 00:30:00 which collectively cover a period from 00:00:00 to 00:45:00.

If these params are not specified, this interval will default to 24 hours in the past to 48 hours in the future, up to the lifetime of the block.

GET

organisations

{organisationID}

virtual-assets

{virtualAssetID}

blocks

{blockID}

Get a block.

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

{
  "end": "2023-11-12T00:00:00Z",
  "id": "11111111-1111-1111-1111-111111111111",
  "powerCapacity": [
    {
      "chargePowerCapacity": 380,
      "dischargePowerCapacity": 380,
      "ratedChargePowerCapacity": 380,
      "ratedDischargePowerCapacity": 380,
      "time": "2023-11-11T14:30:00Z"
    }
  ],
  "ratedChargePower": 1000,
  "ratedDischargePower": 1000,
  "schedule": [
    {
      "power": 380,
      "time": "2023-11-11T14:30:00Z"
    }
  ],
  "start": "2023-11-11T00:00:00Z",
  "unitsPower": "kW"
}

Headers

Authorization

string

default:Bearer <access token value>

required

Access token

Path Parameters

organisationID

string

required

Organisation ID

virtualAssetID

string

required

Virtual Asset ID

blockID

string

required

Block ID

Query Parameters

start

string

Query start time

end

string

Query end time

Body

application/json

The body is of type object.

Response

end

string<dateTime>

Example:

"2023-11-12T00:00:00Z"

string<uuid>

Example:

"11111111-1111-1111-1111-111111111111"

powerCapacity

object[]

Hide child attributes

powerCapacity.chargePowerCapacity

number<float>

required

Example:

380

powerCapacity.dischargePowerCapacity

number<float>

required

Example:

380

powerCapacity.ratedChargePowerCapacity

number<float>

required

Example:

380

powerCapacity.ratedDischargePowerCapacity

number<float>

required

Example:

380

powerCapacity.time

string<dateTime>

required

Example:

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

ratedChargePower

number<float>

Example:

1000

ratedDischargePower

number<float>

Example:

1000

schedule

object[]

Hide child attributes

schedule.power

number<float>

required

Example:

380

schedule.time

string<dateTime>

required

Example:

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

start

string<dateTime>

Example:

"2023-11-11T00:00:00Z"

unitsPower

string

Example:

"kW"

Last modified on June 30, 2026

Get all the blocks belonging to a virtual asset.Update the schedule of a block

⌘I