{"openapi":"3.0.3","info":{"title":"APICK 도로명주소 조회","version":"1.0.0","description":"주소 검색을 통해 도로명 주소를 조회합니다."},"servers":[{"url":"https://apick.app"}],"paths":{"/rest/search_juso":{"post":{"summary":"도로명주소 조회","description":"주소 검색을 통해 도로명 주소를 조회합니다.","security":[{"bearerAuth":[]}],"parameters":[],"responses":{"200":{"description":"서비스별 성공·처리 상태 응답","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"roadAddr":{"type":"string","description":"전체 도로명주소입니다(참고항목 포함)."},"roadAddrPart1":{"type":"string","description":"도로명주소(참고항목 제외)입니다. 상세주소를 붙여 저장할 때 씁니다."},"roadAddrPart2":{"type":"string","description":"도로명주소 참고항목입니다. 예: (가리봉동)."},"jibunAddr":{"type":"string","description":"지번주소입니다."},"engAddr":{"type":"string","description":"영문 도로명주소입니다."},"zipNo":{"type":"string","description":"우편번호(5자리)입니다."},"siNm":{"type":"string","description":"시도명입니다."},"sggNm":{"type":"string","description":"시군구명입니다."},"emdNm":{"type":"string","description":"읍면동명입니다."},"emdNo":{"type":"string","description":"읍면동 일련번호입니다."},"liNm":{"type":"string","description":"법정리명입니다. 없으면 빈 문자열입니다."},"rn":{"type":"string","description":"도로명입니다."},"rnMgtSn":{"type":"string","description":"도로명코드입니다."},"buldMnnm":{"type":"string","description":"건물본번입니다."},"buldSlno":{"type":"string","description":"건물부번입니다. 부번이 없으면 0입니다."},"udrtYn":{"type":"string","description":"지하 여부입니다. 0: 지상, 1: 지하."},"lnbrMnnm":{"type":"string","description":"지번 본번(번지)입니다."},"lnbrSlno":{"type":"string","description":"지번 부번(호)입니다. 부번이 없으면 0입니다."},"mtYn":{"type":"string","description":"산 여부입니다. 0: 대지, 1: 산."},"admCd":{"type":"string","description":"행정구역코드(10자리)입니다."},"bdMgtSn":{"type":"string","description":"건물관리번호(25자리)입니다. 건물을 하나로 식별하는 값이라 주소 중복 판정에 씁니다."},"bdNm":{"type":"string","description":"건물명입니다. 없으면 빈 문자열입니다."},"detBdNmList":{"type":"string","description":"상세건물명(동 이름 등)입니다. 여러 개면 쉼표로 이어집니다."},"bdKdcd":{"type":"string","description":"공동주택 여부입니다. 1: 공동주택, 0: 비공동주택."}}},"description":"이번 페이지의 주소 목록(최대 10건)입니다."},"total_count":{"type":"integer","description":"전체 검색 결과 건수입니다. 마지막 페이지는 ceil(total_count / 10)입니다."},"success":{"type":"integer"}}},"api":{"type":"object","properties":{"success":{"type":"boolean"},"cost":{"type":"integer","description":"차감된 포인트입니다. 실패하면 0 입니다."},"ms":{"type":"integer"},"pl_id":{"type":"integer"}}}}}}}},"default":{"description":"HTTP 상태 및 서비스 오류코드 확인","content":{"application/json":{"schema":{"type":"object"}}}}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"juso":{"type":"string","description":"검색할 주소 키워드입니다. 도로명·지번·건물명 일부를 입력하며, 예: 디지털로. 너무 짧으면 결과가 많아집니다. (string)","example":"디지털로"},"page":{"type":"string","description":"검색 결과 조회 페이지 (기본값 1, 페이지당 10건) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. (string)","example":"1"}},"required":["juso"]}}}}}}},"x-code-tables":[{"title":"오류 코드","columns":["data.error","의미","대처"],"rows":[["페이지 번호는 숫자만 입력할 수 있습니다.","page가 1 이상의 정수가 아닙니다.","숫자로 고쳐 다시 요청합니다."],["잘못된 검색어를 입력했습니다.","검색어가 비었거나, 너무 짧거나, 특수문자만 있거나, 조회에 실패했습니다.","도로명·지번·건물명이 들어간 검색어로 다시 요청합니다. 과금되지 않습니다."]]}],"x-service-errors":[],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}}