PublicDataReader package

Subpackages

Submodules

PublicDataReader.data module

Module contents

class PublicDataReader.Building(serviceKey=None, debug=False)

기반 클래스: object

(Deprecated) 건축물대장정보 서비스

공공 데이터 포털에서 발급받은 Service Key를 입력받아 초기화합니다.

매개변수

  • serviceKey (서비스 인증키 문자열) –

  • debug (True이면 모든 로깅 메시지 출력, False이면 에러 로깅 메시지만 출력) –

ChangeCols(df, category)

영문 컬럼명을 국문 컬럼명으로 변경

read_data(category, **kwargs)

데이터 조회

매개변수

category (오퍼레이션 종류 (ex. 기본개요, 총괄표제부, 표제부, 층별개요, 부속지번, 전유공용면적, 오수정화시설, 주택가격, 전유부, 지역지구구역)) –

class PublicDataReader.BuildingLedger(service_key=None)

기반 클래스: object

국토교통부 건축물대장 정보 조회 클래스

매개변수

service_key (str) – 국토교통부 API 서비스키

get_data(ledger_type, sigungu_code, bdong_code, bun=None, ji=None, translate=True, verbose=False, wait_time=30, **kwargs)

건축물대장 정보 조회

매개변수

  • ledger_type (str) – 건축물대장 유형 (ex. 기본개요, 총괄표제부, 표제부, 층별개요, 부속지번, 전유공용면적, 오수정화시설, 주택가격, 전유부, 지역지구구역)

  • sigungu_code (str) – 시군구 코드 (ex. 11110)

  • bdong_code (str) – 법정동 코드 (ex. 1111051500)

  • bun (str) – 번 (ex. 200)

  • ji (str) – 지 (ex. 5)

  • translate (bool) – 한글 컬럼명으로 변환 여부 (기본값: True)

  • verbose (bool) – 진행 상황 출력 여부 (기본값: False)

  • wait_time (int) – API 요청 간의 대기 시간 (초) (기본값: 30초)

  • **kwargs (dict) – API 요청에 필요한 추가 인자

translate_columns(df)

영문 컬럼명을 한글로 변경

class PublicDataReader.Kamco(service_key=None)

기반 클래스: object

KAMCO Open API 클래스

get_data(service, function, **kwargs)
class PublicDataReader.Kbland

기반 클래스: object

get_apartment_mortgage_loan_pir(**kwargs)

주택가격동향조사 - 소득연계 - KB아파트주택담보대출 PIR

매개변수

**kwargs (dict) – 그 외 필요한 파라미터 기간 : str

get_average_price(매물종별구분, 매매전세코드, **kwargs)

주택가격동향조사 - 평균가격

매개변수

  • 매물종별구분 (str) – 매물종별구분 01: 아파트 08: 연립 09: 단독 98: 주택종합

  • 매매전세코드 (str) – 매매전세코드 01: 매매 02: 전세

get_average_price_by_area(매매전세코드, 면적별코드, **kwargs)

주택가격동향조사 - 면적별 평균가격

매개변수

  • 매매전세코드 (str) – 매매전세코드 01: 매매 02: 전세

  • 면적별코드 (str) – 면적별코드 01: 전용면적별(구) 02: 전용면적별

get_average_price_by_quintile(메뉴코드, 매매전세코드, **kwargs)

주택가격동향조사 - 5분위 평균가격

매개변수

  • 메뉴코드 (str) – 메뉴코드 01: 아파트 평균가격 02: 주택종합 평균가격 08: 아파트 ㎡당 평균가격

  • 매매전세코드 (str) – 매매전세코드 01: 매매 02: 전세

get_average_price_per_squaremeter(매물종별구분, 매매전세코드, **kwargs)

주택가격동향조사 - ㎡당 평균가격

매개변수

  • 매물종별구분 (str) – 매물종별구분 01: 아파트 08: 연립 09: 단독 98: 주택종합

  • 매매전세코드 (str) – 매매전세코드 01: 매매 02: 전세

get_hai(**kwargs)

주택가격동향조사 - 소득연계 - 주택구매력지수

매개변수

**kwargs (dict) – 그 외 필요한 파라미터 기간 : str

get_jeonse_price_ratio(매물종별구분, **kwargs)

KB통계 - 주택가격동향조사 - 전세가격비율

매개변수

  • 매물종별구분 (str) – 매물종별구분 01: 아파트 08: 연립 09: 단독 98: 주택종합

  • **kwargs (dict) – 그 외 필요한 파라미터 지역코드 : str

get_jeonwolse_conversion_rate(**kwargs)

KB통계 - 주택가격동향조사 - 전월세전환율

매개변수

**kwargs (dict) – 선택 파라미터

get_kb_housing_purchase_potential_index(**kwargs)

주택가격동향조사 - 소득연계 - KB주택구입잠재력지수

매개변수

**kwargs (dict) – 그 외 필요한 파라미터 기간 : str

get_lead_apartment_50_index(**kwargs)

KB통계 - 주택가격동향조사 - KB선도아파트 50 지수

매개변수

**kwargs (dict) – 선택 파라미터

get_market_trend(메뉴코드, 월간주간구분코드, **kwargs)

KB통계 - 주택가격동향조사 - 시장동향/설문조사

매개변수

  • 메뉴코드 (str) – 메뉴코드 01: 매수우위지수 02: 매매거래활발지수 03: 전세수급지수 04: 전세거래활발지수 05: 매매가격전망지수 06: 전세가격전망지수

  • 월간주간구분코드 (str) – 월간주간구분코드 01: 월간 02: 주간

  • **kwargs (dict) – 그 외 선택 파라미터 기간: str

get_median_household_monthly_income(**kwargs)

(비노출) 주택가격동향조사 - 소득연계 - 중위가구월소득금액

매개변수

**kwargs (dict) – 그 외 필요한 파라미터 기간 : str

get_median_price(매물종별구분, 매매전세코드, **kwargs)

주택가격동향조사 - 중위가격

매개변수

  • 매물종별구분 (str) – 매물종별구분 01: 아파트 08: 연립 09: 단독 98: 주택종합

  • 매매전세코드 (str) – 매매전세코드 01: 매매 02: 전세

get_monthly_apartment_wolse_index(**kwargs)

KB통계 - 주택가격동향조사 - 월간 아파트 월세가격지수

매개변수

**kwargs (dict) – 선택 파라미터

get_pir(메뉴코드, **kwargs)

주택가격동향조사 - 소득연계 - PIR 및 J-PIR

매개변수

  • 메뉴코드 (str) – 메뉴코드 01: PIR 02: J-PIR

  • **kwargs (dict) – 그 외 필요한 파라미터 기간 : str

get_price_index(월간주간구분코드, 매물종별구분, 매매전세코드, **kwargs)

KB통계 - 주택가격동향조사 - 가격지수

매개변수

  • 월간주간구분코드 (str) – 월간주간구분코드 01: 월간 02: 주간

  • 매물종별구분 (str) – 매물종별구분 01: 아파트 08: 연립 09: 단독 98: 주택종합

  • 매매전세코드 (str) – 매매전세코드 01: 매매 02: 전세

  • **kwargs (dict) – 그 외 필요한 파라미터 지역코드 : str

get_price_index_by_area(월간주간구분코드, 매물종별구분, 면적별코드, 매매전세코드, **kwargs)

주택가격동향조사 - 면적별 가격지수

매개변수

  • 월간주간구분코드 (str) – 월간주간구분코드 01: 월간 02: 주간

  • 매물종별구분 (str) – 매물종별구분 01: 아파트 08: 연립 09: 단독 98: 주택종합

  • 면적별코드 (str) – 면적별코드 01: 전용면적별(구) 02: 전용면적별

  • 매매전세코드 (str) – 매매전세코드 01: 매매 02: 전세

  • **kwargs (dict) – 그 외 필요한 파라미터 기간 : str

get_price_index_change_rate(월간주간구분코드, 매물종별구분, 매매전세코드, **kwargs)

KB통계 - 주택가격동향조사 - 가격지수증감률

매개변수

  • 월간주간구분코드 (str) – 월간주간구분코드 01: 월간 02: 주간

  • 매물종별구분 (str) – 매물종별구분 01: 아파트 08: 연립 09: 단독 98: 주택종합

  • 매매전세코드 (str) – 매매전세코드 01: 매매 02: 전세

  • **kwargs (dict) – 그 외 필요한 파라미터 지역코드 : str

class PublicDataReader.Kosis(apiKey, serviceName)

기반 클래스: object

KOSIS 공유서비스 클래스

KOSIS 공유서비스에서 발급받은 사용자 인증키를 입력받아 초기화합니다.

매개변수

  • apiKey (str) – KOSIS 공유서비스에서 발급받은 사용자 인증키

  • serviceName (str) – KOSIS 공유서비스 서비스명

예제

>>> import PublicDataReader as pdr
>>> # KOSIS 공유서비스 OPEN API 인스턴스 생성
>>> apiKey = "YOUR_API_KEY"
>>> serviceName = "KOSIS통합검색" # (예시) KOSIS통합검색, 통계설명, 통계표설명, 통계목록, 통계자료
>>> kosis = pdr.Kosis(apiKey, serviceName)
get_data(**kwargs)

API 호출

KOSIS 공유서비스 API를 호출하여 데이터를 반환합니다.

매개변수

**kwargs (dict) – API 호출에 필요한 파라미터

반환

API 호출 결과를 DataFrame 형태로 반환합니다.

반환 형식

DataFrame

예제

>>> import PublicDataReader as pdr
>>> # KOSIS 공유서비스 OPEN API 인스턴스 생성
>>> apiKey = "YOUR_API_KEY"
>>> serviceName = "KOSIS통합검색"
>>> kosis = pdr.Kosis(apiKey, serviceName)
>>> # 파라미터 설정
>>> orgId = "101"
>>> tblId = "DT_1B040A3"
>>> metaItm = "ALL"
>>> # 데이터 조회
>>> df = kosis.get_data(orgId=orgId, tblId=tblId, metaItm=metaItm)
class PublicDataReader.Nts(service_key=None)

기반 클래스: object

NTS Open API 클래스

status(b_no)

사업자등록정보 상태조회 API

매개변수

b_no (list) – 사업자등록번호 (1회 호출 시 최대 100개까지 조회 가능)

반환

상태조회 결과

반환 형식

DataFrame

validate(businesses)

사업자등록정보 진위확인 API

매개변수

businesses (list, DataFrame) – 사업자등록정보 리스트 (1회 호출 시 최대 100개까지 조회 가능)

반환

진위확인 결과

반환 형식

DataFrame

class PublicDataReader.SmallShop(service_key=None)

기반 클래스: object

get_data(service_name, key=None, divId=None, radius=None, cx=None, cy=None, minx=None, miny=None, maxx=None, maxy=None, translate=True, verbose=False, **kwargs)
translate_columns(df)

영문 컬럼명을 한글로 변경

class PublicDataReader.StoreInfo(serviceKey=None, debug=False)

기반 클래스: object

소상공인 상가업소 정보 조회 클래스

공공 데이터 포털에서 발급받은 Service Key를 입력받아 초기화합니다.

매개변수

  • serviceKey (서비스 인증키 문자열) –

  • debug (True이면 모든 로깅 메시지 출력, False이면 에러 로깅 메시지만 출력) –

ChangeCols(df)

영문 컬럼명을 국문 컬럼명으로 변경

read_data(category, **kwargs)

데이터 조회

매개변수

category (오퍼레이션 종류 (ex. 지정상권, 반경상권, 사각형상권, 행정구역상권 등)) –

class PublicDataReader.Transaction(serviceKey=None, debug=False)

기반 클래스: object

(Deprecated) 부동산 실거래가 조회 클래스

공공 데이터 포털에서 발급받은 Service Key를 입력받아 초기화합니다.

매개변수

  • serviceKey (서비스 인증키 문자열) –

  • debug (True이면 모든 로깅 메시지 출력, False이면 에러 로깅 메시지만 출력) –

collect_data(prod, trans, sigunguCode, startYearMonth, endYearMonth)

기간별 조회

매개변수

  • prod (상품유형 (ex.아파트, 오피스텔, 단독다가구, 연립다세대, 토지, 상업업무용, 공장창고등)) –

  • trans (매매, 전월세) –

  • sigunguCode (시군구코드(5자리)) –

  • startYearMonth (조회시작 계약년월("YYYYmm")) –

  • endYearMonth (조회종료 계약년월("YYYYmm")) –

read_data(prod, trans, sigunguCode, yearMonth)

월별 조회

매개변수

  • prod (상품유형 (ex.아파트, 오피스텔, 단독다가구, 연립다세대, 토지, 상업업무용, 공장창고등)) –

  • trans (매매, 전월세) –

  • sigunguCode (시군구코드(5자리)) –

  • yearMonth (계약년월("YYYYmm")) –

class PublicDataReader.TransactionPrice(service_key=None)

기반 클래스: object

국토교통부 부동산 실거래가 조회 클래스

매개변수

service_key (str) – 국토교통부 Open API 서비스키

get_data(property_type, trade_type, sigungu_code, year_month=None, start_year_month=None, end_year_month=None, verbose=False, **kwargs)

부동산 실거래가 조회

매개변수

  • property_type (str) – 부동산 이름 (ex. 아파트, 오피스텔, 단독다가구, 연립다세대, 토지, 분양입주권, 공장창고등)

  • trade_type (str) – 거래 유형 (ex. 매매, 전월세)

  • sigungu_code (str) – 시군구코드 (ex. 11110)

  • year_month (str, optional) – 조회할 연월 (ex. 201901), by default None

  • start_year_month (str, optional) – 조회할 시작 연월 (ex. 201901), by default None

  • end_year_month (str, optional) – 조회할 종료 연월 (ex. 201901), by default None

  • verbose (bool, optional) – 진행 상황 출력 여부, by default False

  • **kwargs (dict) – API 요청에 필요한 추가 인자

class PublicDataReader.Transportation(serviceKey, debug=False)

기반 클래스: object

서울 열린데이터 광장 교통 관련 정보 조회 클래스

서울 열린데이터 광장에서 발급받은 Service Key를 입력받아 초기화합니다.

매개변수

  • serviceKey (서비스 인증키 문자열) –

  • debug (True이면 모든 로깅 메시지 출력, False이면 에러 로깅 메시지만 출력) –

ChangeCols(df)

영문 컬럼명을 국문 컬럼명으로 변경

read_data(category, **kwargs)

데이터 조회

class PublicDataReader.VworldData(apiKey)

기반 클래스: object

Vworld 데이터 API 클래스

Vworld에서 발급받은 API 서비스 인증키를 입력받아 초기화합니다.

매개변수

apiKey (str) – Vworld Open API 서비스 인증키

get_data(**kwargs)

API 호출

매개변수

**kwargs (dict) – API 호출에 필요한 파라미터를 입력합니다. API 호출에 필요한 파라미터는 Vworld Open API 문서를 참고하세요. https://www.vworld.kr/dev/v4dv_2ddataguide2_s001.do

반환

API 호출 결과를 반환합니다.

반환 형식

dict

PublicDataReader.code_bdong()

법정동코드(실제주소) 데이터 반환

PublicDataReader.code_hdong()

행정기관코드(행정동) 데이터 반환

PublicDataReader.code_hdong_bdong()

행정기관코드 + 관할 법정동코드 데이터 반환

PublicDataReader.get_vworld_data_api_info_by_dataframe()

vworld 코드 데이터 반환

PublicDataReader.get_vworld_data_api_info_by_dict()

vworld 코드 테이블 반환