Geocoding API

VPC環境で利用できます。

入力した住所と関連する住所情報を検索します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

Maps APIで共通して使用されるヘッダの詳細は、Mapsの共通ヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/map-geocode/v2/geocode?query=盆唐区佛亭路6\
--header 'x-ncp-apigw-api-key-id: {API Key ID}' \
--header 'x-ncp-apigw-api-key: {API Key}' \
--header 'Accept: application/json'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

addresses

addressesの説明は次の通りです。

addressElements

addressElementsの説明は次の通りです。

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "status": "OK",
    "meta": {
        "totalCount": 1,
        "page": 1,
        "count": 1
    },
    "addresses": [
        {
            "roadAddress": "京畿道城南市盆唐区佛亭路6 NAVERグリーンファクトリー",
            "jibunAddress": "京畿道城南市盆唐区亭子洞178-1 NAVERグリーンファクトリー",
            "englishAddress": "6, Buljeong-ro, Bundang-gu, Seongnam-si, Gyeonggi-do, Republic of Korea",
            "addressElements": [
                {
                    "types": [
                        "SIDO"
                    ],
                    "longName": "京畿道",
                    "shortName": "京畿道",
                    "code": ""
                },
                {
                    "types": [
                        "SIGUGUN"
                    ],
                    "longName": "城南市盆唐区",
                    "shortName": "城南市盆唐区",
                    "code": ""
                },
                {
                    "types": [
                        "DONGMYUN"
                    ],
                    "longName": "亭子洞",
                    "shortName": "亭子洞",
                    "code": ""
                },
                {
                    "types": [
                        "RI"
                    ],
                    "longName": "",
                    "shortName": "",
                    "code": ""
                },
                {
                    "types": [
                        "ROAD_NAME"
                    ],
                    "longName": "佛亭路",
                    "shortName": "佛亭路",
                    "code": ""
                },
                {
                    "types": [
                        "BUILDING_NUMBER"
                    ],
                    "longName": "6",
                    "shortName": "6",
                    "code": ""
                },
                {
                    "types": [
                        "BUILDING_NAME"
                    ],
                    "longName": "NAVERグリーンファクトリー",
                    "shortName": "NAVERグリーンファクトリー",
                    "code": ""
                },
                {
                    "types": [
                        "LAND_NUMBER"
                    ],
                    "longName": "178-1",
                    "shortName": "178-1",
                    "code": ""
                },
                {
                    "types": [
                        "POSTAL_CODE"
                    ],
                    "longName": "13561",
                    "shortName": "13561",
                    "code": ""
                }
            ],
            "x": "127.1054328",
            "y": "37.3595963",
            "distance": 0.0
        }
    ],
    "errorMessage": ""
}