반응형
| 국토교통부 실거래가 정보 오픈API 활용 가이드 - 아파트 전월세 신고정보 조회 - |
| Ⅰ | 서비스 명세 |
공공데이터 OpenAPI 조회 서비스
가. API 서비스 개요
| API 서비스 정보 | API명(영문) | Apartment Rent Data | ||
| API명(국문) | 아파트 전월세 자료 | |||
| API 설명 | 지역코드와 기간을 설정하여 해당지역, 해당기간의 아파트 전월세 신고 자료를 제공하는 아파트 전월세 신고 정보 조회 | |||
| API 서비스 보안적용 기술 수준 | 서비스 인증/권한 | [O] Service Key [ ] 인증서 (GPKI/NPKI) [ ] BASID(IP/PW) [ ] 없음 |
||
| 메시지 레벨 암호화 | [ ] 전자서명 [ ] 암호화 [O] 없음 | |||
| 전송 레벨 암호화 | [ ] SSL [O] 없음 | |||
| 인터페이스 표준 | [ ] SOAP 1.2 (RPC-Encoded, Document Literal, Document Literal Wrapped) [O] REST (GET) [ ] RSS 1.0 [ ] RSS 2.0 [ ]ATOM 1.0 [ ] 기타 |
|||
| 교환 데이터 표준 (중복선택가능) |
[O] XML [ ] JSON [ ] MINE [ ] MTOM | |||
| API 서비스 배포정보 | 서비스 URL | http://openapi.molit.go.kr:8081/OpenAPI_ToolInstallPackage/service/rest/RTMSOBJSvc/getRTMSDataSvcAptRent | ||
| 서비스 명세 URL (WSDL 또는 WADL) |
http://openapi.molit.go.kr:8081/OpenAPI_ToolInstallPackage/service/rest/RTMSOBJSvc/getRTMSDataSvcAptRent?_wadl&type=xml | |||
| 서비스 버전 | 1.0 | |||
| 서비스 시작일 | 2016.02.01 | 서비스 배포일 | 2016.02.01 | |
| 서비스 이력 | ||||
| 메시지 교환유형 | [O] Request-Response [ ] Publish-Subscribe [ ] Fire-and-Forgot [ ] Notification |
|||
| 서비스 제공자 | ||||
| 데이터 갱신주기 | 일 1회 | |||
나. 상세기능 목록
| 번호 | API명(국문) | 상세기능명(영문) | 상세기능명(국문) |
| 1 | 아파트 전월세 자료 | getRTMSDataSvcAptRent | 아파트 전월세 신고정보 |
다. 상세기능내역
a) 상세기능정보
| 상세기능 번호 | 1 | 상세기능 유형 | 조회 (자료) |
| 상세기능명(국문) | 아파트 전월세 신고정보 | ||
| 상세기능 설명 | 행정표준코드관리시스템(www.code.go.kr)의 법정동 코드 중 앞5자리(예시 : 서울 종로구 - 11110), 계약년월(예시 : 201801)로 해당 지역, 해당 기간의 아파트 전월세 신고정보를 조회 | ||
| Call Back URL | http://openapi.molit.go.kr:8081/OpenAPI_ToolInstallPackage/service/rest/RTMSOBJSvc/getRTMSDataSvcAptRent | ||
| 최대 메시지 사이즈 | [1000 bytes] | ||
| 평균 응답 시간 | [500] ms | 초당 최대 트랙잭션 | [30] tps |
b) 요청 메시지 명세
| 항목명(영문) | 항목명(국문) | 항목 크기 |
항목 구분* |
샘플 데이터 |
항목설명 |
| LAWD_CD | 지역코드 | 5 | 1 | 11110 | 각 지역별 코드 행정표준코드관리시스템(www.code.go.kr)의 법정동코드 10자리 중 앞 5자리 |
| DEAL_YMD | 계약월 | 6 | 1 | 202201 | 실거래 자료의 계약년월(6자리) |
| serviceKey | 인증키 | 100 | 1 | 인증키 (URL Encode) |
공공데이터포털에서 발급받은 인증키 |
※ 항목구분 : 필수(1), 옵션(0), 1건 이상 복수건(1..n), 0건 또는 복수건(0..n)
c) 응답 메시지 명세
| 항목명(영문) | 항목명(국문) | 항목설명 | 항목크기 | 항목구분 | 샘플데이터 |
| resultCode | 결과코드 | 결과코드 | 2 | 1 | 00 |
| resultMsg | 결과메세지 | 결과메세지 | 50 | 1 | NORMAL SERVICE. |
| Use Request Renewal Contract Right | 갱신요구권사용 | 갱신요구권사용 | 10 | 0 | 사용 |
| Build Year | 건축년도 | 건축년도 | 4 | 1 | 1993 |
| Contract Type | 계약구분 | 계약구분 | 10 | 0 | 갱신 |
| Term of Contract | 계약기간 | 계약기간 | 20 | 0 | 22.02~24.02 |
| Deal Year | 년 | 계약년도 | 4 | 1 | 2022 |
| Dong | 법정동 | 법정동 | 40 | 1 | 창신동 |
| Deposit | 보증금액 | 보증금(만원) | 10 | 1 | 28,300 |
| Apartment Name | 아파트 | 아파트명 | 40 | 1 | 창신쌍용2 |
| Deal Month | 월 | 계약월 | 2 | 1 | 1 |
| Monthly Rent | 월세금액 | 월세(만원) | 10 | 1 | 0 |
| Deal Day | 일 | 일 | 6 | 1 | 26 |
| Area for Exclusive Use | 전용면적 | 전용면적(㎡) | 20 | 1 | 54.7 |
| Previous Deposit | 종전계약보증금 | 종전계약보증금 | 20 | 0 | 27,000 |
| Previous Monthly Rent | 종전계약월세 | 종전계약월세 | 20 | 0 | 0 |
| Jibun | 지번 | 지번 | 10 | 1 | 703 |
| Regional Code | 지역코드 | 지역코드 | 5 | 1 | 11110 |
| Floor | 층 | 층 | 4 | 1 | 3 |
※ 항목구분 : 필수(1), 옵션(0), 1건 이상 복수건(1..n), 0건 또는 복수건(0..n)
d) 요청/응답 메시지 예제
| 요청메시지 |
| http://openapi.molit.go.kr:8081/OpenAPI_ToolInstallPackage/service/rest/RTMSOBJSvc/getRTMSDataSvcAptRent?LAWD_CD=11110&DEAL_YMD=201512&serviceKey=서비스키00 |
| 응답 메시지 |
| <?xml version="1.0" encoding="UTF-8" standalone="true"?> <response> <header> <resultCode>00</resultCode> <resultMsg>NORMAL SERVICE.</resultMsg> </header> <body> <item> <갱신요구권사용>사용</갱신요구권사용> <건축년도>1993</건축년도> <계약구분>갱신</계약구분> <계약기간>22.02~24.02</계약기간> <년>2022</년> <법정동> 창신동</법정동> <보증금액> 28,300</보증금액> <아파트>창신쌍용2</아파트> <월>1</월> <월세금액> 0</월세금액> <일>26</일> <전용면적>54.7</전용면적> <종전계약보증금> 27,000</종전계약보증금> <종전계약월세> 0</종전계약월세> <지번>703</지번> <지역코드>11110</지역코드> <층>3</층> </item> </body> </response> |
OpenAPI 에러 코드정리
OPEN API 에러 코드 별 조치방안
| code | 코드값 | 설명 | 조치방안 |
| 01 | Application Error | 제공기관 서비스 제공 상태가 원활하지 않습니다. | 서비스 제공기관의 관리자에게 문의하시기 바랍니다. |
| 02 | DB Error | 제공기관 서비스 제공 상태가 원활하지 않습니다. | 서비스 제공기관의 관리자에게 문의하시기 바랍니다. |
| 03 | No Data | 데이터없음 에러 | |
| 04 | HTTP Error | 제공기관 서비스 제공 상태가 원활하지 않습니다. | 서비스 제공기관의 관리자에게 문의하시기 바랍니다. |
| 05 | service time out | 제공기관 서비스 제공 상태가 원활하지 않습니다. | 서비스 제공기관의 관리자에게 문의하시기 바랍니다. |
| 10 | 잘못된 요청 파라미터 에러 | OpenApi 요청시 ServiceKey 파라미터가 없음 | •OpenAPI 요청 값에서 ServiceKey 파라미터가 누락되었습니다. •OpenAPI 요청 URL을 확인하시기 바랍니다. |
| 11 | 필수 요청 파라미터가 없음 | 요청하신 OpenApi의 필수 파라미터가 누락되었습니다. | 기술문서를 다시 한번 확인하시어 주시기 바랍니다. |
| 12 | 해당 오픈 API 서비스가 없거나 폐기됨 | OpenApi 호출시 URL이 잘못됨 | •제공기관 관리자에게 폐기된 서비스인지 확인합니다. 폐기된 서비스가 아니면 개발가이드에서 OpenApi 요청 URL을 다시 확인하시기 바랍니다. |
| 20 | 서비스 접근 거부 | 활용승인이 되지 않은 OpenApi 호출 | •OpenApi활용 신청정보의 승인상태를 확인하시기 바랍니다. •활용신청에 대해 제공기관 담당자가 확인 후 ‘승인’이후부터 사용할 수 있습니다. •신청 후 2~3일이 소요되고 결과는 회원가입 시 등록한 e-mail로 발송합니다. |
| 22 | 서비스 요청 제한 횟수 초과 에러 | 일일 활용건수가 초과함 (활용건수 증가 필요) |
•OpenAPI 활용신청정보의 서비스 상세기능별 일일트랙픽량을 확인하시기 바랍니다. •개발계정의 경우 제공기관에서 정의한 트래픽을 초과하여 활용할 수 없습니다. •운영계정의 경우 변경신청을 통해서 일일트래픽량을 변경할 수 있습니다. |
| 30 | 등록되지 않은 서비스키 | 잘못된 서비스키를 사용하였거나 서비스키를 URL 인코딩하지 않음 | •OpenAPI 활용신청정보의 발급받은 서비스키를 다시 확인하시기 바랍니다. •서비스키 값이 같다면 서비스키가 URL 인코딩 되었는지 다시 확인하시기 바랍니다. |
| 31 | 기간 만료된 서비스키 | OpenApi 사용기간이 만료됨 (활용연장신청 후 사용가능) |
•OpenAPI 활용신청정보의 활용기간을 확인합니다. •활용기간이 지난 서비스는 이용할 수 없으며 연장신청을 통해 승인받은 후 다시 이용이 가능합니다. |
| 32 | 등록되지 않은 도메인명 또는 IP 주소 | 활용신청한 서버의 IP와 실제 OpenAPI호출한 서버가 다를 경우 | •OpenAPI활용신청정보의 등록된 도메인명이나 IP주소를 다시 확인합니다. •IP나 도메인의 정보를 변경하기 위해 변경신청을 할 수 있습니다. |
반응형
'IT와 보안 그 어디 쯤 > 웹프로그래밍_끄적이기' 카테고리의 다른 글
| 코인자동매매 프로그램 - 업비트 용. 텔레그램봇 - 테스트용 (0) | 2024.08.18 |
|---|---|
| REST API (0) | 2023.06.02 |
| 국토교통부 실거래가 정보 오픈API 활용 가이드연립다세대 전월세 신고정보 조회 - (0) | 2023.05.23 |
| 국토교통부 실거래가 정보 오픈API 활용 가이드- 아파트 매매 신고 상세자료 조회 - (0) | 2023.05.23 |
| 국토교통부 실거래가 정보 오픈API 활용 가이드- 연립다세대 매매 신고정보 조회 - (0) | 2023.05.23 |