본문으로 건너뛰기

한국 주소

도로명·지번·우편번호·건물명으로 주소를 찾고, 주소를 좌표로, 좌표를 행정구역으로 바꾼다. 공급자가 달라도 같은 결과 모양이고, 공급자가 거부할 검색어는 묻기 전에 거른다

npm install @duolabs-deux/unit-kr-address

직접 넣어 보기

    찾은 주소가 없습니다

    환경변수

    이름설명
    JUSO_CONFM_KEY선택도로명주소 검색 API 승인키(주소기반산업지원서비스). juso 어댑터를 쓸 때
    KAKAO_REST_API_KEY선택카카오 개발자 앱의 REST API 키. kakao 어댑터를 쓸 때. 서버에서만 쓴다

    어댑터

    id종류설명
    juso실제행정안전부 도로명주소 검색. 주소 검색만 한다(좌표 없음). 한 쪽 최대 100건
    kakao실제카카오 로컬. 검색·주소 → 좌표·좌표 → 행정구역. 주소로 안 잡히는 건물·장소 이름은 키워드 검색으로 한 번 더 찾는다
    fake가짜키 없이 결정적으로 답한다. 가상 주소 여섯 개만 안다

    실패와 소비 앱이 할 일

    종류언제할 일
    invalid-input검색어가 너무 짧거나 길 때, 공급자가 거부할 글자가 있을 때, 좌표가 대한민국 밖일 때. 밖으로 나가지 않는다입력 칸에서 바로 알린다
    auth키가 없거나 맞지 않을 때, 승인 기간이 끝났을 때운영자에게 알린다. 주소를 손으로 적게 하는 길을 남긴다
    quota호출 한도를 넘었을 때캐시 TTL 을 늘리고, 타자마다 묻지 말고 잠깐 멈췄을 때 묻는다
    timeout공급자가 5초 안에 답하지 않을 때(1회 재시도 뒤)다시 시도하게 하거나 손으로 적게 한다
    upstream-down공급자 서버 오류timeout 과 같다
    unexpected응답 형식이 명세와 다를 때명세가 바뀌었는지 사람이 확인한다

    한도

    • juso 검색은 숫자만(우편번호만)으로는 찾지 못한다. 한글 40자·전체 80자, 숫자 10자리까지
    • juso 검색은 좌표를 주지 않는다. 좌표가 필요하면 kakao 어댑터를 쓴다
    • 카카오 주소 검색은 한 쪽 30건, 키워드 검색은 15건까지
    • 좌표 → 행정구역은 행정구역까지만 준다. 가장 가까운 번지 주소는 주지 않는다

    명세