geocode

打印
分享
PDF

概述

地址搜索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

请求参数

参数	数据类型	是否为必填	说明
query	string	Y	地址
coordinate	string	N	- 搜索中心坐标以“lon,lat”的格式输入
filter	string	N	- 过滤搜索结果的条件 “过滤类型@代码1;代码2;...”的格式输入提供的过滤类型如下： `HCODE`：行政洞代码 `BCODE`：法定洞代码例）HCODE@4113554500;4113555000
language	string	N	- 增加language=eng时激活英文地址搜索默认值： kor
page	number	N	- 页码默认值： 1
count	number	N	- 结果目录大小输入范围：1~100 默认值： 10

请求报头

报头名称	是否为必填	说明
X-NCP-APIGW-API-KEY-ID	Y	注册应用程序时获取的Client ID `X-NCP-APIGW-API-KEY-ID:{Client ID}`
X-NCP-APIGW-API-KEY	Y	注册应用程序时获取的Client Secret `X-NCP-APIGW-API-KEY:{Client Secret}`
Accept	N	- 响应格式 JSON（默认值），支持XML 设置MIME类型所需格式 `Accept: application/json` `Accept: application/xml`

请求体

该API不需要任何请求体。

响应

响应体

属性	数据类型	是否为必填	说明
status	string	Y	搜索结果状态代码
errorMessage	string	N	异常发生时的信息
meta	object	N	搜索元数据
meta.totalCount	number	N	搜索总数
meta.page	number	N	当前页码
meta.count	number	N	页面内结果个数
addresses	array	N	地址搜索结果目录
addresses[].roadAddress	string	N	道路名地址
addresses[].jibunAddress	string	N	地区编码地址
addresses[].englishAddress	string	N	英语地址
addresses[].x	string	N	x坐标（经度）
addresses[].y	string	N	y坐标（纬度）
addresses[].distance	double	N	距搜索中心坐标的距离（单位：米）
addresses[].addressElements	array	N	构成地址的要素

示例

请求示例

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 Green Factory",
            "jibunAddress": "京畿道城南市盆唐区亭子洞178-1 Green Factory",
            "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": ""
}

错误代码

HttpStatusCode	ResultCode	ErrorMessage	Description
200	`OK`	-	正常响应
400	`INVALID_REQUEST`	Bad Request Exception	请求错误
500	`SYSTEM_ERROR`	Unexpected Error	未处理的异常错误

本文对您有帮助吗？

What's Next

Reverse Geocoding概述

概述
请求
响应
示例
错误代码

标签