API 요청
POST
/rest/geo_address_autocomplete요청 파라미터 3개 · 필수 1
파라미터
설명
query입력 중인 주소 (예: 테헤란로) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
- 최대 길이
- 50자
- 예시
강남대로
size출력 이미지의 크기입니다. 1024x1024 같은 WxH 형식으로 보내며, 모델별 지원 크기를 확인하세요.
- 범위
- 1 ~ 10
- 예시
5
category검색 범위 (기본 auto) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. 가능한 값은 3가지입니다. auto = 서버·모델이 상황에 맞춰 자동으로 정하는 값입니다. 별도 지정이 필요 없습니다. road = 도로명 주소를 기준으로 조회하는 값입니다. parcel = 지번 주소를 기준으로 조회하는 값입니다.
- 허용값
autoroadparcel
응답 필드 27개
응답 필드
설명
data요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.
data.query검색에 사용한 키워드를 그대로 반환한 값입니다. 응답의 결과가 어떤 검색어 기준인지 확인할 때 사용합니다.
data.count제안 수입니다. 건수입니다. 0이면 해당 항목이 없습니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.items조회 결과 항목 목록입니다. 항목이 없으면 빈 배열이며, 각 항목의 필드 구성은 서비스마다 다릅니다.
data.suggestions화면에 그대로 보여줄 주소 문자열 목록입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다. 항목 수와 순서를 함께 확인하세요.
data.error오류 원인을 설명하는 문구입니다. 성공 응답에는 없거나 빈 문자열입니다.
apiAPI 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.
api.cost이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.
api.successAPI 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.
api.ms서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.
하위 필드 17개 더 보기
응답 필드
설명
data.items[].index'index' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.items[].pnu'pnu' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.items[].roadAddress도로명 주소 후보입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.items[].parcelAddress지번 주소 후보입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.items[].jibun'jibun' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.items[].buildingName건물명입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.items[].zipcode우편번호입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.items[].category'category' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.items[].point'point' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.items[].point.x경도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.items[].point.y위도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.items[].point.crs'crs' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.items[].codes'codes' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.items[].codes.pnu'pnu' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.items[].codes.bjdongCode'bjdongCode' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.items[].codes.lawdCd'lawdCd' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.items[].rank입력과 얼마나 일치하는지 나타내는 점수입니다. 클수록 잘 맞습니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
