Core Reference Data

GET/referencedata

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.

Query ParametersExpand Collapse

countryid: optional array of unknown

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

ReturnsExpand Collapse

ChargerTypes: optional array of object { Comments, ID, IsFastChargeCapable, Title }

Comments: string

ID: number

IsFastChargeCapable: boolean

If true, this level is considered ‘fast’ charging, relative to other levels.

Title: optional string

CheckinStatusTypes: optional array of object { ID, IsAutomatedCheckin, IsPositive, Title }

ID: number

IsAutomatedCheckin: boolean

If true, checkin or comment was provided by an automated system.

IsPositive: optional boolean

If true, this type of checkin/comment is considered positive.

Title: optional string

ConnectionTypes: optional array of object { FormalName, ID, IsDiscontinued, 2 more }

FormalName: optional string

Formal (standard) name for this connection type

ID: optional number

IsDiscontinued: optional boolean

If true, this is an discontinued but used connection type

IsObsolete: optional boolean

If true, this is an obsolete connection type and is unlikely top be present in modern infrastructure

Title: optional string

Countries: optional array of Country { ContinentCode, ID, ISOCode, Title }

ContinentCode: string

The Continentcode Schema

ID: number

The Id Schema

ISOCode: string

The Isocode Schema

Title: optional string

The Title Schema

CurrentTypes: optional array of object { ID, Title }

ID: number

Title: optional string

DataProviders: optional array of object { ID, IsRestrictedEdit, Comments, 7 more }

ID: number

The reference ID for this Data Provider

IsRestrictedEdit: boolean

Currently not implemented. Indicates a potential editing restriction.

Comments: optional string

General public comments with information about this Data Provider.

DataProviderStatusType: optional object { ID, IsProviderEnabled, description }

Status object describing whether this data provider is currently enabled and the type of source (manual entry, imported etc)

ID: number

The reference ID for this provider status type

IsProviderEnabled: boolean

If false, results from this data provider are not currently enabled

description: optional string

The Title of this status type

DateLastImported: optional string

Date and time (UTC) the last import was performed for this data provider (if an import).

formatdate-time

IsApprovedImport: optional boolean

If false, data may not be imported for this provider.

IsOpenDataLicensed: optional boolean

If true, data provider uses an Open Data license

License: optional string

Summary of the licensing which applies for this Data Provider. Each Data Provider has one specific license or agreement. Usage of the data requires acceptance of the given license.

Title: optional string

The Title for this Data Provider

WebsiteURL: optional string

Website URL for this data provider

DataTypes: optional unknown

MetadataGroups: optional string

Operators: optional array of object { ID, AddressInfo, BookingURL, 9 more }

ID: number

AddressInfo: optional object { CountryID, ID, Latitude, 15 more }

Geographic position for site and (nearest) address component information.

CountryID: number

The reference ID for the Country

ID: number

Latitude: number

Site latitude coordinate in decimal degrees

Longitude: number

Site longitude coordinate in decimal degrees

AccessComments: optional string

Guidance for users to use or find the equipment

AddressLine1: optional string

First line of nearby street address

AddressLine2: optional string

Second line of nearby street address

ContactEmail: optional string

Primary contact email

ContactTelephone1: optional string

Primary contact number

ContactTelephone2: optional string

Secondary contact number

Country: optional Country { ContinentCode, ID, ISOCode, Title }

Country details

ContinentCode: string

The Continentcode Schema

ID: number

The Id Schema

ISOCode: string

The Isocode Schema

Title: optional string

The Title Schema

Distance: optional number

Distance from search location, if search is around a point

DistanceUnit: optional number

Unit used for distance, 1= Miles, 2 = KM

Postcode: optional string

Postal code or Zipcode

RelatedURL: optional string

Optional website for more information

StateOrProvince: optional string

State or Province

Title: optional string

General title for this location to aid user

Town: optional string

Town or City

BookingURL: optional string

Comments: optional string

ContactEmail: optional string

FaultReportEmail: optional string

Used to send automated notification to network operator if a user submits a fault report comment/check-in

DeprecatedIsPrivateIndividual: optional boolean

If true, this operator represents a private individual

IsRestrictedEdit: optional boolean

If true, this network restricts community edits for OCM data

PhonePrimaryContact: optional string

Primary contact number for network users

PhoneSecondaryContact: optional string

Secondary contact number

Title: optional string

Title

WebsiteURL: optional string

Website for more information about this network

StatusTypes: optional array of object { ID, IsOperational, IsUserSelectable, Title }

ID: number

IsOperational: boolean

IsUserSelectable: boolean

Title: optional string

SubmissionStatusTypes: optional array of object { ID, IsLive, Title }

ID: number

Submission Status Type reference ID

IsLive: boolean

If true, POI listing is live (not draft or de-listed)

Title: optional string

UsageTypes: optional array of object { ID, IsAccessKeyRequired, IsMembershipRequired, 2 more }

ID: number

DeprecatedIsAccessKeyRequired: boolean

If true this usage required a physical access key

IsMembershipRequired: boolean

If true, this usage type requires registration or membership with a service.

IsPayAtLocation: boolean

If true, usage requires paying at location

Title: optional string

UserCommentTypes: optional array of object { ID, Title }

ID: optional number

Title: optional string

Core Reference Data

curl https://api.openchargemap.io/v3/referencedata

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

Returns Examples

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