Read

Values of many timeseries

The latest values of up to 2,000 timeseries over one shared window, in one call. The body lists the series; the response holds one block per series, in the same order, each exactly what the one-series values call returns for it. A series that cannot be read (unknown entity, name or provider, a window too large for it) answers an error block instead, and the rest are still read.

A page holds whole series, up to 200,000 points in total and at least one series. When the next series would go over, the page stops and next is set: send it back as cursor with the same body. One call counts as one request against the rate limit.

POST
/timeseries/values
X-API-Key<token>

Optional. The Grid API key, also accepted as ?api_key=; without it a request is answered at 30 per minute per IP address. How to get a key: grid.rebase.energy/docs/v1/guides/authentication/. The key is in the API tab of the grid map.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://grid.rebase.energy/api/v1/timeseries/values" \  -H "Content-Type: application/json" \  -d '{    "series": [      {        "entity": "string",        "name": "string",        "provider": "string"      }    ],    "start": "2019-08-24T14:15:22Z",    "end": "2019-08-24T14:15:22Z"  }'
{
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "as_of": "latest",
  "series": [
    {
      "entity": "string",
      "name": "string",
      "provider": "string",
      "unit": "string",
      "resolution": "string",
      "publication_time": "declared",
      "licence": {
        "name": "string",
        "url": "string",
        "attribution": "string"
      },
      "columns": [
        "string"
      ],
      "points": [
        {
          "valid_time": "2019-08-24T14:15:22Z",
          "value": 0,
          "values": {
            "property1": 0,
            "property2": 0
          },
          "knowledge_time": "2019-08-24T14:15:22Z",
          "annotation": "string",
          "message": {
            "id": "string",
            "revision": "string",
            "reason": "string",
            "status": "string"
          }
        }
      ]
    }
  ],
  "next": "string"
}
{
  "error": "not_found",
  "message": "string",
  "param": "string",
  "anonymous": true,
  "limit_rpm": 0,
  "key_limit_rpm": 0,
  "retry_after_s": 0,
  "sign_up": "string",
  "docs": "string",
  "info": "string",
  "reason": "string",
  "closest": [
    "string"
  ],
  "providers": [
    "string"
  ]
}
{
  "error": "not_found",
  "message": "string",
  "param": "string",
  "anonymous": true,
  "limit_rpm": 0,
  "key_limit_rpm": 0,
  "retry_after_s": 0,
  "sign_up": "string",
  "docs": "string",
  "info": "string",
  "reason": "string",
  "closest": [
    "string"
  ],
  "providers": [
    "string"
  ]
}
{
  "error": "not_found",
  "message": "string",
  "param": "string",
  "anonymous": true,
  "limit_rpm": 0,
  "key_limit_rpm": 0,
  "retry_after_s": 0,
  "sign_up": "string",
  "docs": "string",
  "info": "string",
  "reason": "string",
  "closest": [
    "string"
  ],
  "providers": [
    "string"
  ]
}
{
  "error": "not_found",
  "message": "string",
  "param": "string",
  "anonymous": true,
  "limit_rpm": 0,
  "key_limit_rpm": 0,
  "retry_after_s": 0,
  "sign_up": "string",
  "docs": "string",
  "info": "string",
  "reason": "string",
  "closest": [
    "string"
  ],
  "providers": [
    "string"
  ]
}