Get all the virtual assets belonging to an organisation.

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

[ { "annualCycleLimit": 730, "availableEnergyCapacity": 800, "blockIDs": [ "<string>" ], "blockMetadata": [ { "end": "2023-11-12T00:00:00Z", "id": "11111111-1111-1111-1111-111111111111", "market": "WHOLESALE", "start": "2023-11-11T00:00:00Z" } ], "chargeEfficiency": 0.943, "createdAt": "2023-11-11T00:00:00Z", "dailyCycleLimit": 2, "deliveryZone": "50Hertz", "dischargeEfficiency": 0.943, "dispatchGateClosureSeconds": 480, "eicCode": "EIC1234567890", "end": "2023-11-12T00:00:00Z", "endStateOfChargePercentage": 75, "energyCapacity": 1000, "feedback": "This block is projected to be over-charged by 250 kilowatt hours. Consider adding more discharging to the schedule, or reducing the amount of charging", "finalSoCTolerance": 0.01, "id": "11111111-1111-1111-1111-111111111111", "imbalanceCharge": 0, "imbalanceDischarge": 250, "portfolioID": "11111111-1111-1111-1111-111111111111", "protectedDurationSeconds": 3600, "rampRate": 66, "ratedChargePower": 1000, "ratedDischargePower": 1000, "start": "2023-11-11T00:00:00Z", "totalAllowedCycles": 123, "unitsEnergy": "kWh", "unitsPower": "kW" } ]

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

Headers

Authorization

string

default:Bearer <access token value>

required

Access token

Path Parameters

organisationID

string

required

Organisation ID

Query Parameters

start

string

Query start time

end

string

Query end time

Body

application/json

The body is of type object.

Response

annualCycleLimit

number<float>

Example:

730

availableEnergyCapacity

number<float>

Example:

800

blockIDs

string[]

blockMetadata

object[]

Hide child attributes

blockMetadata.end

string<dateTime>

Example:

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

blockMetadata.id

string<uuid>

Example:

"11111111-1111-1111-1111-111111111111"

blockMetadata.market

string

Example:

"WHOLESALE"

blockMetadata.start

string<dateTime>

Example:

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

chargeEfficiency

number<float>

Example:

0.943

createdAt

string<dateTime>

Example:

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

dailyCycleLimit

number<float>

Example:

2

deliveryZone

string

Example:

"50Hertz"

dischargeEfficiency

number<float>

Example:

0.943

dispatchGateClosureSeconds

number<string>

Example:

480

eicCode

string

Example:

"EIC1234567890"

end

string<dateTime>

Example:

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

endStateOfChargePercentage

number<float>

Example:

75

energyCapacity

number<float>

Example:

1000

feedback

string

Example:

"This block is projected to be over-charged by 250 kilowatt hours. Consider adding more discharging to the schedule, or reducing the amount of charging"

finalSoCTolerance

number<float>

Example:

0.01

string<uuid>

Example:

"11111111-1111-1111-1111-111111111111"

imbalanceCharge

number<float>

Example:

0

imbalanceDischarge

number<float>

Example:

250

portfolioID

string<uuid>

Example:

"11111111-1111-1111-1111-111111111111"

protectedDurationSeconds

integer

Example:

3600

rampRate

number<float>

Example:

66

ratedChargePower

number<float>

Example:

1000

ratedDischargePower

number<float>

Example:

1000

start

string<dateTime>

Example:

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

totalAllowedCycles

number<float>

unitsEnergy

string

Example:

"kWh"

unitsPower

string

Example:

"kW"