Get all assets

Base URL: https://api.tensorenergy.jp/v1

Path: /assets

Method: GET

Query parameters

This API does not require any query parameters.

Response

The response is an non-nullable JSON object with the following fields:

Field	Type	Description
data	[Asset] | null	Returned data from the query. If error is non-null, then this value will be null.
error	Error | null	Any error returned from the query. If data is non-null, then this value will be null.

Asset Object

Field	Type	Description
id	string	ID of the asset.
name	string	Name of the asset.
status	operation | planning | maintenance	Status of the asset.
grid_zone	chugoku | chubu | kyushu | hokkaido | hokuriku | tokyo | kansai | tohoku | shikoku | okinawa	Grid zone the asset is located in.
latitude	float	Distance of the asset north or south of the earth's equator, expressed in degrees.
longitude	float	Distance of the asset east or west of the earth's equator, expressed in degrees.
altitude	float	Asset site altitude, expressed in meters.
location_name	string	Name of the asset's location.
subsidy_scheme	fit | fip | none	Subsidy scheme the asset is currently under.
subsidy_rate	number | null	FIT or FIP approved for your asset in Japanese Yen. Only guarenteed to be non-null if the asset's subsidy scheme is not set to none.
subsidy_start_date	string | null	Start time of the asset's subsidy, expressed as an ISO 8601 compliant UTC timestamp. Only guarenteed to be non-null if the asset's subsidy scheme is not set to none.
cod_date	string	Expected date of grid interconnection, expressed as an ISO 8601 compliant UTC timestamp.
metering_day	integer	Day of the calendar month that the asset meters will be read by the electric utility.
meti_permit_number	string | null	ID provided to you by METI upon asset registration.
meti_application_id	string | null	Secondary METI ID used for ownership transfer.
location_id	string | null	ID provided to you by your grid operator.
developer_id	string | null	ID of the Developer.
om_provider_id	string | null	ID of the OM provider.
epc_company_id	string | null	ID of the EPC company.
balancing_group_id	string	ID of the balancing group the asset is associated with.
spv_id	string | null	ID of the SPV the asset is associated with.
readable_id	string	Human readable ID of the asset. Should be in the format XXX-A-{INTEGER}. Ex XXX-A-1 or XXX-A-10.
is_using_advanced_losses	boolean	Indicates if the asset is using the advanced losses flag.
simulation_status	succeeded | failed | pending | running	Status of the simulation for the asset.
created_at	string	Time the asset was created at, expressed as an ISO 8601 compliant UTC timestamp.
updated_at	string	Time the asset was updated at, expressed as an ISO 8601 compliant UTC timestamp.
creator_user_id	string	ID of the user who created the asset.
grid_code	string | null	Code for OCCTO submission file.
contract_classification_number_2	string | null	Number for OCCTO submission file.
scenario_id	string	ID of the scenario that is associated with the asset.

Error object

Field	Type	Description
message	string	Message that explains what went wrong.
code	internal_server_error | not_authorized	Error code that occurred.

Example request

cURL

curl --request GET \
     --url https://api.tensorenergy.jp/v1/assets \
     --header "authorization: Bearer ${API_TOKEN}"

Python

import requests

API_URL = 'https://api.tensorenergy.jp/v1/assets'
API_TOKEN = 'YOUR_API_KEY'

headers = {
    'authorization': f'Bearer {API_TOKEN}',
}

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

print(response.json())

Typescript

const API_URL = 'https://api.tensorenergy.jp/v1/assets'
const API_TOKEN = 'YOUR_API_KEY'

const fetchData = async () => {
    try {
        const response = await fetch(API_URL, {
          method: 'GET',
          headers: {
            'authorization': `Bearer ${API_TOKEN}`
          }
        })
        console.log(response)
    } catch (error) {
        console.error(error)
    }
};

fetchData()

Example responses

No Error occurs during operation

{
  "data": [
    {
        "id": "51d5ffcf-1347-4277-93e8-dfca140fe8b3",
        "name": "Demo asset",
        "status": "planning",
        "grid_zone": "tokyo",
        "latitude": 38.543,
        "longitude": 138.564,
        "altitude": 0,
        "location_name": "Greenfield",
        "subsidy_scheme": "none",
        "subsidy_rate": null,
        "subsidy_start_date": null,
        "cod_date": "2022-01-01T15:00:00Z",
        "metering_day": 1,
        "meti_permit_number": null,
        "meti_application_id": null,
        "location_id": null,
        "developer_id": null,
        "om_provider_id": null,
        "epc_company_id": null,
        "balancing_group_id": "5ca33061-3ad3-4051-9518-0af37f68f861",
        "spv_id": null,
        "readable_id": "XXX-A-1",
        "is_using_advanced_losses": true,
        "simulation_status": "succeeded",
        "created_at": "2021-12-29T15:21:11Z",
        "updated_at": "2022-01-01T12:11:00Z",
        "creator_user_id": "9696f450-569d-4c79-995b-36d959eb3182",
        "grid_code": null,
        "contract_classification_number_2": null,
        "scenario_id": "c387383d-bf50-4c90-8a82-f72ad6383ba4"
    }
  ],
  "error": null
}

Error occurs during operation

{
  "data": null,
  "error": {
    "message": "something went wrong during the process",
    "code": "internal_server_error"
  }
}

No asset exists within workspace and no error occurs during operation

{
  "data": [],
  "error": null
}