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

To query a station around GeoJSON point you have set various query arguments including location, distance and optionally power and amenities. To limit your results and improve the performance you can use pagination on your query.

Arguments

query • input_object • StationAroundQuery

Deprecated

Deprecated: Replaced by filter and search params

filter • input_object • StationAroundFilter

Filter station around result

location • input_object • PointInput

The GeoJSON Point of the center of the around me circle

distance • scalar • Int

Distance, in meters, to search around

powers • list • Float

Powers in kWh

amenities • list • Amenities

Amenities available near a station

power_groups • list • StationSpeedType

Station speed

connectors • list • ConnectorType

Station socket or plug standards

available_only • scalar • Boolean

Flag that allows you to return only available stations

preferred_operator • scalar • Boolean

Flag indicating if only stations that are owned by an operator from a clients ranking list are returned

search • scalar • String

Search for stations around by name, id and external id

size • scalar • Int

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

page • scalar • Int

Page number to return, default: 0

Frequently used fields

id • non_null • ID

Required

Unique ID of a station

Other fields

review • object • ReviewStats

Review of a station

id • non_null • ID

Required

Unique ID of a station

country_code • scalar • String

ISO-3166 alpha-2 country code of a station

party_id • scalar • String

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

publish • scalar • 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 • scalar • String

Name of a charging station

address • scalar • String

Street/block name and house number if available

city • scalar • String

City or town

postal_code • scalar • 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 • scalar • String

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

country • scalar • String

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

coordinates • object • OCPIGeoLocation

Coordinates of a location

related_locations • list • OCPIAdditionalGeoLocation

Geographical location of related points relevant to a user

parking_type • enum • OCPIParkingType

Type of parking at a charge point location

evses • list • EVSE

EVSEs that belong to a station

uid • scalar • String

Uniquely identifies an EVSE within the CPOs platform (and suboperator platforms). For example a database ID or the actual "EVSE ID". This field can never be changed, modified or renamed. This is the 'technical' identification of the EVSE, not to be used as 'human readable' identification, use the field evse_id for that. This field is named uid instead of id, because id could be confused with evse_id which is an eMI3 defined field.

evse_id • scalar • String

Compliant with the following specification for EVSE ID from "eMI3 standard version V1.0" (http://emi3group.com/documents-links/) "Part 2: business objects." Optional because: if an evse_id is to be re-used in the real world, the evse_id can be removed from an EVSE object if the status is set to REMOVED.

status • enum • OCPIStatus

Indicates the current status of an EVSE.

status_schedule • list • OCPIStatusSchedule

Indicates a planned status update of a nEVSE.

capabilities • list • OCPICapability

List of functionalities that an EVSE is capable of.

connectors • list • Connector

List of available connectors on an EVSE.

id • scalar • String

Identifier of a connector within an EVSE. Two connectors may have the same ID as long as they do not belong to the same EVSE object.

standard • enum • ConnectorType

Standard of an installed connector.

format • enum • OCPIConnectorFormat

Format (socket/cable) of an installed connector.

power_type • enum • OCPIPowerType

Type of power of an installed connector.

max_voltage • scalar • Int

Maximum voltage of an connector (line to neutral for AC_3_PHASE), in volt [V]. For example: DC Chargers might vary the voltage during charging when battery almost full.

max_amperage • scalar • Int

Maximum amperage of a connector, in ampere [A].

max_electric_power • scalar • Int

Maximum electric power that can be delivered by a connector, in watt [W]. When the maximum electric power is lower than the calculated value from voltage and amperage, this value should be set. For example: A DC Charge Point which can deliver up to 920V and up to 400A can be limited to a maximum of 150kW. Depending on the car, it may supply maximum voltage or current, but not both at the same time. For AC Charge Points, the amount of phases used can also have influence on the maximum power.

power • scalar • Float

Maximum electric power in kW

tariff_ids • list • String

Identifiers of the currently valid charging tariffs. Multiple tariffs are possible, but only one of each Tariff.type can be active at the same time. Tariffs with the same type are only allowed, if they are not active at the same time: start_date_time and end_date_time period not overlapping. When preference-based smart charging is supported, one tariff for every possible ProfileType should be provided. This tells the user about the options they have at this Connector, and what the tariff is for every option. For a "free of charge" tariff, this field should be set and point to a defined "free of charge" tariff.

terms_and_conditions • scalar • String

URL to an operator’s terms and conditions.

last_updated • scalar • DateTime

Timestamp when a connector was last updated (or created).

properties • scalar • JSON

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

tariff • list • OCPITariff

List of valid charging tariffs

country_code • scalar • String

ISO-3166 alpha-2 country code of the CPO that owns this tariff

party_id • scalar • String

CPO ID of the CPO that owns this tariff (following the ISO-15118 standard)

id • scalar • String

Uniquely identifies the tariff within the CPO’s platform (and suboperator platforms)

currency • scalar • String

ISO-4217 code of the currency of this tariff.

type • enum • OCPITariffType

Defines the type of the tariff. This allows for distinction in case of given charging preferences. When omitted, this tariff is valid for all sessions

tariff_alt_text • list • OCPIDisplayText

List of alternative tariff information texts, in multiple languages

tariff_alt_url • scalar • String

URL to a web page that contains an explanation of the tariff information in human readable form

min_price • object • OCPIPrice

When this field is set, a charging session with this tariff will cost at least the amount shown. This is different from a FLAT fee (start tariff, transaction fee), as a FLAT fee is a fixed amount that must be paid for any charging session. A minimum price indicates that when the cost of a charging session is lower than this amount, the cost of the session will be equal to this amount

max_price • object • OCPIPrice

When this field is set, a charging session with this tariff will NOT cost more than this amount

elements • list • OCPITariffElement

List of tariff elements

price_components • list • OCPIPriceComponent

List of price components that describe the pricing of a tariff.

restrictions • list • OCPITariffRestrictions

Restrictions that describe the applicability of a tariff.

start_time • scalar • String

Start time of day in local time, the time zone is defined in the time_zone field of the Location, for example 13:30, valid from this time of the day. Must be in 24h format with leading zeros. Hour/Minute separator: ":" Regex: ([0-1][0-9]|2[1-3]):[0-5][0-9]

end_time • scalar • String

End time of day in local time, the time zone is defined in the time_zone field of the Location, for example 19:45, valid until this time of the day. Same syntax as start_time.

start_date • scalar • String

Start date in local time, the time zone is defined in the time_zone field of the Location, for example: 2015-12-24, valid from this day. Regex: ([12][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])

end_date • scalar • String

End date in local time, the time zone is defined in the time_zone field of the Location, for example: 2015-12-27, valid until this day (exclusive). Same syntax as start_date

min_kwh • scalar • Float

Minimum consumed energy in kWh, for example 20, valid from this amount of energy being used

max_kwh • scalar • Float

Maximum consumed energy in kWh, for example 50, valid until this amount of energy being used

min_current • scalar • Float

Sum of the minimum current in over all phases, for example 5. When the EV is charging with more than the defined amount of current, this tariff element is/becomes active. If the charging current is or becomes lower, this tariff element is not or no longer valid and becomes inactive. This does not describe the minimum current over the entire charging session. This restriction can make a tariff element become active when the charging current is above the defined value, but the tariff element MUST no longer be active when the charging current drops below the defined value

max_current • scalar • Float

Sum of the maximum current in over all phases, for example 20. When the EV is charging with less than the defined amount of current, this tariff element becomes/is active. If the charging current is or becomes higher, this tariff element is not or no longer valid and becomes inactive. This describes NOT the maximum current over the entire Charging Session. This restriction can make a tariff element become active when the charging current is below this value, but the tariff element MUST no longer be active when the charging current raises above the defined value

min_power • scalar • Float

Minimum power in kW, for example 5. When the EV is charging with more than the defined amount of power, this tariff element is/becomes active. If the charging power is or becomes lower, this tariff element is not or no longer valid and becomes inactive. This does not describe the minimum power over the entire charging session. This restriction can make a tariff element become active when the charging power is above this value, but the TariffElement MUST no longer be active when the charging power drops below the defined value

max_power • scalar • Float

Maximum power in kW, for example 20. When the EV is charging with less than the defined amount of power, this tariff element becomes/is active. If the charging power is or becomes higher, this tariff element is not or no longer valid and becomes inactive. This does not describe the maximum power over the entire charging session. This restriction can make a tariff element become active when the charging power is below this value, but the TariffElement MUST no longer be active when the charging power raises above the defined value

min_duration • scalar • Float

Minimum duration in seconds the charging session MUST last (inclusive). When the duration of a charging session is longer than the defined value, this TariffElement is or becomes active. Before that moment, this tariff element is not yet active

max_duration • scalar • Float

Maximum duration in seconds the charging session MUST last (exclusive). When the duration of a charging session is shorter than the defined value, this tariff element is or becomes active. After that moment, this tariff element is no longer active

day_of_week • enum • OCPIDayOfWeek

Which day(s) of the week this tariff element is active.

reservation • enum • OCPIReservationRestrictionType

When this field is present, the tariff element describes reservation costs. A reservation starts when the reservation is made, and ends when the drivers starts charging on the reserved EVSE/Location, or when the reservation expires. A reservation can only have: FLAT and TIME TariffDimensions, where TIME is for the duration of the reservation

start_date_time • scalar • DateTime

Time when this tariff becomes active, in UTC, time_zone field of the Location can be used to convert to local time. Typically used for a new tariff that is already given with the location, before it becomes active

end_date_time • scalar • DateTime

Time after which this tariff is no longer valid, in UTC, time_zone field if the location can be used to convert to local time. Typically used when this tariff is going to be replaced with a different tariff in the near future

energy_mix • object • OCPIEnergyMix

Details about the energy supplied with this tariff

last_updated • scalar • DateTime

Timestamp when this tariff was last updated (or created)

pricing • object • Pricing

Deprecated

Charging prices

custom_properties • object • ConnectorCustomProperties

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

floor_level • scalar • String

Level on which a Charge Point is located (in garage buildings) in the locally displayed numbering scheme.

coordinates • object • OCPIGeoLocation

Coordinates of a EVSE.

physical_reference • scalar • String

A number/string printed on the outside of an EVSE for visual identification.

parking_restrictions • list • OCPIParkingRestriction

Restrictions that apply to a parking spot.

images • list • OCPIImage

Links to images related to an EVSE such as photos or logos.

last_updated • scalar • DateTime

Timestamp when this EVSE or one of its Connectors was last updated (or created).

parking_cost • enum • ParkingCost

Indicates if parking is free or paid.

properties • scalar • JSON

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

directions • list • OCPIDisplayText

Human-readable directions on how to reach a station

operator • object • Operator

Information about an operator

id • scalar • ID

Unique operator ID

external_id • scalar • String

External ID of an operator provided by the operator data source

name • scalar • String

Name of an operator

website • scalar • String

Link to an operator’s website

logo • object • OCPIImage

Image link to an operator’s logo

country • scalar • String

Deprecated

Deprecated: Not used anymore, please use countries property instead

countries • list • CountryCodeAlpha2

ISO-3166 alpha-2 country codes an operator is active in.

contact • object • Contact

Contact information

ranking • scalar • Int

Ranking level on which the operator is placed or null in case the operator is not on any ranking level

excluded • scalar • Boolean

Flag which indicates if the operator is in the excluded list

suboperator • object • Operator

Information about a suboperator if applicable

id • scalar • ID

Unique operator ID

external_id • scalar • String

External ID of an operator provided by the operator data source

name • scalar • String

Name of an operator

website • scalar • String

Link to an operator’s website

logo • object • OCPIImage

Image link to an operator’s logo

country • scalar • String

Deprecated

Deprecated: Not used anymore, please use countries property instead

countries • list • CountryCodeAlpha2

ISO-3166 alpha-2 country codes an operator is active in.