Poi

Retrieve POI list (sites)

GET/poi

ModelsExpand Collapse

PoiListResponse = array of object { AddressInfo, Connections, DataProvider, 27 more }

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

Connections: optional array of object { Amps, Comments, ConnectionType, 12 more }

List of equipment summary information for this site

Amps: optional number

EVSE supply max current in Amps

Comments: optional string

ConnectionType: optional object { FormalName, ID, IsDiscontinued, 2 more }

The type of end-user connection an EVSE supports.

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

ConnectionTypeID: optional number

CurrentType: optional object { ID, Title }

Indicates the EVSE power supply type e.g. DC (Direct Current), AC (Single Phase), AC (3 Phase).

ID: number

Title: optional string

CurrentTypeID: optional number

The supply type reference ID (e.g. DC etc)

ID: optional number

Level: optional object { Comments, ID, IsFastChargeCapable, Title }

A general category for equipment power capability. Deprecated for general use. Currently computed automatically based on equipment power.

Comments: string

ID: number

IsFastChargeCapable: boolean

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

Title: optional string

DeprecatedLevelID: optional number

A general category for power capability. Depreceated in favour of documenting specific equipment power in kW.

PowerKW: optional number

Peak available power in kW

Quantity: optional number

Optional summary number of equipment items available with this specification

Reference: optional string

Optional operators reference for this connection/port

StatusType: optional object { ID, IsOperational, IsUserSelectable, Title }

The Status Type of a site or equipment item indicates whether it is generally operational.

ID: number

IsOperational: boolean

IsUserSelectable: boolean

Title: optional string

StatusTypeID: optional number

Status Type reference ID. 0 = Unknown

Voltage: optional number

EVSE supply voltage

DataProvider: optional object { ID, IsRestrictedEdit, Comments, 7 more }

A Data Provider is the controller of the source data set used to construct the details for this POI. Data has been transformed and interpreted from it’s original form. Each Data Provider provides data either by an explicit license or agreement.

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

DataProviderID: optional number

The reference ID for the Data Provider of this POI

DataProvidersReference: optional string

If present, this is the Data Providers own key for this POI within their source data set

DataQualityLevel: optional number

A metric applied during imports to indicate a quality level based on available information detail (5 == best). Largely unused currently.

DateCreated: optional string

The date and time (UTC, ISO 8601) this POI was added to the Open Charge Map database

formatdate-time

DateLastConfirmed: optional string

The date and time (UTC, ISO 8601) this POI was last confirmed according to the data provider or a user. See DateLastVerified for a dynamically computed date based on multiple signals.

formatdate-time

DateLastStatusUpdate: optional string

The date and time (UTC, ISO 8601) this POI or directly related child properties were updated.

formatdate-time

DateLastVerified: optional string

A dynamically computed value, the date and time (UTC, ISO 8601) this POI was last confirmed by a user edit or related user comment

formatdate-time

DatePlanned: optional string

The date and time (UTC, ISO 8601) this POI is or was planned for commissioning. In general planned POIs should not be presented to end users until confirmed operational.

formatdate-time

GeneralComments: optional string

General additional factual information for the POI. Users are discouraged from using this field for opinions on site quality etc.

ID: optional number

The OCM reference ID for this POI (Point of Interest).

IsRecentlyVerified: optional boolean

A dynamically computed value indicating of any recently confirmation activity has taken place for this site (positive check-ins etc)

MediaItems: optional array of object { ChargePointID, Comment, DateCreated, 8 more }

A list of user submitted photos for this site

ChargePointID: optional string

Comment: optional string

DateCreated: optional string

ID: optional string

IsEnabled: optional boolean

IsExternalResource: optional boolean

IsFeaturedItem: optional boolean

IsVideo: optional boolean

ItemThumbnailURL: optional string

ItemURL: optional string

User: optional object { ID, ProfileImageURL, ReputationPoints, Username }

Short public summary profile for a specific Open Charge Map user

ID: optional number

ProfileImageURL: optional string

ReputationPoints: optional number

Username: optional string

MetadataValues: optional array of unknown

Optional array of metadata values. Generally used to indicate data attribution but is also intended for future use to indicate surrounding amenties, links or foreign key values into other data sets.

NumberOfPoints: optional number

The number of bays or discreet stations available overall at this site. This indicates the limiting for number of simultaneous site users.

OperatorID: optional number

The reference ID of the equipment network operator or owner

OperatorInfo: optional object { ID, AddressInfo, BookingURL, 9 more }

An Operator is the public organisation which controls a network of charging points.

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

OperatorsReference: optional string

The network operators own reference for this site (may be a site reference or a single equipment reference)

ParentChargePointID: optional number

If present, this data in this POI supercedes information in another POI. Generally not relevant to consumers.

StatusType: optional object { ID, IsOperational, IsUserSelectable, Title }

The Status Type of a site or equipment item indicates whether it is generally operational.

ID: number

IsOperational: boolean

IsUserSelectable: boolean

Title: optional string

StatusTypeID: optional number

The overall operational status type reference ID for this POI (i.e. Operational etc). 0 == Unknown

SubmissionStatus: optional object { ID, IsLive, Title }

Submission Status object, detailing the POI listing status

ID: number

Submission Status Type reference ID

IsLive: boolean

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

Title: optional string

SubmissionStatusTypeID: optional number

The reference ID for the submission status type which applied to this POI.

UsageCost: optional string

Free text description of likely usage costs associated with this site. Generally relates to parking charges whether network operates this site as Free

UsageType: optional object { ID, IsAccessKeyRequired, IsMembershipRequired, 2 more }

The Usage Type of a site indicates the general restrictions on usage.

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

UsageTypeID: optional number

The reference ID for the site Usage Type, 0 == Unknown

UserComments: optional array of object { ChargePointID, CheckinStatusType, CheckinStatusTypeID, 8 more }

A list of user comments or check-ins for this site

ChargePointID: optional number

CheckinStatusType: optional object { ID, IsAutomatedCheckin, IsPositive, Title }

Classification for the users comment or experience using a specific charging location.

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

CheckinStatusTypeID: optional number

Comment: optional string

CommentType: optional object { ID, Title }

Category for a user comment, e.g. General Comment, Fault Report (Notice To Users And Operator)

ID: optional number

Title: optional string

CommentTypeID: optional number

DateCreated: optional string

formatdate-time

ID: optional string

RelatedURL: optional string

User: optional object { ID, ProfileImageURL, ReputationPoints, Username }

Short public summary profile for a specific Open Charge Map user

ID: optional number

ProfileImageURL: optional string

ReputationPoints: optional number

Username: optional string

UserName: optional string

UUID: optional string

A universally unique identifier used as surrogate key. ID and UUID must be preserved when submitting POI update information.

formatuuid