콘텐츠로 이동

통계용어사전 개발 명세서

개요

한국은행 경제통계 Open API의 통계 용어 및 용어 설명을 조회하는 서비스입니다.

상세주소

요청인자

항목명(국문) 필수여부 샘플데이터 항목설명
서비스명 Y StatisticWord API 서비스명
인증키 Y sample 한국은행에서 발급받은 오픈API 인증키
요청유형 Y xml 결과값의 파일 형식 - xml, json
언어구분 Y kr 결과값의 언어 - kr(국문), en(영문)
요청시작건수 Y 1 전체 결과값 중 시작 번호
요청종료건수 Y 10 전체 결과값 중 끝 번호
용어 Y 소비자동향지수 검색할 용어

요청인자 설명

  • 서비스명: 고정값 StatisticWord
  • 인증키: 한국은행 Open API에서 발급받은 인증키
  • 요청유형: 응답 형식 (xml 또는 json)
  • 언어구분: 응답 언어 (kr: 국문, en: 영문)
  • 요청시작건수: 페이징을 위한 시작 번호 (1부터 시작)
  • 요청종료건수: 페이징을 위한 종료 번호
  • 용어: 검색할 통계 용어 (필수)

출력값

항목명(국문) 항목명(영문) 항목크기 샘플데이터 항목설명
용어 WORD 100 소비자동향지수 용어
용어설명 CONTENT 4000 소비자들이 느끼는 경기, 소비지출계획, 생활형편 등 경제에 대한 전반적인 인식을 조사하여 지수화함으로써 소비 및 경기를 파악하는 지표로 활용된다. 소비자동향지수는 1964년 미국 미시간대학이 최초로 작성하였으며 그 이후 우리나라를 비롯한 세계 각국에서 편제하여 공표하고 있다. 한국은행의 소비자동향지수는 매월 초～중순에 걸쳐 조사하여 하순에 결과를 발표하고 있다. 용어설명

출력값 설명

  • 용어: 검색된 통계 용어명
  • 용어설명: 해당 용어에 대한 상세 설명 (최대 4000자)

샘플 URL

https://ecos.bok.or.kr/api/StatisticWord/{인증키}/xml/kr/1/10/소비자동향지수

URL 구성 요소

  1. 기본 URL: https://ecos.bok.or.kr/api/
  2. 서비스명: StatisticWord
  3. 인증키: {인증키} (실제 인증키로 대체)
  4. 요청유형: xml 또는 json
  5. 언어구분: kr 또는 en
  6. 요청시작건수: 1
  7. 요청종료건수: 10
  8. 용어: 검색할 용어 (예: 소비자동향지수)

메시지 설명

정보 메시지

코드 설명
100 인증키가 유효하지 않습니다. 인증키를 확인하십시오! 인증키가 없는 경우 인증키를 신청하십시오!
200 해당하는 데이터가 없습니다.

에러 메시지

코드 설명
100 필수 값이 누락되어 있습니다. 필수 값을 확인하십시오! 필수 값이 누락되어 있으면 오류를 발생합니다. 요청 변수를 참고 하십시오!
101 주기와 다른 형식의 날짜 형식입니다.
200 파일타입 값이 누락 혹은 유효하지 않습니다. 파일타입 값을 확인하십시오! 파일타입 값이 누락 혹은 유효하지 않으면 오류를 발생합니다. 요청 변수를 참고 하십시오!
300 조회건수 값이 누락되어 있습니다. 조회시작건수/조회종료건수 값을 확인하십시오! 조회시작건수/조회종료건수 값이 누락되어 있으면 오류를 발생합니다.
301 조회건수 값의 타입이 유효하지 않습니다. 조회건수 값을 확인하십시오! 조회건수 값의 타입이 유효하지 않으면 오류를 발생합니다. 정수를 입력하세요.
400 검색범위가 적정범위를 초과하여 60초 TIMEOUT이 발생하였습니다. 요청조건 조정하여 다시 요청하시기 바랍니다.
500 서버 오류입니다. OpenAPI 호출시 서버에서 오류가 발생하였습니다. 해당 서비스를 찾을 수 없습니다.
600 DB Connection 오류입니다. OpenAPI 호출시 서버에서 DB접속 오류가 발생했습니다.
601 SQL 오류입니다. OpenAPI 호출시 서버에서 SQL 오류가 발생했습니다.
602 과도한 OpenAPI호출로 이용이 제한되었습니다. 잠시후 이용해주시기 바랍니다.

사용 예제

XML 형식 요청

curl "https://ecos.bok.or.kr/api/StatisticWord/YOUR_API_KEY/xml/kr/1/10/소비자동향지수"

JSON 형식 요청

curl "https://ecos.bok.or.kr/api/StatisticWord/YOUR_API_KEY/json/kr/1/10/소비자동향지수"

URL 인코딩이 필요한 경우

용어에 특수문자나 공백이 포함된 경우 URL 인코딩이 필요합니다:

# Python 예제
import urllib.parse

term = "소비자동향지수"
encoded_term = urllib.parse.quote(term)
url = f"https://ecos.bok.or.kr/api/StatisticWord/YOUR_API_KEY/xml/kr/1/10/{encoded_term}"

페이징 처리

# 첫 10개 결과
curl "https://ecos.bok.or.kr/api/StatisticWord/YOUR_API_KEY/xml/kr/1/10/소비자동향지수"

# 다음 10개 결과
curl "https://ecos.bok.or.kr/api/StatisticWord/YOUR_API_KEY/xml/kr/11/20/소비자동향지수"

다양한 용어 검색 예제

# GDP 검색
curl "https://ecos.bok.or.kr/api/StatisticWord/YOUR_API_KEY/xml/kr/1/10/GDP"

# 기준금리 검색
curl "https://ecos.bok.or.kr/api/StatisticWord/YOUR_API_KEY/xml/kr/1/10/기준금리"

# 소비자물가지수 검색
curl "https://ecos.bok.or.kr/api/StatisticWord/YOUR_API_KEY/xml/kr/1/10/소비자물가지수"

주의사항

  1. 인증키: 모든 요청에 유효한 인증키가 필요합니다.
  2. 용어 필수: 용어 파라미터는 필수이며, 검색할 용어를 정확히 입력해야 합니다.
  3. 페이징: 요청시작건수와 요청종료건수는 필수이며, 정수값이어야 합니다.
  4. URL 인코딩: 용어에 한글이나 특수문자가 포함된 경우 URL 인코딩이 필요할 수 있습니다.
  5. 타임아웃: 검색 범위가 너무 넓으면 60초 타임아웃이 발생할 수 있습니다.
  6. 호출 제한: 과도한 호출 시 일시적으로 이용이 제한될 수 있습니다.
  7. 부분 일치: 용어 검색은 부분 일치 검색을 지원할 수 있습니다.

관련 서비스