geocode
    • PDF

    geocode

    • PDF

    Article Summary

    概要

    住所検索 APIは地番、道路名などをクエリとして使用し、住所情報を検索します。その検索結果として、住所リストや詳細情報を JSON形式で返します。

    リクエスト

    curl -G "https://naveropenapi.apigw.ntruss.com/map-geocode/v2/geocode" \
        --data-urlencode "query={アドレス}" \
        --data-urlencode "coordinate={検索_中心_座標}" \
        -H "X-NCP-APIGW-API-KEY-ID: {アプリケーション登録時に発行された Client ID値}" \
        -H "X-NCP-APIGW-API-KEY: {アプリケーション登録時に発行された Client Secret値}" -v
    

    リクエストパラメータ

    パラメータデータタイプ要否説明
    querystringY住所
    coordinatestringN- 検索中心座標
    「lon,lat」形式で入力
    filterstringN- 検索結果のフィルタリング条件
    「フィルタタイプ@コード1;コード2;...」形式で入力
    提供するフィルタタイプは以下同様:
    HCODE: 行政洞コード
    BCODE: 法定洞コード

    例) HCODE@4113554500;4113555000
    languagestringN- language=engの追加時、英文住所検索を有効化
    デフォルト値: kor
    pagenumberN- ページ番号
    デフォルト値: 1
    countnumberN- 結果リストのサイズ
    入力範囲: 1~100
    デフォルト値: 10

    リクエストヘッダ

    ヘッダ名要否説明
    X-NCP-APIGW-API-KEY-IDYアプリ登録時に発行されたClient ID
    X-NCP-APIGW-API-KEY-ID:{Client ID}
    X-NCP-APIGW-API-KEYYアプリ登録時に発行されたClient Secret
    X-NCP-APIGW-API-KEY:{Client Secret}
    AcceptN- レスポンスフォーマット
    JSON(デフォルト値)、XMLサポート
    MIMEタイプで希望するフォーマットを設定
    Accept: application/json
    Accept: application/xml

    リクエストボディ

    • 当該 APIは、リクエストボディが不要です。

    レスポンス

    レスポンスボディ

    属性データタイプ要否説明
    status                                  string      Y        検査結果のステータスコード
    errorMessagestringN例外発生時のメッセージ
    metaobjectN検索メタデータ
    meta.totalCountnumberN総検索件数:
    meta.pagenumberN現在のページ番号
    meta.countnumberNページ内の結果件数
    addressesarrayN住所検索の結果リスト
    addresses[].roadAddressstringN道路名住所
    addresses[].jibunAddressstringN地番住所
    addresses[].englishAddressstringN英文住所
    addresses[].xstringNx座標(経度)
    addresses[].ystringNy座標(緯度)
    addresses[].distancedoubleN検索中心座標からの距離(単位: メータ)
    addresses[].addressElementsarrayN住所の要素

    リクエスト例

    curl -G "https://naveropenapi.apigw.ntruss.com/map-geocode/v2/geocode" \
        --data-urlencode "query=盆唐区ブルジョンロ6" \
        --data-urlencode "coordinate=127.1054328,37.3595963" \
        -H "X-NCP-APIGW-API-KEY-ID: {アプリケーション登録時に発行された Client ID値}" \
        -H "X-NCP-APIGW-API-KEY: {アプリケーション登録時に発行された Client Secret値}" -v
    

    レスポンス例

    {
        "status": "OK",
        "meta": {
            "totalCount": 1,
            "page": 1,
            "count": 1
        },
        "addresses": [
            {
                "roadAddress": "京畿道城南市盆唐区ブルジョンロ6グリーンファクトリー",
                "jibunAddress": "京畿道城南市盆唐区チョンジャドン178-1グリーンファクトリー",
                "englishAddress": "6, Buljeong-ro, Bundang-gu, Seongnam-si, Gyeonggi-do, Republic of Korea",
                "addressElements": [
                    {
                        "types": [
                            "POSTAL_CODE"
                        ],
                        "longName": "13561",
                        "shortName": "",
                        "code": ""
                    }
                ],
                "x": "127.10522081658463",
                "y": "37.35951219616309",
                "distance": 20.925857741585514
            }
        ],
        "errorMessage": ""
    }
    

    エラーコード

    HttpStatusCodeResultCodeErrorMessageDescription
    200OK-正常レスポンス
    400INVALID_REQUESTBad Request Exceptionリクエストエラー
    500SYSTEM_ERRORUnexpected Error例外処理できないエラー

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.