Skip to main content
GET
/
entities
/
asset
Get Assets
curl --request GET \
  --url https://api-sandbox.axle.energy/entities/asset \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api-sandbox.axle.energy/entities/asset"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.axle.energy/entities/asset', 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-sandbox.axle.energy/entities/asset",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://api-sandbox.axle.energy/entities/asset"

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

req.Header.Add("Authorization", "Bearer <token>")

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-sandbox.axle.energy/entities/asset")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.axle.energy/entities/asset")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "assets": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "properties": {
        "power_kw": 1,
        "capacity_kwh": 1
      }
    }
  ],
  "total_num_assets": 123,
  "total_num_pages": 123,
  "page_number": 123
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer
default:10

Maximum number of assets to return (1-5000)

Required range: 1 <= x <= 5000
offset
integer
default:0

Number of assets to skip for pagination

Required range: x >= 0

Response

Page of assets with pagination info

Paginated response for asset listings.

assets
AssetResponse · object[]
required

List of assets for the current page

total_num_assets
integer
required

Total number of assets available

total_num_pages
integer
required

Total number of pages available

page_number
integer
required

Current page number (1-based)