공공데이터 API 인증키 얻기
이번 시간에는 데이터를 분석하기 위한 첫 단계로
공공데이터 포털에서 제공되는 공공데이터를 이용하기 위하여 API 인증키를 발급받는 방법을 알아보려고 합니다.
우선 공공데이터 포털에 접속하여 회원가입 후에 로그인을 합니다.
- 공공데이터 포털 : data.go.kr
검색창에서 '국토교통부_아파트매매' 를 입력합니다.
2건이 검색되네요.
국토교통부_아파트매매 실거래자료의 '활용신청' 버튼을 클릭합니다.
활용 목적을 작성하고, 라이선스 표시에서 '동의합니다' 의 체크박스를 클릭한 다음에 '활용신청' 버튼을 클릭합니다.
활용신청이 완료되면 아래 메시지 화면과 같이 표시됩니다.
마이패이지 > 데이터 활용 > Open API > 활용신청 현황 메뉴에서 검색 버튼을 클릭하시면 활용신청 건을 확인할 수 있습니다.
승인받은 '[승인] 국토교통부_아파트매매 실거래자료' 를 클릭하시면 상세 내용과 인증키 정보를 확인할 수 있습니다.
https://www.data.go.kr/catalog/15058747/openapi.json
{"name":"국토교통부_아파트매매 실거래자료","description":"부동산 거래신고에 관한 법률에 따라 신고된 주택의 실거래 자료를 제공","url":"https://www.data.go.kr/data/15058747/openapi.do","keywords":["주택,아파트,실거래가"],"license":"https://data.go.kr/ugs/selectPortalPolicyView.do","dateCreated":"2016-02-01","dateModified":"2023-04-20","datePublished":"2016-02-01","creator":{"name":"국토교통부","contactPoint":{"contactType":"거래신고관리부","telephone":"+82-0536638642","@type":"ContactPoint"},"@type":"Organization"},"distribution":[{"encodingFormat":"XML","contentUrl":"https://www.data.go.kr/data/15058747/openapi.do","@type":"DataDownload"}],"@context":"https://schema.org","@type":"Dataset"}
참고문서 : 국토교통부 실거래가 정보 오픈API 활용 가이드
아파트 매매 신고정보 조회 기술문서.hwp
0.06MB
ㅁ 상세기능정보
| 상세기능 번호 | 1 | 상세기능 유형 | 조회 (자료) |
| 상세기능명(국문) | 아파트 매매 신고정보 | ||
| 상세기능 설명 | 행정표준코드관리시스템(www.code.go.kr)의 법정동 코드 중 앞5자리(예시 : 서울 종로구 - 11110), 계약년월(예시 : 201801)로 해당 지역, 해당 기간의 아파트 매매 신고정보를 조회 | ||
| Call Back URL | http://openapi.molit.go.kr:8081/OpenAPI_ToolInstallPackage/service/rest/RTMSOBJSvc/getRTMSDataSvcAptTrade | ||
| 최대 메시지 사이즈 | [1000 bytes] | ||
| 평균 응답 시간 | [500] ms | 초당 최대 트랙잭션 | [30] tps |
ㅁ 요청 메시지 명세
| 항목명(영문) | 항목명(국문) | 항목 크기 |
항목 구분* |
샘플 데이터 |
항목설명 |
| LAWD_CD | 지역코드 | 5 | 1 | 11110 | 각 지역별 코드 행정표준코드관리시스템(www.code.go.kr)의 법정동코드 10자리 중 앞 5자리 |
| DEAL_YMD | 계약월 | 6 | 1 | 201512 | 실거래 자료의 계약년월(6자리) |
| serviceKey | 인증키 | 100 | 1 | 인증키 (URL Encode) |
공공데이터포털에서 발급받은 인증키 |
※ 항목구분 : 필수(1), 옵션(0), 1건 이상 복수건(1..n), 0건 또는 복수건(0..n)
ㅁ 응답 메시지 명세
| 항목명(영문) | 항목명(국문) | 항목설명 | 항목 크기 |
항목 구분 |
샘플데이터 |
| resultCode | 결과코드 | 결과코드 | 2 | 1 | 00 |
| resultMsg | 결과메세지 | 결과메세지 | 50 | 1 | NORMAL SERVICE. |
| Deal Amount | 거래금액 | 거래금액(만원) | 40 | 1 | 82,500 |
| Build Year | 건축년도 | 건축년도 | 4 | 1 | 2015 |
| Deal Year | 년 | 계약년도 | 4 | 1 | 2015 |
| Dong | 법정동 | 법정동 | 40 | 1 | 사직동 |
| Apartment Name | 아파트 | 아파트명 | 40 | 1 | 광화문풍림스페이스본(9-0) |
| Deal Month | 월 | 계약월 | 2 | 1 | 12 |
| Deal Day | 일 | 일 | 6 | 1 | 1 |
| Area for Exclusive Use | 전용면적 | 전용면적(㎡) | 20 | 1 | 94.51 |
| Jibun | 지번 | 지번 | 10 | 1 | 9 |
| Regional Code | 지역코드 | 지역코드 | 5 | 1 | 11110 |
| Floor | 층 | 층 | 4 | 1 | 11 |
| Cancel Deal Type | 해제여부 | 해제여부 | 1 | 0 | O |
| Cancel Deal Day | 해제사유발생일 | 해제사유발생일 | 8 | 0 | 21.01.27 |
| REQ GBN | 거래유형 | 중개 및 직거래 여부 | 10 | 1 | 중개거래 |
| Rdealer Lawdnm | 중개업소주소 | 시군구 단위 | 150 | 1 | 서울 서초구 |
※ 항목구분 : 필수(1), 옵션(0), 1건 이상 복수건(1..n), 0건 또는 복수건(0..n)
※ 신규 추가 항목은 빨간색으로 표시해 두었음
ㅁ 요청 / 응답 메시지 예
| 요청메시지 |
| http://openapi.molit.go.kr:8081/OpenAPI_ToolInstallPackage/service/rest/RTMSOBJSvc/getRTMSDataSvcAptTrade?LAWD_CD=11110&DEAL_YMD=201512&serviceKey=서비스키 |
| 응답 메시지 |
| <?xml version="1.0" encoding="UTF-8" standalone="true"?> <response> <header> <resultCode>00</resultCode> <resultMsg>NORMAL SERVICE.</resultMsg> </header> <body> <item> <거래금액>82,500</거래금액> <건축년도>2015</건축년도> <년>2015</년> <법정동>교남동</법정동> <아파트>광화문풍림스페이스본(9-0)</아파트> <월>12</월> <일>1</일> <전용면적>94.51</전용면적> <지번>9</지번> <지역코드>11110</지역코드> <층>11</층> <해제여부>O</해제여부> <해제사유발생일>20200221</해제사유발생일> <거래유형>중개거래</거래유형> <중개업소주소>서울 서초구</중개업소주소> </item> </body> </response> |
ㅁ Open API Error code
| 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나 도메인의 정보를 변경하기 위해 변경신청을 할 수 있습니다. |
활용신청 후에 API 조회하니 다음과 같이 에러가 발생하네요.
승인받은지 1시간은 지난거 같은데 계속 에러가 발생해서 공공데이터포털의 '자주하는 질문'에서 에러 코드를 찾아보니
정의된 에러 코드와 실제 발생된 에러 코드 내용이 다르네요.
https://www.data.go.kr/bbs/faq/selectFaqList.do
승인받는 시간이 좀더 필요한건지 기다려봐야 겠습니다.
'▶ 데이터분석 전문가' 카테고리의 다른 글
| 지오 코딩을 위한 카카오맵 API 키 얻기 (0) | 2023.05.29 |
|---|---|
| 데이터 분석을 위하여 R을 사용해볼까요? (0) | 2023.05.28 |
| 파이썬과 친해지기 (with Anaconda, JupyterLab) (0) | 2023.05.11 |
| 구글 바드 (Google Bard) - chatGPT와 비교 (0) | 2023.05.11 |
| 파이썬에서 텔레그램으로 문자 보내기 (0) | 2023.04.27 |
댓글