Skip to content

iplocate

Сервис определяет город по IP-адресу (в России). Использует IP-адрес клиента, значение из параметра ip или заголовок X-Forwarded-For.

  • Поддерживает как IPv4, так и IPv6 адреса.
  • Возвращает детальную информацию о городе, в том числе почтовый индекс.

Алгоритм выбора IP-адреса из параметров запроса:

ЕСЛИ IP указан в параметре ip
ТО использовать его
ИНАЧЕ
  ЕСЛИ IP указан в HTTP-заголовке X-Forwarded-For
  ТО использовать его
  ИНАЧЕ вернуть IP сокета соединения

Местоположение определяется только для российских адресов.


Город по IP-адресу (GET)

GET
/iplocate/address

Определяет город по IP-адресу, указанному в URL параметре, или в заголовке X-Forwarded-For, или по IP сокета соединения.

Авторизация

ApiKey

API-ключ. Полный вид заголовка: Authorization: Token <YOUR_KEY>. Получить ключ

Тип
API Key (header: Authorization)

Параметры

Параметры заголовков

X-Forwarded-For

IP-адрес клиента (используется если ip не указан в параметрах)

Тип
string

Параметры запроса

ip

IP-адрес для определения города (IPv4 или IPv6)

Тип
string
language

Язык результата

Тип
string
Возможные значения
"ru""en"
По умолчанию
"ru"
division

Административное либо муниципальное деление

Тип
string
Возможные значения
"ADMINISTRATIVE""MUNICIPAL"
По умолчанию
"ADMINISTRATIVE"

Ответы API

Запрос успешно обработан

application/json
object
object |null
Обязательный
Любой из:
object

Объект подсказки в административном делении (параметр division=ADMINISTRATIVE)

Адрес одной строкой (как показывается в списке подсказок),
сокращённый по правилам, описанным здесь:
https://confluence.hflabs.ru/pages/viewpage.action?pageId=1105068073

  • (может меняться в зависимости от текущих параметров запроса)

Адрес одной строкой (полный, с индексом)

object
Обязательный

Подробные поля адреса

object

Объект подсказки в муниципальном делении (параметр division=MUNICIPAL)

Адрес одной строкой (как показывается в списке подсказок),
сокращённый по правилам, описанным здесь:
https://confluence.hflabs.ru/pages/viewpage.action?pageId=1105068073

  • (может меняться в зависимости от текущих параметров запроса)

Адрес одной строкой (полный, с индексом)

object
Обязательный

Подробные поля адреса

Песочница

Сервер
Авторизация
Заголовки
Переменные
Ключ
Значение

Примеры кода


Город по IP-адресу (POST)

POST
/iplocate/address

Определяет город по IP-адресу, указанному в теле запроса, или в заголовке X-Forwarded-For, или по IP сокета соединения.

Авторизация

ApiKey

API-ключ. Полный вид заголовка: Authorization: Token <YOUR_KEY>. Получить ключ

Тип
API Key (header: Authorization)

Формат запроса

application/json
object

https://dadata.ru/api/iplocate/

IP-адрес для определения города.

Если не указан, будет использован IP из заголовка X-Forwarded-For.
Если и там пусто, будет использован IP сокета соединения.

@example '46.226.227.20'

На каком языке вернуть результат
@default 'ru'

Возможные значения"RU""EN"
По умолчанию"ru"

Административное либо муниципальное деление
См. https://confluence.hflabs.ru/pages/viewpage.action?pageId=1326056589
@default 'ADMINISTRATIVE'

Возможные значения"ADMINISTRATIVE""MUNICIPAL"
По умолчанию"ADMINISTRATIVE"

Ответы API

Запрос успешно обработан

application/json
object
object |null
Обязательный
Любой из:
object

Объект подсказки в административном делении (параметр division=ADMINISTRATIVE)

Адрес одной строкой (как показывается в списке подсказок),
сокращённый по правилам, описанным здесь:
https://confluence.hflabs.ru/pages/viewpage.action?pageId=1105068073

  • (может меняться в зависимости от текущих параметров запроса)

Адрес одной строкой (полный, с индексом)

object
Обязательный

Подробные поля адреса

object

Объект подсказки в муниципальном делении (параметр division=MUNICIPAL)

Адрес одной строкой (как показывается в списке подсказок),
сокращённый по правилам, описанным здесь:
https://confluence.hflabs.ru/pages/viewpage.action?pageId=1105068073

  • (может меняться в зависимости от текущих параметров запроса)

Адрес одной строкой (полный, с индексом)

object
Обязательный

Подробные поля адреса

Песочница

Сервер
Авторизация
Тело запроса

Примеры кода


Создано с помощью VitePress OpenAPI