PublicDataReader.kosis package

Submodules

PublicDataReader.kosis.kosis module

KOSIS Open API Python Module

class PublicDataReader.kosis.kosis.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)

Module contents