Skip to content
Мои токены Поддержка
Чат для вопросов по API Мгновенно ответим на ваши вопросы
api@ati.su Электронная почта техподдержки
Тикетная система Оставить заявку на отдел "Консультанты по интеграции (API)"
api.ati.su - заказы, торги, площадки Наш телеграм-канал
Для подтверждения действия введите пароль
Чтобы продолжить, введите пароль для пользователя
Отменить

Словари географических объектов

Каждому населённому пункту, району, региону и стране присвоен свой уникальный идентификатор в базе данных ATI.SU.

Для получения геообъектов рекомендуем пользоваться этими идентификаторами. Получить объекты можно по кодам ФИАС, КЛАДР и координатам.

Если у вас нет кода населённого пункта, региона, страны или координат объекта, можете использовать автокомплит, получить код ATI.SU объекта и дальше пользоваться им.

База данных расширяется, но если вы не нашли необходимый населённый пункт, обратитесь в чат поддержки по API.

Некоторые геообъекты мы внесли в справочник для совместимости с прежними версиями геосервиса. Такие объекты помечены атрибутом “is_legacy”: true. Настоятельно не рекомендуем использовать эти объекты, т.к. со временем мы их удалим.

Методы получения населённых пунктов

Не у всех населённых пунктов есть перевод на русский и английский языки — название может вернуться на национальном языке, например, армянском или казахском.

Авторизация
Получение населённых пунктов по списку идентификаторов (кодов ATI.SU)
post /gw/gis-dict/v1/cities/by-ids
Запрос
Модель
{...}
ids*: [int32]

Список идентификаторов населённых пунктов (кодов ATI.SU)

Допустимое количество элементов от 1 до 1000

}
Пример запроса 
curl 'https://api.ati.su/gw/gis-dict/v1/cities/by-ids' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ids":[0]}'
Ответ
200 OK
Модель
{...}
}
Пример
{...}
"cities":[...]
{...}
"country_id":0,
"federal_district_id":0,
"region_id":0,
"district_ids":[...],
0
],
"name":"string",
"alt_name":"string",
"old_name":"string",
"subdistrict":"string",
"short_subdistrict":"string",
"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"kladr":"string",
"okato":"string",
"oktmo":"string",
"is_regional_center":false,
"is_district_center":false,
"size":0,
"geo_point":{...},
"lat":0.5,
"lon":0.5
},
"city_type_id":0,
"timezone":"string",
"clarified_name":"string",
"legacy_attributes":0,
"is_legacy":false
}
]
}
400 Bad Request
Модель
{...}
error: string

Текстовый код ошибки

reason: string

Человекочитаемое описание ошибки

}
Пример
{...}
"error":"string",
"reason":"string",
"details":{...}
"any-key":null
}
}

Пример ids [1,3611].

Авторизация
Получение населённого пункта по координате
post /gw/gis-dict/v1/cities/by-coordinate
Запрос
Модель
{...}
}
Пример запроса 
curl 'https://api.ati.su/gw/gis-dict/v1/cities/by-coordinate' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"location":{"lat":59.93904,"lon":30.31581}}'
Ответ
200 OK
Модель
{...}

Модель, описывающая сущность "Населённый пункт"

city_id*: int32

Идентификатор населённого пункта

read only
country_id*: int32

Идентификатор страны

federal_district_id: int32 (nullable)

Идентификатор федерального округа

Значение по умолчанию: null

region_id: int32 (nullable)

Идентификатор региона

Значение по умолчанию: null

district_ids: [int32]

Идентификаторы районов

Значение по умолчанию: null

name*: string

Название населённого пункта

alt_name: string (nullable)

Альтернативное название населённого пункта

Значение по умолчанию: null

old_name: string (nullable)

Старое название населённого пункта

Значение по умолчанию: null

subdistrict: string (nullable)

Часть района

Значение по умолчанию: null

short_subdistrict: string (nullable)

Часть района с сокращениями типа

Значение по умолчанию: null

fias_id: uuid (nullable)

Идентификатор ФИАС

Значение по умолчанию: null

kladr: string (nullable)

Идентификатор КЛАДР

Значение по умолчанию: null

okato: string (nullable)

Код ОКАТО

Значение по умолчанию: null

oktmo: string (nullable)

Код ОКТМО

Значение по умолчанию: null

is_regional_center: boolean

Является ли населённый пункт региональным центром

Значение по умолчанию: false

is_district_center: boolean

Является ли населённый пункт районным центром

Значение по умолчанию: false

size*: enum
[1, 2, 3, 4, 5, 6]

Размер населённого пункта.

Members:

  • 1 - Население менее 10 000 человек
  • 2 - Население от 10 000 до 50 000 человек
  • 3 - Население от 50 000 до 100 000 человек
  • 4 - Население от 100 000 до 500 000 человек
  • 5 - Население от 500 000 до 1 000 000 человек
  • 6 - Население свыше 1 000 000 человек

Members:

    city_type_id: int32 (nullable)

    Идентификатор типа населённого пункта

    Значение по умолчанию: null

    timezone: string (nullable)

    Часовой пояс в формате IANA.

    Значение по умолчанию: null

    clarified_name*: string

    Название населённого пункта с уточнением типа и района при необходимости Если в регионе несколько населённых пунктов с одинаковым названием, то для них добавляется уточнение

    legacy_attributes: int32 (nullable)

    Атрибуты устаревшей записи населённого пункта

    Возвращаются только для населенных пунктов, помеченных как is_legacy=true. Значение по умолчанию: null

    is_legacy: boolean

    Флаг, обозначающий, что объект является устаревшим

    Значение по умолчанию: false

    }
    Пример
    {...}
    "country_id":0,
    "federal_district_id":0,
    "region_id":0,
    "district_ids":[...],
    0
    ],
    "name":"string",
    "alt_name":"string",
    "old_name":"string",
    "subdistrict":"string",
    "short_subdistrict":"string",
    "fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "kladr":"string",
    "okato":"string",
    "oktmo":"string",
    "is_regional_center":false,
    "is_district_center":false,
    "size":0,
    "geo_point":{...},
    "lat":0.5,
    "lon":0.5
    },
    "city_type_id":0,
    "timezone":"string",
    "clarified_name":"string",
    "legacy_attributes":0,
    "is_legacy":false
    }
    404 Not Found
    Модель
    {...}
    error: string

    Текстовый код ошибки

    reason: string

    Человекочитаемое описание ошибки

    }
    Пример
    {...}
    "error":"string",
    "reason":"string",
    "details":{...}
    "any-key":null
    }
    }
    Авторизация
    Получение населённых пунктов по списку идентификаторов ФИАС
    post /gw/gis-dict/v1/cities/by-fias-ids
    Запрос
    Модель
    {...}
    fias_ids*: [uuid]

    Список идентификаторов ФИАС населённых пунктов

    Допустимое количество элементов от 1 до 1000

    }
    Пример запроса 
    curl 'https://api.ati.su/gw/gis-dict/v1/cities/by-fias-ids' \
      -X 'POST' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json' \
      --data-raw '{"fias_ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"]}'
    Ответ
    200 OK
    Модель
    {...}
    }
    Пример
    {...}
    "cities":[...]
    {...}
    "country_id":0,
    "federal_district_id":0,
    "region_id":0,
    "district_ids":[...],
    0
    ],
    "name":"string",
    "alt_name":"string",
    "old_name":"string",
    "subdistrict":"string",
    "short_subdistrict":"string",
    "fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "kladr":"string",
    "okato":"string",
    "oktmo":"string",
    "is_regional_center":false,
    "is_district_center":false,
    "size":0,
    "geo_point":{...},
    "lat":0.5,
    "lon":0.5
    },
    "city_type_id":0,
    "timezone":"string",
    "clarified_name":"string",
    "legacy_attributes":0,
    "is_legacy":false
    }
    ]
    }
    400 Bad Request
    Модель
    {...}
    error: string

    Текстовый код ошибки

    reason: string

    Человекочитаемое описание ошибки

    }
    Пример
    {...}
    "error":"string",
    "reason":"string",
    "details":{...}
    "any-key":null
    }
    }

    Пример fias_ids ["c2deb16a-0330-4f05-821f-1d09c93331e6", "0c5b2444-70a0-4932-980c-b4dc0d3f02b5"].

    Авторизация
    Получение населённых пунктов по списку идентификаторов КЛАДР
    post /gw/gis-dict/v1/cities/by-kladr-codes
    Запрос
    Модель
    {...}
    kladr_codes*: [string]

    Список идентификаторов КЛАДР населённых пунктов

    Допустимое количество элементов от 1 до 1000

    }
    Пример запроса 
    curl 'https://api.ati.su/gw/gis-dict/v1/cities/by-kladr-codes' \
      -X 'POST' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json' \
      --data-raw '{"kladr_codes":["string"]}'
    Ответ
    200 OK
    Модель
    {...}
    }
    Пример
    {...}
    "cities":[...]
    {...}
    "country_id":0,
    "federal_district_id":0,
    "region_id":0,
    "district_ids":[...],
    0
    ],
    "name":"string",
    "alt_name":"string",
    "old_name":"string",
    "subdistrict":"string",
    "short_subdistrict":"string",
    "fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "kladr":"string",
    "okato":"string",
    "oktmo":"string",
    "is_regional_center":false,
    "is_district_center":false,
    "size":0,
    "geo_point":{...},
    "lat":0.5,
    "lon":0.5
    },
    "city_type_id":0,
    "timezone":"string",
    "clarified_name":"string",
    "legacy_attributes":0,
    "is_legacy":false
    }
    ]
    }
    400 Bad Request
    Модель
    {...}
    error: string

    Текстовый код ошибки

    reason: string

    Человекочитаемое описание ошибки

    }
    Пример
    {...}
    "error":"string",
    "reason":"string",
    "details":{...}
    "any-key":null
    }
    }

    Пример kladr_codes ["7800000000000", "7700000000000"].

    Авторизация
    Получение всех типов населённых пунктов
    get /gw/gis-dict/v1/city-types
    Запрос
    Пример запроса 
    curl 'https://api.ati.su/gw/gis-dict/v1/city-types' \
      -X 'GET' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json'
    Ответ
    200 OK
    Модель
    {...}
    }
    Пример
    {...}
    "city_types":[...]
    {...}
    "city_type_id":0,
    "name":"string",
    "short_name":"string"
    }
    ]
    }
    304 Not Modified
    Модель
    null
    Пример
    null

    Метод получения районов

    Авторизация
    Получение районов по списку идентификаторов (кодов ATI.SU)
    post /gw/gis-dict/v1/districts/by-ids
    Запрос
    Модель
    {...}
    ids*: [int32]

    Список идентификаторов районов (кодов ATI.SU)

    Допустимое количество элементов от 1 до 1000

    }
    Пример запроса 
    curl 'https://api.ati.su/gw/gis-dict/v1/districts/by-ids' \
      -X 'POST' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json' \
      --data-raw '{"ids":[0]}'
    Ответ
    200 OK
    Модель
    {...}
    }
    Пример
    {...}
    "districts":[...]
    {...}
    "district_id":0,
    "country_id":0,
    "federal_district_id":0,
    "name":"string",
    "short_name":"string",
    "region_id":0
    }
    ]
    }
    400 Bad Request
    Модель
    {...}
    error: string

    Текстовый код ошибки

    reason: string

    Человекочитаемое описание ошибки

    }
    Пример
    {...}
    "error":"string",
    "reason":"string",
    "details":{...}
    "any-key":null
    }
    }

    Пример ids [8456, 8464 , 6857].

    Метод получения федеральных округов

    Авторизация
    Получение всех федеральных округов
    get /gw/gis-dict/v1/federal-districts
    Запрос
    Пример запроса 
    curl 'https://api.ati.su/gw/gis-dict/v1/federal-districts' \
      -X 'GET' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json'
    Ответ
    200 OK
    Модель
    {...}
    }
    Пример
    {...}
    "federal_districts":[...]
    {...}
    "federal_district_id":0,
    "country_id":0,
    "name":"string",
    "is_legacy":false
    }
    ]
    }
    304 Not Modified
    Модель
    null
    Пример
    null

    Методы получения регионов

    Авторизация
    Получение регионов по списку идентификаторов (кодов ATI.SU)
    post /gw/gis-dict/v1/regions/by-ids
    Запрос
    Модель
    {...}
    ids*: [int32]

    Список идентификаторов регионов (кодов ATI.SU)

    }
    Пример запроса 
    curl 'https://api.ati.su/gw/gis-dict/v1/regions/by-ids' \
      -X 'POST' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json' \
      --data-raw '{"ids":[0]}'
    Ответ
    200 OK
    Модель
    {...}
    }
    Пример
    {...}
    "regions":[...]
    {...}
    "region_id":0,
    "name":"string",
    "country_id":0,
    "federal_district_id":0,
    "fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tax_region_code":"string",
    "clarified_name":"string",
    "regional_center_id":0,
    "is_legacy":false
    }
    ]
    }
    400 Bad Request
    Модель
    {...}
    error: string

    Текстовый код ошибки

    reason: string

    Человекочитаемое описание ошибки

    }
    Пример
    {...}
    "error":"string",
    "reason":"string",
    "details":{...}
    "any-key":null
    }
    }

    Пример ids [1, 680, 681].

    Авторизация
    Получение региона по координате
    post /gw/gis-dict/v1/regions/by-coordinate
    Запрос
    Модель
    {...}
    }
    Пример запроса 
    curl 'https://api.ati.su/gw/gis-dict/v1/regions/by-coordinate' \
      -X 'POST' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json' \
      --data-raw '{"location":{"lat":59.93904,"lon":30.31581}}'
    Ответ
    200 OK
    Модель
    {...}

    Модель, описывающая сущность "Регион"

    region_id*: int32

    Идентификатор региона

    name*: string

    Название региона

    country_id*: int32

    Идентификатор страны

    federal_district_id: int32 (nullable)

    Идентификатор федерального округа

    Значение по умолчанию: null

    fias_id: uuid (nullable)

    Идентификатор ФИАС

    Значение по умолчанию: null

    tax_region_code: string (nullable)

    Код региона для ФНС.

    Значение по умолчанию: null

    clarified_name*: string

    Название региона с уточнением, что это регион при необходимости. Если название региона совпадает с каким-нибудь городом, то для него добавляется уточнение.

    regional_center_id: int32 (nullable)

    Идентификатор регионального центра

    Значение по умолчанию: null

    is_legacy: boolean

    Флаг, обозначающий, что объект является устаревшим.

    Значение по умолчанию: false

    }
    Пример
    {...}
    "region_id":0,
    "name":"string",
    "country_id":0,
    "federal_district_id":0,
    "fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tax_region_code":"string",
    "clarified_name":"string",
    "regional_center_id":0,
    "is_legacy":false
    }
    404 Not Found
    Модель
    {...}
    error: string

    Текстовый код ошибки

    reason: string

    Человекочитаемое описание ошибки

    }
    Пример
    {...}
    "error":"string",
    "reason":"string",
    "details":{...}
    "any-key":null
    }
    }
    Авторизация
    Получение регионов по списку идентификаторов ФИАС
    post /gw/gis-dict/v1/regions/by-fias-ids
    Запрос
    Модель
    {...}
    fias_ids*: [uuid]

    Список идентификаторов ФИАС регионов

    Допустимое количество элементов от 1 до 1000

    }
    Пример запроса 
    curl 'https://api.ati.su/gw/gis-dict/v1/regions/by-fias-ids' \
      -X 'POST' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json' \
      --data-raw '{"fias_ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"]}'
    Ответ
    200 OK
    Модель
    {...}
    }
    Пример
    {...}
    "regions":[...]
    {...}
    "region_id":0,
    "name":"string",
    "country_id":0,
    "federal_district_id":0,
    "fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tax_region_code":"string",
    "clarified_name":"string",
    "regional_center_id":0,
    "is_legacy":false
    }
    ]
    }

    Пример fias_ids ["6d1ebb35-70c6-4129-bd55-da3969658f5d", "29251dcf-00a1-4e34-98d4-5c47484a36d4"].

    Методы получения стран

    Авторизация
    Получение стран по списку идентификаторов (кодов ATI.SU)
    post /gw/gis-dict/v1/countries/by-ids
    Запрос
    Модель
    {...}
    ids*: [int32]

    Список идентификаторов стран (кодов ATI.SU)

    Допустимое количество элементов от 1 до 1000

    }
    Пример запроса 
    curl 'https://api.ati.su/gw/gis-dict/v1/countries/by-ids' \
      -X 'POST' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json' \
      --data-raw '{"ids":[0]}'
    Ответ
    200 OK
    Модель
    {...}
    }
    Пример
    {...}
    "countries":[...]
    {...}
    "country_id":0,
    "name":"string",
    "iso_3166_alpha2":"string",
    "iso_3166_alpha3":"string",
    "iso_3166_numeric":0,
    "is_legacy":false
    }
    ]
    }
    400 Bad Request
    Модель
    {...}
    error: string

    Текстовый код ошибки

    reason: string

    Человекочитаемое описание ошибки

    }
    Пример
    {...}
    "error":"string",
    "reason":"string",
    "details":{...}
    "any-key":null
    }
    }

    Пример ids [1, 50].

    Авторизация
    Получение страны по координате
    post /gw/gis-dict/v1/countries/by-coordinate
    Запрос
    Модель
    {...}
    }
    Пример запроса 
    curl 'https://api.ati.su/gw/gis-dict/v1/countries/by-coordinate' \
      -X 'POST' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json' \
      --data-raw '{"location":{"lat":59.93904,"lon":30.31581}}'
    Ответ
    200 OK
    Модель
    {...}

    Модель, описывающая сущность "Страна"

    country_id*: int32

    Идентификатор страны

    name*: string

    Название страны

    iso_3166_alpha2*: string

    Двухбуквенный код страны по ISO-3166

    iso_3166_alpha3*: string

    Трехбуквенный код страны по ISO-3166

    iso_3166_numeric*: int32

    Числовой код страны по ISO-3166

    is_legacy: boolean

    Флаг, обозначающий, что объект является устаревшим.

    Значение по умолчанию: false

    }
    Пример
    {...}
    "country_id":0,
    "name":"string",
    "iso_3166_alpha2":"string",
    "iso_3166_alpha3":"string",
    "iso_3166_numeric":0,
    "is_legacy":false
    }
    404 Not Found
    Модель
    {...}
    error: string

    Текстовый код ошибки

    reason: string

    Человекочитаемое описание ошибки

    }
    Пример
    {...}
    "error":"string",
    "reason":"string",
    "details":{...}
    "any-key":null
    }
    }

    Методы получения направлений

    Авторизация
    Получение всех направлений
    get /gw/gis-dict/v1/directions
    Запрос
    Пример запроса 
    curl 'https://api.ati.su/gw/gis-dict/v1/directions' \
      -X 'GET' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json'
    Ответ
    200 OK
    Модель
    {...}
    }
    Пример
    {...}
    "directions":[...]
    {...}
    "id":0,
    "name":"string"
    }
    ]
    }
    304 Not Modified
    Модель
    null
    Пример
    null
    Авторизация
    Получение направления между городами
    get /gw/gis-dict/v1/direction/from/{from}/to/{to}
    Запрос
    Пример запроса 
    curl 'https://api.ati.su/gw/gis-dict/v1/direction/from/{from}/to/{to}' \
      -X 'GET' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json'
    Ответ
    200 OK
    Модель
    {...}

    Направление "Север", "Юг" и т.д.

    id*: int32

    Идентификатор направления. Может быть битовой маской

    name*: string

    Описание направления. Может быть перечислением направлений

    }
    Пример
    {...}
    "id":0,
    "name":"string"
    }

    Метод для работы с улицами

    Получение списка типов улиц
    get /v1.0/dictionaries/streetTypes
    Запрос
    Пример запроса 
    curl 'https://api.ati.su/v1.0/dictionaries/streetTypes' \
      -X 'GET' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json'
    Ответ
    200 Типы улиц
    Модель
    [{...}]
    Id: int64

    Id

    Id2: guid

    Guid

    Name: string

    Название

    ShortName: string

    Короткое название

    }]
    Пример
    [...]
    {...}
    "Id":0,
    "Id2":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Name":"string",
    "ShortName":"string"
    }
    ]

    Автокомплит

    Метод автокомплита предназначен для поиска населённых пунктов, регионов, стран или направлений по их названию. Если у вас уже есть идентификатор объекта (код ATI.SU, ФИАС, КЛАДР) или его координаты, рекомендуем использовать соответствующие методы, указанные выше.

    Если вы не нашли нужный населённый пункт, попробуйте добавить название района, региона или страны в поисковую строку. Например, вместо слова «Бор» написать «Бор Ленинградская», чтобы найти населённые пункты Бор Ленинградской области.

    Авторизация
    Автокомплит до населённого пункта
    post /gw/gis-dict/v1/autocomplete/suggestions
    Запрос
    Модель
    {...}
    prefix*: string
    От (0 до 200 символов)

    Поисковая строка

    suggestion_types: enum
    [1, 2, 4, 8]

    Тип элемента для автокомплита. В запросе может быть маской, в ответе не может быть маской.

    Значение по умолчанию: 1

    Members:

    • 1 - Населённый пункт
    • 2 - Регион
    • 4 - Страна
    • 8 - Направление

    limit: int32 (nullable)
    >=1 and <= 50

    Сколько элементов нужно вернуть пользователю

    Значение по умолчанию: 10

    country_id: int32 (nullable)

    Страна по умолчанию для сортировки объектов. Объекты из этой страны будут наверху списка.

    Если не передать или передать null, то для залогиненного пользователя настройка возьмется из кабинета. Значение по умолчанию: null

    }
    Пример запроса 
    curl 'https://api.ati.su/gw/gis-dict/v1/autocomplete/suggestions' \
      -X 'POST' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json' \
      --data-raw '{"prefix":"санкт","suggestion_types":15,"limit":15,"country_id":1}'
    Ответ
    200 OK
    Модель
    {...}
    }
    Пример
    {...}
    "suggestions":[...]
    {...}
    "type":0,
    "direction":{...},
    "id":0,
    "name":"string",
    "short_name":"string"
    },
    "country":{...},
    "id":0,
    "name":"string",
    "short_name":"string"
    },
    "region":{...},
    "id":0,
    "name":"string",
    "short_name":"string"
    },
    "districts":[...],
    {...}
    "id":0,
    "name":"string",
    "short_name":"string"
    }
    ],
    "subdistrict":{...},
    "name":"string",
    "short_name":"string"
    },
    "city":{...},
    "id":0,
    "name":"string",
    "short_name":"string",
    "city_type":{...},
    "city_type_id":0,
    "name":"string",
    "short_name":"string"
    },
    "old_name":"string",
    "alt_name":"string"
    },
    "address":"string",
    "geo_point":{...}
    "lat":0.5,
    "lon":0.5
    }
    }
    ]
    }
    400 Bad Request
    Модель
    {...}
    error: string

    Текстовый код ошибки

    reason: string

    Человекочитаемое описание ошибки

    }
    Пример
    {...}
    "error":"string",
    "reason":"string",
    "details":{...}
    "any-key":null
    }
    }

    Геокодирование

    Эти API методы позволяют преобразовывать координаты в адрес и наоборот, что значительно упрощает работу с адресами. Прямое геокодирование используется для определения координат по адресу или названию. Обратное геокодирование позволяет по координатам определить ближайший адрес.

    Доступ к сервису

    Доступ к API методам геокодирования платный, предоставляется по запросу.

    Чтобы узнать условия использования, свяжитесь с отделом продаж по телефону +7 812 602-01-06.

    Авторизация
    Получение координаты гео-объекта по адресной строке (платный)
    post /gw/gis-dict/v1/direct-geocoding
    Запрос
    Модель
    {...}

    Запрос на гео-кодирование по адресной строке

    address*: string
    От (0 до 1024 символов)

    Адресная строка.

    exact_in_bounding_box: boolean (nullable)

    Флаг, указывающий, что искать объекты нужно строго в области, обозначенной в параметре bounding_box. Для true вне области не ищем. Для false приоритет для объектов внутри области. Если true, то обязательно передавать bounding_box.

    Значение по умолчанию: false

    ! Зарезервирован на будущее, сейчас не используется.

    max_level*: int32
    >=1 and <= 5

    Максимальный уровень, до которого необходимо провести гео-кодирование.

    Возможные значения

    1 — страна

    2 — область/регион

    3 — населённый пункт

    4 — улица

    5 — дом

    count: int32
    >=1 and <= 10

    Ограничение количества элементов в выдаче.

    Диапазон значений от 1 до 10.

    Значение по умолчанию: 1

    }
    Пример запроса 
    curl 'https://api.ati.su/gw/gis-dict/v1/direct-geocoding' \
      -X 'POST' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json' \
      --data-raw '{"address":"Россия, Ленинградская область, Гатчинский муниципальный округ, Вырица, Вокзальная улица, д. 23","exact_in_bounding_box":false,"max_level":3,"bounding_box":{"sw":{"lat":59.93904,"lon":30.31581},"ne":{"lat":59.93904,"lon":30.31581}},"count":1}'
    Ответ
    200 OK
    Модель
    {...}

    Результат гео-кодирования

    max_count_exceeded: boolean

    Флаг, указывающий, что найдено больше результатов, чем просили в параметре count и требуется уточнение.

    Значение по умолчанию: false

    uncertainty_score: int32

    Минимальная степень неуверенности в точности распознавания среди всех результатов.

    uncertainty_reasons: [string]

    Ошибки распознавания, которые приводят к тому, что нельзя быть на 100% уверенными в результате

    }
    Пример
    {...}
    "max_count_exceeded":false,
    "uncertainty_score":0,
    "uncertainty_reasons":[...],
    "string"
    ],
    "suggestions":[...]
    {...}
    "uncertainty_score":0,
    "uncertainty_reasons":[...],
    "string"
    ],
    "level":0,
    "country":{...},
    "id":0,
    "name":"string",
    "short_name":"string"
    },
    "region":{...},
    "id":0,
    "name":"string",
    "short_name":"string"
    },
    "districts":[...],
    {...}
    "id":0,
    "name":"string",
    "short_name":"string"
    }
    ],
    "subdistrict":{...},
    "name":"string",
    "short_name":"string"
    },
    "city":{...},
    "id":0,
    "name":"string",
    "city_type":{...}
    "city_type_id":0,
    "name":"string",
    "short_name":"string"
    }
    },
    "geo_point":{...},
    "lat":0.5,
    "lon":0.5
    },
    "name":"string",
    "street":{...},
    "name":"string",
    "short_name":"string"
    },
    "house":{...}
    "id":0,
    "name":"string",
    "short_name":"string"
    }
    }
    ]
    }
    400 Bad Request
    Модель
    {...}
    error: string
    read only
    reason: string
    read only
    }
    Пример
    {...}
    "error_list":[...],
    {...}
    "error":"string",
    "reason":"string",
    "details":{...}
    "any-key":null
    }
    }
    ],
    "details":{...}
    "any-key":null
    }
    }
    403 Forbidden
    Модель
    {...}
    error: string

    Текстовый код ошибки

    reason: string

    Человекочитаемое описание ошибки

    }
    Пример
    {...}
    "error":"string",
    "reason":"string",
    "details":{...}
    "any-key":null
    }
    }
    429 Too Many Requests
    Модель
    {...}
    error: string

    Текстовый код ошибки

    reason: string

    Человекочитаемое описание ошибки

    }
    Пример
    {...}
    "error":"string",
    "reason":"string",
    "details":{...}
    "any-key":null
    }
    }

    Метод нужен для определения адресного объекта по координате

    Авторизация
    Получение адресной структуры гео-объекта по координате (платный)
    post /gw/gis-dict/v1/reverse-geocoding
    Запрос
    Модель
    {...}

    Модель, представляющая настройки обратного гео-кодирования

    max_level*: int32 (nullable)

    Максимальный уровень, до которого необходимо провести гео-кодирование.

    Возможные значения

    1 — страна

    2 — область/регион

    3 — населённый пункт

    4 — улица

    5 — дом

    count: int32

    Ограничение количества элементов в выдаче.

    Диапазон значений от 1 до 10.

    Значение по умолчанию: 1

    }
    Пример запроса 
    curl 'https://api.ati.su/gw/gis-dict/v1/reverse-geocoding' \
      -X 'POST' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json' \
      --data-raw '{"location":{"lat":59.93904,"lon":30.31581},"max_level":3,"count":1}'
    Ответ
    200 OK
    Модель
    {...}

    Результат гео-кодирования

    max_count_exceeded: boolean

    Флаг, указывающий, что найдено больше результатов, чем просили в параметре count и требуется уточнение.

    Значение по умолчанию: false

    uncertainty_score: int32

    Минимальная степень неуверенности в точности распознавания среди всех результатов.

    uncertainty_reasons: [string]

    Ошибки распознавания, которые приводят к тому, что нельзя быть на 100% уверенными в результате

    }
    Пример
    {...}
    "max_count_exceeded":false,
    "uncertainty_score":0,
    "uncertainty_reasons":[...],
    "string"
    ],
    "suggestions":[...]
    {...}
    "uncertainty_score":0,
    "uncertainty_reasons":[...],
    "string"
    ],
    "level":0,
    "country":{...},
    "id":0,
    "name":"string",
    "short_name":"string"
    },
    "region":{...},
    "id":0,
    "name":"string",
    "short_name":"string"
    },
    "districts":[...],
    {...}
    "id":0,
    "name":"string",
    "short_name":"string"
    }
    ],
    "subdistrict":{...},
    "name":"string",
    "short_name":"string"
    },
    "city":{...},
    "id":0,
    "name":"string",
    "city_type":{...}
    "city_type_id":0,
    "name":"string",
    "short_name":"string"
    }
    },
    "geo_point":{...},
    "lat":0.5,
    "lon":0.5
    },
    "name":"string",
    "street":{...},
    "name":"string",
    "short_name":"string"
    },
    "house":{...}
    "id":0,
    "name":"string",
    "short_name":"string"
    }
    }
    ]
    }
    400 Bad Request
    Модель
    {...}
    error: string
    read only
    reason: string
    read only
    }
    Пример
    {...}
    "error_list":[...],
    {...}
    "error":"string",
    "reason":"string",
    "details":{...}
    "any-key":null
    }
    }
    ],
    "details":{...}
    "any-key":null
    }
    }
    403 Forbidden
    Модель
    {...}
    error: string

    Текстовый код ошибки

    reason: string

    Человекочитаемое описание ошибки

    }
    Пример
    {...}
    "error":"string",
    "reason":"string",
    "details":{...}
    "any-key":null
    }
    }
    429 Too Many Requests
    Модель
    {...}
    error: string

    Текстовый код ошибки

    reason: string

    Человекочитаемое описание ошибки

    }
    Пример
    {...}
    "error":"string",
    "reason":"string",
    "details":{...}
    "any-key":null
    }
    }

    Устаревшие методы

    Получение списка всех городов с возможностью поиска по префиксу имени, по id городов или только по названию города
    get /v1.0/dictionaries/cities
    Запрос
    Пример запроса 
    curl 'https://api.ati.su/v1.0/dictionaries/cities' \
      -X 'GET' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json'
    Ответ
    200 Города
    Модель
    [{...}]
    Id2: guid
    CityId: int32

    Id города

    RegionId: int32 (nullable)

    Id региона

    CountryId: int32 (nullable)

    Id страны

    FullName: string

    Составное название состоящее из названий города, региона и страны разделенные через запятую

    ShortName: string

    Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

    FullNameEng: string

    Составное название состоящее из названий города, региона и страны разделенные через запятую, на английском

    ShortNameEng: string

    Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России), на английском

    IsRegionalCenter: boolean

    Является ли город региональным центром

    CitySize: int32

    Размер города по числу жителей

    FiasId: guid (nullable)

    идентификатор в базе данных ФИАС

    Longitude: double (nullable)

    Долгота города

    Latitude: double (nullable)

    Широта города

    CityName: string

    Название города

    RegionName: string

    Название региона

    CountryName: string

    Название страны

    CityNameEng: string

    Название города на английском

    RegionNameEng: string

    Название региона на английском

    CountryNameEng: string

    Название страны на английском

    CountryCodeName: string

    Буквенный код страны

    }]
    Пример
    [...]
    {...}
    "Id2":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "CityId":0,
    "RegionId":0,
    "CountryId":0,
    "FullName":"string",
    "ShortName":"string",
    "FullNameEng":"string",
    "ShortNameEng":"string",
    "IsRegionalCenter":false,
    "CitySize":0,
    "FiasId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Longitude":0.5,
    "Latitude":0.5,
    "CityName":"string",
    "RegionName":"string",
    "CountryName":"string",
    "CityNameEng":"string",
    "RegionNameEng":"string",
    "CountryNameEng":"string",
    "CountryCodeName":"string"
    }
    ]
    Получение конкретного города по его идентификатору в базе ФИАС
    get /v1.0/dictionaries/cities/byfias/{fias}
    Запрос
    Пример запроса 
    curl 'https://api.ati.su/v1.0/dictionaries/cities/byfias/{fias}' \
      -X 'GET' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json'
    Ответ
    200 Город
    Модель
    {...}
    Id2: guid
    CityId: int32

    Id города

    RegionId: int32 (nullable)

    Id региона

    CountryId: int32 (nullable)

    Id страны

    FullName: string

    Составное название состоящее из названий города, региона и страны разделенные через запятую

    ShortName: string

    Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

    FullNameEng: string

    Составное название состоящее из названий города, региона и страны разделенные через запятую, на английском

    ShortNameEng: string

    Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России), на английском

    IsRegionalCenter: boolean

    Является ли город региональным центром

    CitySize: int32

    Размер города по числу жителей

    FiasId: guid (nullable)

    идентификатор в базе данных ФИАС

    Longitude: double (nullable)

    Долгота города

    Latitude: double (nullable)

    Широта города

    CityName: string

    Название города

    RegionName: string

    Название региона

    CountryName: string

    Название страны

    CityNameEng: string

    Название города на английском

    RegionNameEng: string

    Название региона на английском

    CountryNameEng: string

    Название страны на английском

    CountryCodeName: string

    Буквенный код страны

    }
    Пример
    {...}
    "Id2":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "CityId":0,
    "RegionId":0,
    "CountryId":0,
    "FullName":"string",
    "ShortName":"string",
    "FullNameEng":"string",
    "ShortNameEng":"string",
    "IsRegionalCenter":false,
    "CitySize":0,
    "FiasId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Longitude":0.5,
    "Latitude":0.5,
    "CityName":"string",
    "RegionName":"string",
    "CountryName":"string",
    "CityNameEng":"string",
    "RegionNameEng":"string",
    "CountryNameEng":"string",
    "CountryCodeName":"string"
    }
    404 Город не найден
    Модель
    {...}

    Модель ошибки

    Reason: string

    Причина ошибки

    Error: string

    Ключ ошибки

    }
    Пример
    {...}
    "Reason":"string",
    "Error":"string"
    }
    Получение конкретного города по его идентификатору
    get /v1.0/dictionaries/cities/{cityId}
    Запрос
    Пример запроса 
    curl 'https://api.ati.su/v1.0/dictionaries/cities/{cityId}' \
      -X 'GET' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json'
    Ответ
    200 Город
    Модель
    {...}
    Id2: guid
    CityId: int32

    Id города

    RegionId: int32 (nullable)

    Id региона

    CountryId: int32 (nullable)

    Id страны

    FullName: string

    Составное название состоящее из названий города, региона и страны разделенные через запятую

    ShortName: string

    Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

    FullNameEng: string

    Составное название состоящее из названий города, региона и страны разделенные через запятую, на английском

    ShortNameEng: string

    Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России), на английском

    IsRegionalCenter: boolean

    Является ли город региональным центром

    CitySize: int32

    Размер города по числу жителей

    FiasId: guid (nullable)

    идентификатор в базе данных ФИАС

    Longitude: double (nullable)

    Долгота города

    Latitude: double (nullable)

    Широта города

    CityName: string

    Название города

    RegionName: string

    Название региона

    CountryName: string

    Название страны

    CityNameEng: string

    Название города на английском

    RegionNameEng: string

    Название региона на английском

    CountryNameEng: string

    Название страны на английском

    CountryCodeName: string

    Буквенный код страны

    }
    Пример
    {...}
    "Id2":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "CityId":0,
    "RegionId":0,
    "CountryId":0,
    "FullName":"string",
    "ShortName":"string",
    "FullNameEng":"string",
    "ShortNameEng":"string",
    "IsRegionalCenter":false,
    "CitySize":0,
    "FiasId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Longitude":0.5,
    "Latitude":0.5,
    "CityName":"string",
    "RegionName":"string",
    "CountryName":"string",
    "CityNameEng":"string",
    "RegionNameEng":"string",
    "CountryNameEng":"string",
    "CountryCodeName":"string"
    }
    404 Город не найден
    Модель
    {...}

    Модель ошибки

    Reason: string

    Причина ошибки

    Error: string

    Ключ ошибки

    }
    Пример
    {...}
    "Reason":"string",
    "Error":"string"
    }
    Получение списка регионов
    get /v1.0/dictionaries/regions
    Запрос
    Пример запроса 
    curl 'https://api.ati.su/v1.0/dictionaries/regions' \
      -X 'GET' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json'
    Ответ
    200 Регионы
    Модель
    [{...}]
    Id: int64

    Id

    Id2: guid

    Guid

    Name: string

    Название

    NameEng: string

    Название на английском

    RegionClearName: string

    Только название области или края. Напр, Московская область -> Московская

    RegionTypeAbbr: string

    Тип региона. Напр, Московская область -> обл.

    CountryId: int32

    Id страны

    RegionCode: string

    Код региона

    }]
    Пример
    [...]
    {...}
    "Id":0,
    "Id2":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Name":"string",
    "NameEng":"string",
    "RegionClearName":"string",
    "RegionTypeAbbr":"string",
    "CountryId":0,
    "RegionCode":"string"
    }
    ]
    Получение города, соответствующего указанному адресу
    post /v1.0/dictionaries/locations/parse
    Запрос
    Модель
    [string]
    Пример запроса 
    curl 'https://api.ati.su/v1.0/dictionaries/locations/parse' \
      -X 'POST' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json' \
      --data-raw '["string"]'
    Ответ
    200 Результат геокодирования
    Модель
    {...}
    }
    Пример
    {...}
    "any-key":{...}
    "city_id":0,
    "is_success":false,
    "street":"string"
    }
    }

    Актуальный метод получения ближайших городов переехал в раздел Расчёт расстояний

    Получение списка ближайших городов по городу
    get /v1.0/dictionaries/cities/{cityId}/near
    Запрос
    Пример запроса 
    curl 'https://api.ati.su/v1.0/dictionaries/cities/{cityId}/near' \
      -X 'GET' \
      -H 'Authorization: Bearer {authorizationToken}' \
      -H 'Content-Type: application/json'
    Ответ
    200 Города
    Модель
    [{...}]
    Id2: guid
    CityId: int32

    Id города

    RegionId: int32 (nullable)

    Id региона

    CountryId: int32 (nullable)

    Id страны

    FullName: string

    Составное название состоящее из названий города, региона и страны разделенные через запятую

    ShortName: string

    Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России)

    FullNameEng: string

    Составное название состоящее из названий города, региона и страны разделенные через запятую, на английском

    ShortNameEng: string

    Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России), на английском

    IsRegionalCenter: boolean

    Является ли город региональным центром

    CitySize: int32

    Размер города по числу жителей

    FiasId: guid (nullable)

    идентификатор в базе данных ФИАС

    Longitude: double (nullable)

    Долгота города

    Latitude: double (nullable)

    Широта города

    CityName: string

    Название города

    RegionName: string

    Название региона

    CountryName: string

    Название страны

    CityNameEng: string

    Название города на английском

    RegionNameEng: string

    Название региона на английском

    CountryNameEng: string

    Название страны на английском

    CountryCodeName: string

    Буквенный код страны

    }]
    Пример
    [...]
    {...}
    "Id2":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "CityId":0,
    "RegionId":0,
    "CountryId":0,
    "FullName":"string",
    "ShortName":"string",
    "FullNameEng":"string",
    "ShortNameEng":"string",
    "IsRegionalCenter":false,
    "CitySize":0,
    "FiasId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Longitude":0.5,
    "Latitude":0.5,
    "CityName":"string",
    "RegionName":"string",
    "CountryName":"string",
    "CityNameEng":"string",
    "RegionNameEng":"string",
    "CountryNameEng":"string",
    "CountryCodeName":"string"
    }
    ]
    404 Город не найден
    Модель
    {...}

    Модель ошибки

    Reason: string

    Причина ошибки

    Error: string

    Ключ ошибки

    }
    Пример
    {...}
    "Reason":"string",
    "Error":"string"
    }