GuidesAPI Reference
API Reference

Retrieve an icon in the requested format

Retrieve customizable icons based on style, country, state, and road class

Path Params
string
required

Specifies the icon type. The /info endpoint response lists the available values. For more information, see Resource types.

string
required

The format of the returned image. The /info endpoint response lists the available values. For more information, see Optimize image dimensions and file type.

Query Params
string
required
length between 1 and 13

Specifies the label for road shields. (string, UTF-8)

string
required

Specifies the country in ISO 3166-1 Alpha-3.

string

If present, selects the style to use to render the image. The /info endpoint response lists the available values. For more information, see Define the map styles. When you do not provide this parameter in a query, the default style is "explore.day".

string

Specifies the state code in ISO 3166-2.

integer

Specifies the image width (if only width is given then the height is determined based on aspect ratio).

integer

Specifies the image height (if only height is given then the width is determined based on aspect ratio).

integer
1 to 6
Defaults to 1

Specifies the route by its priority. The values are from 1 to 6: 1 - international or european road 2 - national 3 - primary road 4 - secondary 5 - minor road 6 - avenue

Headers
string

Specifies an optional entity tag of the resource cached in the client. See the 304 response of the getTile operation for more details.

string

The ID given by the caller to match in the response.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
image/png
image/svg
*/*
application/json