Getting Started with Open API (2)

Open API (Application Programming Interface) 이해하기 - XML to Excel
data.go.kr

 

 

API 구조 이해하기

 

 

 

제가 오픈 API 활용신청을 한 데이터명은 "행정안전부_지역별 인구이동 현황" 입니다.

마이페이지 > 데이터 활용 > Open API > 활용신청 현황 > 아래 활용신청한 목록 선택 > 개발계정 상세보기

 

 

 

 

 

 

 

[개발계정 상세보기] 에서 API 호출 URL 주소인 End Point 및 API 파라미터 확인

 

 

1. End Point | API 호출 URL 주소 확인

 

http://apis.data.go.kr/1741000/ppltnDataStus

• http://apis.data.go.kr/1741000/ppltnDataStus : Base URL
• http://apis.data.go.kr/1741000/ppltnDataStus : 호출주소

 

 

2. serviceKey | 일반 인증키 (Decoding) 확인

 

 

 

3. API 파라미터 | 요청변수(Request Parameter) 확인

 

 

요청변수의 serviceKey에 일반 인증키(Decoding)을 입력하고 "미리보기"를 누르면 아래와 같이 API 호출 결과를 확인할 수 있습니다.

 

 

 

Google Colab을 통한 Python 코드 실행 전 XML 다운 받기

 

 

1. 데이터 조회하기로 변수명 확인

 

 

2. Open API 실행 준비

 

 

3. Open API 호출한 XML 다운로드

 

 

 

Google Colab을 통한 Python 코드 실행

 

 

1. 구글 코랩에 다운 받은 xml 파일 업로드 및 경로 복사

 

 

2. 업로드한 파일 및 다운로드를 위한 경로 붙여넣고 코드 실행

import pandas as pd

import xml.etree.ElementTree as ET

# Parse the XML file

tree = ET.parse('/content/sample_data/response_1722494619624.xml')

root = tree.getroot()

# Create a list to store the data

data = []

# Iterate through each 'item' element in the XML

for item in root.findall('.//item'):

record = {}

for child in item:

record[child.tag] = child.text

data.append(record)

# Convert the list of dictionaries to a DataFrame

df = pd.DataFrame(data)

# Save the DataFrame to an Excel file

df.to_excel('/content/sample_data/api_data.xlsx', index=False)

print("Data successfully saved to api_data.xlsx")

 

결과물 : 

 

 

3. '데이터 조회하기'로 본 국문 변수명으로 저장하고 싶어 아래 코드를 추가하였습니다.

 

코드:

import pandas as pd

import xml.etree.ElementTree as ET

# Parse the XML file

tree = ET.parse('/content/sample_data/response_1722494619624.xml')

root = tree.getroot()

# Define the column names

columns = [

"통계년월", "전입행정기관코드", "전출행정기관코드", "전입시도명", "전입시군구명", "전입행정동명",

"전출시도명", "전출시군구명", "전출행정동명", "총인구수", "남자인구수", "여자인구수", "만0세남자",

"만1세남자", "만2세남자", "만3세남자", "만4세남자", "만5세남자", "만6세남자", "만7세남자",

"만8세남자", "만9세남자", "만10세남자", "만11세남자", "만12세남자", "만13세남자", "만14세남자",

"만15세남자", "만16세남자", "만17세남자", "만18세남자", "만19세남자", "만20세남자", "만21세남자",

"만22세남자", "만23세남자", "만24세남자", "만25세남자", "만26세남자", "만27세남자", "만28세남자",

"만29세남자", "만30세남자", "만31세남자", "만32세남자", "만33세남자", "만34세남자", "만35세남자",

"만36세남자", "만37세남자", "만38세남자", "만39세남자", "만40세남자", "만41세남자", "만42세남자",

"만43세남자", "만44세남자", "만45세남자", "만46세남자", "만47세남자", "만48세남자", "만49세남자",

"만50세남자", "만51세남자", "만52세남자", "만53세남자", "만54세남자", "만55세남자", "만56세남자",

"만57세남자", "만58세남자", "만59세남자", "만60세남자", "만61세남자", "만62세남자", "만63세남자",

"만64세남자", "만65세남자", "만66세남자", "만67세남자", "만68세남자", "만69세남자", "만70세남자",

"만71세남자", "만72세남자", "만73세남자", "만74세남자", "만75세남자", "만76세남자", "만77세남자",

"만78세남자", "만79세남자", "만80세남자", "만81세남자", "만82세남자", "만83세남자", "만84세남자",

"만85세남자", "만86세남자", "만87세남자", "만88세남자", "만89세남자", "만90세남자", "만91세남자",

"만92세남자", "만93세남자", "만94세남자", "만95세남자", "만96세남자", "만97세남자", "만98세남자",

"만99세남자", "만100세남자", "만101세남자", "만102세남자", "만103세남자", "만104세남자", "만105세남자",

"만106세남자", "만107세남자", "만108세남자", "만109세남자", "만110세남자", "만0세여자", "만1세여자",

"만2세여자", "만3세여자", "만4세여자", "만5세여자", "만6세여자", "만7세여자", "만8세여자", "만9세여자",

"만10세여자", "만11세여자", "만12세여자", "만13세여자", "만14세여자", "만15세여자", "만16세여자",

"만17세여자", "만18세여자", "만19세여자", "만20세여자", "만21세여자", "만22세여자", "만23세여자",

"만24세여자", "만25세여자", "만26세여자", "만27세여자", "만28세여자", "만29세여자", "만30세여자",

"만31세여자", "만32세여자", "만33세여자", "만34세여자", "만35세여자", "만36세여자", "만37세여자",

"만38세여자", "만39세여자", "만40세여자", "만41세여자", "만42세여자", "만43세여자", "만44세여자",

"만45세여자", "만46세여자", "만47세여자", "만48세여자", "만49세여자", "만50세여자", "만51세여자",

"만52세여자", "만53세여자", "만54세여자", "만55세여자", "만56세여자", "만57세여자", "만58세여자",

"만59세여자", "만60세여자", "만61세여자", "만62세여자", "만63세여자", "만64세여자", "만65세여자",

"만66세여자", "만67세여자", "만68세여자", "만69세여자", "만70세여자", "만71세여자", "만72세여자",

"만73세여자", "만74세여자", "만75세여자", "만76세여자", "만77세여자", "만78세여자", "만79세여자",

"만80세여자", "만81세여자", "만82세여자", "만83세여자", "만84세여자", "만85세여자", "만86세여자",

"만87세여자", "만88세여자", "만89세여자", "만90세여자", "만91세여자", "만92세여자", "만93세여자",

"만94세여자", "만95세여자", "만96세여자", "만97세여자", "만98세여자", "만99세여자", "만100세여자",

"만101세여자", "만102세여자", "만103세여자", "만104세여자", "만105세여자", "만106세여자", "만107세여자",

"만108세여자", "만109세여자", "만110세여자"

]

# Create a list to store the data

data = []

# Iterate through each 'item' element in the XML

for item in root.findall('.//item'):

record = {}

for child in item:

record[child.tag] = child.text

data.append(record)

# Convert the list of dictionaries to a DataFrame

df = pd.DataFrame(data)

# Reorder and rename the columns

df.columns = columns[:len(df.columns)]

# Save the DataFrame to an Excel file

df.to_excel('/content/sample_data/api_data.xlsx', index=False)

print("Data successfully saved to api_data.xlsx")

 

결과물:

 

 

한계점

 

1. 공공데이터포털의 '데이터 조회하기'와 API 목록 아래에 있는 'OpenAPI 실행 준비'를 통한 XML 파일을 다운 받은 후에야 파이썬을 통한 파일데이터 저장이 완료되었는데, 그 전에 바로 실행하였을 때 계속 "HTTP Error: 500 Internal Server Error" 서버 오류가 발생함

 

2. 행정안전부에서 제공하는 "지역별 인구이동 현황"의 전입-전출행정구역이 같은 시도 안에서 한정되어, 시군구별 인구이동을 일괄적으로 볼 수 없으며 조회 기간도 년이 아닌 월별로 3개월에 한정되어 있어, 데이터 획득에 드는 시간이 너무 클 것 같아 해당 공공데이터 활용 효율성에 대한 의문이 생김