get
https://customer-api.prod.paren.app/realtime/v1/locations
Return a list of locations
The Realtime locations endpoint response is different from the Metadata location response. The Realtime response is intended to be used by apps to make routing and other decisions based on the status and recent history of the charging station. The response is based on the OCPI structure but is unique to Paren.
Attributes
| Attribute | Description | |
|---|---|---|
| data | The data object is an array of details about charging stations that match the input parameters | |
| data.address.address | Street address for the charging station location | |
| data.address.city | City of the charging station location | |
| data.address.postal_code | Postal code of the charging station location | |
| data.address.state | State or province of the charging station | |
| data.address.country | Country of the charging station location | |
| data.address.coordinates.latitude data.address.coordinates.longitude | Latitude, Longitude coordinates of the charging station location | |
| data.charging_pool | The charging_pool structure encapsulates all of the EVSEs at the charging station location | |
| P | data.charging_pool.current_pricing | The current_pricing structure describes the most recent pricing data from the charging station |
| P | data.charging_pool.current_pricing.non-member | If available, the non-member element denotes the pricing for those charging at this station who are not members of the charging network's membership program. |
| P | data.charging_pool.current_pricing. non-member.currency | The currency of the pricing information for this charging station |
| P | data.charging_pool.current_pricing. non-member.elements | The elements of the pricing structure is an array that describes price components and any time restrictions based, if time of use pricing is used. |
| P | data.charging_pool.current_pricing. non-member.elements[] .pricing_components.price | The decimal price based on the pricing type |
| P | data.charging_pool.current_pricing. non-member.elements[] .pricing_components.type | ENERGY for pricing per kW or TIME for pricing per hour |
| P | data.charging_pool.current_pricing. non-member.elements[]. pricing_components.restrictions | For TOU pricing, the start and end times reflect the time of day, in 24-hour format, when these charges are in effect. |
| P | data.charging_pool.current_pricing. nonmember.elements[]. pricing_components.restrictions.start_time | See above |
| P | data.charging_pool.current_pricing.non-member.elements[]. pricing_components.restrictions.end_time | See above |
| data.charging_pool.evses[].connectors[].id | a unique id for the EVSE generated by the charging_network | |
| data.charging_pool.evses[].connectors[]. max_power | A decimal value denoting the max rated power of the EVSE | |
| data.charging_pool.evses[].connectors[]. standard | The charging protocol used by the connector. Valid values are COMBO or CCS, NACS, CHADEMO | |
| data.charging_pool.evses[].id | A unique id for the EVSE generated by the charging network | |
| data.charging_pool.evses[].created_at | The UTC data when the EVSE was opened. | |
| data.charging_pool.evses[].evse_id | ||
| P | data.charging_pool.evses[].last_successful_charge | The UTC timestamp of the end time of the last successful charge on this EVSE. |
| data.charging_pool_evses[].last_updated | ||
| P | data.charging_pool.evses[].metrics | Metrics are a unique set of Paren extensions that describe recent activity on the EVSE |
| P | data.charging_pool.evses[].metrics. average_charging_time | A value, in seconds, of the average charging time on this EVSE over the last 3 weeks |
| P | data.charging_pool.evses[].metrics. current_utilization.charging_seconds | A value, in seconds. |
| P | data.charging_pool.evses[].metrics. current_utilization.charging_sessions | The number of charging sessions over the time period |
| P | data.charging_pool.evses[].metrics.failure_rate | A decimal value representing the number of failed charging sessions over the time period as a percentage of overall charging attempts |
| P | data.charging.pool.evess[].metrics. hourly_historical_utilization | This array of elements contains 24 entries representing the current day. Each entry is an hour and includes the average charging_seconds occuring within that hour and the average number of charging sessions within the hour on this EVSE as measured over the last 3 weeks. |
| P | data.charging_pool.evses[].metrics. hourly_historical_utilization.hour. charging_seconds | See above |
| P | data.charging_pool.evses[].metrics. hourly_historical_utilization.hour. charging_sessions | See above |
| P | data.charging_pool.evses[].metrics.retry_rate | A decimal value representing the percentage of successful charging sessions that resulted from a retry. |
| p | data.charging_pool.evses[].name | |
| data.charging_pool.evses[].status | ||
| data.charging_pool.evses[].uid | ||
| data.charging_pool.last_updated | ||
| P | data.charging_pool.model | |
| P | data.charging_pool.program | |
| P | data.charging_pool.reliability_score | The reliability score of a charging station is a custom calculation that represents an approximation of first-time plug success. Charging session retries, failures and charging unit downtime all negatively effect a charging station reliability score. This score is calculated over the last 7 day period. |