跳到正文
Documentation Powered by Redocly

NBAI Map API (0.1.0)

Download OpenAPI specification:Download

routing

Operations to manage routing

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 steps flag determines whether to return the individual maneuver instructions that comprise the route in the response. Default is false.

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 polyline, polyline6, or geojson. If geojson is selected, the response will include geometry in polyline6 format and will also include a geojson object that defines the route polyline.

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 property.

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 alternatives property is set to false.

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

Content type
application/json
{
  • "errorMessage": "string",
  • "mode": "string",
  • "routes": [
    ],
  • "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

deprecated

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "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

deprecated

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

Content type
application/json
{
  • "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

Content type
application/json
{
  • "rows": [
    ],
  • "status": "string"
}

DistanceMatrix JSON Handler

query Parameters
approaches
string
avoid
string
context
string

deprecated

debug
boolean

enable to show debug information.

Default: false

departure_time
integer <int64>

departure time.

Format: unix timestamp.

Unit: seconds.

Default: 0

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:car|auto|bike|escooter|4w|2w....

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

Content type
application/json
{
  • "rows": [
    ],
  • "status": "string"
}

DistanceMatrixConcise JSON POST Handler

query Parameters
key
string
Request Body schema: application/json
approaches
string
avoid
string
context
string

deprecated

debug
boolean

enable to show debug information.

Default: false

departure_time
integer <int64>

departure time.

Format: unix timestamp.

Unit: seconds.

Default: 0

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:car|auto|bike|escooter|4w|2w....

Default: ""

origins
required
string

locations of origins

Format: lat0,lng0|lat1,lng1|...

Regex: ^[\d.-]+,[\d.-]+(|[\d.-]+,[\d.-]+)*$

Responses

Request samples

Content type
application/json
{
  • "approaches": "string",
  • "avoid": "string",
  • "context": "string",
  • "debug": true,
  • "departure_time": 0,
  • "destinations": "string",
  • "key": "string",
  • "mode": "string",
  • "origins": "string"
}

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "status": "string"
}

Isochrone JSON Handler

query Parameters
center
required
string
departure_time
integer <int64>
distances
string
key
string
mode
string

mode of service.

Values:car|auto|bike|escooter|4w|2w....

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

Content type
application/json
{
  • "distances": [
    ],
  • "opacities": [
    ],
  • "polylines": [
    ],
  • "status": "string",
  • "strokes": [
    ],
  • "times": [
    ]
}

Navigating Json Handler

query Parameters
altcount
integer <int32>

number of alternative routes to return.

Default: 1 if alternatives is disabled, 3 otherwise

alternatives
boolean

enable to return alternative routes.

Note: altcount will default to 3 if this is enabled.

Default: false

approaches
string
avoid
string

Indicates that the calculated route(s) should avoid the indicated features.

Format: value1|value2|.... Default:""

bearings
string

Limits the search to segments with given bearing in degrees towards true north in clockwise direction.

Format: degree,range;degree,range.... Default:""

departure_time
integer <int64>

departure time.

Format: unix timestamp.

Unit: seconds.

Default: 0

destination
string

location of destination.

Format: lat,lng.

Regex: ^[\d.-]+,[\d.-]+$

geometry
string

geometry input, if this is given, other params will not be considered except geometry_type & lang & key.

geometry_type
string

format of geometry.

Default: polyline6

key
string

apikey for authentication.

Default: ""

lang
string

language of the text instruction

mode
string

mode of service.

Values:car|auto|bike|escooter|4w|2w....

Default: ""

For any mode aside from 4w, please contact support@nextbillion.ai to enable it for your organization.

origin
string

{{location_of_origin}}

Format: lat,lng.

Regex: ^[\d.-]+,[\d.-]+$

overview
string
Enum: "full" "simplified" "false"

output verbosity of overview (whole trip) geometry.

Default: full

session
string

unique session id for trip identification.

Note: Help to reuse cached trip characteritics when set.

Default: ""

waypoints
string

location(s) of waypoint(s) along the trip.

Format: lat0,lng0|lat1,lng1|....

Regex: (^[\d.-]+,[\d.-]+(|[\d.-]+,[\d.-]+)*$)

Responses

Response samples

Content type
application/json
{
  • "error_msg": "string",
  • "routes": [
    ],
  • "status": "string"
}

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

Content type
application/json
{
  • "code": "string",
  • "trips": [
    ],
  • "waypoints": [
    ],
  • "location": null
}

Post Trip Route Json Handler

Request Body schema: application/json
context
string

deprecated

debug
boolean

enable to show debug information.

Default: false

key
string

apikey for authentication.

Default: ""

mode
string

mode of service.

Values:car|auto|bike|escooter|4w|2w....

Default: ""

special_object_types
Array of strings

special geospatial objects to include in response.

Default: ["traffic_signals"]

timestamps
string

unix timestamp of each waypoints.

Unit: seconds

Format: ts0|ts1|...

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: false

waypoints
required
string

location(s) of waypoint(s) along the trip.

Format:lat0,lng0|lat1,lng1|...

Regex: ^[\d.-]+,[\d.-]+(|[\d.-]+,[\d.-]+)*$

Responses

Request samples

Content type
application/json
{
  • "context": "string",
  • "debug": true,
  • "key": "string",
  • "mode": "string",
  • "special_object_types": [
    ],
  • "timestamps": "string",
  • "tolerate_outlier": true,
  • "waypoints": "string"
}

Response samples

Content type
application/json
{
  • "errorMessage": "string",
  • "mode": "string",
  • "route": {
    },
  • "status": "string"
}

SnapToRoads Json Handler

query Parameters
key
string

API Key used for authentication

path
required
string

Locations to perform snap2roads.

Format: lat0,lng0|lat1,lng1|...

Regex: ^[\d.-]+,[\d.-]+(|[\d.-]+,[\d.-]+)*$

timestamps
string

Pipe separated unix timestamps for each location.

Unit: seconds.

Format: ts0|ts1|...

Regex: ^[\d]+(|[\d]+)*$

radiuses
string

Pipe separated Radiuses of each location for performing snap2road

Unit: meters.

Format: radius0|radius1|...

Regex: ^[\d]+(|[\d]+)*$

interpolate
boolean

Enable to interpolate the path.

Note: might return more points

Default: false

approaches
string
avoid
string
context
string

deprecated

geometry
string

only supports for polyline and geojson

mode
string

mode of service.

Values:car|auto|bike|escooter|4w|2w....

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: false

Responses

Response samples

Content type
application/json
{
  • "distance": "Unit: meters.",
  • "geojson": [
    ],
  • "geometry": [
    ],
  • "snappedPoints": [
    ],
  • "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

deprecated

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:car|auto|bike|escooter|4w|2w....

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

Content type
application/json
{
  • "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

Content type
application/json
{
  • "distance": 0,
  • "geojson": [
    ],
  • "geometry": [
    ],
  • "snappedPoints": [
    ],
  • "status": "string"
}

geocode

Operations to manage geocode

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: {latitude},{longitude}

Type: {decimal},{decimal}

Example: -13.163068,-72.545128 (Machu Picchu Mountain, Peru)

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

  • a country (or multiple countries), provided as comma-separated ISO 3166-1 alpha-3 country codes

    The country codes are to be provided in all uppercase.

    Format: countryCode:{countryCode}[,{countryCode}]*

    Examples:

    • countryCode:USA
    • countryCode:CAN,MEX,USA
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:

  • 125, Berliner, berlin
  • Beacon, Boston, Hospital
  • Schnurrbart German Pub and Restaurant, Hong Kong

Note: Either q or qq-parameter is required on this endpoint. Both parameters can be provided in the same request.

qq
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 country, state, county, city, district, street, houseNumber, and postalCode.

Format: {sub-parameter}={string}[;{sub-parameter}={string}]*

Examples:

  • city=Berlin;country=Germany;street=Friedrichstr;houseNumber=20
  • city=Berlin;country=Germany
  • postalCode=10969

Note: Either q or qq-parameter is required on this endpoint. Both parameters can be provided in the same 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:

  • RUS expressing the Russian view on Crimea
  • SRB expressing the Serbian view on Kosovo, Vukovar and Sarengrad Islands
  • MAR expressing the Moroccan view on Western Sahara
  • SUR Suriname view on Courantyne Headwaters and Lawa Headwaters
  • KEN Kenya view on Ilemi Triangle
  • TZA Tanzania view on Lake Malawi
  • URY Uruguay view on Rincon de Artigas
  • EGY Egypt view on Bir Tawil
  • SDN Sudan view on Halaib Triangle
  • SYR Syria view on Golan Heights
  • ARG Argentina view on Southern Patagonian Ice Field and Tierra Del Fuego, including Falkland Islands, South Georgia and South Sandwich Islands
  • IND Indian View on Gilgit-Baltistan
  • PAK Pakistan View on Jammu and Kashmir and Junagadh Area

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

Content type
application/json
{
  • "items": [
    ]
}

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:

  • 125, Berliner, berlin
  • Beacon, Boston, Hospital
  • Schnurrbart German Pub and Restaurant, Hong Kong

_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: {latitude},{longitude}

Type: {decimal},{decimal}

Example: -13.163068,-72.545128 (Machu Picchu Mountain, Peru)

The following constraints apply:

  • One of "at", "in=circle" or "in=bbox" is required.

  • Parameters "at", "in=circle" and "in=bbox" are mutually exclusive. Only one of them is allowed.

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

  • a country (or multiple countries), provided as comma-separated ISO 3166-1 alpha-3 country codes

    The country codes are to be provided in all uppercase.

    Format: countryCode:{countryCode}[,{countryCode}]*

    Examples:

    • countryCode:USA
    • countryCode:CAN,MEX,USA

  • a circular area, provided as latitude, longitude, and radius (in meters)

    Format: circle:{latitude},{longitude};r={radius}

    Type: circle:{decimal},{decimal};r={integer}

    Example: circle:52.53,13.38;r=10000

  • a bounding box, provided as west longitude, south latitude, east longitude, north latitude

    Format: bbox:{west longitude},{south latitude},{east longitude},{north latitude}

    Example: bbox:13.08836,52.33812,13.761,52.6755

The following constraints apply:

  • Parameters "at", "in=circle" and "in=bbox" are mutually exclusive. Only one of them is allowed.

  • One of "at", "in=circle" or "in=bbox" is required.

  • The "in=countryCode" parameter must be accompanied by exactly one of "at", "in=circle" or "in=bbox".

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 route is defined by a Flexible Polyline Encoding, followed by an optional width, represented by a sub-parameter "w".

Format: {route};w={width}

In regular expression syntax, the values of route look like:

[a-zA-Z0-9_-]+(;w=\d+)?

"[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: {Flexible Polyline Encoding};w={integer}

The following constraints apply:

  • A route MUST NOT contain more than 2000 points.

Examples:

  • BFoz5xJ67i1B1B7PzIhaxL7Y
  • BFoz5xJ67i1B1B7PzIhaxL7Y;w=5000
  • BlD05xgKuy2xCCx9B7vUCl0OhnRC54EqSCzpEl-HCxjD3pBCiGnyGCi2CvwFCsgD3nDC4vB6eC;w=2000

Note: The last example above can be decoded (using the Python class here as follows:

>>> import flexpolyline
>>> polyline = 'BlD05xgKuy2xCCx9B7vUCl0OhnRC54EqSCzpEl-HCxjD3pBCiGnyGCi2CvwFCsgD3nDC4vB6eC'
>>> flexpolyline.decode(polyline)
[(52.51994, 13.38663, 1.0), (52.51009, 13.28169, 2.0), (52.43518, 13.19352, 3.0), (52.41073, 13.19645, 4.0), (52.38871, 13.15578, 5.0), (52.37278, 13.1491, 6.0), (52.37375, 13.11546, 7.0), (52.38752, 13.08722, 8.0), (52.40294, 13.07062, 9.0), (52.41058, 13.07555, 10.0)]
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:

  • RUS expressing the Russian view on Crimea
  • SRB expressing the Serbian view on Kosovo, Vukovar and Sarengrad Islands
  • MAR expressing the Moroccan view on Western Sahara
  • SUR Suriname view on Courantyne Headwaters and Lawa Headwaters
  • KEN Kenya view on Ilemi Triangle
  • TZA Tanzania view on Lake Malawi
  • URY Uruguay view on Rincon de Artigas
  • EGY Egypt view on Bir Tawil
  • SDN Sudan view on Halaib Triangle
  • SYR Syria view on Golan Heights
  • ARG Argentina view on Southern Patagonian Ice Field and Tierra Del Fuego, including Falkland Islands, South Georgia and South Sandwich Islands
  • IND Indian View on Gilgit-Baltistan
  • PAK Pakistan View on Jammu and Kashmir and Junagadh Area

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

Content type
application/json
{
  • "items": [
    ]
}

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:

  • res, rest, resta, restau, ...
  • berlin+bran, berlin+brand, berlin+branden, ...
  • New+Yok+Giants

_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: {latitude},{longitude}

Type: {decimal},{decimal}

Example: -13.163068,-72.545128 (Machu Picchu Mountain, Peru)

The following constraints apply:

  • One of "at", "in=circle" or "in=bbox" is required.

  • Parameters "at", "in=circle" and "in=bbox" are mutually exclusive. Only one of them is allowed.

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

  • a country (or multiple countries), provided as comma-separated ISO 3166-1 alpha-3 country codes

    The country codes are to be provided in all uppercase.

    Format: countryCode:{countryCode}[,{countryCode}]*

    Examples:

    • countryCode:USA
    • countryCode:CAN,MEX,USA

  • a circular area, provided as latitude, longitude, and radius (in meters)

    Format: circle:{latitude},{longitude};r={radius}

    Type: circle:{decimal},{decimal};r={integer}

    Example: circle:52.53,13.38;r=10000

  • a bounding box, provided as west longitude, south latitude, east longitude, north latitude

    Format: bbox:{west longitude},{south latitude},{east longitude},{north latitude}

    Example: bbox:13.08836,52.33812,13.761,52.6755

The following constraints apply:

  • Parameters "at", "in=circle" and "in=bbox" are mutually exclusive. Only one of them is allowed.

  • One of "at", "in=circle" or "in=bbox" is required.

  • The "in=countryCode" parameter must be accompanied by exactly one of "at", "in=circle" or "in=bbox".

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 route is defined by a Flexible Polyline Encoding, followed by an optional width, represented by a sub-parameter "w".

Format: {route};w={width}

In regular expression syntax, the values of route look like:

[a-zA-Z0-9_-]+(;w=\d+)?

"[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: {Flexible Polyline Encoding};w={integer}

The following constraints apply:

  • A route MUST NOT contain more than 2000 points.

Examples:

  • BFoz5xJ67i1B1B7PzIhaxL7Y
  • BFoz5xJ67i1B1B7PzIhaxL7Y;w=5000
  • BlD05xgKuy2xCCx9B7vUCl0OhnRC54EqSCzpEl-HCxjD3pBCiGnyGCi2CvwFCsgD3nDC4vB6eC;w=2000

Note: The last example above can be decoded (using the Python class here as follows:

>>> import flexpolyline
>>> polyline = 'BlD05xgKuy2xCCx9B7vUCl0OhnRC54EqSCzpEl-HCxjD3pBCiGnyGCi2CvwFCsgD3nDC4vB6eC'
>>> flexpolyline.decode(polyline)
[(52.51994, 13.38663, 1.0), (52.51009, 13.28169, 2.0), (52.43518, 13.19352, 3.0), (52.41073, 13.19645, 4.0), (52.38871, 13.15578, 5.0), (52.37278, 13.1491, 6.0), (52.37375, 13.11546, 7.0), (52.38752, 13.08722, 8.0), (52.40294, 13.07062, 9.0), (52.41058, 13.07555, 10.0)]
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:

  • RUS expressing the Russian view on Crimea
  • SRB expressing the Serbian view on Kosovo, Vukovar and Sarengrad Islands
  • MAR expressing the Moroccan view on Western Sahara
  • SUR Suriname view on Courantyne Headwaters and Lawa Headwaters
  • KEN Kenya view on Ilemi Triangle
  • TZA Tanzania view on Lake Malawi
  • URY Uruguay view on Rincon de Artigas
  • EGY Egypt view on Bir Tawil
  • SDN Sudan view on Halaib Triangle
  • SYR Syria view on Golan Heights
  • ARG Argentina view on Southern Patagonian Ice Field and Tierra Del Fuego, including Falkland Islands, South Georgia and South Sandwich Islands
  • IND Indian View on Gilgit-Baltistan
  • PAK Pakistan View on Jammu and Kashmir and Junagadh Area

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

Content type
application/json
{
  • "items": [
    ],
  • "queryTerms": [
    ]
}

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:

  • ber, berl, berli, ...
  • berlin+p, berlin+paris, berlin+parise, ...
  • berlin+pariser+20

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: {latitude},{longitude}

Type: {decimal},{decimal}

Example: -13.163068,-72.545128 (Machu Picchu Mountain, Peru)

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

  • a country (or multiple countries), provided as comma-separated ISO 3166-1 alpha-3 country codes

    The country codes are to be provided in all uppercase.

    Format: countryCode:{countryCode}[,{countryCode}]*

    Examples:

    • countryCode:USA
    • countryCode:CAN,MEX,USA
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:

  • city - restricting results to result type locality and locality type city
  • postalCode - restricting results to result type locality and locality type postalCode,
  • area - restricting results to result types: locality or administrativeArea including all the sub-types

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:

  • RUS expressing the Russian view on Crimea
  • SRB expressing the Serbian view on Kosovo, Vukovar and Sarengrad Islands
  • MAR expressing the Moroccan view on Western Sahara
  • SUR Suriname view on Courantyne Headwaters and Lawa Headwaters
  • KEN Kenya view on Ilemi Triangle
  • TZA Tanzania view on Lake Malawi
  • URY Uruguay view on Rincon de Artigas
  • EGY Egypt view on Bir Tawil
  • SDN Sudan view on Halaib Triangle
  • SYR Syria view on Golan Heights
  • ARG Argentina view on Southern Patagonian Ice Field and Tierra Del Fuego, including Falkland Islands, South Georgia and South Sandwich Islands
  • IND Indian View on Gilgit-Baltistan
  • PAK Pakistan View on Jammu and Kashmir and Junagadh Area

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

Content type
application/json
{
  • "items": [
    ]
}

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: {latitude},{longitude}

Type: {decimal},{decimal}

Example: -13.163068,-72.545128 (Machu Picchu Mountain, Peru)

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 "!" in front of a category ID causes that category to be excluded from the results. It is possible to mix excluded and included categories in the request - e.g. searching for places that are restaurants but not fast food restaurants. An exclusion will always win over an inclusion.

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 "!" in front of a chain ID causes that chain to be excluded from the results. It is possible to mix excluded and included chains in the request - e.g. searching for places that are amazon but not wholefoods. An exclusion will always win over an inclusion.

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 front of a cuisine ID causes that foodType to be excluded from the results. It is possible to mix excluded and included foodTypes in the request - e.g. searching for places that serve italian but not chinese. An exclusion will always win over an inclusion.

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

  • a country (or multiple countries), provided as comma-separated ISO 3166-1 alpha-3 country codes

    The country codes are to be provided in all uppercase.

    Format: countryCode:{countryCode}[,{countryCode}]*

    Examples:

    • countryCode:USA
    • countryCode:CAN,MEX,USA

  • a circular area, provided as latitude, longitude, and radius (in meters)

    Format: circle:{latitude},{longitude};r={radius}

    Type: circle:{decimal},{decimal};r={integer}

    Example: circle:52.53,13.38;r=10000

  • a bounding box, provided as west longitude, south latitude, east longitude, north latitude

    Format: bbox:{west longitude},{south latitude},{east longitude},{north latitude}

    Example: bbox:13.08836,52.33812,13.761,52.6755

The following constraints apply:

  • Parameters "in=circle" and "in=bbox" are mutually exclusive. Only one of them is allowed.
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 route is defined by a Flexible Polyline Encoding, followed by an optional width, represented by a sub-parameter "w".

Format: {route};w={width}

In regular expression syntax, the values of route look like:

[a-zA-Z0-9_-]+(;w=\d+)?

"[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: {Flexible Polyline Encoding};w={integer}

The following constraints apply:

  • A route MUST NOT contain more than 2000 points.

Examples:

  • BFoz5xJ67i1B1B7PzIhaxL7Y
  • BFoz5xJ67i1B1B7PzIhaxL7Y;w=5000
  • BlD05xgKuy2xCCx9B7vUCl0OhnRC54EqSCzpEl-HCxjD3pBCiGnyGCi2CvwFCsgD3nDC4vB6eC;w=2000

Note: The last example above can be decoded (using the Python class here as follows:

>>> import flexpolyline
>>> polyline = 'BlD05xgKuy2xCCx9B7vUCl0OhnRC54EqSCzpEl-HCxjD3pBCiGnyGCi2CvwFCsgD3nDC4vB6eC'
>>> flexpolyline.decode(polyline)
[(52.51994, 13.38663, 1.0), (52.51009, 13.28169, 2.0), (52.43518, 13.19352, 3.0), (52.41073, 13.19645, 4.0), (52.38871, 13.15578, 5.0), (52.37278, 13.1491, 6.0), (52.37375, 13.11546, 7.0), (52.38752, 13.08722, 8.0), (52.40294, 13.07062, 9.0), (52.41058, 13.07555, 10.0)]
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:

  • RUS expressing the Russian view on Crimea
  • SRB expressing the Serbian view on Kosovo, Vukovar and Sarengrad Islands
  • MAR expressing the Moroccan view on Western Sahara
  • SUR Suriname view on Courantyne Headwaters and Lawa Headwaters
  • KEN Kenya view on Ilemi Triangle
  • TZA Tanzania view on Lake Malawi
  • URY Uruguay view on Rincon de Artigas
  • EGY Egypt view on Bir Tawil
  • SDN Sudan view on Halaib Triangle
  • SYR Syria view on Golan Heights
  • ARG Argentina view on Southern Patagonian Ice Field and Tierra Del Fuego, including Falkland Islands, South Georgia and South Sandwich Islands
  • IND Indian View on Gilgit-Baltistan
  • PAK Pakistan View on Jammu and Kashmir and Junagadh Area

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

Content type
application/json
{
  • "items": [
    ]
}

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: {latitude},{longitude}

Type: {decimal},{decimal}

Example: -13.163068,-72.545128 (Machu Picchu Mountain, Peru)

The following constraints apply:

  • Either "at" or "in=circle" is required.

  • Parameters "at" and "in=circle" are mutually exclusive. Only one of them is allowed.

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

  • a circular area, provided as latitude, longitude, and radius (in meters)

    Format: circle:{latitude},{longitude};r={radius}

    Type: circle:{decimal},{decimal};r={integer}

    Example: circle:52.53,13.38;r=10000

The following constraints apply:

  • Either "at" or "in=circle" is required.
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:

  • RUS expressing the Russian view on Crimea
  • SRB expressing the Serbian view on Kosovo, Vukovar and Sarengrad Islands
  • MAR expressing the Moroccan view on Western Sahara
  • SUR Suriname view on Courantyne Headwaters and Lawa Headwaters
  • KEN Kenya view on Ilemi Triangle
  • TZA Tanzania view on Lake Malawi
  • URY Uruguay view on Rincon de Artigas
  • EGY Egypt view on Bir Tawil
  • SDN Sudan view on Halaib Triangle
  • SYR Syria view on Golan Heights
  • ARG Argentina view on Southern Patagonian Ice Field and Tierra Del Fuego, including Falkland Islands, South Georgia and South Sandwich Islands
  • IND Indian View on Gilgit-Baltistan
  • PAK Pakistan View on Jammu and Kashmir and Junagadh Area

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

Content type
application/json
{
  • "items": [
    ]
}

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:

  • RUS expressing the Russian view on Crimea
  • SRB expressing the Serbian view on Kosovo, Vukovar and Sarengrad Islands
  • MAR expressing the Moroccan view on Western Sahara
  • SUR Suriname view on Courantyne Headwaters and Lawa Headwaters
  • KEN Kenya view on Ilemi Triangle
  • TZA Tanzania view on Lake Malawi
  • URY Uruguay view on Rincon de Artigas
  • EGY Egypt view on Bir Tawil
  • SDN Sudan view on Halaib Triangle
  • SYR Syria view on Golan Heights
  • ARG Argentina view on Southern Patagonian Ice Field and Tierra Del Fuego, including Falkland Islands, South Georgia and South Sandwich Islands
  • IND Indian View on Gilgit-Baltistan
  • PAK Pakistan View on Jammu and Kashmir and Junagadh Area

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

Content type
application/json
{
  • "title": "string",
  • "id": "string",
  • "politicalView": "string",
  • "resultType": "administrativeArea",
  • "houseNumberType": "PA",
  • "addressBlockType": "block",
  • "localityType": "postalCode",
  • "administrativeAreaType": "county",
  • "houseNumberFallback": true,
  • "address": {
    },
  • "position": {
    },
  • "access": [
    ],
  • "mapView": {
    },
  • "categories": [
    ],
  • "chains": [
    ],
  • "references": [
    ],
  • "foodTypes": [
    ],
  • "contacts": [
    ],
  • "openingHours": [
    ],
  • "timeZone": {
    },
  • "extended": {
    },
  • "phonemes": {
    },
  • "streetInfo": [
    ],
  • "countryInfo": {
    }
}

tiles

Operations to manage tiles

Style JSON of the map

Style JSON describing the map cartography. Can be used with various libraries to display a vector map (e.g. Mapbox GL JS, OpenLayers, ...).

path Parameters
mapId
required
string
Example: streets

Identifier of the map.

Responses

Response samples

Content type
application/json
{ }

TileJSON

TileJSON describing the metadata of the tiles as well as link to the XYZ tiles. Can be used with various libraries to display the tiles (e.g. Leaflet, OpenLayers, ...).

path Parameters
tilesId
required
string
Example: satellite

Identifier of the tiles. See MapTiler Cloud Tiles.

Responses

Response samples

Content type
application/json
{ }