API 레퍼런스
본 자료는 T/M 관측소에서 송신된 원시자료 입니다.
이 자료는 측정기기의 오작동, 전파경로상의 혼선, 측정지점의 변화 등에 대한 보정을 거친 최종자료와 다를 수 있습니다.
따라서 사용자는 개인(대중)의 안전과 관련된 의사결정 또는 영리를 목적으로 하는 사업에 본 자료를 사용하기에 앞서 주의를 기울여야 하며,
이를 소홀히 함으로써 발생된 제반책임은 사용자에게 있음을 알려드리니, 이상이 있을 경우 담당자에게 문의바랍니다.
한국수자원공사(02-2150-0317), 한국수력원자력(033-245-2430)에서 제공하는 자료에 대한 자세한 사항은 해당기관에 문의하시기 바랍니다.
2024년 홍수특보지점 확대•운영으로 인한 홍수특보 발령서 개정에 따라 한강홍수통제소 오픈API에서 제공 중인 정보를 변경하오니
사용 중인 기관에서는 조치하여 주시기 바랍니다.
- 2024.05.04. 부터 적용예정.
- 자세한 사항은 공지사항을 참고하여 주시기 바랍니다.
수위 자료 요청 포맷
| 변수명 | 필수여부 | 사용예 | 설명 |
|---|---|---|---|
| ServiceKey | 필수 | OpenAPI 인증키 | 한강홍수통제소에서 발급한 OpenAPI 인증키 |
| HydroType | 필수 | waterlevel | 수문자료 종류 : 수위 |
| DataType | 필수 | list | 실시간 자료 |
| TimeType | 필수 | 10M | 10분 단위 자료 |
| 1H | 1시간 단위 자료 | ||
| 1D | 1일 단위 자료 | ||
| Wlobscd | 선택 | 관측소 코드 | 수위 관측소 코드, 명시하지 않을 경우 전체 관측소의 최종 시간 자료 제공 |
| Sdt | 선택 | yyyyMMddHHmm | 검색 시작시간 및 검색 종료시간(10분 단위), 최대1개월 |
| yyyyMMddHH | 검색 시작시간 및 검색 종료시간(1시간 단위), 최대1년 | ||
| Edt | yyyyMMdd | 검색 시작시간 및 검색 종료시간(1일 단위), 최대1년 | |
| DocumentType | 필수 | .xml | xml 문서 포맷 |
| .json | json 문서 포맷 |
- 굵은 글씨는 고정값을 의미합니다.
- 관측소코드 및 검색기간을 명시하지 않을 경우 최종 시간의 자료만 제공 됩니다.
-
낙동강, 금강, 영산강 권역의 자료는 한강 권역의 자료 보다 늦게 수집 됩니다.
한강 권역 : 7~8분, 낙동강, 금강, 영산강 권역 : 11분 이상
따라서 관측소별로 최종자료 시간이 다를 수 있습니다. - 검색시간 조회시 관측소 코드는 필수 입력입니다.
요청 URL 예시
- 전체 10분 자료 : https://api.hrfco.go.kr/ServiceKey/waterlevel/list/10M.xml
- 서울시(한강대교) 10분 자료 : https://api.hrfco.go.kr/ServiceKey/waterlevel/list/10M/1018683.xml
- 서울시(한강대교) 10분 기간별 자료 : https://api.hrfco.go.kr/ServiceKey/waterlevel/list/10M/1018683/202404270100/202404280100.xml
요청결과 출력
| No | 출력명 | 출력설명 |
|---|---|---|
| 1 | WLOBSCD | 수위 관측소 코드 |
| 2 | YMDHM | 년월일시분(yyyyMMddHHmm) |
| 3 | WL | 수위자료(단위 : m) |
| 4 | FW | 유량자료(단위 : m³/s) |
수위 관측소 제원 요청 포맷
| 변수명 | 필수여부 | 사용예 | 설명 |
|---|---|---|---|
| ServiceKey | 필수 | OpenAPI 인증키 | 한강홍수통제소에서 발급한 OpenAPI 인증키 |
| HydroType | 필수 | waterlevel | 수문자료 종류 : 수위 |
| DataType | 필수 | info | 관측소 제원 정보 |
| DocumentType | 필수 | .xml | xml 문서 포맷 |
| .json | json 문서 포맷 |
- 굵은 글씨는 고정값을 의미합니다.
제원 요청 URL 예시
- 관측소 제원 : https://api.hrfco.go.kr/ServiceKey/waterlevel/info.xml
제원 요청결과 출력
| No | 출력명 | 출력설명 |
|---|---|---|
| 1 | WLOBSCD | 수위 관측소 코드 |
| 2 | OBSNM | 수위 관측소 명칭 |
| 3 | AGCNM | 관할 기관 |
| 4 | ADDR | 주소 |
| 5 | ETCADDR | 나머지 주소 |
| 6 | LON | 경도(000-00-00, 세계측지계) |
| 7 | LAT | 위도(000-00-00, 세계측지계) |
| 8 | GDT | 영점표고(단위:EL.m) |
| 9 | ATTWL | 관심 수위(단위:m) |
| 10 | WRNWL | 주의보 수위(단위:m) |
| 11 | ALMWL | 경보 수위(단위:m) |
| 12 | SRSWL | 심각 수위(단위:m) |
| 13 | PFH | 계획홍수위(단위:m) |
| 14 | FSTNYN | 특보지점여부(Y,N) |
오픈 API 테스트
| 요청 타입 설정 | HydroType | |
|---|---|---|
| DataType | ||
| TimeType | ||
| 관측소 코드 | ||
| 검색 시작 시간 | ||
| 검색 종료 시간 | ||
| DocumentType | ||
| API 호출 | ||
| 호출 URL | ||
| 결과 |
|
|
오류 코드 설명
| 오류코드 | 설명 |
|---|---|
| 900 | 인증키가 유효하지 않습니다. |
| 910 | Time Type 파라미터 입력 형식이 잘못 되었습니다. |
| 920 | 잘못된 관측소 코드입니다. |
| 930 | 잘못된 날짜 형식입니다. |
| 940 | API 인증에 실패 하였습니다. |
| 941 | 미 승인 인증키 입니다. |
| 942 | 차단된 인증키 입니다. |
| 943 | 휴면 인증키 입니다. |
| 944 | 삭제된 인증키 입니다. |
| 990 | 검색된 자료가 없습니다. |
| 400 | 서버가 요청의 구문을 인식하지 못했습니다. |
| 401 | 이 요청은 인증이 필요합니다. |
| 403 | 서버에서 요청을 거부하고 있습니다. |
| 404 | 요청하신 주소를 서버에서 찾을 수 없습니다. |
| 500 | 서버 오류입니다. |
| 501 | 서버 오류입니다. |
| 502 | 서버 오류입니다. |
| 503 | 서버 오류입니다. |
(06501) 서울특별시 서초구 동작대로 328 한강홍수통제소
본 홈페이지는 게시된 이메일주소가 자동 수집되는것을 거부하며 이를 위반시 정보통신망법에 의해 처벌됨을 유념하여 주시기 바랍니다. Copyright (c) Han River Flood Control Office, All Right reserved.