Поисковый запрос к Народной карте представляет собой обращение по HTTP-протоколу к URL http://psearch-maps.yandex.ru/1.x/. Обязательными параметрами запроса являются:
Например, для того, чтобы найти на Народной карте самый известный памятник Петру I в Санкт-Петербурге, можно выполнить следующий запрос:
http://psearch-maps.yandex.ru/1.x/?text=Медный всадник&key=API-ключ
Ответ будет содержать координаты размещённых на Народной карте объектов, соответствующих запросу (если таковые нашлись) и дополнительную информацию о найденных объектах.
В таблице приведен полный список параметров HTTP-запроса.
| Параметр |
Значение |
Пример |
|
Обязательные параметры
|
|
text
|
Текст поискового запроса. Например, название объекта.
|
text=остров Балчуг
|
|
key
|
Ключ API Яндекс.Карт. |
key=API-ключ
|
|
Необязательные параметры
|
|
format
|
Формат ответа геокодера:
- xml — результат возвращается в виде YMapsML-документа;
- json — результат возвращается в формате JSON.
Значение по умолчанию: xml.
|
format=json
|
|
callback
|
Имя JavaScript-функции, в которую передается ответ геокодера (в соответствии с соглашениями JSONP).
Параметр учитывается только в том случае, если ответ возвращается в формате JSON.
|
callback=my_response_handler
|
| ll,spn |
Область, в районе которой предположительно находятся искомые объекты.
Параметр ll{longitude,latitude} задаёт долготу и широту центра области (в градусах), а spn {span} - её протяженность (в градусах).
Протяженность области задается двумя числами, первое из которых есть разница между максимальной и минимальной долготой, а второе - между максимальной и минимальной широтой данной области.
|
ll=37.618920,55.756994&spn=0.552069,0.400552
|
|
rspn
|
Позволяет ограничить поиск объектов областью, заданной с помощью параметров ll и spn. Возможные значения:
- 0 - не ограничивать поиск (по умолчанию),
- 1 - ограничить.
|
rspn=1
|
|
results
|
Максимальное количество выводимых результатов.
Значение по умолчанию: 10.
|
results=5
|
|
skip
|
Количество результатов (начиная с первого), которое необходимо пропустить. |
skip=10
|
