Response Data Types

Address

Name	Type	Description
address_lines	[ string ]	A display formatted address.
city	string	The city name.
country	string	The three-letter country code, as specified in ISO_3166.
county	string	The county name.
cross_street	Street	The cross street for the address, if any.
formatted_address	string	A display formatted address.
geo_coordinates	GeoPoint	Display geo-coordinate for the address.
house_number	string	The house/door number of the place.
locality	string	The locality or neighborhood information.
location_type	string	Location type of the address which indicates the precision level of the geo coordinates. Support: ADDRESS_POINT INTERPOLATED GEOMETRIC_CENTER APPROXIMATE
nav_coordinates	GeoPoint	Navigation coordinates (routable points) of the address used for routing purpose.
neighbourhood	string	The neighbourhood name.
postal_code	string	The postal or zip code.
state	string	The state name or province in some countries.
street	Street	The street information divided into multiple components.
suite	string	The suite, apartment or building number.

AliasName

Name	Type	Description
language	string	Provides the language corresponding to a rich field.
name	string	Provides the name corresponding to a rich field.

Booking

Name	Type	Description
booking_providers	[ BookingProvider ]	Lists the booking providers.

BookingProvider

Name	Type	Description
additional_info	[ DataField ]	List of supplementary booking details.
additional_required_fields	[ string ]	List of additional fields required in the booking api call.
booking_quotes	[ BookingQuote ]	Provides booking price quote based on entry time and duration.
name	string	The name of the booking provider.
provider_id	string	The booking provider ID.
provider_source_id	string	The booking-service-provider's ID.

BookingQuote

Name	Type	Description
amount	double	Provides the quoted price.
amount_text	string	Provides the quoted price as text.
availability	boolean	Indicates booking availability.
currency	string	The pricing currency.
duration	integer	The reservation duration in minutes.
end_time	string	Provides reserve end time ISO8601 DateTime format.
quote_reference_id	string	Provides booking price quote reference.
start_time	string	Provides reserve start time in ISO8601 DateTime format.
symbol	string	The currency symbol.

Brand

Name	Type	Description
brand_icon_id	string	The id assigned to a brand icon.
brand_id	string	The id for to a brand or chain.
brand_name	string	The brand or chain name.
category	Category	The primary category id and category name associated with the brand.
count	integer	The count of stores for the brand.

Category

Name	Type	Description
child_nodes	[ Category ]	List of child categories associated with a parent category.
id	string	The id associated to a category.
name	string	The category name or label.

Connector

Name	Type	Description
available	integer
charge_capacity	string	Charge capacity of the connector. Example: "100-120VAC, 1-phase at max 6A".
charge_mode	integer	Charging mode of the connector.
charger_brand	Brand	EV charging network or brand.
charger_manufacturer	string	The charge station manufacturer. Example: Coulomb, Tesla
connector_number	integer	Number of connectors at the charging station.
connector_type	ConnectorType	Identifies the connector type.
customer_charge_level	integer	Customer charge levels. Supported: 1 - Normal charge, maxPower <= 6kW 2 - Sem-fast charge, 6KW < maxPower <= 15KW 3 - Fast charge, 15KW < maxPower <= 50KW 4 - Super fast charge, maxPower > 50KW
customer_connector_name	string	Customer specific connector name associated with connect type. Example: "AC
id	string	Identifier of the connector.(Optional, depends on data vendor)
inuse	integer	The number of connectors in use.
is_free	boolean	Indicate if it is free.
last_update_timestamp	long	Time stamp of last update in unix seconds. e.g. 1548292528
max_power	double	Max power supported in KW for the connector, e.g. 7.2.
ocpi_attributes	EvOcpiAttributes	OCPI attributes. (Optional, depends on data vendor)
power_feed_level	PowerFeedType	The power feed details.
pricing	EvPricing	EV connector pricing.

ConnectorCount

Name	Type	Description
level	integer	Power feed level id.
total	integer	Total number of connectors for this power feel level.

ConnectorType

Name	Type	Description
id	integer	Connector type id
name	string	Connector type label.

DataField

Name	Type	Description
id	string	The data field id
label	string	The corresponding name or label.
value	string	Provides the value pertaining to an amenity or restriction, if applicable.

Entity

Name	Type	Description
address	EntityAddress	Provides details of the physical location of a place.
distance	double	Distance from the anchor point to the entity in meter.
facets	Facets	An extended set of attributions for an entity. Such as open_hours, price_info, rating, etc.
id	string	Unique identifier (entity id) for a place, address or event.
label	string	Customized label added to the entity by system or user.
place	EntityPlace	Provides information available for the place of interest.
type	string	Indicates the type of entity: PLACE ADDRESS

EntityAddress

Name	Type	Description
address_lines	[ string ]
address_type	string	Indicates the type of address Supported: STREET CROSS_STREET CITY ZIPCODE LOCALITY STATE COUNTY COUNTRY
city	string	The city name.
country	string	The three-letter country code, as specified in ISO_3166
county	string	The county name.
cross_street	Street	The cross street for the address, if any.
formatted_address	string	A display formatted address.
geo_coordinates	GeoPoint	Display geo-coordinate for the address.
house_number	string	The house/door number of the place.
locality	string	The locality information.
location_type	string	Location type of the address which indicates the precision level of the geo coordinates. Support: ADDRESS_POINT INTERPOLATED GEOMETRIC_CENTER APPROXIMATE
nav_coordinates	GeoPoint	Navigation coordinates (routable points) of the address used for routing purpose.
neighbourhood	string	The neighbourhood name.
postal_code	string	The postal or zip code.
state	string	The state name or province in some countries.
street	Street	The street information divided into multiple components.
suite	string	The suite, apartment or building number.
time_zone	string	Time zone of the address, refer to ISO-3166.

EntityExit

Name	Type	Description
available_categories	[ EntityExitCategory ]	List of categories that are available at the exit.
entity	Entity	Provides the rest area place details for the exit.
exit_id	string	The identifier for an exit.
exit_location	GeoPoint	Exit location.
exit_type	string	Exit point type, support: REST_AREA EXIT_POINT

EntityExitCategory

Name	Type	Description
category	Category	The associated category.
entity_count	integer	The number of entities belonging to the category.

EntityPlace

Name	Type	Description
address	Address	The physical location details of the place.
alias_names	[ AliasName ]	List of alias names for the place.
brands	[ Brand ]	The list of brands associated with an entity.
categories	[ Category ]	List of categories associated to an entity.
emails	[ string ]	List of email contacts for the place.
name	string	Contains the name of the place
permanently_closed	boolean	Indicates whether place is permanently shutdown.
phone_numbers	[ string ]	Phone number of the place.
websites	[ string ]	List of URLs of the website associated with the place.

EntityResponse

Name	Type	Description
has_more	boolean	Boolean flag, when true indicates more search results are available.
pagination_context	PaginationContext	Pagination links, use actionUrls instead.
reference_id	string	An id assigned to the category response that can be used for referencing it
response_time	long	Request processing time in milliseconds.
results	[ Entity ]	Collection of results in generic type.
results_facet	ResultsFacet	Provides breakdown statistic of matching results based on search criteria.
search_metadata	SearchMetadata	Metadata providing result count and query inference.
status	V5ResponseStatus	Response status.

EvCluster

Name	Type	Description
cluster_number	integer	Index of cluster list
entities	[ Entity ]	List of entity.

EvOcpiAttributes

Name	Type	Description
evse_capabilities	[ string ]	The capabilities of an EVSE.
evse_coordinates	GeoPoint	Coordinates of the EVSE.
evse_id	string	EVSE ID.
evse_status	string	Indicates the current status of the EVSE.
evse_uid	string	Uniquely identifies the EVSE within the CPOs platform (and suboperator platforms).
location_id	string	Uniquely identifies the location within the CPOs platform (and suboperator platforms).
location_name	string	Display name of the location.
parking_type	string	The general type of the charge point location.

EvPrice

Name	Type	Description
amount	double	Price per unit. e.g. amount = 1.80 (unit = 60 , pricingType = minutes)
currency	string	The currency for the amount. e.g currency = USD
day_mask	integer	Day mask used if pricing varies based on day of week. For example if cost on weekdays is different from weekends.
idle_fee	double	Cost of occupying the charging slot after charging completed.
period	TimeRange	The time period for which this pricing applies. e.g. period.from = 09:00 , period.to = 18:00
service_fee	double	Minimum cost or Session fee for using the charging service.
subscription_type	string	Indicates if pricing is for General or Members-subscribed.
symbol	string	The currency symbol. e.g. symbol = $
text	string	Any additional free text description.
tier_end	double	The tier upper bound value, for tier based pricing. e.g. tierEnd = 120 (i.e. upto 120mins) or tierEnd = 15 (i.e. upto 15kWh)
tier_start	double	The tier lower bound value, for tier based pricing. e.g. tierStart = 0 (i.e. from 0mins) or tierStart = 0 (i.e. from 0kWh)
unit	double	Price unit for the related pricing type : e.g. 1 (kWh) , i.e. cost per 1kWh usage e.g. 30 (minutes), i.e., cost per 30mins of charging
unit_type	string	The UnitType can be duration or power based.

EvPricing

Name	Type	Description
price	[ EvPrice ]	Provides the structured EV rates.
rate_card	RateCard	Provides simplified human readable EV price.

FacetContent

Name	Type	Description
count	integer	Entity count for the given facet field.
id	string	The id for the distinct facet field name.
name	string	A distinct value of the facet field.

FacetDriveTime

Name	Type	Description
drive_distance	double	The travel distance from the anchor point to the destination in meters.
drive_duration	integer	The travel duration from the anchor point to the destination in seconds.
detour_distance	double	Provides the change in travel distance(in meters) when driving to a location that deviates from the original route.
detour_duration	integer	Provides the change in travel duration(in seconds) when driving to a location that deviates from the original route.

FacetEvConnectors

Name	Type	Description
connector_counts	[ ConnectorCount ]	Number of connectors by power feed level.
connectors	[ Connector ]	EV connector specifics.
total_number	integer	Total number of connectors.

FacetField

Name	Type	Description
facets	[ FacetContent ]	List of faceted counts by distinct field value.
field	string	The attribute on which faceted count generated.

FacetNearby

Name	Type	Description
nearby_categories	[ NearbyCategory ]	List of categories close by to a place.

FacetOpenHours

Name	Type	Description
display_text	string	Provides operational hours in free text.
open24hours	boolean	Indicates if the place is open 24 hours.
open_now	boolean	Indicates if the place is currently open.
regular_open_hours	[ Period ]	Provides usual operational hours.

FacetParking

Name	Type	Description
booking	Booking	Contains booking details for parking.
last_update_time	long	Timestamp of last update in unix seconds.
parking_facility_details	ParkingFacilityDetails	Provides additional details about the parking facility.
pricing	ParkingPrice	Provides the detail pricing for parking.
spaces_available	integer	Number of available parking spaces.
spaces_total	integer	The total parking capacity.

FacetPayment

Name	Type	Description
payment_methods	[ PaymentMethod ]	Lists the accepted payment methods.

FacetPivotField

Name	Type	Description
fields	[ string ]	The list of fields on which pivoted facet counts generated.
pivots	[ Pivot ]	Lists the pivots and its breakdown counts.

FacetPriceInfo

Name	Type	Description
price_description	string	Additional description of the price.
price_details	[ Price ]	The actual price info.
price_level	integer	An indicator of how expensive the place is.

FacetRating

Name	Type	Description
average_rating	double	The average ratings across all users.
rating_type	string	Rating type, only "star" is supported now, the rating type may be extended in future.
source	string	The ratings provider.
total_count	integer	The total rating count for the place.
url	string	Link to the ratings.

FacetRelatedEntities

Name	Type	Description
children	[ Entity ]	Contains places that have child relationship to the referred entity.
linked_entities	[ Entity ]	Contains places that are related to the referred entity.
parents	[ Entity ]	Contains places that have parent relationship to the referred entity.

Facets

Name	Type	Description
drive_time	FacetDriveTime	Provides the drive time from user location to the entity.
ev_connectors	FacetEvConnectors	Provides electric charging details.
nearby	FacetNearby	Provides category based grouping of POIs within a certain proximity to the entity.
open_hours	FacetOpenHours	Provides the operational hours.
parking	FacetParking	Provides parking details.
payment	FacetPayment	Provides the payment options.
price_info	FacetPriceInfo	Provides pricing level and details.
rating	[ FacetRating ]	Provides user ratings for the place.
related_entities	FacetRelatedEntities	Contains other places that are related to this entity.

GeoPoint

Name	Type	Description
latitude	double	The latitude of the location in degrees.
longitude	double	The longitude of the location in degrees.

MetadataItemDescriptor

Name	Type	Description
count	integer	The item count for a particular metadata type.
type	string	The metadata descriptor type.

NearbyCategory

Name	Type	Description
category	Category	The category of a nearby POI.
count	integer	The number of POIs belonging to a category.
distance	double	The max search distance of the category.

PaginationContext

Name	Type	Description
next_page_context	string	Next page context.
prev_page_context	string	Previous page context.

ParkingFacilityDetails

Name	Type	Description
drive_max_height	double	Indicates vehicle height restrictions in meters.
drive_max_weight	double	Indicates vehicle weight restriction.
drive_max_width	double	Indicates vehicle width restriction.
facility_levels	integer	Indicates the number of floors/levels at a parking facility.

ParkingPrice

Name	Type	Description
calculated_rates	[ Rate ]	Provides calculated parking price based on entry time and duration.
prices	[ ParkingPriceItem ]	Provides the structured parking rates.
rate_card	RateCard	Provides simplified human readable parking price.

ParkingPriceItem

Name	Type	Description
amount	double	Parking cost specific to the parking time and day.
arrive_after	integer	Denotes the time to arrive by for the price to apply.
arrive_before	integer	Denotes the time to arrive after for the price to apply.
currency	string	The pricing currency.
day_mask	integer	Days of the week as an 8-bit integer mask.
depart_after	integer	Denotes the time to depart after for the price to apply.
depart_before	integer	Denotes the time to depart by for the price to apply.
max_minutes	integer	Denotes the maximum minutes that a vehicle can be parked to be in this price group.
min_minutes	integer	Denotes the minimum duration a vehicle needs to be parked for this price group to apply.
price_class	string	Price class type.
price_group	integer	Price group number.
symbol	string	Currency symbol.
text	string	Any additional textual information.
unit	integer	Parking duration in minutes.
unit_text	string	Parking duration as textual data.

PaymentMethod

Name	Type	Description
accept	boolean	Indicates if the payment method is accepted or not.
description	string	Provides additional description for the payment method.
payment_method_type	string	Provides the supported payment method.
supported_vendors	[ string ]	Lists any vendor specific payment mode.

Period

Name	Type	Description
day	integer	Day of the week.
open_time	[ TimeRange ]	Provides the from and to operational hours.

Pivot

Name	Type	Description
count	integer	Entity count for the given facet field.
field	string	The attribute on which pivoted faceting counts generated.
id	string	The id for the distinct facet field name.
name	string	A distinct value of the facet field.
pivots	[ Pivot ]	Lists the sub pivot fields and its breakdown counts.

PowerFeedType

Name	Type	Description
level	integer	The electric power feed level.
name	string	Provides the electric power naming.

Price

Name	Type	Description
amount	double	The item cost.
currency	string	The pricing currency.
description	string	Item description.
label	string	Item name
last_update_time	long	The most recent price updated time, in unix seconds.
symbol	string	Currency symbol.
type	string	Item type.
unit	string	The unit measure associated with the amount.

QueryResolution

Name	Type	Description
query_tags	[ QueryTag ]	Provides the query tags corresponding to the result.
search_location	GeoPoint	The search anchor point.

QueryTag

Name	Type	Description
what	string	The query tag indicative of a keyword, category, place.
where	string	The query tag indicative of address parts.

Rate

Name	Type	Description
amount	double	Provides the price amount.
currency	string	The pricing currency.
symbol	string	The currency symbol.
unit	integer	The unit measure associated with the amount.

RateCard

Name	Type	Description
text	[ string ]	List of price variations.

ResultsFacet

Name	Type	Description
facet_fields	[ FacetField ]	Lists the facet counts by attribute.
facet_pivot_fields	[ FacetPivotField ]	Lists the facet counts by pivoted attributes. not supported now.

SearchMetadata

Name	Type	Description
counts	[ MetadataItemDescriptor ]	Shows the result count grouped by EntityType.
features	object	Set of search engine features.
query_resolution	QueryResolution	Shows how the request query was inferred by the search engine.
version	string	Build version info. e.g. version = Q2xvdWQ7MS4wLjk0LjM7TkE7MThRMzsyMDE5LTAxLTI4IDIyOjM3 .

Street

Name	Type	Description
body	string	The street body. e.g. body = Charing Cross Road
dirs	[ string ]	List of street directions.
formatted_name	string	The standardized street name. e.g. formatted_name = Charing Cross Road
type	string	The type of street.

Suggestion

Name	Type	Description
entity	Entity	Provides the complete entity object.
formatted_label	string	The suggestion display text.
id	string	Contains place or address id if suggestion is of type 'entity'.
query	string	The formatted suggestion query string generated based on user input.
type	string	The suggestion type, can be 'query' or 'entity'.

TimeRange

Name	Type	Description
from	string	Provides the start time, in HH:mm:ss format.
to	string	Provides the end time, in HH:mm:ss format.

V5ResponseStatus

Name	Type	Description
message	string	Response status message. e.g. "INVALID_REQUEST"
status	integer	Response status code. e.g. "12200" meaning success

WordPrediction

Name	Type	Description
active_word	string	The preceding word related to which the next word is proposed.
predict_word	string	The predict word.
type	string	Indicates the word suggestion type, can be 'Prefix' or 'Next'.