Query stations around a GeoJSON point

With the query stationsAround you can fetch the stations around a GeoJSON point with a specific distance in meters. This can be useful when a station is busy, or when you want to provide several charging options.

Query stations around

Fetch the 20 closest stations around a GeoJSON location and plot them on a map.

Query stations around

Query

Query stations around a certain location by passing some coordinates into the stationAround query. Optionally add some filters or maintain performance by including pagination.

Filters

When querying a station around a GeoJSON location you need to set the location and distance on the filter argument. Optionally you can set power and amenities.

Pagination

To limit your results and improve the performance you can use pagination on your query.

Arguments

query StationAroundQuery

Deprecated

Deprecated: Replaced by filter and search params

filter StationAroundFilter

Filter station around result

size Int

Number of elements (count) to return, default: 10

page Int

Page number to return, default: 0

Frequently used fields

id ID

Unique ID of a station

Other fields

review ReviewStats

Review of a station

country_code String

ISO-3166 alpha-2 country code of a station

party_id String

CPO ID of a CPO that 'owns' this station (following the ISO-15118 standard)

publish Boolean

Defines if a location may be published on a website or app etc. When this is set to false, only tokens identified in the field: publish_allowed_to are allowed to show this location. When the same location has EVSEs that may be published and may not be published, two 'locations' should be created

name String

Name of a charging station

address String

Street/block name and house number if available

city String

City or town

postal_code String

Postal code of a location, may only be omitted when a location has no postal code: in some countries charging locations at highways don’t have postal codes.

state String

State or province of a location, only to be used when relevant

country String

ISO 3166-1 alpha-3 code for the country of this station

coordinates OCPIGeoLocation

Coordinates of a location

parking_type OCPIParkingType

Type of parking at a charge point location

Show OCPIParkingType enum values

evses EVSE

EVSEs that belong to a station

directions OCPIDisplayText

Human-readable directions on how to reach a station

operator Operator

Information about an operator

suboperator Operator

Information about a suboperator if applicable

owner Operator

Information about an owner if available

facilities OCPIFacility

Facilities a charging station belongs to

Show OCPIFacility enum values

time_zone String

Value from the IANA time zone database representing the time zone of a location. Examples: "Europe/Oslo", "Europe/Zurich". (http://www.iana.org/time-zones)

opening_times OCPIHours

Times when an EVSEs at a location can be accessed for charging

charging_when_closed Boolean

Indicates if the EVSEs are still charging outside the opening hours. E.g. when a parking garage closes its barriers overnight, is it allowed to charge till the next morning? Default: true

images OCPIImage

Links to images related to a location such as photos or logos

energy_mix OCPIEnergyMix

Details of the energy supplied at a location

last_updated DateTime

Timestamp when a location, or one of its EVSEs or Connectors were last updated (or created)

external_id String

ID provided by a station data source

location Point

GeoJSON location of a charging station

elevation Int

Elevation (altitude) level

chargers Charger

Groups of EVSEs by power and type

amenities JSON

Amenities located at this location

physical_address Address

Enriched information about the physical address of a station

properties JSON

Optional object where you can store custom data you need in your application. This extends the current functionalities we offer

realtime Boolean

A flag that indicates if a station has real-time information about the availability of its connectors

private Boolean

A flag that indicates if a station is on private property

power JSON

Connectors grouped by power

predicted_availability StationPredictedAvailability

Deprecated

Station availability

predicted_occupancy StationPredictedOccupancy

Deprecated

Predicted station occupancy

speed StationSpeedType

Charging speed for a station

Show StationSpeedType enum values

status ChargerStatus

Global status for a station

Show ChargerStatus enum values

custom_properties StationCustomProperties

Custom properties of a station. These are vendor specific and will return null values on the fields that are not supported by your station database

Response

A response can either contain a data or an errors object. The response header will always return 200 as a status code.

Data object

When successful, a data object will be returned with the requested fields. If there are no fields present the data object will return the operation name with the appropriate return type. If the operation was a query, this output will be an object of the schema’s query root type; if the operation was a mutation, this output will be an object of the schema’s mutation root type.

Error object

If unsuccessful, an errors object will be returned with more details in the extensions object. The error object can contain any of the following objects.