N-n-a-andreibesleaga

Core Reference Data

Changed on

Returns the core reference data used for looking up IDs such as Connection Types, Operators, Countries etc.

This information is useful for UIs such as editing systems or for fetching results in the lighter non-verbose mode, then hydrating POI results back into complex objects.

get/referencedata

Request

  • Base URL
    https://api.openchargemap.io/v3
  • Auth
    • API key in query parameter key
    • or API key in header X-API-Key

Query parameters

unknown

Optional filter on countryid, exact match on a given numeric country id (comma separated list)

Response

OK

DataTypesunknown
MetadataGroupsstring

Example response

{
  "ChargerTypes": [
    {
      "ID": 2,
      "Title": "Level 2 : Medium (Over 2kW)",
      "Comments": "Over 2 kW, usually non-domestic socket type"
    }
  ],
  "ConnectionTypes": [
    {
      "FormalName": "IEC 62196-2 Type 2",
      "ID": 25,
      "Title": "Type 2 (Socket Only)"
    }
  ],
  "Countries": [
    {
      "ID": 1,
      "ISOCode": "GB",
      "ContinentCode": "EU",
      "Title": "United Kingdom"
    }
  ],
  "CurrentTypes": [
    {
      "ID": 10,
      "Title": "AC (Single-Phase)"
    }
  ],
  "DataProviders": [
    {
      "WebsiteURL": "https://openchargemap.org",
      "DataProviderStatusType": {
        "IsProviderEnabled": true
      },
      "IsOpenDataLicensed": true,
      "IsApprovedImport": true,
      "License": "Licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)",
      "DateLastImported": "2020-02-04T23:09:00Z",
      "ID": 1,
      "Title": "Open Charge Map Contributors"
    }
  ],
  "Operators": [
    {
      "WebsiteURL": "http://www.pod-point.com/",
      "AddressInfo": {
        "ID": 148879,
        "AddressLine1": "Buttsgrove Way",
        "Town": "Huntingdon",
        "Postcode": "PE29 1PE",
        "CountryID": 1,
        "Country": {
          "ID": 1,
          "ISOCode": "GB",
          "ContinentCode": "EU",
          "Title": "United Kingdom"
        },
        "Latitude": 52.343197,
        "Longitude": -0.170632
      },
      "ContactEmail": "enquiries@pod-point.com",
      "FaultReportEmail": "enquiries@pod-point.com",
      "Title": "POD Point (UK)"
    }
  ],
  "StatusTypes": [
    {
      "IsOperational": true,
      "IsUserSelectable": true,
      "ID": 50,
      "Title": "Operational"
    }
  ],
  "SubmissionStatusTypes": [
    {
      "ID": 200
    }
  ],
  "UsageTypes": [
    {
      "Title": "Public - Membership Required"
    }
  ]
}

Changes