본문 바로가기
개발가이드공간정보주소 검색·정규화

주소 검색·정규화 API

명세 내보내기
OpenAPI 3.0.3Postman 컬렉션Markdown

도로명·지번 주소를 검색해 표준 주소, 필지번호, 지역코드, 좌표로 정리합니다. 주소 입력 화면의 검색 결과를 표준화할 때 씁니다.

POSThttps://apick.app/rest/geo_address_search
인증
Bearer 키
요청 형식
form-data
응답
JSON
경로
1개

왜 주소 검색·정규화인가

도로명이든 지번이든, 표준 주소로 정리

고객은 도로명으로, 직원은 지번으로 적어 같은 주소가 서로 다른 데이터가 됩니다. 주소를 검색해 표준 주소, 필지번호, 지역코드, 좌표로 정리해 기준을 하나로 맞춥니다.

도입 효과

  • 도로명·지번 혼용 데이터를 단일 기준화
  • 필지번호로 부동산 데이터와 바로 연결
  • 좌표까지 함께 받아 지도 표시가 즉시

이런 곳에서 많이 씁니다

  • 부동산 앱 매물 주소 검색과 등록
  • 보험사 계약 주소 표준화 검증
  • 시설 관리 현장 주소 일괄 정리
가입하고 API 키 받기API 키 하나로 바로 호출 · 실패한 요청은 과금되지 않습니다

알아둘 점

이용 전 확인

성공한 요청 한 건당 20P가 차감됩니다. 입력이 잘못됐거나 결과를 찾지 못하면 data.error로 응답하며 api.cost는 0입니다.

category=auto(기본)면 도로명·지번 결과를 합치고 같은 필지는 한 번만 담습니다. 합친 뒤에도 한 페이지에는 size개까지만 담습니다.

다음 결과가 필요하면 page를 올려 요청합니다. page·size가 범위를 벗어나면 가장 가까운 허용값(1~100, 1~20)으로 맞춰 처리합니다.

data.page.total은 전체 결과 수이며 알 수 없으면 null입니다. category=auto면 한 유형의 결과 수이므로 대략적인 값으로 쓰세요.

좌표는 WGS84 경위도(EPSG:4326)이며 x가 경도, y가 위도입니다. 거리·면적은 지구를 구로 본 근사값이며 필지·행정구역 규모에서는 오차가 작습니다.

응답 시간은 보통 2초 이내이고 최대 18초입니다. 요청 시간 제한을 23초 이상으로 잡으세요.

인증키는 서버 환경변수에 보관하고 공개 저장소·웹페이지에 넣지 마세요.

요청과 응답

API 요청
POST/rest/geo_address_search
  • Bearer 인증
  • multipart/form-data
  • JSON 응답
요청 파라미터 4개 · 필수 1
파라미터
설명
querystring필수
검색어 (예: 테헤란로 152) 문자열로 보내며, 빼거나 빈 값으로 보내면 요청이 거부됩니다.
최대 길이
100자
예시
강남대로 396
categorystring선택
검색 범위 (기본 auto) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. 가능한 값은 3가지입니다. auto = 서버·모델이 상황에 맞춰 자동으로 정하는 값입니다. 별도 지정이 필요 없습니다. road = 도로명 주소를 기준으로 조회하는 값입니다. parcel = 지번 주소를 기준으로 조회하는 값입니다.
허용값
auto road parcel
예시
road
pageinteger선택
페이지 번호 (기본 1) 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다.
범위
1 ~ 100
sizeinteger선택
페이지당 결과 수 (기본 10, 최대 20) 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다.
범위
1 ~ 20
예시
5
응답 필드 29개
응답 필드
설명
dataobject
요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.
data.querystring
검색에 사용한 키워드를 그대로 반환한 값입니다. 응답의 결과가 어떤 검색어 기준인지 확인할 때 사용합니다.
data.categorystring
적용한 검색 범위입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.pageobject
조회한 리뷰 페이지 번호입니다. 1부터 시작합니다. 하위 필드에 코드·이름·상태 같은 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.countinteger
이번 응답의 결과 수입니다. 건수입니다. 0이면 해당 항목이 없습니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.itemsarray
조회 결과 항목 목록입니다. 항목이 없으면 빈 배열이며, 각 항목의 필드 구성은 서비스마다 다릅니다.
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
서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.
하위 필드 19개 더 보기
응답 필드
설명
data.page.currentinteger
현재 페이지입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.page.sizeinteger
페이지당 결과 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.page.totalinteger
전체 결과 수입니다. 알 수 없으면 null입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. null 허용.
data.items[].indexinteger
이번 응답 안에서의 순서(0부터)입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.items[].pnustring
필지번호 19자리입니다. 없으면 빈 문자열입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.items[].roadAddressstring
도로명 주소입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.items[].parcelAddressstring
지번 주소입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.items[].jibunstring
지번 주소의 마지막 번지입니다. 예: 858 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.items[].buildingNamestring
건물명입니다. 없으면 빈 문자열입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.items[].zipcodestring
우편번호입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.items[].categorystring
이 결과의 주소 유형(road·parcel)입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. 가능한 값은 2가지입니다. road = 도로명 주소를 기준으로 조회하는 값입니다. parcel = 지번 주소를 기준으로 조회하는 값입니다.
data.items[].pointobject
'point' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.items[].point.xnumber
경도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.items[].point.ynumber
위도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.items[].point.crsstring
'crs' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.items[].codesobject
'codes' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.items[].codes.pnustring
필지번호 19자리입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.items[].codes.bjdongCodestring
법정동코드 10자리입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.items[].codes.lawdCdstring
시군구 단위 지역코드 5자리입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
입력 조건·전송 규칙
항목
설정
메서드·주소
POST https://apick.app/rest/geo_address_search
인증 헤더
Authorization: Bearer — 내 계정의 API 인증키
본문 형식
multipart/form-data
category 허용값
값
의미
auto
도로명·지번 결과를 합칩니다. 같은 필지는 한 번만 담습니다 (기본값).
road
도로명 주소 결과만 받습니다.
parcel
지번 주소 결과만 받습니다.

숫자(number·integer)·참거짓(boolean) 항목에 형식이 맞지 않는 값을 보내면 처리 전에 HTTP 400으로 거절되며 과금되지 않습니다. 참거짓 값은 true·false(또는 1·0)로 보냅니다.

요청 예시

성공 시 과금되는 실제 요청입니다.

사용 예시

상황별로 보내는 값과 응답에서 확인할 값을 모았습니다. 언어 탭에서 그대로 복사해 쓸 수 있습니다.

예시 1. 도로명 주소 검색

주소 입력 화면에서 사용자가 입력한 도로명으로 후보를 찾습니다.

요청POST/rest/geo_address_search
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를 넘겨 더 받습니다.

요청POST/rest/geo_address_search
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보다 적으면 마지막 페이지입니다.

응답 처리

HTTP 성공과 업무 결과를 구분하세요. 경로별 응답 필드와 예시는 위 요청과 응답에 함께 있습니다.

{
  "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.query
string
공백을 정리한 검색어입니다.
data.category
string
적용한 검색 범위입니다.
data.page.current
integer
현재 페이지입니다.
data.page.size
integer
페이지당 결과 수입니다.
data.page.total
integer
전체 결과 수입니다. 알 수 없으면 null입니다.
data.count
integer
이번 응답의 결과 수입니다.
data.items[].index
integer
이번 응답 안에서의 순서(0부터)입니다.
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
이 결과의 주소 유형(road·parcel)입니다.
data.items[].point.x
number
경도입니다.
data.items[].point.y
number
위도입니다.
data.items[].codes.pnu
string
필지번호 19자리입니다.
data.items[].codes.bjdongCode
string
법정동코드 10자리입니다.
data.items[].codes.lawdCd
string
시군구 단위 지역코드 5자리입니다.
api.cost
integer
차감된 포인트입니다. 실패한 응답은 0입니다.
api.ms
integer
처리 시간(밀리초)입니다.

오류 코드

응답을 아래 순서로 확인하세요. 결과 유무와 과금 여부는 서로 다릅니다.

  1. HTTP 상태전송·인증·입력 오류
  2. api.successAPI 처리 여부
  3. data · result업무 결과와 오류 문구
  4. api.cost이번 요청의 과금
업무 실패 응답 data.error
  • 입력값이 맞지 않거나 대상 자료가 없거나 일시적으로 처리하지 못하면 data.error(사유 문구)와 data.success=0을 돌려줍니다. HTTP 상태는 사유에 따라 400·404·408·424 중 하나입니다.
  • 이때 api.cost는 0이며 과금되지 않습니다. data.error 문구를 그대로 기록하고 사용자에게 보여 주세요.
  • 입력 오류(400)는 값을 고친 뒤 다시 요청하세요. 408·424는 잠시 후 한 번 다시 시도하고, 같은 입력으로 짧은 간격의 자동 반복은 하지 마세요.
{
  "data": {
    "error": "입력값을 확인해 주세요.",
    "success": 0
  },
  "api": {
    "success": true,
    "cost": 0,
    "ms": 5
  }
}
서비스 코드·조건

오류와 복구

아래 경우는 data.error로 응답하며 과금되지 않습니다(api.cost 0). 실패 응답은 표의 HTTP 상태 코드와 함께 옵니다. 화면에 보여 줄 안내는 본문의 data.error를 쓰고, 성공 여부는 data.error가 있는지로 판단하세요.

상황
HTTP
data.error
해결
검색어 누락
400
검색어가 필요합니다.
query를 보냅니다.
검색어 길이 초과
400
검색어가 너무 깁니다.
표의 최대 길이 안으로 줄입니다.
category 값 오류
400
category는 auto·road·parcel 중 하나입니다.
auto·road·parcel 중 하나로 보내거나 생략합니다.
검색 결과 없음
404
입력한 위치를 찾지 못했습니다.
검색어를 줄이거나 시도·시군구 이름을 더해 다시 검색합니다.
처리 시간 초과
408
처리 시간이 초과됐습니다. 범위를 줄여 다시 시도해 주세요.
목록 건수·반경·분류 수를 줄여 다시 요청합니다.
일시적 조회 실패
424
공간정보를 일시적으로 가져오지 못했습니다. 잠시 후 다시 시도해 주세요.
잠시 후 같은 요청을 다시 보냅니다.
인증·포인트 오류 result.error 문구
코드
HTTP
의미·조치
유효하지 않은 API키 입니다.
401
Authorization: Bearer 헤더의 인증키를 확인하세요.
허용되지 않은 IP주소 입니다.
401
마이페이지의 허용 IP 설정과 요청 서버 IP를 확인하세요.
비활성화된 계정입니다.
401
계정 이용 상태를 고객지원으로 문의하세요.
사용 가능한 포인트이 부족합니다.
200
HTTP 200이어도 result.error가 있으면 실패입니다. 포인트를 충전한 뒤 다시 요청하세요. 이 응답은 과금되지 않습니다.
인증 정보를 확인할 수 없습니다.
424
일시적인 확인 실패입니다. 잠시 후 다시 시도하세요.
폼 입력 오류 error.code
코드
HTTP
의미·조치
FORM_DATA_INVALID
400
필드 이름·값의 타입·배열 인덱스를 확인하세요. 인덱스는 0부터 연속으로 사용합니다.
FORM_DATA_FIELD_CONFLICT
400
같은 값과 중첩 경로를 동시에 지정하지 마세요.
MULTIPART_LIMIT_OR_PARSE_ERROR
400·413
boundary·파일 크기·필드 개수를 확인하세요. 서비스별 제한이 우선 적용됩니다.

요금·이용 조건

기본 요금기본 단가 20P · 건당

실제 차감 금액은 응답의 api.cost로 확인하세요. 상세 요금은 요금정책에서 볼 수 있습니다.

연동 팁

  • 요청 예제의 오류 처리 포함 모드는 시간 제한과 업무 실패 판정을 함께 보여줍니다.
  • 인증키는 서버 환경변수에 두고 브라우저·앱에 넣지 마세요.
  • HTTP 성공과 업무 결과를 구분하고, 실패 응답의 오류 문구를 그대로 기록하세요.
추가 예제·서비스별 연동 안내

호출 예시

같은 요청을 JavaScript와 Python으로 옮긴 예시입니다. 키는 환경변수 APICK_API_KEY 에서 읽습니다.

JavaScript 예시
Python 예시

개발가이드 검색

API 이름·경로·파라미터·오류 코드로 찾을 수 있습니다.

표시 가격은 기본 단가입니다. 상세 과금 조건은 각 가이드에서 확인하세요.