Обзор Static API
Static API формирует изображение карты в соответствии со значениями параметров, передаваемых сервису в URL следующего формата:
https://static-maps.yandex.ru/1.x/?{параметры URL}
Строка {параметры URL}
представляет собой последовательность пар вида {имя параметра}={значение параметра}
, разделенных символом амперсанда (&
).
Ниже приведен пример запроса изображения карты центра Москвы с двумя пронумерованными метками:
https://static-maps.yandex.ru/1.x/?ll=37.620070,55.753630&size=450,450&z=13&l=map&pt=37.620070,55.753630,pmwtm1~37.64,55.76363,pmwtm99
Ниже приводится полный список параметров URL.
Параметр | Тип данных и пример | Описание |
---|---|---|
Обязательные параметры | ||
l |
| Перечень слоев, определяющих тип карты: map (схема), sat (спутник) и sat,skl (гибрид). Подробнее см. Слои и типы карты. |
ll |
| Долгота и широта центра карты в градусах, см. Центр карты. |
key |
| API-ключ для коммерческой версии Static API. Необходимо указывать при использовании коммерческой версии. |
Необязательные параметры | ||
spn |
| Протяженность области показа карты по долготе и широте (в градусах), см. Область показа. |
z |
| Уровень масштабирования карты (0-17), см. Уровень масштабирования карты. |
size |
| Ширина и высота запрашиваемого изображения карты (в пикселах), см. Размер карты. По умолчанию принимает значение 450x450. |
scale |
| Коэффициент увеличения объектов на карте. Может принимать дробное значение от 1.0 до 4.0. Подробнее см. в разделе Увеличение объектов на карте. |
pt |
| Содержит описание одной или нескольких меток, которые требуется отобразить на карте. Описание каждой метки содержит ее координаты (долготу и широту), а также сведения о ее внешнем виде (включая стиль, цвет, размер и текст метки). Описания меток перечисляются через тильду (~). Подробнее см. Метки. |
pl |
| Содержит набор описаний геометрических фигур (ломаных и многоугольников), которые требуется отобразить на карте. Описание фигуры содержит координаты ее вершин, в формате "Долгота1,Широта2, ... ,ДолготаN,ШиротаN" или Подробнее см. Линии и многоугольники |
lang | string (language_region)
| API позволяет отображать карты, локализованные на различных языках с учетом специфики отдельных стран. Например, можно показать карту с надписями на английском языке и обозначить на ней расстояния в милях (инструмент Линейка).
На данный момент поддерживаются следующие локали:
Примечание. В ранних версиях API локаль указывалась через дефис. Например, ru-RU . Данное обозначение поддерживается в целях сохранения обратной совместимости, но не рекомендуется к использованию. |
Параметр | Тип данных и пример | Описание |
---|---|---|
Обязательные параметры | ||
l |
| Перечень слоев, определяющих тип карты: map (схема), sat (спутник) и sat,skl (гибрид). Подробнее см. Слои и типы карты. |
ll |
| Долгота и широта центра карты в градусах, см. Центр карты. |
key |
| API-ключ для коммерческой версии Static API. Необходимо указывать при использовании коммерческой версии. |
Необязательные параметры | ||
spn |
| Протяженность области показа карты по долготе и широте (в градусах), см. Область показа. |
z |
| Уровень масштабирования карты (0-17), см. Уровень масштабирования карты. |
size |
| Ширина и высота запрашиваемого изображения карты (в пикселах), см. Размер карты. По умолчанию принимает значение 450x450. |
scale |
| Коэффициент увеличения объектов на карте. Может принимать дробное значение от 1.0 до 4.0. Подробнее см. в разделе Увеличение объектов на карте. |
pt |
| Содержит описание одной или нескольких меток, которые требуется отобразить на карте. Описание каждой метки содержит ее координаты (долготу и широту), а также сведения о ее внешнем виде (включая стиль, цвет, размер и текст метки). Описания меток перечисляются через тильду (~). Подробнее см. Метки. |
pl |
| Содержит набор описаний геометрических фигур (ломаных и многоугольников), которые требуется отобразить на карте. Описание фигуры содержит координаты ее вершин, в формате "Долгота1,Широта2, ... ,ДолготаN,ШиротаN" или Подробнее см. Линии и многоугольники |
lang | string (language_region)
| API позволяет отображать карты, локализованные на различных языках с учетом специфики отдельных стран. Например, можно показать карту с надписями на английском языке и обозначить на ней расстояния в милях (инструмент Линейка).
На данный момент поддерживаются следующие локали:
Примечание. В ранних версиях API локаль указывалась через дефис. Например, ru-RU . Данное обозначение поддерживается в целях сохранения обратной совместимости, но не рекомендуется к использованию. |
Коммерческая версия
Для Static API доступна коммерческая версия. Эту версию следует использовать если ваш проект нарушает хотя бы одно из условий использования.
Для коммерческой версии API используйте URL следующего формата:
https://enterprise.static-maps.yandex.ru/1.x/?key=ваш API-ключ&{параметры URL}
Коммерческую версию Static API можно приобрести в Кабинете разработчика.