If you're interested in the English version of this spec, let us know on the GitHub.

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 сокета соединения.

Authorizations

ApiKey

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

Type

API Key (header: Authorization)

Parameters

Header Parameters

X-Forwarded-For

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

Type

string

Query Parameters

ip

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

Type

string

language

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

Type

string

Valid values

"ru""en"

Default

"ru"

division

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

Type

string

Valid values

"ADMINISTRATIVE""MUNICIPAL"

Default

"ADMINISTRATIVE"

Responses

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

Content-Type

application/json

object

object |null

Required

Any of

object

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

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

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

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

object

Required

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

object

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

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

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

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

object

Required

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