Use the locations
endpoint to retrieve a list of all locations or a specific location (using the location's id).
Note
The location information is retrieved in bulk. Eco-Movement recommends that you retrieve the entire dataset once a day.
Request
See locations and locations/{id} to know more about the parameters that are used with the two versions of the locations
endpoint.
Response
The following is a sample response for the locations
endpoint:
{
data: [
{ location 1
[
{ EVSE 1
[{ connnector 1 },{ connector 2 }]},
{ EVSE 2
[{...},{...}]}
]
},
{ location 2 [{...}]},
],
}
Note
Use the "Try It!" button in locations and locations/{id} to view an actual response from our API.
The following table describes the main objects in the response of the locations
endpoint:
Main Object | Description |
---|---|
Location | A location is a group of one or more EVSEs that logically belong together. For example, all the charge points at a roadside service area. |
EVSE | An EVSE is a spot where a single EV can charge. An EVSE may provide multiple connectors, but only one of these connectors can be active at the same time. This is similar to the various diesel and petrol nozzles present at a single dispenser. |
Connector | A connector is a specific socket or cable available for the electric vehicle. |
Caution
Eco-Movement may send new attributes in our JSON response when we add an OCPI mandatory attribute to the JSON response to be OCPI compliant.
Response Definitions
The main objects consist of several OCPI attributes.
Standard OCPI Attributes
The following are the standard attributes of OCPI 2.2.1:
Attribute | Description |
---|---|
data.country_code | The ISO-3166 alpha-2 country code of the CPO that owns the location. For example, NL for The Netherlands. |
data.party_id | The ID of the CPO that owns the location based on the ISO-15118 standard. For example, ECO for Eco-Movement. |
data.id | The unique id for a location. It is created by Eco-Movement, and it is stable. This attribute may change when two or more locations are merged, which results in one location only. |
data.address | The street and house number where the charge point is located. |
data.city | The name of the city where the charge point is located. |
data.postal_code | The postal code where the charge point is located. It conforms to the country standard. |
data.state | The state where the charging station is located. |
data.country | The ISO 3166-1 alpha-3 code for the country of this location. |
data.coordinates | The coordinates of the location in decimal degrees. |
data.coordinates.latitude | The latitude of the location in decimal degrees. |
data.coordinates.longitude | The longitude of the location in decimal degrees. |
data.publish | Indicates that the location is published. It is always set to true . |
data.last_updated | Indicates when the location data was last updated. The date is in ISO 8601 standard and the time zone is UTC. The update could be a status update or any other update (for example, coordinates update). |
data.name | The name of the location. |
data.owner | The details of the location's owner. |
data.owner.name | The name of the location's owner. |
data.owner.website | The website of the location's owner. |
data.owner.logo | The link to the owner's logo. |
data.operator | The name and website of the operator of the charge points in the location. |
data.operator.name | The name of the location's operator. |
data.operator.website | The website of the location's operator. |
data.operator.logo | The link to the operator's logo. |
data.suboperator | The name and website of the suboperator of the charge points in the location. |
data.suboperator.name | The name of the location's suboperator. |
data.suboperator.website | The website of the location's suboperator. |
data.suboperator.logo | The link to the suboperator's logo. |
data.opening_times | Indicates if the location is always open or has certain opening and closing times. |
data.charging_when_closed | Indicates if the EVSEs can be used for charging outside the opening hours of the location. For example, when the parking garage closes its barriers overnight, this attribute indicates if you can still charge until the next morning. |
data.time_zone | The time zone of the location. It is one of www.iana.org tzdata's TZ-values representing the time zone of the location. |
data.energy_mix | Describes the energy mix and environmental impact of the supplied energy at the location. |
data.energy_mix.is_green_energy | Indicates true if the supplied energy at the location is 100% from regenerative sources. (CO2 and nuclear waste is zero.) |
data.energy_mix.supplier_name | The name of the energy supplier that delivers the energy for the location. |
data.energy_mix.energy_product_name | The name of the energy supplier's product that is used at the location. |
data.energy_mix.energy_sources | The type of energy source and the percentage. |
data.energy_mix.energy_sources.source | The type of energy source. The different types of energy sources are: - NUCLEAR : Nuclear power source- GENERAL_FOSSIL : All kinds of fossil power sources- COAL : Fossil power form coal- GAS : Fossil power from gas- GENERAL_GREEN : All kinds of regenerative power sources- SOLAR : Regenerative power from PV- WIND : Regenerative power from wind turbines- WATER : Regenerative power from water turbines |
data.energy_mix.energy_sources.percentage | The percentage of the source (0%-100%) in the mix. |
data.energy_mix.environ_impact | The environmental impact of nuclear waste and CO2 exhaust of the location. |
data.energy_mix.environ_impact.source | The type of pollutant. The different types of pollutants are: - NUCLEAR_WASTE : Produced nuclear waste in grams per kilowatt-hour.- CARBON_DIOXIDE : Exhausted carbon dioxide in grams per kilowatt-hour. |
data.energy_mix.environ_impact.amount | The amount of nuclear waste produced or carbon dioxide exhausted in grams per kilowatt-hour. |
data.evses.uid | The unique ID of an EVSE in the system of the CPO. It is created by the CPO and is not unique within Eco-Movement's database. Note: Use this attribute for PATCH requests as an evse's id. |
data.evses.status | Indicates if an EVSE is available for charging or not. It is the real-time status of an EVSE, which is monitored and noise-filtered by Eco-Movement. It can be one of the following: - AVAILABLE - BLOCKED - CHARGING - INOPERATIVE - OUTOFORDER - PLANNED - REMOVED - RESERVED - UNKNOWN |
data.evses.capabilities | The capabilities of an EVSE. Eco-Movement is only partially OCPI compliant for this attribute and is only filled when supplied by the CPO. The different types of EVSE capabilities are: - CHARGING_PROFILE_CAPABLE - CHARGING_PREFERENCES_CAPABLE - CHIP_CARD_SUPPORT - REMOTE_START_STOP_CAPABLE - CREDIT_CARD_PAYABLE - RESERVABLE - RFID_READER - UNLOCK_CAPABLE - DEBIT_CARD_PAYABLE - PED_TERMINAL - TOKEN_GROUP_CAPABLE |
data.evses.last_updated | Indicates when the EVSE data was last updated. The date is in ISO 8601 standard and the time zone is UTC. The update could be a status update or any other update (for example, capabilities update). |
data.evses.physical_reference | A number or string printed on the outside of the EVSE for visual identification. Note: This attribute is limited to 16 characters. |
data.evses.evse_id | The unique ID of an EVSE for the outside world. It is unique across all databases, but it is not always available. It is compliant with "eMI3standard version V1.0". |
data.evses.floor_level | The level on which the charging station is located. For example, the floor level in a parking garage. |
data.evses.parking_restrictions | Indicates if there are any restrictions to the parking lot. This attribute is only filled if it is supplied by the CPO. The different types of parking restrictions are: - EV_ONLY - PLUGGED - DISABLED - CUSTOMERS - MOTORCYCLES |
data.evses.connectors.id | The identifier of the connector within the EVSE created by the CPO. Two connectors may have the same id as long as they do not belong to the same EVSE object. |
data.evses.connectors.standard | The socket or plug standard of the charging point. The standards are: - CHADEMO : The connector type is CHAdeMO, DC- CHAOJI : The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMOand GB/T. DC. - DOMESTIC_A : Standard or Domestic household, type "A", NEMA 1-15, 2 pins- DOMESTIC_B : Standard or Domestic household, type "B", NEMA 5-15, 3 pins- DOMESTIC_C : Standard or Domestic household, type "C", CEE 7/17, 2 pins- DOMESTIC_D : Standard or Domestic household, type "D", 3 pin- DOMESTIC_E : Standard or Domestic household, type "E", CEE 7/5 3 pins- DOMESTIC_F : Standard or Domestic household, type "F", CEE 7/4, Schuko, 3 pins- DOMESTIC_G : Standard or Domestic household, type "G", BS 1363, Commonwealth, 3 pins- DOMESTIC_H : Standard or Domestic household, type "H" SI-32, 3 pins- DOMESTIC_I : Standard or Domestic household, type "I", AS 3112, 3 pins- DOMESTIC_J : Standard or Domestic household, type "J", SEV 1011, 3 pins- DOMESTIC_K : Standard or Domestic household, type "K", DS 60884-2-D1, 3 pins- DOMESTIC_L : Standard or Domestic household, type "L", CEI 23-16-VII, 3 pins- DOMESTIC_M : Standard/Domestic household, type "M", BS 546, 3 pins- DOMESTIC_N : Standard/Domestic household, type "N", NBR 14136, 3 pins- DOMESTIC_O : Standard/Domestic household, type "O", TIS 166-2549, 3 pins- DOMESTIC_O : Standard/Domestic household, type "O", TIS 166-2549, 3 pins- GBT_AC : Guobiao GB/T 20234.2 AC socket/connector- GBT_DC : Guobiao GB/T 20234.3 DC connector- IEC_60309_2_single_16 : IEC 60309-2 Industrial Connector single phase 16 Amperes (usually blue)- IEC_60309_2_three_16 : IEC 60309-2 Industrial Connector three phase 16 Amperes (usually red)- IEC_60309_2_three_32 : IEC 60309-2 Industrial Connector three phase 32 Amperes (usually red)- IEC_60309_2_three_64 : IEC 60309-2 Industrial Connector three phase 64 Amperes (usually red)- IEC_62196_T1 : IEC 62196 Type 1 "SAE J1772"- IEC_62196_T1_COMBO : Combo Type 1 based, DC- IEC_62196_T2 : IEC 62196 Type 2 “Mennekes”- IEC_62196_T2_COMBO : Combo Type 2 based, DC- IEC_62196_T3A : IEC 62196 Type 3A- IEC_62196_T3C : IEC 62196 Type 3C "Scame"- NEMA_5_20 : NEMA 5-20, 3 pins- NEMA_6_30 : NEMA 6-30, 3 pins- NEMA_6_50 : NEMA 6-50, 3 pins- NEMA_10_30 : NEMA 10-30, 3 pins- NEMA_10_50 : NEMA 10-50, 3 pins- NEMA_14_30 : NEMA 14-30, 3 pins, rating of 30 A- NEMA_14_50 : NEMA 14-50, 3 pins, rating of 50 A- PANTOGRAPH_BOTTOM_UP : On-board Bottom-up-Pantograph typically for bus charging- PANTOGRAPH_TOP_DOWN : On-board Top-down-Pantograph typically for bus charging- TESLA_R : Tesla Connector "Roadster" - Type (round, 4 pin)- TESLA_S : Tesla Connector "Model-S" - Type (oval, 5 pin) |
data.evses.connectors.format | The format of the connector. It can be one of the following formats: - SOCKET - CABLE |
data.evses.connectors.power_type | The power type of the connector. The different power types are: - AC_3_PHASE - AC_1_PHASE - DC |
data.evses.connectors.max_amperage | The maximum allowed amperage that the connector can safely handle under peak or specific conditions. This attribute is validated and corrected by Eco-Movement. |
data.evses.connectors.max_voltage | The maximum allowed voltage that the connector can safely handle under peak or specific conditions. This attribute is validated and corrected by Eco-Movement. |
data.evses.connectors.max_electric_power | The maximum power is calculated by Eco-Movement based on the voltage and amperage. Note: You can request the attribute as an extra feature. |
data.evses.connectors.tariff_id | Corresponds to the tariffs module. This attribute shows the CPO ad hoc prices. See tariffs endpoint for more information. |
data.evses.connectors.last_updated | Indicates when the connector data was last updated. The date is in ISO 8601 standard and the time zone is UTC. The update could be a status update or any other update (for example, voltage update). |