Overview of the Static API

The Static API generates a map image based on the parameter values passed to the service in a URL with the following format:

https://static-maps.yandex.ru/1.x/?{URL parameters}

The substring {URL parameters} contains a sequence of pairs in the format {parameter name}={parameter value}, separated by the ampersand symbol (&).

The following example is a request for a map image of the center of Ankara with two numbered markers:


https://static-maps.yandex.ru/1.x/?lang=en_US&ll=32.810152,39.889847&size=450,450&z=10&l=map&pt=32.810152,39.889847,pm2rdl1~32.870152,39.869847,pm2rdl99

The complete list of URL parameters is shown below.

Parameter Data type and example Description
Required parameters
lang string (language_region)
lang=en_US

The API lets you display maps that are localized in various languages with allowances for the differences in specific countries. For example, you can display a map with labels in English and mark distances in miles on it (using the Ruler tool).

lang=language_region
  • language — Two-letter language code. Specified in ISO 639-1 format. Sets the language for objects on the map (toponyms and controls).
  • region — Two-letter country code. Specified in ISO 3166-1 format. Determines regional settings such as measurement units (for indicating distances between objects or driving speeds on a route).
    Note. For the regions RU, UA and TR, distance is shown in kilometers; for US, it is shown in miles.
The following locales are currently supported:
  • lang=tr-TR
  • lang=en-US (distance in miles)
  • lang=en_RU
  • lang=ru-RU
  • lang=ru_UA
  • lang=uk_UA
Note. In early versions of the API, the locale was specified after a dash. For example, en-US. This notation is supported for backward compatibility, but is not recommended.
l

string,[string]...

l=map
List of layers that define the type of map: map (roadmap), sat (satellite) and sat,skl (hybrid). For more information, see Map layers and types.
Optional parameters
ll

float,float

ll=32.810152,39.889847

Longitude and latitude of the map center in degrees; see Map center.

spn

float

spn=0.01,0.01

Range of the map's viewport by longitude and latitude (in degrees); see Viewport.

z

integer

z=10

Zoom level of the map (0-17); see Map zoom level.

size

integer,integer

size=450,450

Height and width of the requested map image (in pixels); see Map size. By default, it takes the value 450x450.

scale

float (from 1.0 to 4.0)

scale=2.0

Coefficient for scaling map objects. Takes a fractional value from 1.0 to 4.0. For more information, see Scaling map objects.

pt

string (MarkerDefinition1~MarkerDefinition2~...)

pt=32.810152,39.889847,pm2rdl1~32.870152,39.869847,pm2rdl99

Contains definitions of one or more markers to be displayed on the map.

Each marker definition contains its coordinates (longitude and latitude) along with information on its appearance (including style, color, size and the marker text). Marker definitions are separated by a tilda (~).

For more information, see Placemarks.

pl

string (FigureDefinition1~FigureDefinition2~...)

pl=c:ec473fFF,f:00FF00A0,w:5,37.51,55.83,37.67,55.82,37.66,55.74,37.49,55.70,37.51,55.83

Contains definitions of geometric figures (polylines and polygons) to display on the map.

The figure definition contains coordinates for its points (either a comma-separated list, or encoded), along with information on line color and thickness, and the fill color (for polygons). Figure definitions are separated by a tilda (~).

For more information, see Lines and polygons