v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Charge Points

Retrieve charge points / sites for map

Required scope: map:read. RateLimit-Policy: Fair-Use

get/api/v1/charge-points/map

Query parameters

topLatitudenumber double required

top (north) latitude value (between -90-90)

Example:90

rightLongitudenumber double required

right (east) longitude value (between -180-180)

Example:180

bottomLatitudenumber double required

bottom (south) latitude value (between -90-90)

Example:-90

leftLongitudenumber double required

left (west) longitude value (between -180-180)

Example:-180

centerLatitudenumber double required

latitude value of the center coordinate of your map (between -90-90)

Example:90

centerLongitudenumber double required

longitude value of the center coordinate of your map (between -180-180)

Example:180

zoomnumber double required

zoom level of the map (between 1-15)

Example:1

includeBusyboolean nullable required

If true, busy charge points are returned as well. Otherwise, only charge points that are active and not in use are returned.

Example:true

includeAllOperatorsboolean nullable required

If true, all public charge points are returned. Otherwise, only charge points owned by the operator/teams matching the request credentials.

Response

List of charges points /sites that match the criteria

Example response

{
  "chargePoints": [
    {
      "id": 1,
      "siteId": 42,
      "name": "Monta CPH HQ",
      "visibility": "public",
      "maxKW": 150,
      "maxKw": 150,
      "type": "ac",
      "note": "In order to access this charge point enter 0000 as code at the gate.",
      "state": "available",
      "location": {
        "coordinates": {
          "latitude": 55.6760968,
          "longitude": 12.5683371
        },
        "addressLabel": "Strandboulevarden 122, 5. sal, 2100 København, Denmark",
        "address": {
          "address1": "Strandboulevarden 122",
          "address2": "København",
          "address3": "5. sal",
          "zip": "2100",
          "city": "Copenhagen",
          "province": "Lombardy",
          "country": "Denmark",
          "countryAreaId": 1
        }
      },
      "connectors": [
        {
          "id": 1,
          "identifier": "ccs",
          "name": "CCS"
        }
      ]
    }
  ],
  "sites": [
    {
      "id": 1,
      "name": "Monta CPH HQ",
      "chargePointCount": 42,
      "maxKW": 150,
      "maxKw": 150,
      "type": "ac",
      "visibility": "public",
      "note": "In order to access this site enter 0000 as code at the gate.",
      "location": {
        "coordinates": {
          "latitude": 55.6760968,
          "longitude": 12.5683371
        },
        "addressLabel": "Strandboulevarden 122, 5. sal, 2100 København, Denmark",
        "address": {
          "address1": "Strandboulevarden 122",
          "address2": "København",
          "address3": "5. sal",
          "zip": "2100",
          "city": "Copenhagen",
          "province": "Lombardy",
          "country": "Denmark",
          "countryAreaId": 1
        }
      },
      "connectors": [
        {
          "id": 1,
          "identifier": "ccs",
          "name": "CCS"
        }
      ]
    }
  ],
  "cluster": [
    {
      "coordinates": {
        "latitude": 55.6760968,
        "longitude": 12.5683371
      }
    }
  ]
}