発電量実績の取得

ベースURL: https://api.tensorenergy.jp/v1

パス: /actuals/{ASSET_ID}

メソッド: GET

クエリパラメータ

フィールド	タイプ	説明	必須
from	string	実績を取得するための期間の開始時間。次の形式で表現: 2006-01-02T15:04:05Z	はい
to	string	実績を取得するための期間の終了時間。次の形式で表現: 2006-01-02T15:04:05Z	はい
source	metering | iot | monitoring	望ましい実績のソース。パラメータが提供されない場合、デフォルトはメーターデータになります。メーターデータが存在しない場合はモニタリングデータにフォールバックします	いいえ

レスポンス

レスポンスは次のフィールドを持つnull不可のJSONオブジェクトです。

フィールド	タイプ	説明
data	[AssetActualSet] | null	クエリから返されたデータ。errorがnullでない場合、この値はnullになります。
error	Error | null	クエリから返されたエラー。dataがnullでない場合、この値はnullになります。

AssetActualSetオブジェクト

フィールド	タイプ	説明
datetime	string	実績のタイムスタンプ。ISO 8601準拠のUTCタイムスタンプで表現。
value	float	エネルギー生成量。キロワット時（kWh）で表現。

エラーオブジェクト

フィールド	タイプ	説明
message	string	問題が発生したことを説明するメッセージ。
code	internal_server_error | not_authorized | invalid_query_parameter | resource_not_found	発生したエラーコード。

リクエスト例

cURL

curl --request GET \
     --url https://api.tensorenergy.jp/v1/actuals/51d5ffcf-1347-4277-93e8-dfca140fe8b3?from=2006-01-02T15:04:05Z&to=2006-01-02T15:04:05Z \
     --header "authorization: Bearer ${API_TOKEN}"

Python

import requests

API_URL = 'https://api.tensorenergy.jp/v1/actuals/51d5ffcf-1347-4277-93e8-dfca140fe8b3?from=2006-01-02T15:04:05Z&to=2006-01-02T15:04:05Z'
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/actuals/51d5ffcf-1347-4277-93e8-dfca140fe8b3?from=2006-01-02T15:04:05Z&to=2006-01-02T15:04:05Z'
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()

レスポンス例

プロジェクトが存在し、エラーが発生しない場合

{
  "data": [
    {
        "datetime": "2024-01-01T00:00:00Z",
        "value": 9.812
    },
    {   
        "datetime": "2024-01-01T00:30:00Z",
        "value": 10.1
    },
    {
        "datetime": "2024-01-01T01:00:00Z",
        "value": 10.891
    }
  ],
  "error": null
}

操作中にエラーが発生する場合

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

プロジェクトの実績が存在しない場合

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