NBAI Map API (0.1.0)
Download OpenAPI specification:Download
Directions
query Parameters
origin required | string Example: origin=`lat,lng`
Example: `41.349302,2.136480` Origin is the starting point of a route. Ensure that the origin is a location on your map of interest and for which your API key is authorized. |
destination required | string Example: destination=`lat,lng`
Example: `41.349302,2.136480` Destination is the ending coordinates of a route. Ensure that the destination is a location on your map of interest and for which your API key is authorized. |
waypoints | string Example: waypoints=`lat0,lng0|lat1,lng1|...`
Example: `41.349302,2.136480|41.389925,2.136258|41.357961,2.097878` Waypoints are coordinates along the route between the Origin and the Destination. Waypoints are represented as a pipe(|) separated list of coordinate pairs. |
steps | boolean Example: steps=Set to `true` to include steps in the response.
Default: `false` The |
mode | string Example: mode=Mode of service.
Values: `car|auto|bike|escooter|4w|2w...`
Default: `""` A string parameter which which sets the transportation mode for the route. For example, if you use 4w or car, the API will return a route which a 4-wheeled vehicle (passenger vehicle) can take. 0w will return a route that a pedestrian can take. [Note: Only the 4w/car profile is enabled by default. For customised routing profiles like 0w, escooter, contact support@nextbillion.ai.] |
departure_time | integer <int64> Example: departure_time=Departure time.
`Unix Timestamp`
Unit: seconds.
Default: `0` This parameter sets the departure time in Unix epoch time seconds format. The response will return a route based on traffic for that specific time of departure from the origin point. |
session | string Example: session=Unique session id for trip identification.
Note: Help to reuse cached trip characteristics when set.
Default: `""` Unique session ID. If set, the response will reuse cached trip characteristics. |
geometry | string Enum: "polyline" "polyline6" "geojson" Example: geometry=Output format of geometry.
Available values: `polyline`, `polyline6`, `geojson`
Default: `polyline6` Sets the output format of the route geometry in the response. Available values are |
alternatives | boolean Example: alternatives=Set to `true` to enable alternative routes.
`altcount` parameter will be set to `3` by default if this is enabled.
Default: `false` If enabled, the API will return alternative routes. You can set the number of routes in the |
altcount | integer <int32> Example: altcount=Number of alternative routes to return.
Default: `1` if `alternatives` is disabled, `3` otherwise. Sets the number of alternative routes to return. The default value is 3 if the |
avoid | string Example: avoid=Either `toll`, `ferry` or `highway`.
Default: `""` Setting this will ensure the route avoids ferry, tolls or highways. |
key | string Example: key=32 character Alphanumeric String.
Default: `""` API Key for authentication |
overview | string Enum: "full" "simplified" "false" Example: overview=Available values: `full`, `simplified`, `false`
Default: `full` Output verbosity of overview (whole trip) geometry. |
approaches | string Example: approaches=Accepts `unrestricted` (default, route can arrive at the waypoint from either side of the road) or `curb` (route will arrive at the waypoint on the driving_side of the region). A semicolon-separated list indicating the side of the road from which to approach waypoints in a requested route. If provided, the number of approaches must be the same as the number of waypoints. However, you can skip a coordinate and show its position in the list with the ; separator. |
Responses
Response samples
- 200
{- "errorMessage": "string",
- "mode": "string",
- "routes": [
- {
- "distance": 0,
- "distance_full": 0,
- "duration": 0,
- "end_location": {
- "latitude": 0,
- "longitude": 0
}, - "geojson": {
- "coordinates": [
- [
- 0
]
]
}, - "geometry": "string",
- "geometry_full": "string",
- "legs": [
- {
- "annotation": {
- "datasources": [
- 0
], - "distance": [
- 0
], - "duration": [
- 0
], - "metadata": {
- "datasource_names": [
- "string"
]
}, - "nodes": [
- 0
], - "speed": [
- 0
], - "weight": [
- 0
]
}, - "distance": {
- "value": 0
}, - "duration": {
- "value": 0
}, - "end_location": {
- "latitude": 0,
- "longitude": 0
}, - "raw_duration": {
- "value": 0
}, - "start_location": {
- "latitude": 0,
- "longitude": 0
}, - "steps": [
- {
- "distance": {
- "value": 0
}, - "duration": {
- "value": 0
}, - "end_location": {
- "latitude": 0,
- "longitude": 0
}, - "geojson": {
- "coordinates": [
- [
- null
]
]
}, - "geometry": "string",
- "intersections": [
- {
- "bearings": [
- null
], - "classes": [
- null
], - "entry": [
- null
], - "intersection_in": 0,
- "intersection_out": 0,
- "lanes": [
- { }
], - "location": {
- "latitude": null,
- "longitude": null,
- "name": null
}
}
], - "maneuver": {
- "bearing_after": 0,
- "bearing_before": 0,
- "coordinate": {
- "latitude": 0,
- "longitude": 0,
- "name": "string"
}, - "instruction": "string",
- "maneuver_type": "string",
- "modifier": "string",
- "voice_instruction": [
- {
- "distance_along_geometry": null,
- "instruction": null,
- "unit": null
}
]
}, - "name": "string",
- "reference": "string",
- "start_location": {
- "latitude": 0,
- "longitude": 0
}
}
]
}
], - "predicted_duration": 0,
- "raw_duration": 0,
- "special_objects": { },
- "start_location": {
- "latitude": 0,
- "longitude": 0
}
}
], - "status": "string"
}
DistanceMatrix JSON Handler
query Parameters
origins required | string Example: origins=Format: `lat,lng`
`41.349302,2.136480|41.389925,2.136258|41.357961,2.097878` Origins are the starting point of your route. Ensure that origins are a valid land location to calculate a route. Multiple origins are separated by a pipe symbol. |
destinations required | string Example: destinations=Format: `lat,lng | lat,lng…`
`41.349302,2.136480|41.389925,2.136258|41.357961,2.097878` Destinations are the ending coordinates of your route. Ensure that destinations are at a valid land location. Multiple destinations are separated by a pipe symbol. |
mode | string Example: mode=Values: `car|auto|bike|escooter|4w|2w|0w...`.
Default: `4w` A string parameter which you can use to set which driving mode the route should use. For example, if you use 4w, the API will return a route that a 4-wheeler can take. 0w will return a route a pedestrian can take. For any mode aside from 4w, please contact support@nextbillion.ai to enable it for your organization. |
departure_time | integer <int64> Example: departure_time=Format: unix timestamp.
Unit: seconds.
Default: 0 Sets the time of departure. The response will return a route based on traffic for that specific departure time. |
debug | boolean Example: debug=Default: `false` Set to True to show debugging information. |
key | string Example: key=32 bit Alphanumeric String API Key for authentication |
avoid | string Example: avoid=Can accept values of `toll`, `highway`, `highways`, `ferry` Set this value to avoid either Tolls, Highway or Ferry routes. |
approaches | string |
context | string
|
Responses
Response samples
- 200
{- "rows": [
- {
- "elements": [
- {
- "distance": {
- "value": 0
}, - "duration": {
- "value": 0
}, - "predicted_duration": {
- "value": 0
}, - "raw_duration": {
- "value": 0
}
}
]
}
], - "status": "string",
- "elements": null,
- "duration": null,
- "distance": null
}
DistanceMatrix JSON POST Handler
query Parameters
key | string Example: key=32 bit Alphanumeric String API Key for authentication |
Request Body schema: application/json
approaches | string |
avoid | string Set this value to avoid either Tolls, Highway or Ferry routes. |
context | string
|
debug | boolean Set to True to show debugging information. |
departure_time | integer <int64> Sets the time of departure. The response will return a route based on traffic for that specific departure time. |
destinations required | string Destinations are the ending coordinates of your route. Ensure that destinations are at a valid land location. Multiple destinations are separated by a pipe symbol. |
key | string API Key for authentication |
mode | string A string parameter which you can use to set which driving mode the route should use. For example, if you use 4w, the API will return a route which a 4-wheeler can take. 0w will return a route a pedestrian can take. For any mode aside from 4w, please contact support@nextbillion.ai to enable it for your organization. |
origins required | string Origins are the starting point of your route. Ensure that origins are a valid land location to calculate a route. Multiple origins are separated by a pipe symbol. |
Responses
Request samples
- Payload
{- "approaches": "string",
- "avoid": "Can accept values of `toll`, `highway`, `highways`, `ferry`",
- "context": "string",
- "debug": "Default: `false`",
- "departure_time": "Format: unix timestamp.\n\nUnit: seconds.\n\nDefault: 0",
- "destinations": "Format: `lat,lng | lat,lng…`\n\n`41.349302,2.136480|41.389925,2.136258|41.357961,2.097878`",
- "key": "32 bit Alphanumeric String",
- "mode": "Values: `car|auto|bike|escooter|4w|2w|0w...`.\n\nDefault: `4w`",
- "origins": "Format: `lat,lng`\n\n`41.349302,2.136480|41.389925,2.136258|41.357961,2.097878`"
}
Response samples
- 200
{- "rows": [
- {
- "elements": [
- {
- "distance": {
- "value": 0
}, - "duration": {
- "value": 0
}, - "predicted_duration": {
- "value": 0
}, - "raw_duration": {
- "value": 0
}
}
]
}
], - "status": "string"
}
DistanceMatrix JSON Handler
query Parameters
approaches | string |
avoid | string |
context | string
|
debug | boolean enable to show debug information. Default: |
departure_time | integer <int64> departure time. Format: Unit: Default: |
destinations required | string locations of destinations Format: lat0,lng0|lat1,lng1|... Regex: ^[\d.-]+,[\d.-]+(|[\d.-]+,[\d.-]+)*$ |
key | string apikey for authentication. Default: |
mode | string mode of service. Values: Default: For any mode aside from 4w, please contact support@nextbillion.ai to enable it for your organization. |
origins required | string locations of origins Format: lat0,lng0|lat1,lng1|... Regex: ^[\d.-]+,[\d.-]+(|[\d.-]+,[\d.-]+)*$ |
Responses
Response samples
- 200
{- "rows": [
- [
- [
- 0
]
]
], - "status": "string"
}
DistanceMatrixConcise JSON POST Handler
query Parameters
key | string |
Request Body schema: application/json
approaches | string |
avoid | string |
context | string
|
debug | boolean enable to show debug information. Default: |
departure_time | integer <int64> departure time. Format: Unit: Default: |
destinations required | string locations of destinations Format: lat0,lng0|lat1,lng1|... Regex: ^[\d.-]+,[\d.-]+(|[\d.-]+,[\d.-]+)*$ |
key | string apikey for authentication. Default: |
mode | string mode of service. Values: Default: |
origins required | string locations of origins Format: lat0,lng0|lat1,lng1|... Regex: ^[\d.-]+,[\d.-]+(|[\d.-]+,[\d.-]+)*$ |
Responses
Request samples
- Payload
{- "approaches": "string",
- "avoid": "string",
- "context": "string",
- "debug": true,
- "departure_time": 0,
- "destinations": "string",
- "key": "string",
- "mode": "string",
- "origins": "string"
}
Response samples
- 200
{- "rows": [
- [
- [
- 0
]
]
], - "status": "string"
}
Isochrone JSON Handler
query Parameters
center required | string |
departure_time | integer <int64> |
distances | string |
key | string |
mode | string mode of service. Values: Default: For any mode aside from 4w, please contact support@nextbillion.ai to enable it for your organization. |
opacities | string |
resolution | integer <int32> |
strokes | string |
times | string |
Responses
Response samples
- 200
{- "distances": [
- 0
], - "opacities": [
- 0
], - "polylines": [
- "string"
], - "status": "string",
- "strokes": [
- "string"
], - "times": [
- 0
]
}
Optimization Json Handler
query Parameters
coordinates required | string Example: coordinates=`{{location_of_origin}}`
Format: `lat,lng`
Regex: `^[\d.-]+,[\d.-]+$` This is a semi-colon separated list of coordinates. |
destination | string Example: destination=Values: `any|last`
Default: `last` Specify the destination coordinate of the returned route. If input is last, the last coordinate will be the destination. |
geometries | string Example: geometries=`geojson|polyline|polyline6`
Default: `polyline6`. Output format of geometry. |
key | string Example: key=32 bit Alphanumeric String API key for authentication |
mode | string Example: mode=Values: `car|auto|bike|escooter|4w|2w|0w...`.
Default: "" A string parameter which you can use to set which driving mode the route should use. For example, if you use 4w, the API will return a route which a 4-wheeler can take. 0w will return a route a pedestrian can take. Modes can vary from geography. For any mode aside from 4w, please contact support@nextbillion.ai to enable it for your organization. |
roundtrip | boolean Indicates whether the returned route is a roundtrip. |
source | string Example: source=Values: `any|first`
Default: `first` The coordinate at which to start the returned route. If this is not configured, the return route’s destination will be the first coordinate. |
with_geometry | boolean Example: with_geometry=Default: `false` Indicates whether the return geometry should be computed or not. |
approaches | string |
Responses
Response samples
- 200
{- "code": "string",
- "trips": [
- {
- "distance": 0,
- "duration": 0,
- "geojson": {
- "coordinates": [
- [
- 0
]
]
}, - "geometry": "string",
- "legs": [
- {
- "distance": 0,
- "duration": 0,
- "steps": [
- {
- "distance": 0,
- "duration": 0,
- "geojson": {
- "coordinates": [
- [
- null
]
]
}, - "geometry": "string"
}
], - "summary": "string"
}
]
}
], - "waypoints": [
- {
- "location": {
- "latitude": 0,
- "longitude": 0
}, - "name": "string",
- "trips_index": 0,
- "waypoint_index": 0,
- "waypoints_index": null
}
], - "location": null
}
Post Trip Route Json Handler
Request Body schema: application/json
context | string
|
debug | boolean enable to show debug information. Default: |
key | string apikey for authentication. Default: |
mode | string mode of service. Values: Default: "" |
special_object_types | Array of strings special geospatial objects to include in response. Default: |
timestamps | string unix timestamp of each Unit: Format: Regex: ^[\d]+(|[\d]+)*$ |
tolerate_outlier | boolean enable to ignore location not found in service boundary. Note: enable this to ignore outliers, otherwise an error will be thrown. Default: |
waypoints required | string location(s) of waypoint(s) along the trip. Format: Regex: ^[\d.-]+,[\d.-]+(|[\d.-]+,[\d.-]+)*$ |
Responses
Request samples
- Payload
{- "context": "string",
- "debug": true,
- "key": "string",
- "mode": "string",
- "special_object_types": [
- "string"
], - "timestamps": "string",
- "tolerate_outlier": true,
- "waypoints": "string"
}
Response samples
- 200
{- "errorMessage": "string",
- "mode": "string",
- "route": {
- "distance": 0,
- "geometry": "string",
- "special_objects": { }
}, - "status": "string"
}
SnapToRoads Json Handler
query Parameters
key | string API Key used for authentication |
path required | string Locations to perform snap2roads. Format: Regex: |
timestamps | string Pipe separated unix timestamps for each location. Unit: seconds. Format: Regex: |
radiuses | string Pipe separated Radiuses of each location for performing snap2road Unit: meters. Format: Regex: |
interpolate | boolean Enable to interpolate the path. Note: might return more points Default: |
approaches | string |
avoid | string |
context | string
|
geometry | string only supports for polyline and geojson |
mode | string mode of service. Values: Default: For any mode aside from 4w, please contact support@nextbillion.ai to enable it for your organization. |
tolerate_outlier | boolean enable to ignore location not found in service boundary. Note: enable this to ignore outliers, otherwise an error will be thrown. Default: |
Responses
Response samples
- 200
{- "distance": "Unit: meters.",
- "geojson": [
- {
- "coordinates": [
- [
- 0
]
]
}
], - "geometry": [
- "string"
], - "snappedPoints": [
- {
- "bearing": "Unit: radian",
- "distance": 0,
- "location": {
- "latitude": 0,
- "longitude": 0
}, - "name": "string",
- "originalIndex": 0
}
], - "status": "string"
}
SnapToRoads JSON POST Handler
query Parameters
key | string API Key used for authentication |
Request Body schema: application/json
approaches | string |
avoid | string |
context | string
|
geometry | string only supports for polyline and geojson |
interpolate | boolean enable to interpolate the path. Note: might return more points |
key | string API Key used for authentication |
mode | string mode of service. Values: Default: For any mode aside from 4w, please contact support@nextbillion.ai to enable it for your organization. |
path required | string Pipe separated list of locations to perform a Snap. |
radiuses | string Pipe separated radii of each location for performing a Snap. |
timestamps | string Pipe separated timestamps for each location. |
tolerate_outlier | boolean Enable to ignore location not found in service boundary. Note: enable this to ignore outliers, otherwise an error will be thrown. |
Responses
Request samples
- Payload
{- "approaches": "string",
- "avoid": "string",
- "context": "string",
- "geometry": "string",
- "interpolate": true,
- "key": "string",
- "mode": "string",
- "path": "Format: `lat0,lng0|lat1,lng1|...`",
- "radiuses": "Unit: metres.\n\nFormat: `radius0|radius1|...`\n\n`20|30|21|55`",
- "timestamps": "Unit: Unix epoch.\n\nFormat: `ts0|ts1|...`\n\n`1650438211|1650448111|1650438412`",
- "tolerate_outlier": true
}
Response samples
- 200
{- "distance": 0,
- "geojson": [
- {
- "coordinates": [
- [
- 0
]
]
}
], - "geometry": [
- "string"
], - "snappedPoints": [
- {
- "bearing": 0,
- "distance": 0,
- "location": {
- "latitude": 0,
- "longitude": 0
}, - "name": "string",
- "originalIndex": 0
}
], - "status": "string"
}
Geocode
This endpoint allows to find the geo-coordinates of a known address, place, locality or administrative area, even if the query is incomplete or partly incorrect. It also returns a complete postal address string and address details. It supports structured, unstructured and hybrid queries - combinations of structured and unstructured query elements.
query Parameters
at | string Specify the center of the search context expressed as coordinates. Format: Type: Example: |
in | string Search within a geographic area. This is a hard filter. Results will be returned if they are located within the specified area. A geographic area can be
|
limit | integer <int32> [ 1 .. 100 ] Default: 20 Maximum number of results to be returned. |
q | string Example: q=Invalidenstraße 116 Berlin Enter a free-text query Examples:
Note: Either |
string Enter a qualified query. A qualified query is similar to a free-text query, but in a structured manner. It can take multiple sub-parameters, separated by semicolon, allowing to specify different aspects of a query. Currently supported sub-parameters are Format: Examples:
Note: Either | |
lang | Array of strings Select the language to be used for result rendering from a list of BCP 47 compliant language codes. |
politicalView | string Toggle the political view. This parameter accepts single ISO 3166-1 alpha-3 country code. The country codes are to be provided in all uppercase. Currently the only supported political views are:
For any valid 3 letter country code, for which GS7 does not have dedicated political view, it falls back to the default view. For not accepted values of the politicalView parameter the GS7 responds with "400" error code. |
show | Array of strings Items Enum: "countryInfo" "streetInfo" "parsing" "tz" Select additional fields to be rendered in the response. Please note that some of the fields involve additional webservice calls and can increase the overall response time. The value is a comma-separated list of the sections to be enabled. For some sections there is a long and a short ID. Description of accepted values: 'countryInfo': For each result item renders additional block with the country info, such as ISO 3166-1 alpha-2 and ISO 3166-1 alpha-3 country code. 'streetInfo': For each result item renders additional block with the street name decomposed into its parts like the base name, the street type, etc. BETA: 'parsing' BETA: 'tz': Renders result items with additional time zone information. Please note that this may impact latency significantly. |
header Parameters
X-Request-ID | string Used to correlate requests with their responses within a customer's application, for logging and error reporting. Format: Free string, but a valid UUIDv4 is recommended. |
Responses
Response samples
- 200
- 400
- 405
- 429
- 503
{- "items": [
- {
- "title": "string",
- "id": "string",
- "politicalView": "string",
- "resultType": "administrativeArea",
- "houseNumberType": "PA",
- "addressBlockType": "block",
- "localityType": "postalCode",
- "administrativeAreaType": "county",
- "address": {
- "label": "string",
- "countryCode": "string",
- "countryName": "string",
- "stateCode": "string",
- "state": "string",
- "countyCode": "string",
- "county": "string",
- "city": "string",
- "district": "string",
- "subdistrict": "string",
- "street": "string",
- "block": "string",
- "subblock": "string",
- "postalCode": "string",
- "houseNumber": "string",
- "building": "string"
}, - "position": {
- "lat": 0,
- "lng": 0
}, - "access": [
- {
- "lat": 0,
- "lng": 0
}
], - "distance": 172039,
- "mapView": {
- "west": 0,
- "south": 0,
- "east": 0,
- "north": 0
}, - "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "foodTypes": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "houseNumberFallback": true,
- "timeZone": {
- "name": "string",
- "utcOffset": "string"
}, - "scoring": {
- "queryScore": 0,
- "fieldScore": {
- "country": 0,
- "countryCode": 0,
- "state": 0,
- "stateCode": 0,
- "county": 0,
- "countyCode": 0,
- "city": 0,
- "district": 0,
- "subdistrict": 0,
- "streets": [
- 0
], - "block": 0,
- "subblock": 0,
- "houseNumber": 0,
- "postalCode": 0,
- "building": 0,
- "unit": 0,
- "placeName": 0,
- "ontologyName": 0
}
}, - "parsing": {
- "placeName": [
- {
- "start": 0,
- "end": 0,
- "value": "string",
- "qq": "country"
}
], - "country": [
- {
- "start": 0,
- "end": 0,
- "value": "string",
- "qq": "country"
}
], - "state": [
- {
- "start": 0,
- "end": 0,
- "value": "string",
- "qq": "country"
}
], - "county": [
- {
- "start": 0,
- "end": 0,
- "value": "string",
- "qq": "country"
}
], - "city": [
- {
- "start": 0,
- "end": 0,
- "value": "string",
- "qq": "country"
}
], - "district": [
- {
- "start": 0,
- "end": 0,
- "value": "string",
- "qq": "country"
}
], - "subdistrict": [
- {
- "start": 0,
- "end": 0,
- "value": "string",
- "qq": "country"
}
], - "street": [
- {
- "start": 0,
- "end": 0,
- "value": "string",
- "qq": "country"
}
], - "block": [
- {
- "start": 0,
- "end": 0,
- "value": "string",
- "qq": "country"
}
], - "subblock": [
- {
- "start": 0,
- "end": 0,
- "value": "string",
- "qq": "country"
}
], - "houseNumber": [
- {
- "start": 0,
- "end": 0,
- "value": "string",
- "qq": "country"
}
], - "postalCode": [
- {
- "start": 0,
- "end": 0,
- "value": "string",
- "qq": "country"
}
], - "building": [
- {
- "start": 0,
- "end": 0,
- "value": "string",
- "qq": "country"
}
], - "secondaryUnits": [
- {
- "start": 0,
- "end": 0,
- "value": "string",
- "qq": "country"
}
], - "ontologyName": [
- {
- "start": 0,
- "end": 0,
- "value": "string",
- "qq": "country"
}
]
}, - "streetInfo": [
- {
- "baseName": "string",
- "streetType": "string",
- "streetTypePrecedes": true,
- "streetTypeAttached": true,
- "prefix": "string",
- "suffix": "string",
- "direction": "string",
- "language": "string"
}
], - "countryInfo": {
- "alpha2": "string",
- "alpha3": "string"
}
}
]
}
Discover
This endpoint processes a free-form text query for an address or place, and returns results in order of relevance.
query Parameters
q required | string Example: q=Eismieze Berlin Enter a free-text query Examples:
_Note: Whitespace, urls, email addresses, or other out-of-scope queries will yield no results. |
at | string Example: at=52.5308,13.3856 Specify the center of the search context expressed as coordinates Format: Type: Example: The following constraints apply:
|
in | string Search within a geographic area. This is a hard filter. Results will be returned if they are located within the specified area. A geographic area can be
The following constraints apply:
|
limit | integer <int32> [ 1 .. 100 ] Default: 20 Maximum number of results to be returned. |
route | string BETA: Select within a geographic corridor. This is a hard filter. Results will be returned if they are located within the specified area. A Format: In regular expression syntax, the values of
"[a-zA-Z0-9._-]+" is the encoded flexible polyline. "w=\d+" is the optional width. The width is specified in meters from the center of the path. If no width is provided, the default is 1000 meters. Type: The following constraints apply:
Examples:
Note: The last example above can be decoded (using the Python class here as follows:
|
lang | Array of strings Select the language to be used for result rendering from a list of BCP 47 compliant language codes. |
politicalView | string Toggle the political view. This parameter accepts single ISO 3166-1 alpha-3 country code. The country codes are to be provided in all uppercase. Currently the only supported political views are:
For any valid 3 letter country code, for which GS7 does not have dedicated political view, it falls back to the default view. For not accepted values of the politicalView parameter the GS7 responds with "400" error code. |
show | Array of strings Items Enum: "phonemes" "streetInfo" "tz" Select additional fields to be rendered in the response. Please note that some of the fields involve additional webservice calls and can increase the overall response time. The value is a comma-separated list of the sections to be enabled. For some sections there is a long and a short ID. Description of accepted values: 'phonemes': Renders phonemes for address and place names into the results. 'streetInfo': For each result item renders additional block with the street name decomposed into its parts like the base name, the street type, etc. BETA: 'tz': Renders result items with additional time zone information. Please note that this may impact latency significantly. |
header Parameters
X-Request-ID | string Used to correlate requests with their responses within a customer's application, for logging and error reporting. Format: Free string, but a valid UUIDv4 is recommended. |
Responses
Response samples
- 200
- 400
- 405
- 429
- 503
{- "items": [
- {
- "title": "string",
- "id": "string",
- "politicalView": "string",
- "ontologyId": "string",
- "resultType": "administrativeArea",
- "houseNumberType": "PA",
- "addressBlockType": "block",
- "localityType": "postalCode",
- "administrativeAreaType": "county",
- "address": {
- "label": "string",
- "countryCode": "string",
- "countryName": "string",
- "stateCode": "string",
- "state": "string",
- "countyCode": "string",
- "county": "string",
- "city": "string",
- "district": "string",
- "subdistrict": "string",
- "street": "string",
- "block": "string",
- "subblock": "string",
- "postalCode": "string",
- "houseNumber": "string",
- "building": "string"
}, - "position": {
- "lat": 0,
- "lng": 0
}, - "access": [
- {
- "lat": 0,
- "lng": 0
}
], - "distance": 172039,
- "excursionDistance": 0,
- "mapView": {
- "west": 0,
- "south": 0,
- "east": 0,
- "north": 0
}, - "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "chains": [
- {
- "id": "string"
}
], - "references": [
- {
- "supplier": {
- "id": "core"
}, - "id": "string"
}
], - "foodTypes": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "houseNumberFallback": true,
- "contacts": [
- {
- "phone": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "mobile": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "tollFree": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "fax": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "www": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "email": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
]
}
], - "openingHours": [
- {
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "text": [
- "string"
], - "isOpen": true,
- "structured": [
- {
- "start": "string",
- "duration": "string",
- "recurrence": "string"
}
]
}
], - "timeZone": {
- "name": "string",
- "utcOffset": "string"
}, - "extended": {
- "evStation": {
- "connectors": [
- {
- "supplierName": "string",
- "connectorType": {
- "name": "string",
- "id": "string"
}, - "powerFeedType": {
- "name": "string",
- "id": "string"
}, - "maxPowerLevel": 0,
- "chargingPoint": {
- "numberOfConnectors": 0,
- "chargeMode": "string",
- "voltsRange": "100-120V AC",
- "phases": 0,
- "ampsRange": "12A-80A"
}
}
], - "totalNumberOfConnectors": 0
}
}, - "phonemes": {
- "placeName": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "countryName": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "state": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "county": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "city": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "district": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "subdistrict": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "street": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "block": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "subblock": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
]
}, - "streetInfo": [
- {
- "baseName": "string",
- "streetType": "string",
- "streetTypePrecedes": true,
- "streetTypeAttached": true,
- "prefix": "string",
- "suffix": "string",
- "direction": "string",
- "language": "string"
}
]
}
]
}
Autosuggest
This endpoint suggests address or place candidates based on an incomplete or misspelled query, from which the user selects the best query to submit.
NOTE: The response may contain experimental elements not documented here. Any undocumented element is subject to removal at any time.
query Parameters
q required | string Example: q=Eismieze Berlin Enter a free-text query Examples:
_Note: Whitespace, urls, email addresses, or other out-of-scope queries will yield no results. |
at | string Example: at=52.5308,13.3856 Specify the center of the search context expressed as coordinates Format: Type: Example: The following constraints apply:
|
in | string Search within a geographic area. This is a hard filter. Results will be returned if they are located within the specified area. A geographic area can be
The following constraints apply:
|
limit | integer <int32> [ 1 .. 100 ] Default: 20 Maximum number of results to be returned. |
route | string BETA: Select within a geographic corridor. This is a hard filter. Results will be returned if they are located within the specified area. A Format: In regular expression syntax, the values of
"[a-zA-Z0-9._-]+" is the encoded flexible polyline. "w=\d+" is the optional width. The width is specified in meters from the center of the path. If no width is provided, the default is 1000 meters. Type: The following constraints apply:
Examples:
Note: The last example above can be decoded (using the Python class here as follows:
|
termsLimit | integer <int32> [ 0 .. 10 ] Maximum number of Query Terms Suggestions to be returned. |
lang | Array of strings Select the language to be used for result rendering from a list of BCP 47 compliant language codes. |
politicalView | string Toggle the political view. This parameter accepts single ISO 3166-1 alpha-3 country code. The country codes are to be provided in all uppercase. Currently the only supported political views are:
For any valid 3 letter country code, for which GS7 does not have dedicated political view, it falls back to the default view. For not accepted values of the politicalView parameter the GS7 responds with "400" error code. |
show | Array of strings Items Enum: "phonemes" "streetInfo" "tz" Select additional fields to be rendered in the response. Please note that some of the fields involve additional webservice calls and can increase the overall response time. The value is a comma-separated list of the sections to be enabled. For some sections there is a long and a short ID. Description of accepted values: 'phonemes': Renders phonemes for address and place names into the results. 'streetInfo': For each result item renders additional block with the street name decomposed into its parts like the base name, the street type, etc. BETA: 'tz': Renders result items with additional time zone information. Please note that this may impact latency significantly. |
header Parameters
X-Request-ID | string Used to correlate requests with their responses within a customer's application, for logging and error reporting. Format: Free string, but a valid UUIDv4 is recommended. |
Responses
Response samples
- 200
- 400
- 405
- 429
- 503
{- "items": [
- {
- "title": "string",
- "id": "string",
- "politicalView": "string",
- "ontologyId": "string",
- "resultType": "administrativeArea",
- "houseNumberType": "PA",
- "addressBlockType": "block",
- "localityType": "postalCode",
- "administrativeAreaType": "county",
- "address": {
- "label": "string",
- "countryCode": "string",
- "countryName": "string",
- "stateCode": "string",
- "state": "string",
- "countyCode": "string",
- "county": "string",
- "city": "string",
- "district": "string",
- "subdistrict": "string",
- "street": "string",
- "block": "string",
- "subblock": "string",
- "postalCode": "string",
- "houseNumber": "string",
- "building": "string"
}, - "position": {
- "lat": 0,
- "lng": 0
}, - "access": [
- {
- "lat": 0,
- "lng": 0
}
], - "distance": 172039,
- "excursionDistance": 0,
- "mapView": {
- "west": 0,
- "south": 0,
- "east": 0,
- "north": 0
}, - "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "chains": [
- {
- "id": "string"
}
], - "references": [
- {
- "supplier": {
- "id": "core"
}, - "id": "string"
}
], - "foodTypes": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "contacts": [
- {
- "phone": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "mobile": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "tollFree": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "fax": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "www": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "email": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
]
}
], - "openingHours": [
- {
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "text": [
- "string"
], - "isOpen": true,
- "structured": [
- {
- "start": "string",
- "duration": "string",
- "recurrence": "string"
}
]
}
], - "timeZone": {
- "name": "string",
- "utcOffset": "string"
}, - "highlights": {
- "title": [
- {
- "start": 0,
- "end": 0
}
]
}, - "phonemes": {
- "placeName": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "countryName": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "state": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "county": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "city": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "district": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "subdistrict": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "street": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "block": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "subblock": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
]
}, - "streetInfo": [
- {
- "baseName": "string",
- "streetType": "string",
- "streetTypePrecedes": true,
- "streetTypeAttached": true,
- "prefix": "string",
- "suffix": "string",
- "direction": "string",
- "language": "string"
}
]
}
], - "queryTerms": [
- {
- "term": "string",
- "replaces": "string",
- "start": 0,
- "end": 0
}
]
}
Autocomplete
BETA: This endpoint completes the few entered keystrokes to the valid street address or administrative area to speed-up entering the address queries.
query Parameters
q required | string Example: q=Berlin Pariser 20 Enter a free-text query Examples:
Note: Whitespace, urls, email addresses, or other out-of-scope queries will yield no results. |
at | string Specify the center of the search context expressed as coordinates. Format: Type: Example: |
in | string Search within a geographic area. This is a hard filter. Results will be returned if they are located within the specified area. A geographic area can be
|
limit | integer <int32> [ 1 .. 20 ] Default: 5 Maximum number of results to be returned. |
types | Array of strings Items Enum: "area" "city" "postalCode" BETA: Limit the result items to the specified types. Currently supported values of the type filter for Autocomplete:
Provide one of the supported values or a comma separated list. |
lang | Array of strings Select the preferred response language for result rendering from a list of BCP47 compliant Language Codes. The autocomplete endpoint tries to detect the query language based on matching name variants and then chooses the same language for the response. Therefore the end-user can see and recognize all the entered terms in the same language as in the query. The specified preferred language is used only for not matched address tokens and for matched address tokens in case of ambiguity |
politicalView | string Toggle the political view. This parameter accepts single ISO 3166-1 alpha-3 country code. The country codes are to be provided in all uppercase. Currently the only supported political views are:
For any valid 3 letter country code, for which GS7 does not have dedicated political view, it falls back to the default view. For not accepted values of the politicalView parameter the GS7 responds with "400" error code. |
show | Array of strings Items Value: "streetInfo" Select additional fields to be rendered in the response. Please note that some of the fields involve additional webservice calls and can increase the overall response time. The value is a comma-separated list of the sections to be enabled. For some sections there is a long and a short ID. Description of accepted values: 'streetInfo': For each result item renders additional block with the street name decomposed into its parts like the base name, the street type, etc. |
header Parameters
X-Request-ID | string Used to correlate requests with their responses within a customer's application, for logging and error reporting. Format: Free string, but a valid UUIDv4 is recommended. |
Responses
Response samples
- 200
- 400
- 405
- 429
- 503
{- "items": [
- {
- "title": "string",
- "id": "string",
- "language": "string",
- "politicalView": "string",
- "resultType": "administrativeArea",
- "houseNumberType": "PA",
- "localityType": "postalCode",
- "administrativeAreaType": "county",
- "address": {
- "label": "string",
- "countryCode": "string",
- "countryName": "string",
- "stateCode": "string",
- "state": "string",
- "countyCode": "string",
- "county": "string",
- "city": "string",
- "district": "string",
- "subdistrict": "string",
- "street": "string",
- "block": "string",
- "subblock": "string",
- "postalCode": "string",
- "houseNumber": "string",
- "building": "string"
}, - "distance": 172039,
- "highlights": {
- "title": [
- {
- "start": 0,
- "end": 0
}
]
}, - "streetInfo": [
- {
- "baseName": "string",
- "streetType": "string",
- "streetTypePrecedes": true,
- "streetTypeAttached": true,
- "prefix": "string",
- "suffix": "string",
- "direction": "string",
- "language": "string"
}
]
}
]
}
Browse
This endpoint provides search results for places based on different filters, such as categories or name, ranked by distance from a given search center. The only mandatory elements exposed in the response are id and position. The other elements shown in the response samples section are only dataset attributes suggestions.
query Parameters
at required | string Example: at=52.5308,13.3856 Specify the center of the search context expressed as coordinates Required parameter for endpoints that are expected to rank results by distance from the explicitly specified search center Format: Type: Example: |
categories | Array of strings Category filter consisting of a comma-separated list of category-IDs for Categories defined in the HERE Places Category System, described in the Appendix to the HERE Search Developer Guide. Places with any assigned categories that match any of the requested categories are included in the response. An exclamation mark " |
chains | Array of strings Chain filter consisting of a comma-separated list of chain-IDs for Chains defined in the HERE Places Chain System, described in the Appendix to the HERE Search Developer Guide. Places with any assigned chains that match any of the requested chains are included in the response. An exclamation mark " |
foodTypes | Array of strings FoodType filter consisting of a comma-separated list of cuisine-IDs for FoodTypes defined in the HERE Places Cuisine System, described in the Appendix to the HERE Search Developer Guide. Places with any assigned foodTypes that match any of the requested foodTypes are included in the response. An exclamation mark " |
in | string Search within a geographic area. This is a hard filter. Results will be returned if they are located within the specified area. A geographic area can be
The following constraints apply:
|
limit | integer <int32> [ 1 .. 100 ] Default: 20 Maximum number of results to be returned. |
name | string Full-text filter on POI names/titles. Results with a partial match on the name parameter are included in the response. |
route | string BETA: Select within a geographic corridor. This is a hard filter. Results will be returned if they are located within the specified area. A Format: In regular expression syntax, the values of
"[a-zA-Z0-9._-]+" is the encoded flexible polyline. "w=\d+" is the optional width. The width is specified in meters from the center of the path. If no width is provided, the default is 1000 meters. Type: The following constraints apply:
Examples:
Note: The last example above can be decoded (using the Python class here as follows:
|
lang | Array of strings Select the language to be used for result rendering from a list of BCP 47 compliant language codes. |
politicalView | string Toggle the political view. This parameter accepts single ISO 3166-1 alpha-3 country code. The country codes are to be provided in all uppercase. Currently the only supported political views are:
For any valid 3 letter country code, for which GS7 does not have dedicated political view, it falls back to the default view. For not accepted values of the politicalView parameter the GS7 responds with "400" error code. |
show | Array of strings Items Enum: "phonemes" "streetInfo" "tz" Select additional fields to be rendered in the response. Please note that some of the fields involve additional webservice calls and can increase the overall response time. The value is a comma-separated list of the sections to be enabled. For some sections there is a long and a short ID. Description of accepted values: 'phonemes': Renders phonemes for address and place names into the results. 'streetInfo': For each result item renders additional block with the street name decomposed into its parts like the base name, the street type, etc. BETA: 'tz': Renders result items with additional time zone information. Please note that this may impact latency significantly. |
header Parameters
X-Request-ID | string Used to correlate requests with their responses within a customer's application, for logging and error reporting. Format: Free string, but a valid UUIDv4 is recommended. |
Responses
Response samples
- 200
- 400
- 405
- 429
- 503
{- "items": [
- {
- "title": "string",
- "id": "string",
- "politicalView": "string",
- "resultType": "administrativeArea",
- "houseNumberType": "PA",
- "addressBlockType": "block",
- "localityType": "postalCode",
- "administrativeAreaType": "county",
- "houseNumberFallback": true,
- "address": {
- "label": "string",
- "countryCode": "string",
- "countryName": "string",
- "stateCode": "string",
- "state": "string",
- "countyCode": "string",
- "county": "string",
- "city": "string",
- "district": "string",
- "subdistrict": "string",
- "street": "string",
- "block": "string",
- "subblock": "string",
- "postalCode": "string",
- "houseNumber": "string",
- "building": "string"
}, - "position": {
- "lat": 0,
- "lng": 0
}, - "access": [
- {
- "lat": 0,
- "lng": 0
}
], - "distance": 172039,
- "excursionDistance": 0,
- "mapView": {
- "west": 0,
- "south": 0,
- "east": 0,
- "north": 0
}, - "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "chains": [
- {
- "id": "string"
}
], - "references": [
- {
- "supplier": {
- "id": "core"
}, - "id": "string"
}
], - "foodTypes": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "contacts": [
- {
- "phone": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "mobile": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "tollFree": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "fax": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "www": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "email": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
]
}
], - "openingHours": [
- {
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "text": [
- "string"
], - "isOpen": true,
- "structured": [
- {
- "start": "string",
- "duration": "string",
- "recurrence": "string"
}
]
}
], - "timeZone": {
- "name": "string",
- "utcOffset": "string"
}, - "extended": {
- "evStation": {
- "connectors": [
- {
- "supplierName": "string",
- "connectorType": {
- "name": "string",
- "id": "string"
}, - "powerFeedType": {
- "name": "string",
- "id": "string"
}, - "maxPowerLevel": 0,
- "chargingPoint": {
- "numberOfConnectors": 0,
- "chargeMode": "string",
- "voltsRange": "100-120V AC",
- "phases": 0,
- "ampsRange": "12A-80A"
}
}
], - "totalNumberOfConnectors": 0
}
}, - "phonemes": {
- "placeName": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "countryName": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "state": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "county": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "city": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "district": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "subdistrict": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "street": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "block": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "subblock": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
]
}, - "streetInfo": [
- {
- "baseName": "string",
- "streetType": "string",
- "streetTypePrecedes": true,
- "streetTypeAttached": true,
- "prefix": "string",
- "suffix": "string",
- "direction": "string",
- "language": "string"
}
]
}
]
}
Reverse Geocode
This endpoint returns the nearest address to geo coordinates specified in the request.
query Parameters
at | string Example: at=52.5308,13.3856 Specify the center of the search context expressed as coordinates. Format: Type: Example: The following constraints apply:
|
in | string Search within a geographic area. This is a hard filter. Results will be returned if they are located within the specified area. A geographic area can be
The following constraints apply:
|
limit | integer <int32> [ 1 .. 100 ] Default: 1 Maximum number of results to be returned. |
lang | Array of strings Select the language to be used for result rendering from a list of BCP 47 compliant language codes. |
politicalView | string Toggle the political view. This parameter accepts single ISO 3166-1 alpha-3 country code. The country codes are to be provided in all uppercase. Currently the only supported political views are:
For any valid 3 letter country code, for which GS7 does not have dedicated political view, it falls back to the default view. For not accepted values of the politicalView parameter the GS7 responds with "400" error code. |
show | Array of strings Items Enum: "countryInfo" "streetInfo" "tz" Select additional fields to be rendered in the response. Please note that some of the fields involve additional webservice calls and can increase the overall response time. The value is a comma-separated list of the sections to be enabled. For some sections there is a long and a short ID. Description of accepted values: 'countryInfo': For each result item renders additional block with the country info, such as ISO 3166-1 alpha-2 and ISO 3166-1 alpha-3 country code. 'streetInfo': For each result item renders additional block with the street name decomposed into its parts like the base name, the street type, etc. BETA: 'tz': Renders result items with additional time zone information. Please note that this may impact latency significantly. |
header Parameters
X-Request-ID | string Used to correlate requests with their responses within a customer's application, for logging and error reporting. Format: Free string, but a valid UUIDv4 is recommended. |
Responses
Response samples
- 200
- 400
- 405
- 429
- 503
{- "items": [
- {
- "title": "string",
- "id": "string",
- "politicalView": "string",
- "resultType": "administrativeArea",
- "houseNumberType": "PA",
- "addressBlockType": "block",
- "localityType": "postalCode",
- "administrativeAreaType": "county",
- "address": {
- "label": "string",
- "countryCode": "string",
- "countryName": "string",
- "stateCode": "string",
- "state": "string",
- "countyCode": "string",
- "county": "string",
- "city": "string",
- "district": "string",
- "subdistrict": "string",
- "street": "string",
- "block": "string",
- "subblock": "string",
- "postalCode": "string",
- "houseNumber": "string",
- "building": "string"
}, - "position": {
- "lat": 0,
- "lng": 0
}, - "access": [
- {
- "lat": 0,
- "lng": 0
}
], - "distance": 172039,
- "mapView": {
- "west": 0,
- "south": 0,
- "east": 0,
- "north": 0
}, - "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "foodTypes": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "houseNumberFallback": true,
- "timeZone": {
- "name": "string",
- "utcOffset": "string"
}, - "streetInfo": [
- {
- "baseName": "string",
- "streetType": "string",
- "streetTypePrecedes": true,
- "streetTypeAttached": true,
- "prefix": "string",
- "suffix": "string",
- "direction": "string",
- "language": "string"
}
], - "countryInfo": {
- "alpha2": "string",
- "alpha3": "string"
}
}
]
}
Lookup By ID
This endpoint looks up a known place by the HERE ID included in the request.
query Parameters
id required | string Example: id=here:pds:place:276u33db-8097f3194e4b411081b761ea9a366776 Location ID, which is the ID of a result item eg. of a Discover request |
lang | Array of strings Select the language to be used for result rendering from a list of BCP 47 compliant language codes. |
politicalView | string Toggle the political view. This parameter accepts single ISO 3166-1 alpha-3 country code. The country codes are to be provided in all uppercase. Currently the only supported political views are:
For any valid 3 letter country code, for which GS7 does not have dedicated political view, it falls back to the default view. For not accepted values of the politicalView parameter the GS7 responds with "400" error code. |
show | Array of strings Items Enum: "countryInfo" "phonemes" "streetInfo" "tz" Select additional fields to be rendered in the response. Please note that some of the fields involve additional webservice calls and can increase the overall response time. The value is a comma-separated list of the sections to be enabled. For some sections there is a long and a short ID. Description of accepted values: 'countryInfo': For each result item renders additional block with the country info, such as ISO 3166-1 alpha-2 and ISO 3166-1 alpha-3 country code. 'phonemes': Renders phonemes for address and place names into the results. 'streetInfo': For each result item renders additional block with the street name decomposed into its parts like the base name, the street type, etc. BETA: 'tz': Renders result items with additional time zone information. Please note that this may impact latency significantly. |
header Parameters
X-Request-ID | string Used to correlate requests with their responses within a customer's application, for logging and error reporting. Format: Free string, but a valid UUIDv4 is recommended. |
Responses
Response samples
- 200
- 400
- 404
- 405
- 429
- 503
{- "title": "string",
- "id": "string",
- "politicalView": "string",
- "resultType": "administrativeArea",
- "houseNumberType": "PA",
- "addressBlockType": "block",
- "localityType": "postalCode",
- "administrativeAreaType": "county",
- "houseNumberFallback": true,
- "address": {
- "label": "string",
- "countryCode": "string",
- "countryName": "string",
- "stateCode": "string",
- "state": "string",
- "countyCode": "string",
- "county": "string",
- "city": "string",
- "district": "string",
- "subdistrict": "string",
- "street": "string",
- "block": "string",
- "subblock": "string",
- "postalCode": "string",
- "houseNumber": "string",
- "building": "string"
}, - "position": {
- "lat": 0,
- "lng": 0
}, - "access": [
- {
- "lat": 0,
- "lng": 0
}
], - "mapView": {
- "west": 0,
- "south": 0,
- "east": 0,
- "north": 0
}, - "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "chains": [
- {
- "id": "string"
}
], - "references": [
- {
- "supplier": {
- "id": "core"
}, - "id": "string"
}
], - "foodTypes": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "contacts": [
- {
- "phone": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "mobile": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "tollFree": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "fax": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "www": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
], - "email": [
- {
- "label": "string",
- "value": "string",
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
]
}
]
}
], - "openingHours": [
- {
- "categories": [
- {
- "id": "string",
- "name": "string",
- "primary": true
}
], - "text": [
- "string"
], - "isOpen": true,
- "structured": [
- {
- "start": "string",
- "duration": "string",
- "recurrence": "string"
}
]
}
], - "timeZone": {
- "name": "string",
- "utcOffset": "string"
}, - "extended": {
- "evStation": {
- "connectors": [
- {
- "supplierName": "string",
- "connectorType": {
- "name": "string",
- "id": "string"
}, - "powerFeedType": {
- "name": "string",
- "id": "string"
}, - "maxPowerLevel": 0,
- "chargingPoint": {
- "numberOfConnectors": 0,
- "chargeMode": "string",
- "voltsRange": "100-120V AC",
- "phases": 0,
- "ampsRange": "12A-80A"
}
}
], - "totalNumberOfConnectors": 0
}
}, - "phonemes": {
- "placeName": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "countryName": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "state": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "county": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "city": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "district": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "subdistrict": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "street": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "block": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
], - "subblock": [
- {
- "value": "string",
- "language": "string",
- "preferred": true
}
]
}, - "streetInfo": [
- {
- "baseName": "string",
- "streetType": "string",
- "streetTypePrecedes": true,
- "streetTypeAttached": true,
- "prefix": "string",
- "suffix": "string",
- "direction": "string",
- "language": "string"
}
], - "countryInfo": {
- "alpha2": "string",
- "alpha3": "string"
}
}