# 주소 품질 진단 주소 목록의 유효성·완성도를 점수와 등급으로 진단하고, 찾지 못한 주소에는 대안 후보를 제시합니다. 고객 주소록·배송지 정리 품질을 수치로 확인할 때 씁니다. 인증: Authorization: Bearer $APICK_API_KEY 본문 있는 REST 요청: multipart/form-data. GET 본문 및 MCP JSON-RPC 규격은 해당 명세를 따릅니다. 인증키는 서버에 보관하세요. 모든 예제는 정적 자료입니다. ## POST /rest/geo_address_quality 응답 필드 - `data` (object): 요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다. - `data.summary` (object): 공고의 짧은 요약입니다. 본문 전체는 description_html에서 확인하세요. - `data.summary.total` (integer): 상태 집계 대상 택배사의 전체 수입니다. 조회 가능·점검 중인 수를 합한 값과 일치합니다. - `data.summary.valid` (integer): 찾은 주소 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.summary.invalid` (integer): 찾지 못한 주소 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.summary.averageScore` (integer): 평균 점수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.summary.partial` (boolean): 시간 초과로 일부를 진단하지 못했으면 true 입니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. - `data.summary.elapsedMs` (integer): 'elapsedMs' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.items` (array): 조회 결과 항목 목록입니다. 항목이 없으면 빈 배열이며, 각 항목의 필드 구성은 서비스마다 다릅니다. - `data.items[].input` (string): 입력한 주소입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].valid` (boolean): 주소를 찾았으면 true 입니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. - `data.items[].score` (integer): 0~100 점수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.items[].grade` (string): A·B·C·D·F 등급입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].issues` (array): 보완할 점입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다. 항목 수와 순서를 함께 확인하세요. - `data.items[].normalized` (object): 'normalized' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.items[].normalized.full` (string): 찾은 주소의 표준 주소입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].codes` (object): 'codes' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.items[].codes.pnu` (string): 필지번호입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.items[].codes.lawdCd` (string): 'lawdCd' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.items[].point` (object): 'point' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.items[].point.x` (number): 'x' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.items[].point.y` (number): 'y' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.items[].point.crs` (string): 'crs' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.items[].suggestions` (array): 찾지 못한 주소의 대안 후보(도로명·지번·우편번호, 최대 3건)입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다. 항목 수와 순서를 함께 확인하세요. - `data.items[].suggestions[].roadAddress` (string): 'roadAddress' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.items[].suggestions[].parcelAddress` (string): 'parcelAddress' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.items[].suggestions[].zipcode` (string): 'zipcode' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `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_quality ### 입력 - `addresses` (array, 필수): 진단할 주소 목록 (최대 20건) 배열로 보내며, 항목이 없으면 빈 배열을 보내거나 필드를 생략합니다. - `addrType` (string, 선택): 주소 유형 (기본 auto) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. 가능한 값은 3가지입니다. auto = 서버·모델이 상황에 맞춰 자동으로 정하는 값입니다. 별도 지정이 필요 없습니다. parcel = 지번 주소를 기준으로 조회하는 값입니다. road = 도로명 주소를 기준으로 조회하는 값입니다. 허용값: auto, parcel, road ### 응답 명세 ```json { "type": "object", "properties": { "data": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "total": { "type": "integer", "description": "진단한 주소 수입니다." }, "valid": { "type": "integer", "description": "찾은 주소 수입니다." }, "invalid": { "type": "integer", "description": "찾지 못한 주소 수입니다." }, "averageScore": { "type": "integer", "description": "평균 점수입니다." }, "partial": { "type": "boolean", "description": "시간 초과로 일부를 진단하지 못했으면 true 입니다." }, "elapsedMs": { "type": "integer" } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "input": { "type": "string", "description": "입력한 주소입니다." }, "valid": { "type": "boolean", "description": "주소를 찾았으면 true 입니다." }, "score": { "type": "integer", "description": "0~100 점수입니다." }, "grade": { "type": "string", "description": "A·B·C·D·F 등급입니다." }, "issues": { "type": "array", "items": { "type": "string" }, "description": "보완할 점입니다." }, "normalized": { "type": "object", "properties": { "full": { "type": "string", "description": "찾은 주소의 표준 주소입니다." } } }, "codes": { "type": "object", "properties": { "pnu": { "type": "string", "description": "필지번호입니다." }, "lawdCd": { "type": "string" } } }, "point": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "crs": { "type": "string" } } }, "suggestions": { "type": "array", "items": { "type": "object", "properties": { "roadAddress": { "type": "string" }, "parcelAddress": { "type": "string" }, "zipcode": { "type": "string" } } }, "description": "찾지 못한 주소의 대안 후보(도로명·지번·우편번호, 최대 3건)입니다." } } } }, "error": { "type": "string", "description": "실패 사유입니다. 이 필드가 있으면 과금되지 않습니다." } } }, "api": { "type": "object", "properties": { "cost": { "type": "integer", "description": "차감된 포인트입니다. 실패한 응답은 0입니다." }, "success": { "type": "boolean" }, "ms": { "type": "integer", "description": "처리 시간(밀리초)입니다." } } } } } ``` ### 정적 응답 예시 ```json { "data": { "summary": { "total": 2, "valid": 1, "invalid": 1, "averageScore": 50, "partial": false, "elapsedMs": 210 }, "items": [ { "input": "서울특별시 강남구 역삼동 808", "valid": true, "score": 100, "grade": "A", "issues": [], "normalized": { "full": "서울특별시 강남구 역삼동 808" }, "codes": { "pnu": "1168010100108080000", "lawdCd": "11680" }, "point": { "x": 127.0250516, "y": 37.5043681, "crs": "EPSG:4326" }, "suggestions": [] }, { "input": "서울 강남구 없는동 999", "valid": false, "score": 0, "grade": "F", "issues": [ "주소를 찾지 못했습니다." ], "suggestions": [ { "roadAddress": "서울특별시 강남구 테헤란로 152", "parcelAddress": "서울특별시 강남구 역삼동 808", "zipcode": "06123" } ] } ] }, "api": { "cost": 30, "success": true, "ms": 220 } } ``` ### curl ```curl curl --fail-with-body --request POST 'https://apick.app/rest/geo_address_quality' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'addresses[0]=서울특별시 강남구 역삼동 808' \ --form-string 'addresses[1]=서울 강남구 없는동 999' ``` ### Node.js (서버 ESM) ```javascript const form = new FormData(); form.append("addresses[0]", "서울특별시 강남구 역삼동 808"); form.append("addresses[1]", "서울 강남구 없는동 999"); const response = await fetch("https://apick.app/rest/geo_address_quality", { 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 = [ ("addresses[0]", (None, "서울특별시 강남구 역삼동 808")), ("addresses[1]", (None, "서울 강남구 없는동 999")), ] response = requests.request("POST", "https://apick.app/rest/geo_address_quality", headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]}, files=parts, timeout=(10, 120)) response.raise_for_status() result = response.json() print(result) ``` ### php ```php '서울특별시 강남구 역삼동 808', 'addresses[1]' => '서울 강남구 없는동 999', ]; $curl = curl_init('https://apick.app/rest/geo_address_quality'); 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. 주소록 품질 진단 고객 주소록 일부를 넣어 점수·등급과 보완할 점을 받습니다(최대 20건). ```bash curl --fail-with-body --request POST 'https://apick.app/rest/geo_address_quality' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'addresses[0]=서울특별시 강남구 역삼동 808' \ --form-string 'addresses[1]=서울 강남구 없는동 999' ``` - `data.items[].grade`가 C 이하인 주소는 `issues[]` 안내로 보완을 요청합니다. - `grade`가 F인 주소는 `suggestions[]`의 후보 중에서 고르게 합니다. ## 사용 예시 2. 줄바꿈 목록으로 보내기 텍스트 파일의 주소를 줄마다 하나씩 넣은 문자열 그대로 보낼 수 있습니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/geo_address_quality' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string '__apick_encoding[addresses]=base64-utf8' \ --form-string 'addresses=7ISc7Jq47Yq567OE7IucIOqwleuCqOq1rCDsl63sgrzrj5kgODA4CuyEnOyauO2KueuzhOyLnCDqsJXrgqjqtawg6rCV64Ko64yA66GcIDM5Ng==' ``` - `data.summary.averageScore`로 주소록 전체 품질을 수치로 비교합니다. - 모든 주소를 찾지 못하면 실패로 끝나며 과금되지 않습니다. ## 코드·오류 ### 업무 실패 응답 입력 오류·대상 없음·일시 실패는 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 } } ``` ## 상세 기능·요금 이용 전 확인 성공한 요청 한 건당 30P가 차감됩니다. 입력이 잘못됐거나 결과를 찾지 못하면 data.error로 응답하며 api.cost는 0입니다. 등급은 90점 이상 A, 75점 이상 B, 55점 이상 C, 그 밖 D 이며 찾지 못한 주소는 F(0점)입니다. 상세 주소(동·호·건물명)가 빠졌거나 너무 짧거나 괄호 같은 특수문자가 섞이면 점수가 낮아집니다.감점된 이유는 issues에 문장으로 담기므로 주소를 고치는 안내에 그대로 쓸 수 있습니다.한 건이라도 찾으면 성공 응답이며 요청 한 번에 위 단가가 한 번 차감됩니다. 모든 주소를 찾지 못하면 실패로 끝나고 과금되지 않습니다. 좌표는 WGS84 경위도(EPSG:4326)이며 x가 경도, y가 위도입니다. 거리·면적은 근사값이며 필지·행정구역 규모에서는 오차가 작습니다. ## 상세 요청 항목설정 메서드·주소POST https://apick.app/rest/geo_address_quality 인증 헤더Authorization: Bearer — 내 계정의 API 인증키 본문 형식multipart/form-data 요청 예시 form-data 전체 예제 보기 ## 상세 응답 필드타입설명 data.summary.totalinteger진단한 주소 수입니다.data.summary.validinteger찾은 주소 수입니다.data.summary.invalidinteger찾지 못한 주소 수입니다.data.summary.averageScorenumber평균 점수입니다.data.summary.partialboolean시간 초과로 일부를 진단하지 못했으면 true 입니다.data.items[].inputstring입력한 주소입니다.data.items[].validboolean주소를 찾았으면 true 입니다.data.items[].scoreinteger0~100 점수입니다.data.items[].gradestringA·B·C·D·F 등급입니다.data.items[].issues[]array보완할 점입니다.data.items[].normalized.fullstring찾은 주소의 표준 주소입니다.data.items[].codes.pnustring필지번호입니다.data.items[].suggestions[]array찾지 못한 주소의 대안 후보(도로명·지번·우편번호, 최대 3건)입니다. data.errorstring실패 사유입니다. 이 필드가 있으면 과금되지 않습니다. api.costinteger차감된 포인트입니다. 실패한 응답은 0입니다. api.msinteger처리 시간(밀리초)입니다. { "data": { "summary": { "total": 2, "valid": 1, "invalid": 1, "averageScore": 50, "partial": false, "elapsedMs": 210 }, "items": [ { "input": "서울특별시 강남구 역삼동 808", "valid": true, "score": 100, "grade": "A", "issues": [], "normalized": { "full": "서울특별시 강남구 역삼동 808" }, "codes": { "pnu": "1168010100108080000", "lawdCd": "11680" }, "point": { "x": 127.0250516, "y": 37.5043681, "crs": "EPSG:4326" }, "suggestions": [] }, { "input": "서울 강남구 없는동 999", "valid": false, "score": 0, "grade": "F", "issues": [ "주소를 찾지 못했습니다." ], "suggestions": [ { "roadAddress": "서울특별시 강남구 테헤란로 152", "parcelAddress": "서울특별시 강남구 역삼동 808", "zipcode": "06123" } ] } ] }, "api": { "cost": 30, "success": true, "ms": 220 } } ## 상세 코드·정책 오류 코드 상황data.error 예대처 입력 누락·형식 오류검색어가 필요합니다. / 주소 유형이 잘못됐습니다. / 좌표가 올바르지 않습니다. …문구가 가리키는 입력을 고쳐 다시 요청합니다. 조회 전에 끝나며 과금되지 않습니다. 개수·길이 초과주소가 너무 깁니다. / 한 요청에 주소를 50개까지 보낼 수 있습니다. …표의 최대값 안으로 줄이거나 나눠서 요청합니다. 위치를 찾지 못함입력한 위치를 찾지 못했습니다.주소 표기(시도·시군구 포함 여부, 오탈자)를 확인합니다. 과금되지 않습니다. 처리 시간 초과처리 시간이 초과됐습니다. 범위를 줄여 다시 시도해 주세요.목록 건수·반경·분류 수를 줄여 다시 요청합니다. 과금되지 않습니다. 일시적 실패공간정보를 일시적으로 가져오지 못했습니다. 잠시 후 다시 시도해 주세요.잠시 뒤 같은 요청을 다시 보냅니다. 과금되지 않습니다.