성공한 요청 한 건당 40P가 차감됩니다. 입력이 잘못됐거나 결과를 찾지 못하면 data.error로 응답하며 api.cost는 0입니다.
한 건이라도 찾으면 성공 응답이며 요청 한 번에 위 단가가 한 번 차감됩니다. 모든 주소를 찾지 못하면 실패로 끝나고 과금되지 않습니다.
찾지 못한 주소는 그 항목의 matched가 false 이고 error에 사유가 담깁니다. 처리 시간이 모자라 일부를 처리하지 못하면 summary.partial이 true 이고, 그 항목들은 시간 초과 안내와 함께 실패로 표시됩니다. 실패한 항목만 모아 다시 요청하세요.
items[].indexes는 입력 목록에서 그 주소가 있던 위치(0부터)입니다. 같은 주소가 여러 번 있으면 위치가 여러 개 담깁니다.
주소 목록. 최대 50건 배열로 보내며, 항목이 없으면 빈 배열을 보내거나 필드를 생략합니다.
addrTypestring선택
주소 유형 (기본 auto) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. 가능한 값은 3가지입니다. auto = 서버·모델이 상황에 맞춰 자동으로 정하는 값입니다. 별도 지정이 필요 없습니다. parcel = 지번 주소를 기준으로 조회하는 값입니다. road = 도로명 주소를 기준으로 조회하는 값입니다.
허용값
autoparcelroad
dedupeboolean선택
중복 주소를 한 번만 조회 (기본 true) true/false로 보내며, 생략하면 서버 기본값이 적용됩니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
응답 필드 31개
응답 필드
설명
dataobject
요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.
data.summaryobject
공고의 짧은 요약입니다. 본문 전체는 description_html에서 확인하세요.
data.itemsarray
조회 결과 항목 목록입니다. 항목이 없으면 빈 배열이며, 각 항목의 필드 구성은 서비스마다 다릅니다.
data.errorstring
오류 원인을 설명하는 문구입니다. 성공 응답에는 없거나 빈 문자열입니다.
apiobject
API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.
api.costinteger
이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.
api.successboolean
API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.
api.msinteger
서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.
하위 필드 23개 더 보기
응답 필드
설명
data.summary.requestedinteger
요청한 주소 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.summary.uniqueinteger
중복 제거 뒤 실제 조회한 주소 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.summary.matchedinteger
좌표를 찾은 주소 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.summary.failedinteger
찾지 못하거나 시간이 초과된 주소 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.summary.partialboolean
시간 초과로 일부를 처리하지 못했으면 true 입니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
data.summary.elapsedMsinteger
처리에 걸린 시간(밀리초)입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.items[].inputstring
입력한 주소입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.items[].indexesarray
입력 목록에서 이 주소가 있던 위치입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다. 항목 수와 순서를 함께 확인하세요.
data.items[].matchedboolean
좌표를 찾았는지 여부입니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
data.items[].addrTypestring
찾은 주소 유형(parcel·road)입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. 가능한 값은 2가지입니다. parcel = 지번 주소를 기준으로 조회하는 값입니다. road = 도로명 주소를 기준으로 조회하는 값입니다.
data.items[].normalizedobject
정제된 주소입니다. 항목은 주소 정제 API 의 normalized 와 같습니다.
data.items[].normalized.fullstring
'full' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.items[].normalized.jibunAddressstring
'jibunAddress' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.items[].normalized.roadAddressstring
'roadAddress' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.items[].codesobject
'codes' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.items[].codes.pnustring
필지번호 19자리입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.items[].codes.bjdongCodestring
'bjdongCode' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.items[].codes.lawdCdstring
시군구 단위 지역코드 5자리입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.items[].pointobject
'point' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.items[].point.xnumber
경도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.items[].point.ynumber
위도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.items[].point.crsstring
'crs' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.items[].errorstring
찾지 못한 주소의 안내입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.