PublicDataReader

https://github.com/wooiljeong/publicdatareader
Admin
PublicDataReader is an open-source Python library that automatically retrieves public data from...
Tokens:213,396
Snippets:785
Trust Score:8.8
License:MIT
Update:6 months ago
Show doc for...
Tokens:
Raw
### Housing License - Get Data (Multiple Service Types)

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/test_housing_license.ipynb

This section demonstrates how to use the HousingLicense API to retrieve different types of housing data by specifying the 'service_type' parameter. Examples include '행위호전유공용면적', '행위개요', '관리공동형별개요', and '관리공동부대복리시설'.

```APIDOC
## Housing License API Endpoints

### Get Housing Permit Data

This endpoint allows you to retrieve various types of housing permit data based on the `service_type`.

### Method
GET

### Endpoint
`/HousingLicense/getData`

### Parameters
#### Query Parameters
- **service_key** (string) - Required - Your service key from the Public Data Portal.
- **service_type** (string) - Required - The type of service data to retrieve. Examples: `행위호전유공용면적`, `행위개요`, `관리공동형별개요`, `관리공동부대복리시설`.
- **sigungu_code** (string) - Required - The SIGUNGGU (city/district) code.
- **bdong_code** (string) - Required - The BDONG (building dong) code.
- **bun** (string) - Required - The BUN (lot number).
- **ji** (string) - Optional - The JI (sub-lot number).

### Request Example (Python)
```python
from PublicDataReader import HousingLicense

# service_key = "공공 데이터 포털에서 발급받은 서비스 키"
api = HousingLicense(service_key)

df = api.get_data(
    service_type="행위호전유공용면적", 
    sigungu_code="41135", 
    bdong_code="11000", 
    bun="542", 
    ji="",
)
df.head(1)
```

### Response
#### Success Response (200)
Returns a pandas DataFrame containing the requested data. The columns depend on the `service_type` requested.

#### Example Response Structure (for `관리공동부대복리시설`)
```json
{
  "rnum": "1",
  "platPlc": "서울특별시 강남구 개포동 12번지",
  "sigunguCd": "11680",
  "bjdongCd": "10300",
  "platGbCd": "0",
  "bun": "12",
  "ji": "",
  "mgmCoophsrgstPk": "11680-17903",
  "splotNm": "",
  "block": "",
  "lot": "",
  "grndPklotUtcnt": "440",
  "ugrndPklotUtcnt": "71",
  "totPklotUtcnt": "511",
  "pkngCctvCnt": "0",
  "reprMtrmArea": "0",
  "mgmOffcArea": "135",
  "plgndCctvCnt": "0",
  "wttnkCapa": "4940",
  "lndscArea": "1043.4",
  "guardrmCnt": "14",
  "hsoldArea": "254.2",
  "lifeConvFcArea": "0",
  "nturFcArea": "197.53",
  "jmExcsFcCnt": "1",
  "kgtFlrCnt": "0",
  "kgtLotArea": "0",
  "kgtPurps": "",
  "mediFcArea": "0",
  "plgndCnt": "5",
  "crtnDay": "20100725"
}
```

### Error Handling
- **400 Bad Request**: Invalid input parameters.
- **401 Unauthorized**: Invalid service key.
- **500 Internal Server Error**: Server error.
```

--------------------------------

### Initialize PublicDataReader Environment

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/sample_kbland.ipynb

Sets up the Python environment by appending the parent directory to the system path and importing the necessary Kbland module.

```python
import os
import sys
from pathlib import Path
sys.path.append(str(Path(os.getcwd()).parent))
from PublicDataReader import Kbland
법정동코드 = "4121000000"
```

--------------------------------

### GET /bfmpub/huse/huseSplyArsltInqury

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/sample_kbland.ipynb

Retrieves housing supply performance data, including permits, construction starts, and completions.

```APIDOC
## GET /bfmpub/huse/huseSplyArsltInqury

### Description
Provides statistical data on housing supply performance based on supply stages or housing types.

### Method
GET

### Endpoint
https://data-api.kbland.kr/bfmpub/huse/huseSplyArsltInqury

### Parameters
#### Query Parameters
- **dtailDataSelct** (integer) - Required - 1: 전체, 2: 공급단계별, 3: 주택유형별
- **법정동코드** (string) - Required
- **splyStge** (string) - Optional - 01: 인허가, 02: 착공, 03: 분양, 04: 준공
- **husePtrn** (string) - Optional - 1: 아파트, 2: 비아파트
```

--------------------------------

### Initialize PublicDataReader Library

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/test_kosis.ipynb

This snippet demonstrates the initial setup for using the PublicDataReader library. It involves importing necessary modules, configuring the system path to include the library, and retrieving an API key from a configuration file.

```python
import os
import sys
from pathlib import Path
sys.path.append(str(Path(os.getcwd()).parent))
```

```python
from config import API_KEY_INFO
service_key = API_KEY_INFO.get("kosis")
```

--------------------------------

### Get Transaction Data by Date Range

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/portal/TransactionPrice.md

Retrieves real estate transaction data for a specified property type, trade type, region, and a date range (start and end year-month).

```APIDOC
## POST /api/get_data (TransactionPrice)

### Description
Retrieves real estate transaction data, such as property sales or leases, for a specified period and region.

### Method
POST

### Endpoint
/api/get_data

### Parameters
#### Query Parameters
- **property_type** (string) - Required - Type of property (e.g., "오피스텔", "아파트").
- **trade_type** (string) - Required - Type of transaction (e.g., "매매", "전월세").
- **sigungu_code** (string) - Required - The "sigungu" code for the desired region.
- **start_year_month** (string) - Required - The start of the period in 'YYYYMM' format.
- **end_year_month** (string) - Required - The end of the period in 'YYYYMM' format.

### Request Example
```python
from PublicDataReader import TransactionPrice

service_key = "YOUR_SERVICE_KEY"
api = TransactionPrice(service_key)

df = api.get_data(
    property_type="오피스텔",
    trade_type="매매",
    sigungu_code="11650",
    start_year_month="202201",
    end_year_month="202212",
)
print(df.tail())
```

### Response
#### Success Response (200)
- **df** (DataFrame) - A pandas DataFrame containing the transaction data. The columns include:
  - 지역코드 (string)
  - 시군구 (string)
  - 법정동 (string)
  - 지번 (string)
  - 단지 (string)
  - 건축년도 (integer)
  - 층 (integer)
  - 전용면적 (float)
  - 년 (integer)
  - 월 (integer)
  - 일 (integer)
  - 거래금액 (string)
  - 거래유형 (string)
  - 중개사소재지 (string)
  - 해제사유발생일 (string)
  - 해제여부 (string)

#### Response Example
```json
{
  "data": [
    {
      "지역코드": "11650",
      "시군구": "서초구",
      "법정동": "서초동",
      "지번": "1446-11",
      "단지": "현대슈퍼빌",
      "건축년도": 2003,
      "층": 14,
      "전용면적": 37.07,
      "년": 2022,
      "월": 12,
      "일": 21,
      "거래금액": "44000",
      "거래유형": "중개거래",
      "중개사소재지": "서울 마포구",
      "해제사유발생일": null,
      "해제여부": null
    }
    // ... more records
  ]
}
```
```

--------------------------------

### Initialize Environment and API Service

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/test_housing_license.ipynb

Sets up the system path for module imports and retrieves the service key from a configuration file to initialize the HousingLicense API client.

```python
import os
import sys
from pathlib import Path
sys.path.append(str(Path(os.getcwd()).parent))
from config import API_KEY_INFO
service_key = API_KEY_INFO.get("portal")
from PublicDataReader import HousingLicense
api = HousingLicense(service_key)
```

--------------------------------

### Get KOSIS Data: Fetch Specific Data by Parameters

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/test_kosis.ipynb

This code snippet shows how to fetch specific statistical data by providing detailed parameters such as organization ID ('orgId'), table ID ('tblId'), item ID ('itmId'), and period (start and end dates). It retrieves data for the year 2021 and displays the first row.

```python
df5 = api.get_data(
    "통계자료",
    orgId = "116",
    tblId = "DT_MLTM_2086",
    itmId = "ALL",
    objL1 = "ALL",
    objL2 = "ALL",
    prdSe = "Y",
    startPrdeDe = "2021",
    endPrdDe = "2021",
    )
df5.head(1)
```

--------------------------------

### Initialize Small Business Information Service

Source: https://github.com/wooiljeong/publicdatareader/blob/main/docs/source/PublicDataReader.PublicDataPortal.md

Initializes the StoreInfo class using a service key from the public data portal to query small business and market information.

```python
from PublicDataReader.PublicDataPortal.semas import StoreInfo

service_key = "YOUR_SERVICE_KEY"
store_api = StoreInfo(serviceKey=service_key, debug=False)

# Retrieve data by category
data = store_api.read_data(category="지정상권", key="some_key")
```

--------------------------------

### GET /building-ledger/regional-districts

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/portal/BuildingLedger.md

건축물대장의 지역지구구역 정보를 조회합니다.

```APIDOC
## GET /building-ledger/regional-districts

### Description
특정 필지(시군구, 법정동, 번, 지)에 대한 건축물대장의 지역지구구역 정보를 조회합니다.

### Method
GET

### Endpoint
/building-ledger/regional-districts

### Parameters
#### Query Parameters
- **ledger_type** (string) - Required - 고정값: "지역지구구역"
- **sigungu_code** (string) - Required - 행정표준 시군구 코드
- **bdong_code** (string) - Required - 행정표준 법정동 코드
- **bun** (string) - Required - 번
- **ji** (string) - Required - 지

### Request Example
{
  "ledger_type": "지역지구구역",
  "sigungu_code": "41135",
  "bdong_code": "11000",
  "bun": "542",
  "ji": ""
}

### Response
#### Success Response (200)
- **rnum** (integer) - 순번
- **platPlc** (string) - 대지위치
- **sigunguCd** (string) - 시군구코드
- **bjdongCd** (string) - 법정동코드
- **jijiguGbCdNm** (string) - 지역지구구역구분코드명
- **jijiguCdNm** (string) - 지역지구구역코드명

#### Response Example
{
  "rnum": 1,
  "platPlc": "경기도 성남시 분당구 백현동 542번지",
  "jijiguGbCdNm": "용도지구코드",
  "jijiguCdNm": "택지개발지구"
}
```

--------------------------------

### Initialize PublicDataReader API Clients

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/test_molit.ipynb

Shows how to import the necessary classes and initialize API clients for TransactionPrice and BuildingLedger using a service key.

```python
from PublicDataReader import TransactionPrice, BuildingLedger

# Initialize clients with your service key
api_transaction = TransactionPrice(service_key)
api_building = BuildingLedger(service_key)
```

--------------------------------

### GET /building/floor-summary

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/portal/BuildingLedger.md

건축물대장의 층별 개요 정보를 조회합니다.

```APIDOC
## GET /building/floor-summary

### Description
건축물대장의 층별 구조, 면적, 사용승인일 등 상세 개요 정보를 조회합니다.

### Method
GET

### Endpoint
/building/floor-summary

### Parameters
#### Query Parameters
- **building_id** (string) - Required - 조회할 건축물의 고유 식별자

### Request Example
GET /building/floor-summary?building_id=11000

### Response
#### Success Response (200)
- **floor_area** (number) - 층 면적
- **structure_type** (string) - 건축물 구조 (예: 철근콘크리트구조)
- **approval_date** (string) - 사용승인일

#### Response Example
{
  "floor_area": 508.9298,
  "structure_type": "철근콘크리트구조",
  "approval_date": "20081216"
}
```

--------------------------------

### Initialize KOSIS API and Fetch Data

Source: https://github.com/wooiljeong/publicdatareader/blob/main/docs/PublicDataReader.html

Demonstrates how to initialize the KOSIS service client using an API key and retrieve data as a pandas DataFrame by specifying organization and table identifiers.

```python
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)
```

--------------------------------

### GET /auction/items

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/portal/Kamco.md

Retrieves the details of a specific public auction item.

```APIDOC
## GET /auction/items

### Description
Retrieves comprehensive details for a public auction item including identification, location, and bidding parameters.

### Method
GET

### Endpoint
/auction/items

### Parameters
#### Query Parameters
- **PLNM_NO** (string) - Optional - Public notice number
- **PBCT_NO** (string) - Optional - Auction number
- **CLTR_NO** (string) - Optional - Item number

### Request Example
{
  "CLTR_NO": "1027091"
}

### Response
#### Success Response (200)
- **PLNM_NO** (string) - Public notice number
- **PBCT_NO** (string) - Auction number
- **CLTR_NM** (string) - Item name
- **MIN_BID_PRC** (number) - Minimum bid price
- **PBCT_CLTR_STAT_NM** (string) - Item status

#### Response Example
{
  "PLNM_NO": "390403",
  "PBCT_NO": "430159",
  "CLTR_NM": "울산 남구 여천동 1394 태강철재㈜ 비상장주식 2,700주",
  "MIN_BID_PRC": 103734000,
  "PBCT_CLTR_STAT_NM": "입찰준비중"
}
```

--------------------------------

### Initialize ECOS API Client

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/develop.ipynb

This snippet shows how to import necessary libraries, configure the path, retrieve an API key, and initialize the ECOS API client with the service key.

```python
import os
import sys
from pathlib import Path
sys.path.append(str(Path(os.getcwd()).parent))

from config import API_KEY_INFO
service_key = API_KEY_INFO.get("ecos")
```

--------------------------------

### Initialize MOLIT API Classes

Source: https://github.com/wooiljeong/publicdatareader/blob/main/docs/source/PublicDataReader.PublicDataPortal.md

Demonstrates how to instantiate various MOLIT API classes using a service key. These classes serve as the base for querying specific real estate and construction data.

```python
from PublicDataReader.PublicDataPortal import molit

service_key = "YOUR_SERVICE_KEY"

# Initialize specific modules
building_ledger = molit.BuildingLedger(service_key=service_key)
building_license = molit.BuildingLicense(service_key=service_key)
housing_license = molit.HousingLicense(service_key=service_key)
land_forest = molit.LandForestLedger(service_key=service_key)
land_ownership = molit.LandOwnership(service_key=service_key)
transaction_price = molit.TransactionPrice(service_key=service_key)
```

--------------------------------

### GET /kamco/announcement/list

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/portal/Kamco.md

Retrieves the integrated list of public auction announcements.

```APIDOC
## GET /kamco/announcement/list

### Description
Retrieves the integrated list of public auction announcements based on announcement type, organization, and date range.

### Method
GET

### Parameters
#### Query Parameters
- **service** (string) - Required - Must be '이용기관공매물건'
- **function** (string) - Required - Must be '통합공고목록'
- **PLNM_KIND_CD** (string) - Optional - Announcement type code (0001-0006)
- **ORG_NM** (string) - Optional - Organization name
- **FROM_ANNOUNCE_DATE** (string) - Optional - Start date (YYYYMMDD)
- **TO_ANNOUNCE_DATE** (string) - Optional - End date (YYYYMMDD)

### Request Example
```python
api.get_data(service='이용기관공매물건', function='통합공고목록', PLNM_KIND_CD='0001')
```

### Response
#### Success Response (200)
- **PLNM_NM** (string) - Announcement name
- **PBCT_BEGN_DTM** (string) - Auction start date
- **PBCT_CLS_DTM** (string) - Auction end date
```

--------------------------------

### GET /building-license/auxiliary-parking

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/test_building_license.ipynb

Retrieves information about auxiliary parking facilities for buildings.

```APIDOC
## GET /building-license/auxiliary-parking

### Description
Retrieves auxiliary parking facility data including land codes and administrative identifiers.

### Method
GET

### Endpoint
/get_data?service_type=부설주차장

### Parameters
#### Query Parameters
- **service_type** (string) - Required - Must be "부설주차장"
- **sigungu_code** (string) - Required - Regional city/district code
- **bdong_code** (string) - Required - Legal dong code

### Response
#### Success Response (200)
- **rnum** (integer) - Sequence number
- **platPlc** (string) - Land location
- **mgmPmsrgstPk** (string) - Management PK
- **jimokCdNm** (string) - Land category name

### Response Example
{
  "rnum": 1,
  "platPlc": "서울특별시 강남구 개포동 1233-22번지",
  "jimokCdNm": "대",
  "crtnDay": "20150321"
}
```

--------------------------------

### Retrieve Building License Data with Python

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/portal/BuildingLicense.md

This snippet demonstrates how to initialize the BuildingLicense class and fetch building data using a service key. It requires a valid service key from the Public Data Portal and returns a pandas DataFrame containing building license details.

```python
from PublicDataReader import BuildingLicense

service_key = "공공 데이터 포털에서 발급받은 서비스 키"
api = BuildingLicense(service_key)

df = api.get_data(
    service_type="기본개요", 
    sigungu_code="41135", 
    bdong_code="11000", 
    plat_code=None,
    bun=None,
    ji=None,
)
df.head(1)
```

--------------------------------

### GET /get_jeonwolse_conversion_rate

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/kbland/Kbland.md

Retrieves the jeonwolse conversion rate for a specified period.

```APIDOC
## GET /get_jeonwolse_conversion_rate

### Description
Retrieves the conversion rate between jeonse and monthly rent.

### Method
GET

### Endpoint
get_jeonwolse_conversion_rate

### Parameters
#### Query Parameters
- **기간** (string) - Optional - Duration in years (e.g., 1)

### Request Example
{
  "기간": "1"
}

### Response
#### Success Response (200)
- **지역코드** (string) - Region code
- **지역명** (string) - Region name
- **날짜** (string) - Date
- **전월세전환율** (float) - Conversion rate

#### Response Example
{
  "지역코드": "4100000000",
  "지역명": "경기도",
  "날짜": "2022-12-01",
  "전월세전환율": 4.556344
}
```

--------------------------------

### Importing Library and Initializing API

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/vworld/VworldData.md

This snippet shows how to import the PublicDataReader library and initialize the VworldData API with your service key.

```APIDOC
## Importing Library and Initializing API

### Description
This section demonstrates how to import the necessary library and initialize the VworldData API client using a provided service key.

### Method
Initialization

### Endpoint
N/A

### Parameters
#### Request Body
- **service_key** (string) - Required - Your Vworld API service key.

### Request Example
```python
from PublicDataReader import VworldData
service_key = "YOUR_SERVICE_KEY"
api = VworldData(service_key)
```

### Response
N/A
```

--------------------------------

### Get Data - 출처

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/kosis/Kosis.md

Retrieves source information for a statistical table.

```APIDOC
## GET /api/data/출처

### Description
Retrieves source information for a statistical table, including the survey name, department, and department phone number.

### Method
GET

### Endpoint
/api/data/출처

### Parameters
#### Query Parameters
- **orgId** (String) - Required - The organization code for the data.
- **tblId** (String) - Required - The statistical table ID.

### Request Example
```json
{
  "orgId": "116",
  "tblId": "DT_MLTM_2086"
}
```

### Response
#### Success Response (200)
- **JOSA_NM** (String) - Survey name.
- **DEPT_NM** (String) - Department name for the statistical table.
- **DEPT_PHONE** (String) - Department phone number.

#### Response Example
```json
{
  "JOSA_NM": "「미분양주택현황보고」",
  "DEPT_NM": "국토교통부 주택토지실 주택정책관 주택정책과",
  "DEPT_PHONE": "044-201-3336"
}
```
```

--------------------------------

### Fetch Housing License Data with PublicDataReader

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/portal/HousingLicense.md

This snippet demonstrates how to initialize the HousingLicense client and retrieve housing license action overview data for a specific region using administrative codes.

```python
from PublicDataReader import HousingLicense

service_key = "공공 데이터 포털에서 발급받은 서비스 키"
api = HousingLicense(service_key)

df = api.get_data(
    service_type="행위개요", 
    sigungu_code="41135", 
    bdong_code="11000", 
    bun="542", 
    ji="",
)
df.head(1)
```

--------------------------------

### Initialize PublicDataReader Environment

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/test_building_license.ipynb

Configures the Python path and retrieves the API service key from a configuration file to prepare for data requests.

```python
import os
import sys
from pathlib import Path
sys.path.append(str(Path(os.getcwd()).parent))
from config import API_KEY_INFO
service_key = API_KEY_INFO.get("portal")
```

--------------------------------

### Get Data - 단위

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/kosis/Kosis.md

Retrieves unit information for a statistical table.

```APIDOC
## GET /api/data/단위

### Description
Retrieves unit information (Korean and English names) for a given statistical table.

### Method
GET

### Endpoint
/api/data/단위

### Parameters
#### Query Parameters
- **orgId** (String) - Required - The organization code for the data.
- **tblId** (String) - Required - The statistical table ID.

### Request Example
```json
{
  "orgId": "116",
  "tblId": "DT_MLTM_2086"
}
```

### Response
#### Success Response (200)
- **UNIT_NM** (String) - Unit Korean name.
- **UNIT_NM_ENG** (String) - Unit English name.

#### Response Example
```json
{
  "UNIT_NM": "호",
  "UNIT_NM_ENG": "Apartment Unit"
}
```
```

--------------------------------

### Initialize PublicDataReader and Get Service Key

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/test_nts.ipynb

Imports the PublicDataReader library, retrieves the API version, and obtains the service key from configuration. This step is necessary before interacting with the library's services.

```python
import PublicDataReader as pdr
from config import API_KEY_INFO
print(pdr.__version__)
serviceKey = API_KEY_INFO.get("portal")
```

--------------------------------

### Get Data - 주석

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/kosis/Kosis.md

Retrieves comment details for a statistical table.

```APIDOC
## GET /api/data/주석

### Description
Retrieves comment details associated with a statistical table, including comment type and description.

### Method
GET

### Endpoint
/api/data/주석

### Parameters
#### Query Parameters
- **orgId** (String) - Required - The organization code for the data.
- **tblId** (String) - Required - The statistical table ID.

### Request Example
```json
{
  "orgId": "116",
  "tblId": "DT_MLTM_2086"
}
```

### Response
#### Success Response (200)
- **CMMT_NM** (String) - Comment type.
- **CMMT_DC** (String) - Comment description.
- **OBJ_ID** (String) - Classification ID.
- **OBJ_NM** (String) - Classification name.
- **ITM_ID** (String) - Item ID.
- **ITM_NM** (String) - Item Korean name.

#### Response Example
```json
{
  "CMMT_NM": "통계표",
  "CMMT_DC": "해당연도 12월말 기준",
  "OBJ_ID": null,
  "OBJ_NM": null,
  "ITM_ID": null,
  "ITM_NM": null
}
```
```

--------------------------------

### Initialize Vworld API Client

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/test_vworld.ipynb

Configures the environment path and initializes the VworldData client using an API key. This is the mandatory first step for fetching data from Vworld services.

```python
import os
import sys
from pathlib import Path
sys.path.append(str(Path(os.getcwd()).parent))
from config import API_KEY_INFO
from PublicDataReader import VworldData
service_key = API_KEY_INFO.get("vworld")
api = VworldData(service_key)
```

--------------------------------

### GET /statistic/word

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/ecos/ecos.md

Retrieves the definition and details of a specific economic term.

```APIDOC
## GET /statistic/word

### Description
Searches for the definition and explanation of a specific economic term.

### Method
GET

### Endpoint
/statistic/word

### Parameters
#### Query Parameters
- **용어** (string) - Required - The economic term to search for (e.g., "소비자동향지수").

### Request Example
{
  "용어": "소비자동향지수"
}

### Response
#### Success Response (200)
- **용어** (string) - The searched term.
- **용어설명** (string) - Detailed explanation of the term.

#### Response Example
{
  "용어": "소비자동향지수",
  "용어설명": "소비자들이 느끼는 경기, 소비지출계획, 생활형편 등 경제에 대한 전반적인 인식"
}
```

--------------------------------

### GET 통합용도별물건주주정보상세

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/portal/Kamco.md

Retrieves detailed shareholder information for a specific property and auction.

```APIDOC
## GET 통합용도별물건주주정보상세

### Description
Retrieves detailed shareholder information for a specific property and auction.

### Method
GET

### Endpoint
Kamco.get_data(service='물건정보', function='통합용도별물건주주정보상세', ...)

### Parameters
#### Query Parameters
- **service** (string) - Required - Must be '물건정보'
- **function** (string) - Required - Must be '통합용도별물건주주정보상세'
- **CLTR_NO** (string) - Required - Property number
- **PBCT_NO** (string) - Required - Auction number

### Request Example
{
  "service": "물건정보",
  "function": "통합용도별물건주주정보상세",
  "CLTR_NO": "1176660",
  "PBCT_NO": "9272855"
}

### Response
#### Success Response (200)
- **totalCount** (integer) - Total result count
- **SCRT_STHL_NO** (string) - Sequence number
- **STHL_NM** (string) - Shareholder name
- **POSN_STK_CNT** (integer) - Number of shares held
- **PCOS** (float) - Ownership percentage

#### Response Example
{
  "totalCount": 3,
  "STHL_NM": "김길웅",
  "PCOS": 66.4092
}
```

--------------------------------

### Initialize SmallShop API Client in Python

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/portal/SmallShop.md

This snippet shows how to import the SmallShop class and initialize the API client with a service key obtained from the Public Data Portal. The service key is essential for authenticating API requests.

```python
from PublicDataReader import SmallShop

# 공공 데이터 포털 오픈 API 서비스 인증키 입력하기
service_key = "공공 데이터 포털에서 발급받은 서비스 키"

# 데이터 조회 API 인스턴스 만들기
api = SmallShop(service_key)
```

--------------------------------

### GET /wooiljeong/publicdatareader

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/portal/Kamco.md

Retrieves a list of auctioned properties based on specified criteria.

```APIDOC
## GET /wooiljeong/publicdatareader

### Description
This endpoint retrieves a list of auctioned properties. Users can filter the results by various criteria such as service type, function, disposal method, category, location, price range, and auction date.

### Method
GET

### Endpoint
/wooiljeong/publicdatareader

### Query Parameters
- **service** (string) - Required - The type of service (e.g., "물건정보").
- **function** (string) - Required - The specific function (e.g., "통합마감임박물건목록").
- **DPSL_MTD_CD** (string) - Required - Disposal method code (e.g., "0001" for sale, "0002" for lease).
- **CTGR_HIRK_ID** (string) - Optional - Category hierarchy ID.
- **CTGR_HIRK_ID_MID** (string) - Optional - Middle category hierarchy ID.
- **SIDO** (string) - Optional - Province/State of the property location (e.g., "서울특별시").
- **SGK** (string) - Optional - City/District of the property location (e.g., "강남구").
- **EMD** (string) - Optional - Town/Neighborhood of the property location (e.g., "개포동").
- **GOODS_PRICE_FROM** (integer) - Optional - Minimum appraised value.
- **GOODS_PRICE_TO** (integer) - Optional - Maximum appraised value.
- **OPEN_PRICE_FROM** (integer) - Optional - Minimum bidding price.
- **OPEN_PRICE_TO** (integer) - Optional - Maximum bidding price.
- **CLTR_NM** (string) - Optional - Name or description of the property.
- **PBCT_BEGN_DTM** (string) - Optional - Auction start date in YYYYMMDD format.
- **PBCT_CLS_DTM** (string) - Optional - Auction end date in YYYYMMDD format.
- **CLTR_MNMT_NO** (string) - Optional - Property management number.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **data** (array) - An array of property objects.
  - Each property object contains details like management number, name, location, appraised value, bidding price, auction dates, etc.

#### Response Example
(Example response structure would be provided here, detailing the fields within each property object.)
```

--------------------------------

### Initialize PublicDataReader Environment

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/test_fred.ipynb

Configures the Python path and imports the PublicDataReader library to prepare for data retrieval.

```python
import os
import sys
from pathlib import Path
sys.path.append(str(Path(os.getcwd()).parent))
import PublicDataReader as pdr
from config import API_KEY_INFO
print(pdr.__version__)
```

--------------------------------

### Initialize Building License API Client

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/test_building_license.ipynb

Basic initialization of the BuildingLicense class to prepare for querying building-related public data services.

```python
from PublicDataReader import BuildingLicense

# Initialize the API client with your service key
api = BuildingLicense(service_key)
```

--------------------------------

### GET /get_monthly_apartment_wolse_index

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/kbland/Kbland.md

Retrieves the monthly apartment rent (Wolse) price index.

```APIDOC
## GET /get_monthly_apartment_wolse_index

### Description
Retrieves the monthly apartment rent price index for a specified period.

### Method
GET

### Endpoint
/get_monthly_apartment_wolse_index

### Parameters
#### Request Body
- **기간** (string) - Optional - Recent years to query

### Request Example
{
  "기간": "1"
}

### Response
#### Success Response (200)
- **월간주간구분** (string) - Monthly indicator
- **매물종별구분** (string) - Property type
- **거래구분** (string) - Transaction type (Wolse)
- **지역코드** (string) - Region code
- **지역명** (string) - Region name
- **날짜** (string) - Date
- **가격지수** (float) - Price index value

#### Response Example
{
  "월간주간구분": "월간",
  "매물종별구분": "아파트",
  "거래구분": "월세",
  "지역코드": "4100000000",
  "지역명": "경기도",
  "날짜": "2022-12-01",
  "가격지수": 107.956571
}
```

--------------------------------

### GET /자료갱신일

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/kosis/Kosis.md

Retrieves the update date information for a specific statistical table.

```APIDOC
## GET /자료갱신일

### Description
Retrieves the latest update date and metadata for a specific statistical table identified by organization and table ID.

### Method
GET

### Endpoint
/자료갱신일

### Parameters
#### Query Parameters
- **orgId** (String) - Required - Organization code
- **tblId** (String) - Required - Statistical table ID
- **prdSe** (String) - Optional - Recording cycle

### Request Example
{
  "orgId": "116",
  "tblId": "DT_MLTM_2086"
}

### Response
#### Success Response (200)
- **ORG_NM** (String) - Organization Name
- **TBL_NM** (String) - Table Name
- **PRD_SE** (String) - Recording Cycle
- **PRD_DE** (String) - Recording Point
- **SEND_DE** (String) - Data Update Date

#### Response Example
{
  "ORG_NM": "국토교통부",
  "TBL_NM": "미분양현황_종합",
  "PRD_SE": "년",
  "PRD_DE": "2001",
  "SEND_DE": "2022-03-16"
}
```

--------------------------------

### Initialize PublicDataReader API Client

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/test_reb.ipynb

This snippet shows how to set up the PublicDataReader API client. It imports necessary modules, retrieves an API key, and instantiates the Reb class.

```python
import os
import sys
from pathlib import Path
sys.path.append(str(Path(os.getcwd()).parent))

from config import API_KEY_INFO
service_key = API_KEY_INFO.get("portal")

from PublicDataReader import Reb

api = Reb(service_key)
```

--------------------------------

### Get Data - 분류/항목

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/kosis/Kosis.md

Retrieves classification and item details for a statistical table.

```APIDOC
## GET /api/data/분류항목

### Description
Retrieves classification and item details for a given statistical table, including IDs, names (Korean and English), and hierarchy information.

### Method
GET

### Endpoint
/api/data/분류항목

### Parameters
#### Query Parameters
- **orgId** (String) - Required - The organization code for the data.
- **tblId** (String) - Required - The statistical table ID.
- **objId** (String) - Optional - The classification code.
- **itmId** (String) - Optional - The item code.

### Request Example
```json
{
  "orgId": "116",
  "tblId": "DT_MLTM_2086"
}
```

### Response
#### Success Response (200)
- **OBJ_ID** (String) - Classification ID.
- **OBJ_NM** (String) - Classification Korean name.
- **OBJ_NM_ENG** (String) - Classification English name.
- **ITM_ID** (String) - Item ID.
- **ITM_NM** (String) - Item Korean name.
- **ITM_NM_ENG** (String) - Item English name.
- **UP_ITM_ID** (String) - Parent item ID.
- **OBJ_ID_SN** (String) - Item sequence number.

#### Response Example
```json
{
  "OBJ_ID": "ITEM",
  "OBJ_NM": "항목",
  "OBJ_NM_ENG": "Item code list",
  "ITM_ID": "13103871014T1",
  "ITM_NM": "미분양(12월기준)",
  "ITM_NM_ENG": "Unsold Housings",
  "UP_ITM_ID": null,
  "OBJ_ID_SN": null
}
```
```

--------------------------------

### Connect to FRED API

Source: https://github.com/wooiljeong/publicdatareader/blob/main/test/test_fred.ipynb

Initializes the FRED client using an API key retrieved from a configuration file.

```python
from PublicDataReader import Fred
api = Fred(API_KEY_INFO["fred"])
```

--------------------------------

### Get Organization Name Description

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/kosis/Kosis.md

Retrieves the Korean and English names of an organization.

```APIDOC
## GET /api/data/통계표설명/기관명칭

### Description
Retrieves the Korean and English names for a given organization ID.

### Method
GET

### Endpoint
/api/data/통계표설명/기관명칭

### Parameters
#### Query Parameters
- **orgId** (String) - Required - Organization ID.

### Request Example
```python
df3_2 = api.get_data(
    "통계표설명",
    "기관명칭",
    orgId = "116",
    tblId = "DT_MLTM_2086",
    )
df3_2.head(1)
```

### Response
#### Success Response (200)
- **ORG_NM** (String) - Korean name of the organization.
- **ORG_NM_ENG** (String) - English name of the organization.

#### Response Example
```json
{
  "기관명": "국토교통부",
  "기관영문명": "Ministry of Land, Infrastructure and Transport"
}
```
```

--------------------------------

### Initialize API and query single month lease data

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/portal/TransactionPrice.md

This snippet shows how to initialize the TransactionPrice client with a service key and perform a query for a single month of lease data. It returns a DataFrame containing details like deposit and monthly rent amounts.

```python
from PublicDataReader import TransactionPrice

service_key = "공공 데이터 포털에서 발급받은 서비스 키"
api = TransactionPrice(service_key)

# 단일 월 조회
df = api.get_data(
    property_type="단독다가구",
    trade_type="전월세",
    sigungu_code="11650",
    year_month="202212",
)
```

--------------------------------

### GET 통합용도별물건입찰이력상세

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/portal/Kamco.md

Retrieves the detailed bidding history for a specific property and auction number.

```APIDOC
## GET 통합용도별물건입찰이력상세

### Description
Retrieves the detailed bidding history for a specific property and auction number.

### Method
GET

### Endpoint
Kamco.get_data(service='물건정보', function='통합용도별물건입찰이력상세', ...)

### Parameters
#### Query Parameters
- **service** (string) - Required - Must be '물건정보'
- **function** (string) - Required - Must be '통합용도별물건입찰이력상세'
- **CLTR_NO** (string) - Required - Property number
- **PBCT_NO** (string) - Required - Auction number

### Request Example
{
  "service": "물건정보",
  "function": "통합용도별물건입찰이력상세",
  "CLTR_NO": "1226758",
  "PBCT_NO": "9301922"
}

### Response
#### Success Response (200)
- **totalCount** (integer) - Total result count
- **PBCT_SEQ** (integer) - Sequence number
- **PBCT_DGR** (integer) - Degree
- **BID_MNMT_NO** (string) - Bid management number
- **DPSL_MTD_NM** (string) - Disposal method name
- **PBCT_EXCT_DTM** (string) - Auction execution date time
- **MIN_BID_PRC** (integer) - Minimum bid price
- **PBCT_STAT_NM** (string) - Auction status name

#### Response Example
{
  "totalCount": 3,
  "PBCT_SEQ": 45,
  "PBCT_DGR": 1,
  "BID_MNMT_NO": "24",
  "PBCT_STAT_NM": "유찰"
}
```

--------------------------------

### Retrieve Building Floor Summary Data with PublicDataReader

Source: https://github.com/wooiljeong/publicdatareader/blob/main/assets/docs/portal/BuildingLicense.md

This snippet demonstrates how to initialize the BuildingLicense client and fetch floor-level summary data for a specific region. It requires a valid service key from the public data portal and returns a pandas DataFrame.

```python
from PublicDataReader import BuildingLicense

service_key = "공공 데이터 포털에서 발급받은 서비스 키"
api = BuildingLicense(service_key)

df = api.get_data(
    service_type="층별개요", 
    sigungu_code="41135", 
    bdong_code="11000", 
    plat_code=None,
    bun=None,
    ji=None,
)
df.head(1)
```
Tokens:
Raw