v1

latestOpenAPI 3.1.0raw.githubusercontent.com2025-07-1162077.3 KB

Retrieve POI list (sites)

Used to fetch a list of POIs (sites) within a geographic boundary or near a specific latitude/longitude. This is the primary method for most applications and services to consume data from Open Charge Map.

get/poi

Query parameters

outputstring

Optional output format json,geojson,xml,csv, JSON is the default and recommended as the highest fidelity.

clientstring

String to identify your client application. Optional but recommended to distinguish your client from other bots/crawlers

maxresultsinteger

Limit on max number of results returned

countrycodestring

2-character ISO Country code to filter to one specific country

countryidstring[]

Exact match on a given numeric country id (comma separated list)

latitudeinteger

Latitude for distance calculation and filtering

longitudenumber

Longitude for distance calculation and filtering

distancenumber

Optionally filter results by a max distance from the given latitude/longitude

distanceunitstring

miles or km distance unit

{"stackTrail":"paths:/poi:get:parameters:9:schema:items","oasType":"schema","type":"unknown"}

Exact match on a given EVSE operator id (comma separated list)

{"stackTrail":"paths:/poi:get:parameters:10:schema:items","oasType":"schema","type":"unknown"}

Exact match on a given connection type id (comma separated list)

{"stackTrail":"paths:/poi:get:parameters:11:schema:items","oasType":"schema","type":"unknown"}

Exact match on a given charging level (1-3) id (comma separated list)

{"stackTrail":"paths:/poi:get:parameters:12:schema:items","oasType":"schema","type":"unknown"}

Exact match on a given usage type id (comma separated list)

{"stackTrail":"paths:/poi:get:parameters:13:schema:items","oasType":"schema","type":"unknown"}

Exact match on a given status type id (comma separated list)

{"stackTrail":"paths:/poi:get:parameters:14:schema:items","oasType":"schema","type":"unknown"}

Exact match on a given data provider id id (comma separated list).

opendataboolean

Use opendata=true for only OCM provided ("Open") data.

includecommentsboolean

If true, user comments and media items will be include in result set

verboseboolean

Set to false to get a smaller result set with null items removed.

compactboolean

Set to true to remove reference data objects from output (just returns IDs for common reference data such as DataProvider etc).

camelcaseboolean

Set to true to get a property names in camelCase format.

chargepointidstring

Exact match on a given OCM POI ID (comma separated list)

{"stackTrail":"paths:/poi:get:parameters:21:schema:items","oasType":"schema","type":"unknown"}

Filter results to a given bounding box. specify top left and bottom right box corners as: (lat,lng),(lat2,lng2)

polygonstring

Filter results within a given Polygon. Specify an encoded polyline for the polygon shape. Polygon will be automatically closed from the last point to the first point.

polylinestring

Filter results along an encoded polyline, use with distance param to increase search distance along line. Polyline is expanded into a polygon to cover the search distance.

sortbystring

Default sort order is based on spatial index but you can optionally sort by modified_asc for results in order of modification (oldest to newest), or id_asc for results in order of ID

modifiedsincestring

Filter to results modified after the given date

greaterthanidstring

Filter to items with ID greater than given value

Response

List of POIs (sites) with associated equipment summary information.

IDinteger

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

UUIDstring uuid

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

IsRecentlyVerifiedboolean

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

DateLastVerifiedstring date-time

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

ParentChargePointIDinteger

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

DataProviderIDinteger

The reference ID for the Data Provider of this POI

DataProvidersReferencestring

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

OperatorIDinteger

The reference ID of the equipment network operator or owner

OperatorsReferencestring

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

UsageTypeIDinteger

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

UsageCoststring

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

NumberOfPointsinteger

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

GeneralCommentsstring

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

DatePlannedstring date-time

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.

DateLastConfirmedstring date-time

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.

StatusTypeIDinteger

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

DateLastStatusUpdatestring date-time

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

DataQualityLevelinteger

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

DateCreatedstring date-time

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

SubmissionStatusTypeIDinteger

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

Example response

[
  {
    "ID": 148527,
    "UUID": "4C524AA1-3413-4D56-804C-480304FEB0FB",
    "UserComments": [
      {
        "ID": "string",
        "ChargePointID": 0,
        "CommentTypeID": 0,
        "CommentType": {
          "ID": 0,
          "Title": "string"
        },
        "UserName": "string",
        "Comment": "string",
        "RelatedURL": "string",
        "DateCreated": "2019-08-24T14:15:22Z",
        "User": {
          "ID": 0,
          "Username": "string",
          "ReputationPoints": 0,
          "ProfileImageURL": "string"
        },
        "CheckinStatusTypeID": 0,
        "CheckinStatusType": {
          "ID": 0,
          "Title": "string",
          "IsAutomatedCheckin": true,
          "IsPositive": true
        }
      }
    ],
    "MediaItems": [
      {
        "ID": "string",
        "ChargePointID": "string",
        "ItemURL": "string",
        "ItemThumbnailURL": "string",
        "Comment": "string",
        "IsEnabled": true,
        "IsVideo": true,
        "IsFeaturedItem": true,
        "IsExternalResource": true,
        "User": {
          "ID": 0,
          "Username": "string",
          "ReputationPoints": 0,
          "ProfileImageURL": "string"
        },
        "DateCreated": "string"
      }
    ],
    "IsRecentlyVerified": true,
    "DateLastVerified": "2020-02-04T06:33:00Z",
    "ParentChargePointID": 0,
    "DataProviderID": 1,
    "DataProvidersReference": "string",
    "OperatorID": 3,
    "OperatorsReference": "PG-84306",
    "UsageTypeID": 4,
    "UsageCost": "See network operators app for current charges",
    "AddressInfo": {
      "ID": 148879,
      "AddressLine1": "Buttsgrove Way",
      "AddressLine2": null,
      "Town": "Huntingdon",
      "StateOrProvince": "string",
      "Postcode": "PE29 1PE",
      "CountryID": 1,
      "Country": {
        "ID": 1,
        "ISOCode": "GB",
        "ContinentCode": "EU",
        "Title": "United Kingdom"
      },
      "Latitude": 52.343197,
      "Longitude": -0.170632,
      "ContactTelephone1": null,
      "ContactTelephone2": null,
      "ContactEmail": "string",
      "AccessComments": "string",
      "RelatedURL": null,
      "Distance": null,
      "DistanceUnit": 1,
      "Title": "string"
    },
    "Connections": [
      {
        "ID": 206241,
        "ConnectionTypeID": 25,
        "ConnectionType": {
          "FormalName": "IEC 62196-2 Type 2",
          "IsDiscontinued": false,
          "IsObsolete": false,
          "ID": 25,
          "Title": "Type 2 (Socket Only)"
        },
        "Reference": null,
        "StatusTypeID": 50,
        "StatusType": {
          "IsOperational": true,
          "IsUserSelectable": true,
          "ID": 50,
          "Title": "Operational"
        },
        "LevelID": 2,
        "Level": {
          "ID": 2,
          "Title": "Level 2 : Medium (Over 2kW)",
          "Comments": "Over 2 kW, usually non-domestic socket type",
          "IsFastChargeCapable": true
        },
        "Amps": 32,
        "Voltage": 230,
        "PowerKW": 7.4,
        "CurrentTypeID": 10,
        "CurrentType": {
          "ID": 10,
          "Title": "AC (Single-Phase)"
        },
        "Quantity": 2,
        "Comments": "string"
      }
    ],
    "NumberOfPoints": 2,
    "GeneralComments": "This is an open charge unit installed at the Coneygear Centre at Buttsgrove Way, Huntingdon",
    "DatePlanned": "2020-02-04T06:33:00Z",
    "DateLastConfirmed": "2020-02-04T06:33:00Z",
    "StatusTypeID": 50,
    "DateLastStatusUpdate": "2020-02-04T06:33:00Z",
    "MetadataValues": [
      null
    ],
    "DataQualityLevel": 5,
    "DateCreated": "2020-02-04T06:33:00Z",
    "SubmissionStatusTypeID": 200,
    "DataProvider": {
      "WebsiteURL": "https://openchargemap.org",
      "Comments": "string",
      "DataProviderStatusType": {
        "IsProviderEnabled": true,
        "ID": [
          1
        ],
        "description": [
          "Manual Data Entry"
        ]
      },
      "IsRestrictedEdit": false,
      "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"
    },
    "OperatorInfo": {
      "WebsiteURL": "http://www.pod-point.com/",
      "Comments": null,
      "PhonePrimaryContact": null,
      "PhoneSecondaryContact": null,
      "IsPrivateIndividual": false,
      "AddressInfo": {
        "ID": 148879,
        "AddressLine1": "Buttsgrove Way",
        "AddressLine2": null,
        "Town": "Huntingdon",
        "StateOrProvince": "string",
        "Postcode": "PE29 1PE",
        "CountryID": 1,
        "Country": {
          "ID": 1,
          "ISOCode": "GB",
          "ContinentCode": "EU",
          "Title": "United Kingdom"
        },
        "Latitude": 52.343197,
        "Longitude": -0.170632,
        "ContactTelephone1": null,
        "ContactTelephone2": null,
        "ContactEmail": "string",
        "AccessComments": "string",
        "RelatedURL": null,
        "Distance": null,
        "DistanceUnit": 1,
        "Title": "string"
      },
      "BookingURL": "string",
      "ContactEmail": "enquiries@pod-point.com",
      "FaultReportEmail": "enquiries@pod-point.com",
      "IsRestrictedEdit": true,
      "ID": 0,
      "Title": "POD Point (UK)"
    },
    "UsageType": {
      "IsPayAtLocation": true,
      "IsMembershipRequired": true,
      "IsAccessKeyRequired": true,
      "ID": 0,
      "Title": "Public - Membership Required"
    },
    "StatusType": {
      "IsOperational": true,
      "IsUserSelectable": true,
      "ID": 50,
      "Title": "Operational"
    },
    "SubmissionStatus": {
      "ID": 200,
      "Title": "string",
      "IsLive": false
    }
  }
]

All 6 operations