ワークスペースの発電予測データを取得

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

パス: /forecasts/workspace

メソッド: GET

クエリパラメータ

フィールド	タイプ	説明	必須
from	string	発電予測データを取得する開始時刻を指定します。フォーマットは 2006-01-02T15:04:05Z です。	true
to	string	発電予測データを取得する終了時刻を指定します。フォーマットは 2006-01-02T15:04:05Z です。from から to の間隔は14日を超えてはなりません。	true
generation	string	発電予測データの生成時間を指定します。許容される値は latest、dayAhead、またはタイムスタンプです。	false
offset	integer	発電予測データの生成時間スロットからのオフセットを秒単位で指定します。	false

レスポンス

レスポンスは以下のフィールドを持つ、null 非許容の JSON オブジェクトです:

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

ForecastSet オブジェクト

フィールド	タイプ	説明
datetime	string	ISO 8601 準拠の UTC タイムスタンプとして表されるスロットの日時です。
total_kwh	float	予測された発電量の合計で、単位はキロワット時 (kWh) です。
values	array	スロットごとのプロジェクト発電予測値です。各エントリには asset_id と value_kwh が含まれます。

Error オブジェクト

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

リクエスト例

cURL

curl --request GET \
     --url https://api.tensorenergy.jp/v1/forecasts/workspace?from=2024-01-01T00:00:00Z&to=2024-01-02T00:00:00Z&generation=latest&offset=3600 \
     --header "authorization: Bearer ${API_TOKEN}"

Python

import requests

API_URL = 'https://api.tensorenergy.jp/v1/forecasts/workspace?from=2024-01-01T00:00:00Z&to=2024-01-02T00:00:00Z&generation=latest&offset=3600'
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/forecasts/workspace?from=2024-01-01T00:00:00Z&to=2024-01-02T00:00:00Z&generation=latest&offset=3600'
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",
      "total_kwh": 100.5,
      "values": [
        {
          "asset_id": "51d5ffcf-1347-4277-93e8-dfca140fe8b3",
          "value_kwh": 10.1
        },
        {
          "asset_id": "7c97f8f2-8d50-4a77-9282-f9a16387dcbf",
          "value_kwh": 20.3
        }
      ]
    },
    {
      "datetime": "2024-01-01T01:00:00Z",
      "total_kwh": 110.7,
      "values": [
        {
          "asset_id": "51d5ffcf-1347-4277-93e8-dfca140fe8b3",
          "value_kwh": 15.2
        },
        {
          "asset_id": "7c97f8f2-8d50-4a77-9282-f9a16387dcbf",
          "value_kwh": 25.4
        }
      ]
    }
  ],
  "error": null
}

操作中にエラーが発生した場合

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

プロジェクトに対して発電予測データが存在しない場合

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