# 주소 검색·정규화 도로명·지번 주소를 검색해 표준 주소, 필지번호, 지역코드, 좌표로 정리합니다. 주소 입력 화면의 검색 결과를 표준화할 때 씁니다. 인증: Authorization: Bearer $APICK_API_KEY 본문 있는 REST 요청: multipart/form-data. GET 본문 및 MCP JSON-RPC 규격은 해당 명세를 따릅니다. 인증키는 서버에 보관하세요. 모든 예제는 정적 자료입니다. ## POST /rest/geo_address_search 응답 필드 - `data` (object): 요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다. - `data.query` (string): 검색에 사용한 키워드를 그대로 반환한 값입니다. 응답의 결과가 어떤 검색어 기준인지 확인할 때 사용합니다. - `data.category` (string): 'category' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.page` (object): 조회한 리뷰 페이지 번호입니다. 1부터 시작합니다. 하위 필드에 코드·이름·상태 같은 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.page.current` (integer): 현재 페이지입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.page.size` (integer): 'size' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.page.total` (integer): 전체 결과 수입니다. 알 수 없으면 null 입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. null 허용. - `data.count` (integer): 이번 응답의 결과 수입니다. 건수입니다. 0이면 해당 항목이 없습니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.items` (array): 조회 결과 항목 목록입니다. 항목이 없으면 빈 배열이며, 각 항목의 필드 구성은 서비스마다 다릅니다. - `data.items[].index` (integer): 'index' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.items[].pnu` (string): 필지번호 19자리입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].roadAddress` (string): 도로명 주소입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].parcelAddress` (string): 지번 주소입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].jibun` (string): 지번입니다. 예: 858 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].buildingName` (string): 건물명입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].zipcode` (string): 우편번호입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].category` (string): 'category' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.items[].point` (object): 'point' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.items[].point.x` (number): 경도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.items[].point.y` (number): 위도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.items[].point.crs` (string): 'crs' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.items[].codes` (object): 'codes' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.items[].codes.pnu` (string): 'pnu' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.items[].codes.bjdongCode` (string): 법정동코드 10자리입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].codes.lawdCd` (string): 시군구 단위 지역코드 5자리입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.error` (string): 오류 원인을 설명하는 문구입니다. 성공 응답에는 없거나 빈 문자열입니다. - `api` (object): API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다. - `api.cost` (integer): 이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다. - `api.success` (boolean): API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다. - `api.ms` (integer): 서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다. ## API 요청: POST /rest/geo_address_search ### 입력 - `query` (string, 필수): 검색어 (예: 테헤란로 152) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. - `category` (string, 선택): 검색 범위 (기본 auto) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. 가능한 값은 3가지입니다. auto = 서버·모델이 상황에 맞춰 자동으로 정하는 값입니다. 별도 지정이 필요 없습니다. road = 도로명 주소를 기준으로 조회하는 값입니다. parcel = 지번 주소를 기준으로 조회하는 값입니다. 허용값: auto, road, parcel - `page` (integer, 선택): 조회할 페이지 번호입니다. 1부터 시작하며, 전체 결과 범위를 넘으면 빈 배열이 옵니다. - `size` (integer, 선택): 출력 이미지의 크기입니다. 1024x1024 같은 WxH 형식으로 보내며, 모델별 지원 크기를 확인하세요. ### 응답 명세 ```json { "type": "object", "properties": { "data": { "type": "object", "properties": { "query": { "type": "string" }, "category": { "type": "string" }, "page": { "type": "object", "properties": { "current": { "type": "integer", "description": "현재 페이지입니다." }, "size": { "type": "integer" }, "total": { "type": "integer", "description": "전체 결과 수입니다. 알 수 없으면 null 입니다.", "nullable": true } } }, "count": { "type": "integer", "description": "이번 응답의 결과 수입니다." }, "items": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer" }, "pnu": { "type": "string", "description": "필지번호 19자리입니다." }, "roadAddress": { "type": "string", "description": "도로명 주소입니다." }, "parcelAddress": { "type": "string", "description": "지번 주소입니다." }, "jibun": { "type": "string", "description": "지번입니다. 예: 858" }, "buildingName": { "type": "string", "description": "건물명입니다." }, "zipcode": { "type": "string", "description": "우편번호입니다." }, "category": { "type": "string" }, "point": { "type": "object", "properties": { "x": { "type": "number", "description": "경도입니다." }, "y": { "type": "number", "description": "위도입니다." }, "crs": { "type": "string" } } }, "codes": { "type": "object", "properties": { "pnu": { "type": "string" }, "bjdongCode": { "type": "string", "description": "법정동코드 10자리입니다." }, "lawdCd": { "type": "string", "description": "시군구 단위 지역코드 5자리입니다." } } } } } }, "error": { "type": "string", "description": "실패 사유입니다. 이 필드가 있으면 과금되지 않습니다." } } }, "api": { "type": "object", "properties": { "cost": { "type": "integer", "description": "차감된 포인트입니다. 실패한 응답은 0입니다." }, "success": { "type": "boolean" }, "ms": { "type": "integer", "description": "처리 시간(밀리초)입니다." } } } } } ``` ### 정적 응답 예시 ```json { "data": { "query": "강남대로 396", "category": "road", "page": { "current": 1, "size": 5, "total": 1 }, "count": 1, "items": [ { "index": 0, "pnu": "1168010100108580000", "roadAddress": "서울특별시 강남구 강남대로 396", "parcelAddress": "서울특별시 강남구 역삼동 858", "jibun": "858", "buildingName": "강남역", "zipcode": "06232", "category": "road", "point": { "x": 127.0283226, "y": 37.4981701, "crs": "EPSG:4326" }, "codes": { "pnu": "1168010100108580000", "bjdongCode": "1168010100", "lawdCd": "11680" } } ] }, "api": { "cost": 20, "success": true, "ms": 70 } } ``` ### curl ```curl curl --fail-with-body --request POST 'https://apick.app/rest/geo_address_search' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'query=강남대로 396' \ --form-string 'category=road' \ --form-string 'size=5' ``` ### Node.js (서버 ESM) ```javascript const form = new FormData(); form.append("query", "강남대로 396"); form.append("category", "road"); form.append("size", "5"); const response = await fetch("https://apick.app/rest/geo_address_search", { method: "POST", headers: { Authorization: "Bearer " + process.env.APICK_API_KEY }, body: form, signal: AbortSignal.timeout(120_000), }); if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`); const result = await response.json(); console.log(result); ``` ### python ```python import os import requests parts = [ ("query", (None, "강남대로 396")), ("category", (None, "road")), ("size", (None, "5")), ] response = requests.request("POST", "https://apick.app/rest/geo_address_search", headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]}, files=parts, timeout=(10, 120)) response.raise_for_status() result = response.json() print(result) ``` ### php ```php '강남대로 396', 'category' => 'road', 'size' => '5', ]; $curl = curl_init('https://apick.app/rest/geo_address_search'); curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => $headers, CURLOPT_POSTFIELDS => $form, CURLOPT_RETURNTRANSFER => true, CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120, ]); $body = curl_exec($curl); if ($body === false) { throw new RuntimeException(curl_error($curl)); } $status = curl_getinfo($curl, CURLINFO_HTTP_CODE); curl_close($curl); if ($status >= 400) { throw new RuntimeException($body); } $result = json_decode($body, true, 512, JSON_THROW_ON_ERROR); print_r($result); ``` ## 사용 예시 1. 도로명 주소 검색 주소 입력 화면에서 사용자가 입력한 도로명으로 후보를 찾습니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/geo_address_search' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'query=강남대로 396' \ --form-string 'category=road' \ --form-string 'size=5' ``` - `data.items[]`의 `roadAddress`·`parcelAddress`·`zipcode`를 후보 목록에 보여 줍니다. ## 사용 예시 2. 결과 다음 페이지 후보가 많을 때 `page`를 넘겨 더 받습니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/geo_address_search' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'query=테헤란로' \ --form-string 'category=auto' \ --form-string 'page=2' \ --form-string 'size=20' ``` - `data.page.total`로 전체 결과 수를 확인하고, `data.count`가 `size`보다 적으면 마지막 페이지입니다. ## 코드·오류 ### 업무 실패 응답 입력 오류·대상 없음·일시 실패는 data.error(사유)와 data.success=0으로 오며 api.cost는 0(과금 없음)입니다. HTTP 상태는 400·404·408·424 중 하나입니다. 입력 오류는 값을 고쳐 다시 요청하고, 408·424는 잠시 후 한 번 다시 시도하세요. ```json { "data": { "error": "입력값을 확인해 주세요.", "success": 0 }, "api": { "success": true, "cost": 0, "ms": 5 } } ``` ## 상세 기능·요금 이용 전 확인 성공한 요청 한 건당 20P가 차감됩니다. 입력이 잘못됐거나 결과를 찾지 못하면 data.error로 응답하며 api.cost는 0입니다. category=auto(기본)면 도로명·지번 결과를 합치고 같은 필지는 한 번만 담습니다.다음 결과가 필요하면 page를 올려 요청합니다. data.page.total은 전체 결과 수이며 알 수 없으면 null 입니다. 좌표는 WGS84 경위도(EPSG:4326)이며 x가 경도, y가 위도입니다. 거리·면적은 근사값이며 필지·행정구역 규모에서는 오차가 작습니다. ## 상세 요청 항목설정 메서드·주소POST https://apick.app/rest/geo_address_search 인증 헤더Authorization: Bearer — 내 계정의 API 인증키 본문 형식multipart/form-data 요청 예시 form-data 전체 예제 보기 ## 상세 응답 필드타입설명 data.page.currentinteger현재 페이지입니다.data.page.totalinteger전체 결과 수입니다. 알 수 없으면 null 입니다.data.countinteger이번 응답의 결과 수입니다.data.items[].pnustring필지번호 19자리입니다.data.items[].roadAddressstring도로명 주소입니다.data.items[].parcelAddressstring지번 주소입니다.data.items[].jibunstring지번입니다. 예: 858data.items[].buildingNamestring건물명입니다.data.items[].zipcodestring우편번호입니다.data.items[].point.xnumber경도입니다.data.items[].point.ynumber위도입니다.data.items[].codes.bjdongCodestring법정동코드 10자리입니다.data.items[].codes.lawdCdstring시군구 단위 지역코드 5자리입니다. data.errorstring실패 사유입니다. 이 필드가 있으면 과금되지 않습니다. api.costinteger차감된 포인트입니다. 실패한 응답은 0입니다. api.msinteger처리 시간(밀리초)입니다. { "data": { "query": "강남대로 396", "category": "road", "page": { "current": 1, "size": 5, "total": 1 }, "count": 1, "items": [ { "index": 0, "pnu": "1168010100108580000", "roadAddress": "서울특별시 강남구 강남대로 396", "parcelAddress": "서울특별시 강남구 역삼동 858", "jibun": "858", "buildingName": "강남역", "zipcode": "06232", "category": "road", "point": { "x": 127.0283226, "y": 37.4981701, "crs": "EPSG:4326" }, "codes": { "pnu": "1168010100108580000", "bjdongCode": "1168010100", "lawdCd": "11680" } } ] }, "api": { "cost": 20, "success": true, "ms": 70 } } ## 상세 코드·정책 오류 코드 상황data.error 예대처 입력 누락·형식 오류검색어가 필요합니다. / 주소 유형이 잘못됐습니다. / 좌표가 올바르지 않습니다. …문구가 가리키는 입력을 고쳐 다시 요청합니다. 조회 전에 끝나며 과금되지 않습니다. 개수·길이 초과주소가 너무 깁니다. / 한 요청에 주소를 50개까지 보낼 수 있습니다. …표의 최대값 안으로 줄이거나 나눠서 요청합니다. 위치를 찾지 못함입력한 위치를 찾지 못했습니다.주소 표기(시도·시군구 포함 여부, 오탈자)를 확인합니다. 과금되지 않습니다. 처리 시간 초과처리 시간이 초과됐습니다. 범위를 줄여 다시 시도해 주세요.목록 건수·반경·분류 수를 줄여 다시 요청합니다. 과금되지 않습니다. 일시적 실패공간정보를 일시적으로 가져오지 못했습니다. 잠시 후 다시 시도해 주세요.잠시 뒤 같은 요청을 다시 보냅니다. 과금되지 않습니다.