Перейти к содержанию

Получение городов по почтовому индексу

Описание

Получение городов по почтовому индексу. Можно указывать только часть индекса.

Структура URL

1
GET /v2/references/towns/by/postcode

Список параметров

Название Описание Тип передачи параметра Обязательный(+)/По умолчанию(значение)
language Язык локализации. Описание использования. Query string parameter ru
areaIds Дополнительно: массив идентификаторов областей. Ограничение использования: этот параметр учитывается только в том случае, если указано хотя бы одно значение в параметре countrySigns. Эффект: в выборку попадут только те города, чьи области указаны в качестве значения этого параметра. Query string parameter
countrySigns Дополнительно: массив кодов стран в формате ISO 3166-1 alpha-2. Эффект: в выборку попадут только те города, чьи страны указаны в качестве значения этого параметра. Query string parameter
excludeCountrySigns Дополнительно: массив кодов стран в формате ISO 3166-1 alpha-2. Ограничение использования: этот параметр учитывается только в том случае, если не указано ни одного значения в параметре countrySigns. Эффект: в выборку попадут только те города, чьи страны не указаны в качестве значения этого параметра. Query string parameter
limit Желаемое количество ответов, максимум 100. Query string parameter 10
query Почтовый индекс или часть почтового индекса. Query string parameter +

Результат

Массив структур "Город".

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

query
1
curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/towns/by/postcode?language=uk&query=001"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
[
    {
        "id": 2791,
        "name": "Єреван",
        "countrySign": "AM",
        "areaId": 0,
        "lat": 40.17765,
        "lon": 44.50532,
        "postcode": [
            "0010"
        ]
    },
    {
        "id": 5496,
        "name": "Лідо-ді-Остія",
        "countrySign": "IT",
        "areaId": 0,
        "lat": 41.732715,
        "lon": 12.276943,
        "postcode": [
            "00121"
        ]
    },
    {
        "id": 112928,
        "name": "Катовіце",
        "countrySign": "PL",
        "areaId": 158,
        "lat": 50.259899,
        "lon": 19.021585,
        "postcode": [
            "40-001"
        ]
    },
    {
        "id": 113124,
        "name": "Хлюдово",
        "countrySign": "PL",
        "areaId": 161,
        "lat": 52.555771,
        "lon": 16.844781,
        "postcode": [
            "62-001"
        ]
    },
    {
        "id": 113127,
        "name": "Тшебовниско",
        "countrySign": "PL",
        "areaId": 155,
        "lat": 50.078002,
        "lon": 22.036459,
        "postcode": [
            "36-001"
        ]
    },
    {
        "id": 113206,
        "name": "Дывиты",
        "countrySign": "PL",
        "areaId": 160,
        "lat": 53.83404,
        "lon": 20.47337,
        "postcode": [
            "11-001"
        ]
    },
    {
        "id": 110187,
        "name": "Торренова",
        "countrySign": "IT",
        "areaId": 0,
        "lat": 41.879132,
        "lon": 12.616869,
        "postcode": [
            "00133"
        ]
    }
]
query + countrySigns
1
curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/towns/by/postcode?language=uk&query=001&countrySigns=PL"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
[
    {
        "id": 112928,
        "name": "Катовіце",
        "countrySign": "PL",
        "areaId": 158,
        "lat": 50.259899,
        "lon": 19.021585,
        "postcode": [
            "40-001"
        ]
    },
    {
        "id": 113124,
        "name": "Хлюдово",
        "countrySign": "PL",
        "areaId": 161,
        "lat": 52.555771,
        "lon": 16.844781,
        "postcode": [
            "62-001"
        ]
    },
    {
        "id": 113127,
        "name": "Тшебовниско",
        "countrySign": "PL",
        "areaId": 155,
        "lat": 50.078002,
        "lon": 22.036459,
        "postcode": [
            "36-001"
        ]
    },
    {
        "id": 113206,
        "name": "Дывиты",
        "countrySign": "PL",
        "areaId": 160,
        "lat": 53.83404,
        "lon": 20.47337,
        "postcode": [
            "11-001"
        ]
    }
]
query + countrySigns + areaIds
1
curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/towns/by/postcode?language=uk&query=001&countrySigns=PL&areaIds=160,161"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
[
    {
        "id": 113124,
        "name": "Хлюдово",
        "countrySign": "PL",
        "areaId": 161,
        "lat": 52.555771,
        "lon": 16.844781,
        "postcode": [
            "62-001"
        ]
    },
    {
        "id": 113206,
        "name": "Дывиты",
        "countrySign": "PL",
        "areaId": 160,
        "lat": 53.83404,
        "lon": 20.47337,
        "postcode": [
            "11-001"
        ]
    }
]
query + excludeCountrySigns
1
curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/towns/by/postcode?language=uk&query=001&excludeCountrySigns=AM,PL"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
[
    {
        "id": 5496,
        "name": "Лідо-ді-Остія",
        "countrySign": "IT",
        "areaId": 0,
        "lat": 41.732715,
        "lon": 12.276943,
        "postcode": [
            "00121"
        ]
    },
    {
        "id": 110187,
        "name": "Торренова",
        "countrySign": "IT",
        "areaId": 0,
        "lat": 41.879132,
        "lon": 12.616869,
        "postcode": [
            "00133"
        ]
    }
]