Discover

Units in an entity

The generation units (machines) under a grid entity, descending the tree; a plant's units; or, on a portfolio, the units of every plant that names it: every battery in DE-LU in one call, rather than one call per plant. Sorted by capacity. Paged: next is the path of the next page, filters and cursor included; request it as it is. Items are unit cards.

GET
/entities/{entity}/units
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

Path Parameters

entity*string

The entity id, e.g. SE-SE3, Sweden, sync:NSA, ca:DE-Amprion, bnd:GB-B1, sub:Blyth, border:FI~SE-SE3, icx:BritNed, or a plant, unit or portfolio: plant:11WD4SAEK2HS---S, unit:…, portfolio:… — the key, or the name after the kind prefix (plant:Säckingen hydroelectric plant). A name shared by several records is 404 listing their ids. See the Entities guide for every kind.

Query Parameters

type?string

wind, solar, hydro, gas, battery, …

production_type?string
fuel?string
min_kw?number
has_timeseries?boolean
bbox?string

minLon,minLat,maxLon,maxLat

provider?string
limit?integer
Default100
Range1 <= value <= 1000
cursor?string

Set for you in next, which is a whole path; do not copy next into this parameter.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://grid.rebase.energy/api/v1/entities/string/units"
{
  "id": "string",
  "total": 0,
  "items": [
    {
      "id": "string",
      "kind": "plant",
      "name": "string",
      "common_name": "string",
      "parent": "string",
      "technology": "string",
      "sub_technology": "string",
      "psr_type": "string",
      "capacity_mw": 0,
      "location": {
        "latitude": 0,
        "longitude": 0,
        "accuracy": "exact"
      },
      "portfolio": "string",
      "provider": {
        "name": "string",
        "id": "string",
        "registry_name": "string"
      },
      "units": 0,
      "timeseries": 0
    }
  ],
  "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"
  ]
}
{
  "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"
  ]
}