Gets a selection of operational data of a virtual-asset as a timeseries.

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

import requests

url = "https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational"

payload = {}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "data": {}
}

virtual-assets

Gets a selection of operational data of a virtual-asset as a timeseries.

Returns a JSON representation of the selected operational data and its metadata at 15 minute granularity.

The user selects the relevant categories of operational data through the query parameter categories, which is a comma separated list. E.g. categories=energyCapacityAvailable,energyCapacityRated The following categories are available:

chargeEfficiency: The one-way efficiency of the virtual asset’s charging operation as a ratio, e.g. 0.95.

dischargeEfficiency: The one-way efficiency of the virtual asset’s discharging operation as a ratio, e.g. 0.95.

energyCapacityRated: The rated energy capacity of the virtual asset in kWh, e.g. 8000.0.

energyCapacityAvailable: The available energy capacity of the virtual asset in kWh at the given timestamp, e.g. 8000.0.

powerCapacityChargeRated: The rated charge power capacity of the virtual asset in kW, e.g. 8000.0.

powerCapacityChargeAvailable: The available charge power capacity of the virtual asset in kW, e.g. 8000.0.

powerCapacityDischargeRated: The rated discharge power capacity of the virtual asset in kW, e.g. 8000.0.

powerCapacityDischargeAvailable: The available discharge power capacity of the virtual asset in kW, e.g. 8000.0.

maximumDeliverablePower: The upper bound on signed power in kW that the virtual asset may schedule in wholesale for the relevant delivery period, subject to relevant limits e.g. 5000.0. This is a signed power value which can be negative if the asset is in a state where it must undertake a wholesale charge.

minimumDeliverablePower: The lower bound on signed power in kW that the virtual asset may schedule in wholesale for the relevant delivery period, subject to relevant limits e.g. 5000.0. This is a signed power value which can be positive if the asset is in a state where it must undertake a wholesale discharge.

The range [minimumDeliverablePower, maximumDeliverablePower] represents the range of values for the wholesale schedule which pass all validations at the time of the query. Note the range [minimumDeliverablePower, maximumDeliverablePower] updates in real time based on live data, such as ancillary activations, and therefore it is not guaranteed that no adjustments will be applied.

These values are calculated only for the upcoming wholsesale delivery period. For example, if polled at 15:50 then values with time 16:00 will be returned, representing the most up-to-date limits for the [16:00, 16:15] delivery period.

stateOfChargeBoundsUpper: The upper boundary of the state of charge of the virtual asset as a ratio, e.g. 0.9 if the virtual-asset is not allowed to be charged beyond 90%. This is measured relative to the currently available energy capacity, and thus should always equal stateOfEnergyBoundsUpper divided by energyCapacityAvailable.

stateOfChargeBoundsLower: The lower boundary of the state of charge of the virtual asset as a ratio, e.g. 0.1 if the virtual-asset is not allowed to be discharged below 10%. This is measured relative to the currently available energy capacity, and thus should always equal stateOfEnergyBoundsLower divided by energyCapacityAvailable.

stateOfChargeProjection: The projected state of charge of the virtual asset as a ratio, e.g. 0.50 for an asset projected to be at 50% state-of-charge. This is measured relative to the currently available energy capacity, and thus should always equal stateOfEnergyProjection divided by energyCapacityAvailable.

stateOfEnergyProjection: The projected state of energy of the virtual asset, based on its initial/current state of charge and schedule in kWh, e.g. 8000.0.

stateOfEnergy: The actual state of energy of the virtual asset, in kWh, e.g. 8000.0.

stateOfEnergyBoundsUpper: The allowed upper boundary of the state of energy of the virtual asset in kWh, e.g. 7200.0 if the virtual-asset is not allowed to be charged beyond 7200 kWh. This is inclusive of required charge flexibility reserves for FCR, but may include other constraints on the asset. This value equals stateOfChargeBoundsUpper multiplied by availableEnergyCapacity.

stateOfEnergyBoundsLower: The allowed lower boundary of the state of energy of the virtual asset in kWh, e.g. 800.0 if the virtual-asset is not allowed to discharged below 800 kWh. inclusive of required discharge flexibility reserves for FCR, but may include other constraints on the asset. This value equals stateOfChargeBoundsLower multiplied by availableEnergyCapacity.

fcrReserveCharge: The energy reserved at the upper state of energy boundary in kWh so that the virtual asset can charge to deliver its FCR commitment, e.g. 900.0. For example, on a 10000 kWh asset where fcrReserveCharge is 900 kWh, you would expect stateOfEnergyBoundsUpper to be no higher than 9100 kWh. The overall boundary can be inclusive of other constraints, such as hardware restrictions.

fcrReserveDischarge: The energy reserved at the lower state of energy boundary in kWh so that the virtual asset can discharge to deliver its FCR commitment, e.g. 900.0. For example, on a 10000 kWh asset where fcrReserveDischarge is 900 kWh, you would expect stateOfEnergyBoundsLower to be no lower than 900 kWh. The overall boundary can be inclusive of other constraints, such as hardware restrictions.

stateOfCharge: The state of energy of the virtual-asset as a fraction of available energy capacity energyCapacityAvailable as a ratio, e.g. 0.10 for a virtual-asset with 1000 kWh of available capacity at a state of energy of 100 kWh.

frozenEnergy: The frozen energy of the virtual asset in kWh, e.g. 500.0. This is energy that is not dispatchable due to an unavailability and is expected to be restored upon the end of that unavailability.

frozenEnergyProjection: The projected frozen energy of the virtual asset in kWh, e.g. 500.0.

energyCharged: The sum total of charged energy of the virtual asset in kWh, e.g. 100.0.

energyDischarged: The sum total of discharged energy of the virtual asset in kWh, e.g. 100.0.

cyclesWholesale: The sum total of discharged energy of the virtual asset in the wholesale market divided by the rated energy capacity of the virtual asset, e.g. 0.1.

cyclesFCR: The sum total of discharged energy of the virtual asset in the FCR market divided by the rated energy capacity of the virtual asset, e.g. 0.1.

cyclesAFRR: The sum total of discharged energy of the virtual asset in the aFRR market divided by the rated energy capacity of the virtual asset, e.g. 0.1.

cyclesTotal: The sum total of discharged energy of the virtual asset in all markets divided by the rated energy capacity of the virtual asset, e.g. 0.1.

availableEnergyDischargesWholesale: The sum total of discharged energy of the virtual asset in the wholesale market divided by the available energy capacity of the virtual asset, e.g. 0.1.

availableEnergyDischargesFCR: The sum total of discharged energy of the virtual asset in the FCR market divided by the available energy capacity of the virtual asset, e.g. 0.1.

availableEnergyDischargesAFRR: The sum total of discharged energy of the virtual asset in the aFRR market divided by the available energy capacity of the virtual asset, e.g. 0.1.

availableEnergyDischargesTotal: The sum total of discharged energy of the virtual asset in all markets divided by the available energy capacity of the virtual asset, e.g. 0.1.

afrrPosCapacityAvailable: The maximum available discharge power which can be bid into positive aFRR market products in kW, e.g. 7000.0. This value may be reduced during periods of unavailability.

afrrPosCapacityAvailableMinusFcr: The maximum available discharge power which can be bid into positive aFRR market products in kW, while taking into account FCR commitments and maxTotalCapacity validation, e.g. 1000.0. The value is calculated according to the following formula: afrrPosCapacityAvailableMinusFcr = minimum((maxTotalAncillaryCapacityDischargeAvailable - fcrCommitment), afrrPosCapacityAvailable). This value may be reduced during periods of unavailability.

afrrPosCapacityRated: The maximum rated discharge power which can be bid into positive aFRR market products in kW, e.g. 7000.0. This value remains unchanged during periods of unavailability.

afrrNegCapacityAvailable: The maximum available charge power which can be bid into negative aFRR market products in kW, e.g. 7000.0. This value may be reduced during periods of unavailability.

afrrNegCapacityAvailableMinusFcr: The maximum available charge power which can be bid into negative aFRR market products in kW, while taking into account FCR commitments and maxTotalCapacity validation, e.g. 1000.0. The value is calculated according to the following formula: afrrNegCapacityAvailableMinusFcr = minimum((maxTotalAncillaryCapacityChargeAvailable - fcrCommitment), afrrNegCapacityAvailable). This value may be reduced during periods of unavailability.

afrrNegCapacityRated: The maximum rated charge power which can be bid into negative aFRR market products in kW, e.g. 7000.0. This value remains unchanged during periods of unavailability.

afrrActivation: The sum total of activated positive/discharge and negative/charge power delivered by the virtual asset in the aFRR ancillary market in kW, e.g. 2000.0.

afrrPosActivation: The sum total of activated positive/discharge power delivered by the virtual asset in the aFRR Pos ancillary market in kW, e.g. 3000.0.

afrrNegActivation: The sum total of activated negative/charge power delivered by the virtual asset in the aFRR Neg ancillary market in kW, e.g. -1000.0.

fcrCapacityAvailable: The maximum available power capacity which can be bid into FCR market products in kW, e.g. 7000.0. This value may be reduced during periods of unavailability.

fcrCapacityRated: The maximum rated power capacity which can be bid into FCR market products in kW, e.g. 7000.0. This value remains unchanged during periods of unavailability.

fcrActivation: The sum total of activated power delivered by the virtual asset in the FCR ancillary market in kW, e.g. 1000.0.

maxTotalAncillaryCapacityChargeAvailable: The maximum total sum of available charge (negative) power capacity that can be bid across markets in kW, e.g. 8000.0. This includes all bids with a negative bid direction (FCR and aFRR Neg). This value may be reduced during periods of unavailability.

maxTotalAncillaryCapacityChargeRated: The maximum total sum of rated charge (negative) power capacity that can be bid across markets in kW, e.g. 10000.0. This includes all bids with a negative bid direction (FCR and aFRR Neg). This value remains unchanged during periods of unavailability.

maxTotalAncillaryCapacityDischargeAvailable: The maximum total sum of available discharge (positive) power capacity that can be bid across markets in kW, e.g. 8000.0. This includes all bids with a positive bid direction (FCR and aFRR Pos). This value may be reduced during periods of unavailability.

maxTotalAncillaryCapacityDischargeRated: The maximum total sum of rated discharge (positive) power capacity that can be bid across markets in kW, e.g. 10000.0. This includes all bids with a positive bid direction (FCR and aFRR Pos). This value remains unchanged during periods of unavailability.

fcrCommitment: The committed FCR capacity of the virtual asset for the latest delivery period in kW, e.g. 5000.0. Before the FCR auction results are released this reflects the total power capacity bid into FCR; once the auction clears it reflects the active commitment that has to be delivered. This value may be reduced during periods of unavailability.

afrrPosCommitment: The committed aFRR Pos (discharge) capacity of the virtual asset for the latest delivery period in kW, e.g. 5000.0. Before the aFRR auction results are released this reflects the total power capacity bid into aFRR Pos; once the auction clears it reflects the active commitment that has to be delivered. This value may be reduced during periods of unavailability.

afrrNegCommitment: The committed aFRR Neg (charge) capacity of the virtual asset for the latest delivery period in kW, e.g. 5000.0. Before the aFRR auction results are released this reflects the total power capacity bid into aFRR Neg; once the auction clears it reflects the active commitment that has to be delivered. This value may be reduced during periods of unavailability.

wholesalePowerCapacityChargeAvailable: The charge power capacity of the virtual asset which is available for wholesale trading in kW, e.g. 5000.0. Reduced by pending and accepted FCR and aFRR Neg ancillary commitments. This value may change during periods of unavailability.

wholesalePowerCapacityDischargeAvailable: The discharge power capacity of the virtual asset which is available for wholesale trading in kW, e.g. 5000.0. Reduced by pending and accepted FCR and aFRR Pos ancillary commitments. This value may change during periods of unavailability.

marketableCapacityAFRRPos: DEPRECATED. Please use the new category name instead: afrrPosCapacityAvailable.

marketableCapacityAFRRNeg: DEPRECATED. Please use the new category name instead: afrrNegCapacityAvailable.

marketableCapacityFCR: DEPRECATED. Please use the new category name instead: fcrCapacityAvailable.

Along with the selected operational data, a metadata object is returned which provides the unit for the selected datapoint.

Note that it is required to provide start and end params to specify the time interval for which to retrieve values. 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.

An example response would be:

{
  "data": {
    "dischargeEfficiency": {
      "metaData": {
        "unit": "ratio"
      },
      "dataPoints": [
        {
          "timestamp": "2025-07-11T22:00:00Z",
          "value": 0.95
        },
        {
          "timestamp": "2025-07-11T22:15:00Z",
          "values": 0.95
        }
      ]
    },
    "marketableCapacityAFRRPos": {
      "metaData": {
        "unit": "kW"
      },
      "dataPoints": [
        {
          "timestamp": "2025-07-11T22:00:00Z",
          "value": 1000
        },
        {
          "timestamp": "2025-07-11T22:15:00Z",
          "values": 1000
        }
      ]
    },
    "marketableCapacityFCR": {
      "metaData": {
        "unit": "kW"
      },
      "dataPoints": [
        {
          "timestamp": "2025-07-11T22:00:00Z",
          "value": 1000
        },
        {
          "timestamp": "2025-07-11T22:15:00Z",
          "values": 1000
        }
      ]
    }
  }
}

GET

organisations

{organisationID}

virtual-assets

{virtualAssetID}

operational

Gets a selection of operational data of a virtual-asset as a timeseries.

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

import requests

url = "https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational"

payload = {}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "data": {}
}

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

Body

application/json

The body is of type object.

Response

data

object

required

Hide child attributes

data.{key}

object

Hide child attributes

data.{key}.dataPoints

object[]

required

Hide child attributes

data.{key}.dataPoints.timestamp

string

required

Example:

"2020-01-01T00:00:00+00:00"

data.{key}.dataPoints.value

number

required

Example:

100

data.{key}.metaData

object

required

Hide child attributes

data.{key}.metaData.unit

enum<string>

required

Available options:

PCT,

KW,

KWH,

KW/S,

AMP,

V,

C,

HZ,

WH,

W,

RATIO,

EFC,

EUR,

GC02EQKWH

Example:

"kW"

API documentation

Auth API

Virtual Assets API

Auctions API

Revenue Reporting API

Physical Asset Management API

Asset Monitoring API

Gets a selection of operational data of a virtual-asset as a timeseries.

Headers

Path Parameters

Query Parameters

Body

Response