Document
ODsay 대중교통 API 를 이용해 멋진 대중교통 애플리케이션을 만들어 보세요.
Document

버스노선 조회(Bus Route)

버스노선 리스트를 리턴합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/searchBusLane json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 busNo Y 조회할 버스노선번호 busNo=10
2 CID N 도시코드 CID=1000
3 stationListYn N 주요정류장 표현 옵션(default:no) stationListYn=no
4 displayCnt N 리턴 결과 개수 displayCnt=10
5 startNO N 결과 개수 중 시작번호 startNO=1

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장 노드 Y 1 데이터를 포함하는 최상위 노드
1-1 totalCount int Y 1 검색 결과 개수
1-2 totalCityList 확장 노드 Y 1 도시 리스트
1-2-1 includeCity 확장 노드 Y 1...n 도시 리스트
1-2-1-1 CID int Y 1 도시코드
1-2-1-2 cityName string Y 1 도시명
1-2-1-3 cityNameKor string N 1 도시명 국문
(다국어 서비스 시 표출)
1-2-1-4 cityNameJpnKata string N 1 도시명 일문(가타카나)
(lang = 2 일 경우 표출)
1-3 lane 확장 노드 Y 1...n 버스노선 정보 리스트
1-3-1 busNo string Y 1 버스번호
1-3-2 busNoKor string N 1 버스번호 국문
(다국어 서비스 시 표출)
1-3-3 busNoJpnKata string N 1 버스번호 일문(가타카나)
(lang = 2 인 경우 표출)
1-3-4 busID int Y 1 버스노선ID
1-3-5 localBusID string Y 1 각 지역버스노선 ID
수도권 : busCityCode가 1000 인 경우
서울, 그 외에는 경기 실시간 사용
울산시 : 노선하나에 상행노선ID, 하행노선ID 모두제공
Ex) 상행ID/하행ID 형태.
1-3-6 type int Y 1 버스노선 종류
문서하단 버스노선타입 참조
1-3-7 busCityName string Y 1 운수회사 승인 도시이름
1-3-8 busCityNameKor string N 1 운수회사 승인 도시이름 국문
(다국어 서비스 시 표출)
1-3-9 busCityNameJpnKata string N 1 운수회사 승인 도시이름 일문(가타카나)
(lang = 2 인 경우 표출)
1-3-10 busCityCode int Y 1 운수회사 승인 도시코드
1-3-11 busStartPoint string Y 1 버스노선 기점
1-3-12 busStartPointKor string N 1 버스노선 기점 국문
(다국어 서비스 시 표출)
1-3-13 busStartPointJpnKata string N 1 버스노선 기점 일문(가타카나)
(lang = 2 인 경우 표출)
1-3-14 busEndPoint string Y 1 버스노선 종점
1-3-15 busEndPointKor string N 1 버스노선 종점 국문
(다국어 서비스 시 표출)
1-3-16 busEndPointJpnKata string N 1 버스노선 종점 일문(가타카나)
(lang = 2 인 경우 표출)
1-3-17 busFirstTime string N 1 첫차시간
1-3-18 busLastTime string N 1 막차시간
1-3-19 busInterval string Y 1 운행간격(분) or 운행횟수(#1)
1-3-20 mainBusStop string N 1 주요 버스정류장
1-3-21 bus_Ep_FirstTime string N 1 종점기준 첫차
1-3-22 bus_Ep_LastTime string N 1 종점기준 막차
1-3-23 bus_Interval_Week string Y 1 평일 배차간격
1-3-24 bus_Interval_Sat string Y 1 토요일 배차간격
1-3-25 bus_Interval_Sun string Y 1 일요일(공휴일) 배차간격
1-3-26 busCompanyNameKor string Y 1 운수회사명
1-3-27 busCompanyID string Y 1 운수회사ID

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

버스노선 상세정보 조회(Bus Route Information)

특정 버스노선의 운행경로에 대한 정보를 리턴합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/busLaneDetail json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 busID Y 운행경로를 조회할 버스노선코드 busID=12018

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장 노드 Y 1 데이터를 포함하는 최상위노드
1-1 busID int Y 1 버스노선코드
1-2 busNo string Y 1 버스번호
1-3 busNoKor string N 1 버스번호 국문
(다국어 서비스 시 표출)
1-4 busNoJpnKata string N 1 버스번호 일문(가타카나)
(lang = 2 인 경우 표출)
1-5 type int Y 1 버스노선 종류
문서하단 버스노선타입 참조.
1-6 busCityName string Y 1 운수회사 승인 도시이름
1-7 busCityNameKor string N 1 운수회사 승인 도시이름 국문
(다국어 서비스 시 표출)
1-8 busCityNameJpnKata string N 1 운수회사 승인 도시이름 일문(가타카나)
(lang = 2 인 경우 표출)
1-9 busCityCode int Y 1 운수회사 승인 도시코드
1-10 busStartPoint string Y 1 버스노선 기점
1-11 busStartPointKor string N 1 버스노선 기점 국문
(다국어 서비스 시 표출)
1-12 busStartPointJpnKata string N 1 버스노선 기점 일문(가타카나)
(lang = 2 인 경우 표출)
1-13 busEndPoint string Y 1 버스노선 종점
1-14 busEndPointKor string N 1 버스노선 종점 국문
(다국어 서비스 시 표출)
1-15 busEndPointJpnKata string N 1 버스노선 종점 일문(가타카나)
(lang = 2 인 경우 표출)
1-16 busFirstTime string N 1 첫차시간
1-17 busLastTime string N 1 막차시간
1-18 busInterval string Y 1 운행간격(분) or 운행횟수(1회 -)
1-19 busTotalDistance int Y 1 버스노선 전체 운행거리
1-20 bus_Ep_FirstTime string N 1 종점기준 첫차
1-21 bus_Ep_LastTime string N 1 종점기준 막차
1-22 bus_Interval_Week string N 1 평일 배차간격(분) or 운행횟수(1회 -)
1-23 bus_Interval_Sat string N 1 토요일 배차간격(분) or 운행횟수(1회 -)
1-24 bus_Interval_Sun string N 1 일요일(공휴일) 배차간격(분) or 운행횟수(1회 -)
1-25 bus_Interval_Rushhour string N 1 출퇴근시간 배차간격(분) or 운행횟수(1회 -)
1-26 busLocalBlID string Y 1 각 지역 버스노선 ID
1-27 station 확장노드 Y 1...n 정류장 리스트
1-27-1 idx int Y 1 정류장순번
1-27-2 stationID int Y 1 정류장 ID
1-27-3 stationName string Y 1 정류장 이름
1-27-4 stationNameKor string N 1 정류장 이름 국문
(다국어 서비스 시 표출)
1-27-5 stationNameJpnKata string N 1 정류장 이름 일문(가타카나)
(lang = 2 인 경우 표출)
1-27-6 stationDistance long Y 1 정류장간 누적거리
(현재정류장에서 다음정류장까지)
1-27-7 stationDirection int Y 1 상하행 구분코드
(0:없음,1:하행,2:상행)
1-27-8 arsID string Y 1 정류장 고유번호
(0:없음)
1-27-9 x double Y 1 정류장 x좌표(경위도)
1-27-10 y double Y 1 정류장 y좌표(경위도)
1-27-11 localStationID string Y 1 정류장 LocalID
1-27-12 stationCityCode string Y 1 정류장 도시코드
1-27-13 nonstopStation int Y 1 미정차정류장
(0:정차, 1:미정차)
1-27-14 busOnlyCentralLane int Y 1 버스전용 중앙차로 정류장 해당 여부
(0: 비해당, 1: 해당)
1-28 turningPointIdx int N 1 회차점 index
1-29 busCompanyNameKor string Y 1 운수회사명
1-30 busCompanyID string Y 1 운수회사ID

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

버스정류장 세부 정보 조회(Bus Stop Information)

특정 버스정류장의 정보를 리턴합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/busStationInfo json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 stationID Y 정류장 정보를 조회할 정류장코드 stationID=107475

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 stationName string Y 1 정류장 이름
1-2 stationNameKor string N 1 정류장 이름 국문
(다국어 서비스 시 표출)
1-3 stationNameJpnKata string N 1 정류장 이름 일문(가타카나)
(lang = 2 인 경우 표출)
1-4 stationID int Y 1 정류장 ID
1-5 x double Y 1 정류장 x좌표(경위도)
1-6 y double Y 1 정류장 y좌표(경위도)
1-7 lane 확장노드 Y 1...n 정류장의 버스 노선 리스트
1-7-1 busNo string Y 1 버스노선 번호
1-7-2 busNoKor string N 1 버스노선 번호 국문
(다국어 서비스 시 표출)
1-7-3 busNoJpnKata string N 1 버스노선 번호 일문(가타카나)
(lang = 2 인 경우 표출)
1-7-4 type int Y 1 버스노선 종류
(문서하단 버스노선타입 참조)
1-7-5 busID int Y 1 버스노선 ID
1-7-6 busStartPoint string Y 1 버스노선 기점
1-7-7 busStartPointKor string N 1 버스노선 기점 국문
(다국어 서비스 시 표출)
1-7-8 busStartPointJpnKata string N 1 버스노선 기점 일문(가타카나)
(lang = 2 인 경우 표출)
1-7-9 busEndPoint string Y 1 버스노선 종점
1-7-10 busEndPointKor string N 1 버스노선 종점 국문
(다국어 서비스 시 표출)
1-7-11 busEndPointJpnKata string N 1 버스노선 종점 일문(가타카나)
(lang = 2 인 경우 표출)
1-7-12 busFirstTime string N 1 첫차시간
1-7-13 busLastTime string N 1 막차시간
1-7-14 busInterval string Y 1 운행간격(분) or 운행횟수(#1)
1-7-15 busCityCode int Y 1 운수회사 승인 도시코드
1-7-16 busCityName string Y 1 운수회사 승인 도시이름
1-7-17 busCityNameKor string N 1 운수회사 승인 도시이름 국문
(다국어 서비스 시 표출)
1-7-18 busCityNameJpnKata string N 1 운수회사 승인 도시이름 일문(가타카나)
(lang = 2 인 경우 표출)
1-7-19 busLocalBlID string Y 1 각 지역 버스노선 ID
1-7-20 busStationIdx int Y 1 정류장 순번
1-7-21 busDirectionName string Y 1 방향/방면 명
1-7-22 busDirectionNameKor string N 1 방향/방면 명 국문
(다국어 서비스 시 표출)
1-7-23 busDirectionNameJpnKata string N 1 방향/방면 명 일문(가타카나)
(lang = 2 인 경우 표출)
1-7-24 busDirectionStationID int N 1 방향/방면 정류장 ID
(busDirectionType = 1 또는 2 인 경우 표출)
1-7-25 busDirectionType int Y 1 종점/방향/방면 구분
(0: 종점, 1:방향, 2:방면)
1-8 localStationID string Y 1 각 지역 버스정류장 ID
1-9 stationCityCode int Y 1 정류장의 도시코드
1-10 arsID string Y 1 정류장 고유번호
1-11 do string Y 1 정류장주소 도
1-12 gu string Y 1 정류장주소 구
1-13 dong string Y 1 정류장주소 동
1-14 nonstopStation int Y 1 미정차정류장
(0:정차, 1:미정차)
1-15 busOnlyCentralLane int Y 1 버스전용 중앙차로 정류장 해당 여부
(0: 비해당, 1: 해당)

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

열차/KTX 운행정보 검색(Train/KTX Operation Information)

열차·KTX 운행정보를 리턴합니다.
* 열차 시간표는 코레일 등 공식 홈페이지에서 공지하는 시간표를 기준으로 제공되며, 임시 운행 열차 시간표는 제외됩니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/trainServiceTime json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 startStationID Y 역 ID startStationID=3300128
2 endStationID Y 역 ID endStationID=3300108

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 count int Y 1 검색결과 개수
1-2 startStationID int Y 1 출발역ID
1-3 startStationName string Y 1 출발역명
1-4 startStationNameKor string N 1 출발역명 국문
(다국어 서비스 시 표출)
1-5 startStationNameJpnKata string N 1 출발역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-6 endStationID int Y 1 도착역ID
1-7 endStationName string Y 1 도착역명
1-8 endStationNameKor string N 1 도착역명 국문
(다국어 서비스 시 표출)
1-9 endStationNameJpnKata string N 1 도착역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-10 station 확장노드 Y 1...n 상위노드
1-10-1 railName string Y 1 노선명(경부선, 호남선 등)
1-10-2 trainClass string Y 1 열차종류(KTX, 무궁화, 새마을, 누리로, 통근, ITX, ITX-청춘, SRT)
1-10-3 trainNo int Y 1 열차번호
1-10-4 departureTime string Y 1 출발시간
1-10-5 arrivalTime string Y 1 도착시간
1-10-6 wasteTime string Y 1 소요시간
1-10-7 runDay string Y 1 운행일
ex) 토 / 금토일 / 토일 /
화수목금토일 / 월화수목토일/
금 / 금토 / 금일 / 월 / 매일/
월화수목금토
1-10-8 generalFare 확장노드 Y 1 일반 요금
1-10-8-1 weekday string N 1 평일
1-10-8-2 weekend string N 1 주말
1-10-8-3 holiday string N 1 공휴일
1-10-9 specialFare 확장노드 Y 1 특실 요금
1-10-9-1 weekday string N 1 평일
1-10-9-2 weekend string N 1 주말
1-10-9-3 holiday string N 1 공휴일
1-10-10 standingFare 확장노드 Y 1 입석/자유석 요금
1-10-10-1 weekday string N 1 평일
1-10-10-2 weekend string N 1 주말
1-10-10-3 holiday string N 1 공휴일
1-10-11 fare 확장노드 Y 1 요금(평일 운행편인 경우 제공)
1-10-11-1 general string N 1 일반요금
1-10-11-2 special string N 1 특실요금
1-10-11-3 standing string N 1 입석/자유석 요금

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

고속버스 운행정보 검색(Express Bus Operation Information)

고속버스 운행정보를 리턴합니다.
* 고속/시외버스 운행정보 검색 API 사용을 권장합니다. 고속/시외버스 운행정보 검색 바로가기
* 고속•시외버스 운행정보는 업데이트 및 정보 수집과정에서 시간차이로 실제 정보와 다소 차이가 있을 수 있습니다.
현재 시각 기준의 정보를 얻기 위해서는 예매사이트를 확인하시기를 권장합니다. (제공 데이터는 금요일 기준)

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/expressServiceTime json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 startStationID Y 터미널 ID startStationID=4000057
2 endStationID Y 터미널 ID endStationID=4000030

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 count int Y 1 검색결과 개수
1-2 startStationID int Y 1 출발역ID
1-3 endStationID int Y 1 도착역ID
1-4 station 확장노드 Y 1...n 상위노드
1-4-1 startTerminal string Y 1 출발 터미널명
1-4-2 startTerminalKor string N 1 출발 터미널명 국문
(다국어 서비스 시 표출)
1-4-3 startTerminalJpnKata string N 1 출발 터미널명 일문(가타카나)
(lang = 2 인 경우 표출)
1-4-4 destTerminal string Y 1 도착 터미널명
1-4-5 destTerminalKor string N 1 도착 터미널명 국문
(다국어 서비스 시 표출)
1-4-6 destTerminalJpnKata string N 1 도착 터미널명 일문(가타카나)
(lang = 2 인 경우 표출)
1-4-7 wasteTime string Y 1 소요시간
1-4-8 normalFare int Y 1 일반버스 요금
1-4-9 specialFare int Y 1 우등버스 요금
1-4-10 nightFare int Y 1 심야버스 요금
1-4-11 nightSpecialFare int Y 1 심야 우등버스 요금
1-4-12 schedule string Y 1 운행시간표
1-4-13 nightSchedule string Y 1 심야 운행시간표

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

시외버스 운행정보 검색(Intercity Bus Operation Information)

시외버스 운행정보를 리턴합니다.
* 고속/시외버스 운행정보 검색 API 사용을 권장합니다. 고속/시외버스 운행정보 검색 바로가기
* 고속•시외버스 운행정보는 업데이트 및 정보 수집과정에서 시간차이로 실제 정보와 다소 차이가 있을 수 있습니다.
현재 시각 기준의 정보를 얻기 위해서는 예매사이트를 확인하시기를 권장합니다. (제공 데이터는 금요일 기준)

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/intercityServiceTime json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 startStationID Y 터미널 ID startStationID=4000022
2 endStationID Y 터미널 ID endStationID=4000255

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 count int Y 1 검색결과 개수
1-2 startStationID int Y 1 출발역ID
1-3 endStationID int Y 1 도착역ID
1-4 station 확장노드 Y 1...n 상위노드
1-4-1 startTerminal string Y 1 출발 터미널명
1-4-2 startTerminalKor string N 1 출발 터미널명 국문
(다국어 서비스 시 표출)
1-4-3 startTerminalJpnKata string N 1 출발 터미널명 일문(가타카나)
(lang = 2 인 경우 표출)
1-4-4 destTerminal string Y 1 도착 터미널명
1-4-5 destTerminalKor string N 1 도착 터미널명 국문
(다국어 서비스 시 표출)
1-4-6 destTerminalJpnKata string N 1 도착 터미널명 일문(가타카나)
(lang = 2 인 경우 표출)
1-4-7 firstTime string Y 1 첫차시간
1-4-8 lastTime string Y 1 막차시간
1-4-9 interval string Y 1 운행횟수/운행간격(두값중 하나만 존재)
ex) 10/0:00 : 일 10회 운행
0/1:30 : 1:30분 간격
1-4-10 wasteTime string Y 1 소요시간
1-4-11 normalFare string Y 1 일반버스 요금
1-4-12 nightFare string Y 1 심야버스 요금
1-4-13 schedule string Y 1 운행시간표
1-4-14 nightSchedule string Y 1 심야 운행시간표

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

고속/시외버스 운행정보 검색(Express/Intercity Bus Operation Information)

고속•시외버스 운행정보를 리턴합니다.
* 고속•시외버스 운행정보를 통합하여 제공하는 API 입니다. 이전 고속버스 운행정보 검색 및 시외버스 운행정보 검색 가이드를 확인하시려면 아래의 링크를 클릭해주세요.
   - 고속버스 운행정보 검색 바로가기
   - 시외버스 운행정보 검색 바로가기
* 고속•시외버스 운행정보는 업데이트 및 정보 수집과정에서 시간차이로 실제 정보와 다소 차이가 있을 수 있습니다.
   현재 시각 기준의 정보를 얻기 위해서는 예매사이트를 확인하시기를 권장합니다. (제공 데이터는 금요일 기준)

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/searchInterBusSchedule json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 startStationID Y 터미널 ID startStationID=4000314
2 endStationID Y 터미널 ID endStationID=4000030
3 stationClass N 정류장 종류
(4:고속버스터미널, 6:시외버스터미널)
stationClass=6

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 count int Y 1 검색결과 개수
1-2 stationClass int Y 1 정류장 종류
(4:고속버스터미널, 6:시외버스터미널)
1-3 startStationID int Y 1 출발역ID
1-4 startStationName string Y 1 출발 터미널명
1-5 startStationNameKor string N 1 출발 터미널명 국문
(다국어 서비스 시 표출)
1-6 startStationNameJpnKata string N 1 출발 터미널명 일문(가타카나)
(lang = 2 인 경우 표출)
1-7 endStationID int Y 1 도착역ID
1-8 endStationName string Y 1 도착 터미널명
1-9 endStationNameKor string N 1 도착 터미널명 국문
(다국어 서비스 시 표출)
1-10 endStationNameJpnKata string N 1 도착 터미널명 일문(가타카나)
(lang = 2 인 경우 표출)
1-11 firstTime string Y 1 첫차시간
1-12 lastTime string Y 1 막차시간
1-13 schedule 확장노드 Y 1...n 운행정보 확장노드
1-13-1 busClass int Y 1 버스타입
1:일반
2:우등
3:프리미엄
4:심야 일반
5:심야 우등
6:심야 프리미엄
7:주말 프리미엄
8:주말심야 프리미엄
1-13-2 departureTime string Y 1 출발시간
1-13-3 wasteTime int Y 1 소요시간
1-13-4 fare int Y 1 요금

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

항공 운행정보 검색(Aviation Operation Information)

항공 운행정보를 리턴합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/airServiceTime json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 startStationID Y 출발 공항 ID startStationID=3500001
2 endStationID Y 도착 공항 ID endStationID=3500003
3 selectTime N 출발시간(정해진 시간이후의 정보만 표출) 기본값은 6이다.
6~21까지 입력가능.
selectTime=6

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 count int Y 1 검색결과 개수
1-2 startStationID int Y 1 출발 공항 ID
1-3 startStationName string Y 1 출발 공항명
1-4 startStationNameKor string N 1 출발 공항명 국문
(다국어 서비스 시 표출)
1-5 startStationNameJpnKata string N 1 출발 공항명 일문
(lang = 2 인 경우 표출)
1-6 endStationID int Y 1 도착 공항 ID
1-7 endStationName string Y 1 도착 공항명
1-8 endStationNameKor string N 1 도착 공항명 국문
(다국어 서비스 시 표출)
1-9 endStationNameJpnKata string N 1 도착 공항명 일문(가타카나)
(lang = 2 인 경우 표출)
1-10 station 확장 노드 Y 1...n 상위노드
1-10-1 airline string Y 1 항공사
1-10-2 departureTime string Y 1 출발시각
1-10-3 arrivalTime string Y 1 도착시각
1-10-4 flight string Y 1 편명
1-10-5 runDay string Y 1 운항일

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

운수회사별 버스노선 조회(Bus Route by Transportation Company)

운수회사별 버스노선를 리턴합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/searchByCompany json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 companyID Y 조회할 운수회사 ID companyID=792
2 busNo N 조회할 버스노선번호 busNo=100

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 lane 확장노드 Y 1...n 버스노선 정보 리스트
1-1-1 busNo string Y 1 버스번호
1-1-2 busNoKor string N 1 버스번호 국문
(다국어 서비스 시 표출)
1-1-3 busNoJpnKata string N 1 버스번호 일문(가타카나)
(lang = 2 인 경우 표출)
1-1-4 busID int Y 1 버스노선 ID
1-1-5 localBusID string Y 1 각 지역버스노선 ID
(수도권 : busCityCode : 1000 -> 서울
그 외에는 경기 실시간 사용)
1-1-6 type int Y 1 버스노선 종류
문서하단 버스노선타입 참조
1-1-7 busCityName string Y 1 운수회사 승인 도시이름
1-1-8 busCityNameKor string N 1 운수회사 승인 도시이름 국문
(다국어 서비스 시 표출)
1-1-9 busCityNameJpnKata string N 1 운수회사 승인 도시이름 일문(가타카나)
(lang = 2 인 경우 표출)
1-1-10 busCityCode int Y 1 운수회사 승인 도시코드
1-1-11 busStartPoint string Y 1 버스노선 기점
1-1-12 busStartPointKor string N 1 버스노선 기점 국문
(다국어 서비스 시 표출)
1-1-13 busStartPointJpnKata string N 1 버스노선 기점 일문(가타카나)
(lang = 2 인 경우 표출)
1-1-14 busEndPoint string Y 1 버스노선 종점
1-1-15 busEndPointKor string N 1 버스노선 종점 국문
(다국어 서비스 시 표출)
1-1-16 busEndPointJpnKata string N 1 버스노선 종점 일문(가타카나)
(lang = 2 인 경우 표출)
1-1-17 busFirstTime string Y 1 첫차시간
1-1-18 busLastTime string Y 1 막차시간
1-1-19 busInterval string Y 1 운행간격(분) or 운행횟수(#1)

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

지하철역 세부 정보 조회(Subway Station Information)

지하철역 세부 정보를 리턴합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/subwayStationInfo json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 stationID Y 지하철 역 정보를 조회 할 역코드 stationID=130

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 stationName string Y 1 지하철역 명
1-2 stationNameKor string N 1 지하철역 명 국문
(다국어 서비스 시 표출)
1-3 stationNameJpnKata string N 1 지하철역 명 일문(가타카나)
(lang = 2 인 경우 표출)
1-4 stationID int Y 1 지하철역 ID
1-5 type int Y 1 노선종류
문서하단 지하철노선타입 참조
1-6 laneName string Y 1 노선명
1-7 laneNameKor string N 1 노선명 국문
(다국어 서비스 시 표출)
1-8 laneNameJpnKata string N 1 노선명 일문(가타카나)
(lang = 2 인 경우 표출)
1-9 laneCity string Y 1 노선지역명
1-10 laneCityKor string N 1 노선지역명 국문
(다국어 서비스 시 표출)
1-11 laneCityJpnKata string N 1 노선지역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-12 x double Y 1 x좌표(경위도)
1-13 y double Y 1 y좌표(경위도)
1-14 exOBJ 확장노드 N 0...1 환승역 리스트
1-14-1 station 확장노드 N 0...n 환승역
1-14-1-1 stationName string N 1 환승역 명
1-14-1-2 stationNameKor string N 1 환승역 명 국문
(다국어 서비스 시 표출)
1-14-1-3 stationNameJpnKata string N 1 환승역 명 일문(가타카나)
(lang = 2 인 경우 표출)
1-14-1-4 stationID int N 1 환승역ID
1-14-1-5 type int N 1 노선종류
* 지하철노선
1-14-1-6 laneName string N 1 노선명
1-14-1-7 laneNameKor string N 1 노선명 국문
(다국어 서비스 시 표출)
1-14-1-8 laneNameJpnKata string N 1 노선명 일문(가타카나)
(lang = 2 인 경우 표출)
1-14-1-9 laneCity string N 1 노선지역명
1-14-1-10 laneCityKor string N 1 노선지역명 국문
(다국어 서비스 시 표출)
1-14-1-11 laneCityJpnKata string N 1 노선지역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-15 prevOBJ 확장 노드 N 0...1 이전역 리스트
1-15-1 station 확장 노드 N 1...n 이전역
1-15-1-1 stationName string N 1 역 명
1-15-1-2 stationNameKor string N 1 역 명 국문
(다국어 서비스 시 표출)
1-15-1-3 stationNameJpnKata string N 1 역 명 일문(가타카나)
(lang = 2 인 경우 표출)
1-15-1-4 stationID int N 1 역 ID
1-15-1-5 type int N 1 노선종류
* 지하철노선
1-15-1-6 laneName string N 1 노선명
1-15-1-7 laneNameKor string N 1 노선명 국문
(다국어 서비스 시 표출)
1-15-1-8 laneNameJpnKata string N 1 노선명 일문(가타카나)
(lang = 2 인 경우 표출)
1-15-1-9 laneCity string N 1 노선지역명
1-15-1-10 laneCityKor string N 1 노선지역명 국문
(다국어 서비스 시 표출)
1-15-1-11 laneCityJpnKata string N 1 노선지역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-15-1-12 x double N 1 x좌표(경위도)
1-15-1-13 y double N 1 y좌표(경위도)
1-16 nextOBJ 확장 노드 N 0...1 다음역 리스트
1-16-1 station 확장 노드 N 0…n 다음역
1-16-1-1 stationName string N 1 역 명
1-16-1-2 stationNameKor string N 1 역 명 국문
(다국어 서비스 시 표출)
1-16-1-3 stationNameJpnKata string N 1 역 명 일문(가타카나)
(lang = 2 인 경우 표출)
1-16-1-4 stationID int N 1 역ID
1-16-1-5 type int N 1 노선종류
* 지하철노선
1-16-1-6 laneName string N 1 노선명
1-16-1-7 laneNameKor string N 1 노선명 국문
(다국어 서비스 시 표출)
1-16-1-8 laneNameJpnKata string N 1 노선명 일문(가타카나)
(lang = 2 인 경우 표출)
1-16-1-9 laneCity string N 1 노선지역명
1-16-1-10 laneCityKor string N 1 노선지역명 국문
(다국어 서비스 시 표출)
1-16-1-11 laneCityJpnKata string N 1 노선지역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-16-1-12 x double N 1 x좌표(경위도)
1-16-1-13 y double N 1 y좌표(경위도)
1-17 defaultInfo 확장 노드 Y 1 기본 역 정보
1-17-1 address string Y 1 역 주소
1-17-2 new_address string N 1 도로명 주소
1-17-3 tel string Y 1 역 전화번호
1-18 useInfo 확장 노드 Y 1 이용정보
1-18-1 platform int Y 1 플랫폼
(0:기타, 1:중앙, 2:양쪽, 3:복선(국 철), 4:일방향)
1-18-2 meetingPlace int Y 1 만남의 장소
(0:없음, 1:있음)
1-18-3 restroom int Y 1 화장실
(0:없음, 1:안쪽, 2:바깥, 3:환승역연 결, 4:안쪽,바깥쪽)
1-18-4 offDoor int Y 1 내리는 문 위치
(0:왼쪽, 1:오른쪽, 2:양쪽)
1-18-5 crossOver int Y 1 반대편 횡단
(0:기타, 1:연결안됨, 2:연결됨, 3:환승역연결)
1-18-6 publicPlace int Y 1 현장 사무소
(0:없음, 1:있음)
1-18-7 handicapCount int Y 1 장애인편의시설
(0:없음, 1:있음)
1-18-8 parkingCount int Y 1 환승주차장
(0:없음, 1:있음)
1-18-9 bicycleCount int Y 1 자전거보관소
(0:없음, 1:있음)
1-18-10 civilCount int Y 1 민원안내 (0:없음, 1:있음)
1-19 exitInfo 확장노드 Y 1 출구정보
1-19-1 gate 확장 노드 Y 1...n 출구
1-19-1-1 gateNo string Y 1 출구번호
1-19-1-2 gateLink string Y 1...n 주요명칭
1-19-1-3 BUSSTOP 확장노드 N 1...n 출구별 버스정류장 정보
1-19-1-3-1 StopName string Y 1 버스정류장명칭
1-19-1-3-2 StopNameKor string N 1 버스정류장명칭 국문
(다국어 서비스 시 표출)
1-19-1-3-3 StopNameJpnKata string N 1 버스정류장명칭 일문(가타카나)
(lang = 2 인 경우 표출)
1-19-1-3-4 StopID string Y 1 버스정류장ID
1-19-1-3-5 Bus 확장노드 Y 1...n 버스노선정보 그룹노드
1-19-1-3-5-1 BusNo string Y 1 버스노선 번호
1-19-1-3-5-2 BusNoKor string N 1 버스노선 번호 국문
(다국어 서비스 시 표출)
1-19-1-3-5-3 BusNoJpnKata string N 1 버스노선 번호 일문(가타카나)
(lang = 2 인 경우 표출)
1-19-1-3-5-4 Type string Y 1 버스노선 타입
1-19-1-3-5-5 BlID string Y 1 버스노선 ID
1-19-1-3-5-6 BusCityName string Y 1 운수회사 승인 도시 이름
1-19-1-3-5-7 BusCityNameKor string N 1 운수회사 승인 도시 이름 국문
(다국어 서비스 시 표출)
1-19-1-3-5-8 BusCityNameJpnKata string N 1 운수회사 승인 도시 이름 일문(가타카나)
(lang = 2 인 경우 표출)
1-20 CityCode int Y 1 도시코드

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

(구) 지하철역 전체 시간표 조회(Subway Station Timetable)

지하철역 전체 시간표를 리턴합니다.
* 결과 포맷이 새로워진 신규 지하철역 전체 시간표 조회 API 사용을 권장합니다. (신) 지하철역 전체 시간표 조회 API 바로가기

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/subwayTimeTable json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=0
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 stationID Y 지하철역 시간표 정보를 조회 할 역코드 stationID=130
2 wayCode N 지하철역 방면 코드
(1:상행, 2:하행)
wayCode=1
3 showExpressTime N 급행시간 표출 여부
(1:급행포함)
showExpressTime=1
4 sepExpressTime N 특급열차 분리 여부
(1:특급분리)
sepExpressTime=1

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 stationName string Y 1 지하철역 명
1-2 stationNameKor string N 1 지하철역 명 국문
(다국어 서비스 시 표출)
1-3 stationNameJpnKata string N 1 지하철역 명 일문(가타카나)
(lang = 2 인 경우 표출)
1-4 stationID int Y 1 지하철역 ID
1-5 type int Y 1 노선종류
문서하단 지하철노선타입 참조
1-6 laneName string Y 1 노선명
1-7 laneNameKor string N 1 노선명 국문
(다국어 서비스 시 표출)
1-8 laneNameJpnKata string N 1 노선명 일문(가타카나)
(lang = 2 인 경우 표출)
1-9 laneCity string Y 1 노선지역명
1-10 laneCityKor string N 1 노선지역명 국문
(다국어 서비스 시 표출)
1-11 laneCityJpnKata string N 1 노선지역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-12 upWay string Y 1 상행방향
1-13 upWayKor string N 1 상행방향 국문
(다국어 서비스 시 표출)
1-14 upWayJpnKata string N 1 상행방향 일문(가타카나)
(lang = 2 인 경우 표출)
1-15 downWay string Y 1 하행방향
1-16 downWayKor string N 1 하행방향 국문
(다국어 서비스 시 표출)
1-17 downWayJpnKata string N 1 하행방향 일문(가타카나)
(lang = 2 인 경우 표출)
1-18 OrdList 확장 노드 Y 1 평일 시간 리스트
1-18-1 up 확장노드 N 0...1 상행선 시간 리스트
1-18-1-1 time 확장 노드 Y 1...n 시간별 시간 data 리스트
1-18-1-1-1 Idx int Y 1 시간
(5~25시 까지 , 25는 1시)
1-18-1-1-2 list string Y 1 시간 data
1-18-1-1-3 listKor string N 1 시간 data 국문
(다국어 서비스 시 표출)
1-18-1-1-4 listJpnKata string N 1 시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-18-1-1-5 expList string N 1 급행시간 data
1-18-1-1-6 expListKor string N 1 급행시간 data 국문
(다국어 서비스 시 표출)
1-18-1-1-7 expListJpnKata string N 1 급행시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-18-1-1-8 expSPList string N 1 특급시간 data
1-18-1-1-9 expSPListKor string N 1 특급시간 data 국문
(댜국어 서비스 시 표출)
1-18-1-1-10 expSPListJpnKata string N 1 특급시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-18-2 down 확장 노드 N 0...1 하행선 시간 리스트
1-18-2-1 time 확장 노드 Y 1 시간별 시간 data 리스트
1-18-2-1-1 Idx int Y 1 시간
(5~25시 까지 , 25는 1시)
1-18-2-1-2 list string Y 1 시간 data
1-18-2-1-3 listKor string N 1 시간 data 국문
(다국어 서비스 시 표출)
1-18-2-1-4 listJpnKata string N 1 시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-18-2-1-5 expList string N 1 급행시간 data
1-18-2-1-6 expListKor string N 1 급행시간 data 국문
(다국어 서비스 시 표출)
1-18-2-1-7 expListJpnKata string N 1 급행시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-18-2-1-8 expSPList string N 1 특급시간 data
1-18-2-1-9 expSPListKor string N 1 특급시간 data 국문
(다국어 서비스 시 표출)
1-18-2-1-10 expSPListJpnKata string N 1 특급시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-19 SatList 확장 노드 Y 1 토요일 시간 리스트
1-19-1 up 확장 노드 N 0...1 상행선 시간 리스트
1-19-1-1 time 확장 노드 Y 1 시간별 시간 data 리스트
1-19-1-1-1 Idx int Y 1 시간
(5~25시 까지 , 25는 1시)
1-19-1-1-2 list string Y 1 시간 data
1-19-1-1-3 listKor string N 1 시간 data 국문
(다국어 서비스 시 표출)
1-19-1-1-4 listJpnKata string N 1 시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-19-1-1-5 expList string N 1 급행시간 data
1-19-1-1-6 expListKor string N 1 급행시간 data 국문
(다국어 서비스 시 표출)
1-19-1-1-7 expListJpnKata string N 1 급행시간 data 일문
(lang = 2 인 경우 표출)
1-19-1-1-8 expSPList string N 1 특급시간 data
1-19-1-1-9 expSPListKor string N 1 특급시간 data 국문
(다국어 서비스 시 표출)
1-19-1-1-10 expSPListJpnKata string N 1 특급시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-19-2 down 확장노드 N 0...1 하행선 시간 리스트
1-19-2-1 time 확장노드 Y 1 시간별 시간 data 리스트
1-19-2-1-1 Idx int Y 1 시간
(5~25시 까지 , 25는 1시)
1-19-2-1-2 list string Y 1 시간 data
1-19-2-1-3 listKor string N 1 시간 data 국문
(다국어 서비스 시 표출)
1-19-2-1-4 listJpnKata string N 1 시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-19-2-1-5 expList string N 1 급행시간 data
1-19-2-1-6 expListKor string N 1 급행시간 data 국문
(다국어 서비스 시 표출)
1-19-2-1-7 expListJpnKata string N 1 급행시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-19-2-1-8 expSPList string N 1 특급시간 data
1-19-2-1-9 expSPListKor string N 1 특급시간 data 국문
(다국어 서비스 시 표출)
1-19-2-1-10 expSPListJpnKata string N 1 특급시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-20 SunList 확장노드 Y 1 일요일 시간 리스트
1-20-1 up 확장노드 N 0...1 상행선 시간 리스트
1-20-1-1 time 확장노드 Y 1 시간별 시간 data 리스트
1-20-1-1-1 Idx int Y 1 시간
(5~25시 까지 , 25는 1시)
1-20-1-1-2 list string Y 1 시간 data
1-20-1-1-3 listKor string N 1 시간 data 국문
(다국어 서비스 시 표출)
1-20-1-1-4 listJpnKata string N 1 시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-20-1-1-5 expList string N 1 급행시간 data
1-20-1-1-6 expListKor string N 1 급행시간 data 국문
(다국어 서비스 시 표출)
1-20-1-1-7 expListJpnKata string N 1 급행시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-20-1-1-8 expSPList string N 1 특급시간 data
1-20-1-1-9 expSPListKor string N 1 특급시간 data 국문
(다국어 서비스 시 표출)
1-20-1-1-10 expSPListJpnKata string N 1 특급시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-20-2 down 확장노드 N 0...1 하행선 시간 리스트
1-20-2-1 time 확장노드 Y 1 시간별 시간 data 리스트
1-20-2-1-1 Idx int Y 1 시간
(5~25시 까지 , 25는 1시)
1-20-2-1-2 list string Y 1 시간 data
1-20-2-1-3 listKor string N 1 시간 data 국문
(다국어 서비스 시 표출)
1-20-2-1-4 listJpnKata string N 1 시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-20-2-1-5 expList string N 1 급행시간 data
1-20-2-1-6 expListKor string N 1 급행시간 data 국문
(다국어 서비스 시 표출)
1-20-2-1-7 expListJpnKata string N 1 급행시간 data 일문(가타카나)
(lang = 2 인 경우 표출)
1-20-2-1-8 expSPList string N 1 특급시간 data
1-20-2-1-9 expSPListKor string N 1 특급시간 data 국문
(다국어 서비스 시 표출)
1-20-2-1-10 expSPListJpnKata string N 1 특급시간 data 일문(가타카나)
(lang = 2 인 경우 표출)

Console에서 예시 확인하기»

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

(신) 지하철역 전체 시간표 조회(Subway Station Timetable)

지하철역 전체 시간표를 리턴합니다.
* 2024.05.02 결과 포맷이 새로워진 신규 지하철역 전체 시간표 조회 API 입니다. 이전 버전의 가이드를 확인하시려면 여기를 클릭하세요.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/searchSubwaySchedule json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=0
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 stationID Y 지하철역 시간표 정보를 조회 할 역코드 stationID=130
2 wayCode N 지하철역 방면 코드
(1:상행, 2:하행)
wayCode=1
3 showExpressTime N 급행시간 표출 여부
(1:급행포함)
showExpressTime=1
4 sepExpressTime N 특급열차 분리 여부
(1:특급분리)
sepExpressTime=1

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최상위 노드
1-1 stationName string Y 1 지하철역 명
1-2 stationNameKor string N 1 지하철역 명 국문
(다국어 서비스 시 표출)
1-3 stationNameJpnKata string N 1 지하철역 명 일문(가타카나)
(lang = 2 인 경우 표출)
1-4 stationID int Y 1 지하철역 ID
1-5 type int Y 1 노선종류
문서하단 지하철노선타입 참조
1-6 laneName string Y 1 노선명
1-7 laneNameKor string N 1 노선명 국문
(다국어 서비스 시 표출)
1-8 laneNameJpnKata string N 1 노선명 일문(가타카나)
(lang = 2 인 경우 표출)
1-9 laneCity string Y 1 노선지역명
1-10 laneCityKor string N 1 노선지역명 국문
(다국어 서비스 시 표출)
1-11 laneCityJpnKata string N 1 노선지역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-12 prevOBJ 확장노드 N 0...1 이전역 리스트
1-12-1 station 확장노드 N 1...n 이전역
1-12-1-1 stationName string N 1 역 명
1-12-1-2 stationNameKor string N 1 역 명 국문
(다국어 서비스 시 표출)
1-12-1-3 stationNameJpnKata string N 1 역 명 일문(가타카나)
(lang = 2 인 경우 표출)
1-12-1-4 stationID int N 1 역 ID
1-12-1-5 type int N 1 노선종류
* 지하철노선
1-12-1-6 laneName string N 1 노선명
1-12-1-7 laneNameKor string N 1 노선명 국문
(다국어 서비스 시 표출)
1-12-1-8 laneNameJpnKata string N 1 노선명 일문(가타카나)
(lang = 2 인 경우 표출)
1-12-1-9 laneCity string N 1 노선지역명
1-12-1-10 laneCityKor string N 1 노선지역명 국문
(다국어 서비스 시 표출)
1-12-1-11 laneCityJpnKata string N 1 노선지역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-12-1-12 x double N 1 x좌표(경위도)
1-12-1-13 y double N 1 y좌표(경위도)
1-13 nextOBJ 확장노드 N 0...1 다음역 리스트
1-13-1 station 확장노드 N 0…n 다음역
1-13-1-1 stationName string N 1 역 명
1-13-1-2 stationNameKor string N 1 역 명 국문
(다국어 서비스 시 표출)
1-13-1-3 stationNameJpnKata string N 1 역 명 일문(가타카나)
(lang = 2 인 경우 표출)
1-13-1-4 stationID int N 1 역ID
1-13-1-5 type int N 1 노선종류
* 지하철노선
1-13-1-6 laneName string N 1 노선명
1-13-1-7 laneNameKor string N 1 노선명 국문
(다국어 서비스 시 표출)
1-13-1-8 laneNameJpnKata string N 1 노선명 일문(가타카나)
(lang = 2 인 경우 표출)
1-13-1-9 laneCity string N 1 노선지역명
1-13-1-10 laneCityKor string N 1 노선지역명 국문
(다국어 서비스 시 표출)
1-13-1-11 laneCityJpnKata string N 1 노선지역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-13-1-12 x double N 1 x좌표(경위도)
1-13-1-13 y double N 1 y좌표(경위도)
1-14 weekdaySchedule 확장노드 Y 1 평일 시간표
1-14-1 up 확장노드 N 0...n 상행선 시간 리스트
1-14-1-1 subwayClass int Y 1 열차 타입
0: 일반
1: 급행
2: 특급
1-14-1-2 departureTime string Y 1 출발시간
1-14-1-3 startStationName string Y 1 출발역명
1-14-1-4 startStationNameKor string N 1 출발역명 국문
(다국어 서비스 시 표출)
1-14-1-5 startStationNameJpnKata string N 1 출발역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-14-1-6 endStationName string Y 1 도착역명
1-14-1-7 endStationNameKor string N 1 도착역명 국문
(다국어 서비스 시 표출)
1-14-1-8 endStationNameJpnKata string N 1 도착역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-14-1-9 firstLastFlag int Y 1 첫/막차 구분
0: 일반
1: 첫차
2: 막차
3: 첫차,막차
1-14-2 down 확장노드 N 0...n 하행선 시간 리스트
1-14-2-1 subwayClass int Y 1 열차 타입
0: 일반
1: 급행
2: 특급
1-14-2-2 departureTime string Y 1 출발시간
1-14-2-3 startStationName string Y 1 출발역명
1-14-2-4 startStationNameKor string N 1 출발역명 국문
(다국어 서비스 시 표출)
1-14-2-5 startStationNameJpnKata string N 1 출발역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-14-2-6 endStationName string Y 1 도착역명
1-14-2-7 endStationNameKor string N 1 도착역명 국문
(다국어 서비스 시 표출)
1-14-2-8 endStationNameJpnKata string N 1 도착역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-14-2-9 firstLastFlag int Y 1 첫/막차 구분
0: 일반
1: 첫차
2: 막차
3: 첫차,막차
1-15 saturdaySchedule 확장노드 Y 1 토요일 시간표
1-15-1 up 확장노드 N 0...n 상행선 시간 리스트
1-15-1-1 subwayClass int Y 1 열차 타입
0: 일반
1: 급행
2: 특급
1-15-1-2 departureTime string Y 1 출발시간
1-15-1-3 startStationName string Y 1 출발역명
1-15-1-4 startStationNameKor string N 1 출발역명 국문
(다국어 서비스 시 표출)
1-15-1-5 startStationNameJpnKata string N 1 출발역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-15-1-6 endStationName string Y 1 도착역명
1-15-1-7 endStationNameKor string N 1 도착역명 국문
(다국어 서비스 시 표출)
1-15-1-8 endStationNameJpnKata string N 1 도착역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-15-1-9 firstLastFlag int Y 1 첫/막차 구분
0: 일반
1: 첫차
2: 막차
3: 첫차,막차
1-15-2 down 확장노드 N 0...n 하행선 시간 리스트
1-15-2-1 subwayClass int Y 1 열차 타입
0: 일반
1: 급행
2: 특급
1-15-2-2 departureTime string Y 1 출발시간
1-15-2-3 startStationName string Y 1 출발역명
1-15-2-4 startStationNameKor string N 1 출발역명 국문
(다국어 서비스 시 표출)
1-15-2-5 startStationNameJpnKata string N 1 출발역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-15-2-6 endStationName string Y 1 도착역명
1-15-2-7 endStationNameKor string N 1 도착역명 국문
(다국어 서비스 시 표출)
1-15-2-8 endStationNameJpnKata string N 1 도착역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-15-2-9 firstLastFlag int Y 1 첫/막차 구분
0: 일반
1: 첫차
2: 막차
3: 첫차,막차
1-16 holidaySchedule 확장노드 Y 1 일요일(공휴일) 시간표
1-16-1 up 확장노드 N 0...n 상행선 시간 리스트
1-16-1-1 subwayClass int Y 1 열차 타입
0: 일반
1: 급행
2: 특급
1-16-1-2 departureTime string Y 1 출발시간
1-16-1-3 startStationName string Y 1 출발역명
1-16-1-4 startStationNameKor string N 1 출발역명 국문
(다국어 서비스 시 표출)
1-16-1-5 startStationNameJpnKata string N 1 출발역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-16-1-6 endStationName string Y 1 도착역명
1-16-1-7 endStationNameKor string N 1 도착역명 국문
(다국어 서비스 시 표출)
1-16-1-8 endStationNameJpnKata string N 1 도착역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-16-1-9 firstLastFlag int Y 1 첫/막차 구분
0: 일반
1: 첫차
2: 막차
3: 첫차,막차
1-16-2 down 확장노드 N 0...n 하행선 시간 리스트
1-16-2-1 subwayClass int Y 1 열차 타입
0: 일반
1: 급행
2: 특급
1-16-2-2 departureTime string Y 1 출발시간
1-16-2-3 startStationName string Y 1 출발역명
1-16-2-4 startStationNameKor string N 1 출발역명 국문
(다국어 서비스 시 표출)
1-16-2-5 startStationNameJpnKata string N 1 출발역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-16-2-6 endStationName string Y 1 도착역명
1-16-2-7 endStationNameKor string N 1 도착역명 국문
(다국어 서비스 시 표출)
1-16-2-8 endStationNameJpnKata string N 1 도착역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-16-2-9 firstLastFlag int Y 1 첫/막차 구분
0: 일반
1: 첫차
2: 막차
3: 첫차,막차

Console에서 예시 확인하기»

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

노선 그래픽 데이터 검색(Route Graphic Data)

구간에 대한 노선 경로 정보를 리턴합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/loadLane json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 mapObject Y 경로를 조회할 코드
경로검색시 나오는 mapOBJ값 형식
BaseX:BaseY@ID:Class:StartIdx:EndIdx@...@ID:Class:StartIdx:EndIdx

BaseX:BaseY : 데이터 기준점이 값이 빼진 값으로 좌표가 리턴됨
ID : (버스노선ID 또는 지하철노선ID)
Class : 1(버스), 2(지하철)
StartIdx : 출발인덱스
EndIdx : 도착인덱스

전체노선 호출시 StartIdx, EndIdx 는 -1
예) 126:37@3:2:310:329 (수도권 지하철 3호선 310에서 319까지 구간)
126:37@2:2:-1:-1 (수도권 지하철 2호선 전체)
mapObject=0:0@12018:1:-1:-1

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 lane 확장노드 Y 1...n 요청된 lane 리스트
1-1-1 class int Y 1 1(버스노선), 2(지하철노선)
1-1-2 type int Y 1 노선종류
문서하단 버스노선, 지하철노선 타입 참조
1-1-3 section 확장노드 Y n section 리스트
1-1-3-1 graphPos 확장 노드 Y 1...n 좌표 리스트
1-1-3-1-1 x double Y 1 x좌표(경위도)
1-1-3-1-2 y double Y 1 y좌표(경위도)
1-2 boundary 확장 노드 Y 1 좌표의 rectangle
Load된 노선들에 대한 경계값
1-2-1 left double Y 1 Left 좌표
1-2-2 top double Y 1 Top 좌표
1-2-3 right double Y 1 Right 좌표
1-2-4 bottom double Y 1 Bottom 좌표

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

대중교통 정류장 검색(Public Transit Stop)

대중교통 정류장 세부정보를 리턴합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/searchStation json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 stationName Y 정류장을 검색 할 이름(2자 이상) stationName=14
2 CID N 도시코드 CID=1000
3 stationClass N 정류장 종류(여러 개 선택 가능)
1:2 (default)
1 : 버스정류장
2 : 지하철역
3 : 기차역
4 : 고속버스터미널
5 : 공항
6 : 시외버스터미널
7 : 항만(업데이트 예정)
stationClass=1:2
4 displayCnt N 리턴 결과 개수
(displayCnt와 startNO중 한 값이라도 없으면 모든 결과 표현)
displayCnt=10
5 startNO N 결과 개수 중 시작번호
(displayCnt와 startNO 중 한 값이라도 없으면 모든 결과 표현)
startNO=1
6 myLocation N 현위치 좌표 myLocation=127.0363583:37.5113295

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 totalCount int Y 1 검색 결과 개수
1-2 totalCityList 확장 노드 Y 1 도시 리스트
1-2-1 includeCity 확장 노드 Y 1...n 도시 리스트
1-2-1-1 CID int Y 1 도시코드
1-2-1-2 cityName string Y 1 도시명
1-2-1-3 cityNameKor string N 1 도시명 국문
(다국어 서비스 시 표출)
1-2-1-4 cityNameJpnKata string N 1 도시명 일문(가타카나)
(lang = 2 인 경우 표출)
1-3 station 확장 노드 Y 1...n 정류장 리스트
1-3-1 stationClass int Y 1 정류장 종류
1 : 버스정류장
2 : 지하철역
3 : 기차역
4 : 고속버스터미널
5 : 공항
6 : 시외버스터미널
7 : 항만
1-3-2 stationName string Y 1 정류장 이름
1-3-3 stationNameKor string N 1 정류장 이름 국문
(다국어 서비스 시 표출)
1-3-4 stationNameJpnKata string N 1 정류장 이름 일문(가타카나)
(lang = 2 인 경우 표출)
1-3-5 stationID int Y 1 정류장ID
1-3-6 localStationID string N 1 각 지역버스정류장 ID
- 수도권(서울,경기,인천의 경우) ARSID / 경기 지자체시스템ID /인천시 ID 구조
Ex) 89123/120000445/ICB165000355
- 경산시, 대구시의 경우 경산시 정류장ID/대구시 정류장ID 형태로 제공 됨
- 나머지 지역은 정류장 ID 단일로 제공
1-3-7 type int N 1 노선종류
문서하단 지하철 노선타입 참조
(stationClass 2 인 경우만)
1-3-8 laneName string N 1 노선명
(stationClass 2 인 경우만)
1-3-9 laneNameKor string N 1 노선명 국문
(stationClass 2 인 경우만)
(다국어 서비스 시 표출)
1-3-10 laneNameJpnKata string N 1 노선명 일문(가타카나)
(stationClass 2 인 경우만)
(lang = 2 인 경우 표출)
1-3-11 laneCity string N 1 노선명
(stationClass 2 인 경우만)
1-3-12 laneCityKor string N 1 노선명 국문
(stationClass 2 인 경우만)
(다국어 서비스 시 표출)
1-3-13 laneCityJpnKata string N 1 노선명 일문(가타카나)
(stationClass 2 인 경우만)
(lang = 2 인 경우 표출)
1-3-14 stationType int N 1 시외버스정류장 종류
(1:시외버스터미널, 2:시외버스정류소)
(stationClass 6 인 경우만)
1-3-15 x double Y 1 정류장 x좌표(경위도)
1-3-16 y double Y 1 정류장 y좌표(경위도)
1-3-17 CID int Y 1 정류장 도시코드
1-3-18 cityName string Y 1 정류장 도시이름
1-3-19 cityNameKor string N 1 정류장 도시이름 국문
(다국어 서비스 시 표출)
1-3-20 cityNameJpnKata string N 1 정류장 도시이름 일문(가타카나)
(lang = 2 인 경우 표출)
1-3-21 arsID string N 1 정류장 고유번호(5자리)
ex)xx-xxx
1-3-22 ebid string N 1 정류장 고유번호(5자리)
ex)xx-xxx
1-3-23 do string Y 1 정류장주소 도
1-3-24 gu string Y 1 정류장주소 구
1-3-25 dong string Y 1 정류장주소 동
1-3-26 stationDirectionName string N 1 정류장 방면 명
(stationClass 1 인 경우만)
1-3-27 stationDirectionNameKor string N 1 정류장 방면 명 국문
(stationClass 1 인 경우만)
(다국어 서비스 시 표출)
1-3-28 stationDirectionNameJpnKata string N 1 정류장 방면 명 일문(가타카나)
(stationClass 1 인 경우만)
(lang = 2 인 경우 표출)
1-3-29 busOnlyCentralLane int N 1 버스전용 중앙차로 정류장 해당 여부
(0: 비해당, 1: 해당)
(stationClass 1 인 경우만)
1-3-30 businfo 확장 노드 N 1...n 버스 리스트
1-3-30-1 busNo string Y 1 버스번호
1-3-30-2 busClass string Y 1 버스타입
1-3-30-3 busLocalBlID string Y 1 각 지역 버스노선 ID

Console에서 예시 확인하기»

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

반경내 대중교통 POI 검색(Public Transit POI within Radius)

지정된 포인트와 반경을 가지고 대중교통 POI정보를 검색합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/pointSearch json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 x Y x좌표(경위도) x=126.933361407195
2 y Y y좌표(경위도) y=37.3643392278118
3 radius N 반경(m) (default:250) radius=250
4 stationClass N 정류장 종류(여러 개 선택 가능)
1:2 (default)
1 : 버스정류장
2 : 지하철역
3 : 기차역
4 : 고속버스터미널
5 : 공항
6 : 시외버스터미널
7 : 항만(업데이트 예정)
stationClass=1:2

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 count int Y 1 대중교통 POI 개수
1-2 station 확장 노드 Y 1...n 대중교통 POI 리스트
1-2-1 stationClass int Y 1 대중교통 POI 종류
1 : 버스정류장
2 : 지하철역
3 : 기차역
4 : 고속버스터미널
5 : 공항
6 : 시외버스터미널
7 : 항만
1-2-2 stationName string Y 1 대중교통 POI 이름
1-2-3 stationNameKor string N 1 대중교통 POI 이름 국문
(다국어 서비스 시 표출)
1-2-4 stationNameJpnKata string N 1 대중교통 POI 이름 일문(가타카나)
(lang = 2 인 경우 표출)
1-2-5 stationID int Y 1 대중교통 POI ID
1-2-6 type int N 1 노선종류
문서하단 지하철노선타입 참조
(stationClass 2 인 경우만)
1-2-7 laneName string N 1 노선명
(stationClass 2 인 경우만)
1-2-8 laneNameKor string N 1 노선명 국문
(stationClass 2 인 경우만)
(다국어 서비스 시 표출)
1-2-9 laneNameJpnKata string N 1 노선명 일문(가타카나)
(stationClass 2 인 경우만)
(lang = 2 인 경우 표출)
1-2-10 laneCity string N 1 노선지역명
(stationClass 2 인 경우만)
1-2-11 laneCityKor string N 1 노선지역명 국문
(stationClass 2 인 경우만)
(다국어 서비스 시 표출)
1-2-12 laneCityJpnKata string N 1 노선지역명 일문(가타카나)
(stationClass 2 인 경우만)
(lang = 2 인 경우 표출)
1-2-13 stationType int N 1 시외버스정류장 종류
(1:시외버스터미널, 2:시외버스정류소)
(stationClass 6 인 경우만)
1-2-14 x double Y 1 x좌표(경위도)
1-2-15 y double Y 1 y좌표(경위도)
1-2-16 arsID string Y 1 정류장 고유번호
1-2-17 ebid string Y 1 정류장 고유번호
1-2-18 nonstopStation int Y 1 미정차정류장
(0:정차, 1:미정차)
1-2-19 busOnlyCentralLane int N 1 버스전용 중앙차로 정류장 해당 여부
(0: 비해당, 1: 해당)
(stationClass 1 인 경우만)

Console에서 예시 확인하기»

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

지도 위 대중교통 POI 검색(Public Transit POI on Map)

지정된 영역내 대중교통 POI정보를 검색합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/boundarySearch json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 param Y 영역 좌표 (left:top:right:bottom)
(경위도)
Param=127.045478316811:37.68882830829:127.055063420699:37.6370465749586
2 Eparam N 제외시킬 영역좌표(left:top:right:bottom)
(경위도)
0:0:0:0(default)
EParam=127.048478316811:37.67882830829:127.051063420699:37.6570465749586
3 stationClass N 정류장 종류(여러 개 선택 가능)
1:2 (default)
1 : 버스정류장
2 : 지하철역
3 : 기차역
4 : 고속버스터미널
5 : 공항
6 : 시외버스터미널
7 : 항만(업데이트 예정)
stationClass=1:2

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 count int Y 1 대중교통 POI 개수
1-2 station 확장 노드 Y 1...n 대중교통 POI 리스트
1-2-1 stationClass int Y 1 대중교통 POI 종류
1 : 버스정류장
2 : 지하철역
3 : 기차역
4 : 고속버스터미널
5 : 공항
6 : 시외버스터미널
7 : 항만
1-2-2 stationName string Y 1 대중교통 POI 이름
1-2-3 stationNameKor string N 1 대중교통 POI 이름 국문
(다국어 서비스 시 표출)
1-2-4 stationNameJpnKata string N 1 대중교통 POI 이름 일문(가타카나)
(lang = 2 인 경우 표출)
1-2-5 stationID int Y 1 대중교통 POI ID
1-2-6 type int N 1 노선종류
문서하단 지하철노선타입 참조
(stationClass 2 인 경우만)
1-2-7 laneName string N 1 노선명
(stationClass 2 인 경우만)
1-2-8 laneNameKor string N 1 노선명 국문
(stationClass 2 인 경우만)
(다국어 서비스 시 표출)
1-2-9 laneNameJpnKata string N 1 노선명 일문(가타카나)
(stationClass 2 인 경우만)
(lang = 2 인 경우 표출)
1-2-10 laneCity string N 1 노선지역명
(stationClass 2 인 경우만)
1-2-11 laneCityKor string N 1 노선지역명 국문
(stationClass 2 인 경우만)
(다국어 서비스 시 표출)
1-2-12 laneCityJpnKata string N 1 노선지역명 일문(가타카나)
(stationClass 2 인 경우만)
(lang = 2 인 경우 표출)
1-2-13 stationType int N 1 시외버스정류장 종류
(1:시외버스터미널, 2:시외버스정류소)
(stationClass 6 인 경우만)
1-2-14 x double Y 1 x좌표(경위도)
1-2-15 y double Y 1 y좌표(경위도)
1-2-16 arsID string N 1 정류장 고유번호(5자리)
ex)xx-xxx
1-2-17 ebid string N 1 정류장 고유번호(5자리)
ex)xx-xxx
1-2-18 busOnlyCentralLane int N 1 버스전용 중앙차로 정류장 해당 여부
(0: 비해당, 1: 해당)
(stationClass 1 인 경우만)

Console에서 예시 확인하기»

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

지하철 경로검색 조회(지하철 노선도)(Subway Route Search)

지하철 경로검색 결과를 리턴합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/subwayPath json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 CID Y 도시코드
(수도권:1000, 부산:7000, 대구:4000, 광주:5000, 대전:3000)
CID=1000
2 SID Y 출발역 코드 SID=201
3 EID Y 도착역 코드 EID=222
4 Sopt N 경로검색 조건(default=1)
(1:최단거리, 2:최소환승)
Sopt=1

• 출력 데이터 (국문)(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 globalStartName string Y 1 출발역 명
1-2 globalEndName string Y 1 도착역 명
1-3 globalTravelTime int Y 1 전체 운행소요시간(분)
1-4 globalDistance int Y 1 전체 운행거리(Km)
1-5 globalStationCount int Y 1 전체 정차역 수
1-6 fare int Y 1 카드요금(성인기준)
1-7 cashFare int Y 1 현금요금(성인기준)
1-8 driveInfoSet 확장노드 Y 1 현금요금(성인기준)
1-8-1 driveInfo 확장노드 Y 1...n 확장노드
1-8-1-1 laneID string Y 1 승차역 ID
1-8-1-2 laneName string Y 1 승차역 호선명
1-8-1-3 startName string Y 1 승차 역명
1-8-1-4 stationCount int Y 1 이동 역 수
1-8-1-5 wayCode int Y 1 방면코드 (1:상행, 2:하행)
1-8-1-6 wayName string Y 1 방면 명
1-9 exChangeInfoSet 확장노드 N 1 환승 정보(환승경로 있을경우 제공)
1-9-1 exChangeInfo 확장노드 Y 1...n 환승역정보 확장노드
1-9-1-1 laneName string Y 1 승차노선 명
1-9-1-2 startName string Y 1 승차역 명
1-9-1-3 exName string Y 1 환승역 명
1-9-1-4 exSID int Y 1 환승역 ID
1-9-1-5 fastTrain int Y 1 빠른 환승 객차 번호
1-9-1-6 fastDoor int Y 1 빠른 환승 객차 문 번호
1-9-1-7 exWalkTime int Y 1 환승소요시간 (초)
1-10 stationSet 확장노드 Y 1 이동역 정보 그룹
1-10-1 stations 확장노드 Y 2...n 이동역 정보 확장노드
1-10-1-1 startID int Y 1 출발역 ID
1-10-1-2 startName string Y 1 출발역명
1-10-1-3 endSID int Y 1 도착역 ID
1-10-1-4 endName string Y 1 도착역명
1-10-1-5 travelTime int Y 1 누적 운행시간(분)

• 출력 데이터 (다국어)(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result Node Y 1 검색 결과를 포함하는 최상위노드
1-1 pathInfo Node Y 1 지하철 경로 노드
1-1-1 globalStartName string Y 1 출발역 명
1-1-2 globalStartNameKor string Y 1 출발역 명 국문
(다국어 서비스 시 표출)
1-1-3 globalStartNameJpnKata string Y 1 출발역 명 일문(가타카나)
(lang = 2 인 경우 표출)
1-1-4 globalStartID int Y 1 출발역 ID
1-1-5 globalEndName string Y 1 도착역 명 국문
(다국어 서비스 시 표출)
1-1-6 globalEndNameKor string Y 1 도착역 명 일문(가타카나)
(lang = 2 인 경우 표출)
1-1-7 globalEndNameJpnKata string Y 1 도착역 명
1-1-8 globalEndID int Y 1 도착역 ID
1-1-9 globalTravelTime int Y 1 전체 운행소요시간(분)
1-1-10 globalDistance int Y 1 전체 운행거리(km)
1-1-11 globalStationCount int Y 1 전체 정차역 수
1-1-12 cardfare int Y 1 카드요금(성인기준),
1-1-13 cashFare int Y 1 현금요금(성인기준).
1-2 onStationSet Node Y 1 전체 탑승호선 정보
1-2-1 station Node Y 1...n 확장노드
1-2-1-1 stationID string Y 1 승차역 ID
1-2-1-2 stationName string Y 1 승차 역명
1-2-1-3 stationNameKor string Y 1 승차 역명 국문
(다국어 서비스 시 표출)
1-2-1-4 stationNameJpnKata string Y 1 승차 역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-2-1-5 laneName int Y 1 승차역 호선명
1-2-1-6 laneNameKor int Y 1 승차역 호선명 국문
(다국어 서비스 시 표출)
1-2-1-7 laneNameJpnKata int Y 1 승차역 호선명 일문(가타카나)
(lang = 2 인 경우 표출)
1-2-1-8 laneID int Y 1 승차역 호선 ID
1-2-1-9 transType int Y 1 환승역 유무(0:미환승역 1:환승역)
1-2-1-10 fastTrainInfo string N 1 빠른 환승문
1-2-1-11 stationCount string Y 1 이동역 개수
1-2-1-12 wayCode int Y 1 방면코드 (1:상행, 2:하행)
1-2-1-13 wayName string Y 1 방면 명
1-2-1-14 wayNameKor string Y 1 방면 명 국문
(다국어 서비스 시 표출)
1-2-1-15 wayNameJpnKata string Y 1 방면 명 일문(가타카나)
(lang = 2 인 경우 표출)
1-3 exChangeInfoSet Node N 1 환승 정보(환승경로 있을경우 제공)
1-3-1 exChangeInfo Node Y 1...n 환승역정보 확장노드
1-3-1-1 laneName string Y 1 승차노선 명
1-3-1-2 laneNameKor string Y 1 승차노선 명 국문
(다국어 서비스 시 표출)
1-3-1-3 startName string Y 1 승차역 명
1-3-1-4 startNameKor string Y 1 승차역 명 국문
(다국어 서비스 시 표출)
1-3-1-5 startNameJpnKata string Y 1 승차역 명 일문(가타카나)
(lang = 2 인 경우 표출)
1-3-1-6 exName string Y 1 환승역 명
1-3-1-7 exNameKor string Y 1 환승역 명 국문
(다국어 서비스 시 표출)
1-3-1-8 exNameJpnKata string Y 1 환승역 명 일문(가타카나)
(lang = 2 인 경우 표출)
1-3-1-9 exSID int Y 1 환승역 ID
1-3-1-10 fastTrain int Y 1 빠른 환승 객차 번호
1-3-1-11 fastDoor int Y 1 빠른 환승 객차 문 번호
1-3-1-12 exWalkTime int Y 1 환승소요시간 (초)
1-4 driveStationSet Node Y 1 이동역 정보 그룹
1-4-1 station Node Y 2...n 이동역 정보 확장노드
1-4-1-1 startID int Y 1 출발역 id
1-4-1-2 startName string Y 1 출발역명
1-4-1-3 startNameKor string Y 1 출발역명 국문
(다국어 서비스 시 표출)
1-4-1-4 startNameJpnKata string Y 1 출발역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-4-1-5 startX double Y 1 출발역 X 좌표
1-4-1-6 startY double Y 1 출발역 Y 좌표
1-4-1-7 endID int Y 1 도착역 id
1-4-1-8 endName string Y 1 도착역명
1-4-1-9 endNameKor string Y 1 도착역명 국문
(다국어 서비스 시 표출)
1-4-1-10 endNameJpnKata string Y 1 도착역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-4-1-11 endX double Y 1 도착역 X 좌표
1-4-1-12 endY double Y 1 도착역 Y 좌표
1-4-1-13 travelTime int Y 1 누적 운행시간(분)

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

시간표 기반 지하철 경로검색 조회(Scheduled Subway Route Search)

시간표 기반 지하철 경로검색 결과를 리턴합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/subwayPathSchedule json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0, 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어: 5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 SID Y 출발역 코드 SID=201
2 EID Y 도착역 코드 EID=222
3 MID N 경유역 코드
경유역 존재 시 입력
MID=213
4 MODE N 탐색 모드(default=1)
- 1: 출발시간 기준 탐색
- 2: 도착시간 기준 탐색
- 3: 첫차 탐색
- 4: 막차 탐색
MODE=2
5 DAY N 요일 구분(default=1)
(1:평일, 2:토요일, 3:공휴일/일요일
DAY=1
6 TIME N 탐색 기준 시간(defualt=현재시간[HHmm])
TIME=1015
7 NEXT_PREV_MODE N 이전/다음 열차 탐색 모드
BASE_TIME 기준 이전/다음 열차 탐색 시 사용
(PREV:이전열차, NEXT:다음열차)
NEXT_PREV_MODE=NEXT
8 BASE_TIME N 이전/다음 열차 탐색 기준 출발시간
해당 값의 출발 시간 기준으로 이전/다음 열차 탐색
hhmmss 형식
BASE_TIME=112430
(11:24:30 출발 열차의 이전/다음 열차 탐색 시)

• 출력 데이터 (국문)(Output Data)

번호 요소 데이터 타입 필수 값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최상위 노드
1-1 notificationCode int Y 1 결과 안내 코드
- 0:모든 열차의 탐승 스케줄이 정상
- 2:운행이 가능한 스케줄이 없어 첫차로 검색
- 3:운행 가능한 스케줄이 없어 막차로 검색
1-2 notificationMessage string Y 1 결과 안내 메시지
1-3 path 확장노드 Y 1...n 경로 탐색 목록
1-3-1 pathType int Y 1 경로 구분
(1:최단시간, 2:최소환승)
1-3-2 info 확장노드 Y 1 요약 정보
1-3-2-1 day int Y 1 탐색 요일 구분
(1:평일, 2:토요일, 3:공휴일/일요일)
1-3-2-2 totalTime int Y 1 총 소요시간(분)
1-3-2-3 subwayTravelTime int Y 1 지하철 소요시간(분)
1-3-2-4 exchangeWalkTime int Y 1 환승 소요시간(분)
1-3-2-5 subwayTravelDistance int Y 1 지하철 운행 거리(m)
1-3-2-6 firstStartStationName string Y 1 최초 승차역명
1-3-2-7 firstStartStationNameKor string N 1 최초 승차역명 국문
(다국어 서비스 시 표출)
1-3-2-8 firstStartStationNameJpnKata string N 1 최초 승차역명 일문 가타카나
(다국어 서비스 일문[lang=2]일 경우 표출)
1-3-2-9 firstStartLaneID int Y 1 최초 승차 노선 ID
1-3-2-10 firstStartLaneName string Y 1 최초 승차 노선명
1-3-2-11 firstStartLaneNameKor string N 1 최초 승차 노선명 국문
(다국어 서비스 시 표출)
1-3-2-12 firstStartLaneNameJpnKata string N 1 최초 승차 노선명 일문 가타카나
(다국어 서비스 일문[lang=2]일 경우 표출)
1-3-2-13 lastEndStationName string Y 1 최종 하차역명
1-3-2-14 lastEndStationNameKor string N 1 최종 하차역명 국문
(다국어 서비스 시 표출)
1-3-2-15 lastEndStationNameJpnKata string N 1 최종 하차역명 일문 가타카나
(다국어 서비스 일문[lang=2]일 경우 표출)
1-3-2-16 lastEndLaneID int Y 1 최종 하차 노선 ID
1-3-2-17 lastEndLaneName string Y 1 최종 하차 노선명
1-3-2-18 lastEndLaneNameKor string N 1 최종 하차 노선명 국문
(다국어 서비스 시 표출)
1-3-2-19 lastEndLaneNameJpnKata string N 1 최종 하차 노선명 일문 가타카나
(다국어 서비스 일문[lang=2]일 경우 표출)
1-3-2-20 departureTime string Y 1 출발시간 (HH:mm:ss)
1-3-2-21 arrivalTime string Y 1 도착시간 (HH:mm:ss)
1-3-2-22 stationCount int Y 1 총 정류장 수
1-3-2-23 transferCount int Y 1 총 환승 횟수
1-3-2-24 cardFare int Y 1 요금 (교통카드)
1-3-3 subPath 확장노드 Y 1 상세 경로 목록
1-3-3-1 movingType int Y 1 이동 구분
(1:지하철, 2:환승, 3:경유)
1-3-3-2 sectionTime int Y 1 구간 소요시간(분)
1-3-3-3 laneID int Y 1 노선 ID
1-3-3-4 laneName string Y 1 노선명
1-3-3-5 laneNameKor string N 1 노선명 국문
(다국어 서비스 시 표출)
1-3-3-6 laneNameJpnKata string N 1 노선명 일문 가타카나
(다국어 서비스 일문[lang=2]일 경우 표출)
1-3-3-7 isExpressLane string Y 1 급행열차 여부
(Y:급행열차, N:일반열차)
1-3-3-8 startName string Y 1 승차역명
1-3-3-9 startNameKor string N 1 승차역명 국문
(다국어 서비스 시 표출)
1-3-3-10 startNameJpnKata string N 1 승차역명 일문 가타카나
(다국어 서비스 일문[lang=2]일 경우 표출)
1-3-3-11 endName string Y 1 하차역명
1-3-3-12 endNameKor string N 1 하차역명 국문
(다국어 서비스 시 표출)
1-3-3-13 endNameJpnKata string N 1 하차역명 일문 가타카나
(다국어 서비스 일문[lang=2]일 경우 표출)
1-3-3-14 startID int Y 1 승차역 ID
1-3-3-15 endID int Y 1 하차역 ID
1-3-3-16 departureTime string Y 1 구간 출발시간 (HH:mm:ss)
1-3-3-17 arrivalTime string Y 1 구간 도착시간 (HH:mm:ss)
1-3-3-18 stopStationCount int Y 1 이동 역수
1-3-3-19 wayCode int Y 1 방면 코드
(1:상행, 2:하행)
1-3-3-20 wayName string Y 1 열차 행선지명
1-3-3-21 wayNameKor string N 1 열차 행선지명 국문
(다국어 서비스 시 표출)
1-3-3-22 wayNameJpnKata string N 1 열차 행선지명 일문 가타카나
(다국어 서비스 일문[lang=2]일 경우 표출)
1-3-3-23 fastTrain int Y 1 빠른 환승 객차 번호
(0:모든 문, -1:정보 수집 중, 그외:객차 번호)
1-3-3-24 fastDoor int Y 1 빠른 환승 객차 문 번호
(0:모든 문, -1:정보 수집 중, 그외:객차 문 번호
1-3-3-25 passStopList 확장노드 Y 1 경유역 목록
1-3-3-25-1 stations 확장노드 Y 1...n 역 목록
1-3-3-25-1-1 index int Y 1 역 순번
1-3-3-25-1-2 stationID int Y 1 역 ID
1-3-3-25-1-3 stationName string Y 1 역명
1-3-3-25-1-4 stationNameKor string N 1 역명 국문
(다국어 서비스 시 표출)
1-3-3-25-1-5 stationNameJpnKata string N 1 역명 일문 가타카나
(다국어 서비스 일문[lang=2]일 경우 표출)
1-3-3-25-1-6 travelTime int Y 1 누적 소요시간(분)
1-3-3-25-1-7 departureTime string N 1 열차 출발시간 (HH:mm:ss)
하차역이 아니면서 정차역인 경우만 제공
1-3-3-25-1-8 arrivalTime string N 1 열차 도착시간 (HH:mm:ss)
승차역이 아니면서 정차역인 경우만 제공
1-3-3-25-1-9 isStop string Y 1 역 정차 여부 (Y/N)
1-3-3-26 prevTrain 확장노드 N 1 동일 구간 이전 열차 정보
이전 열차 존재 시 제공
1-3-3-26-1 laneID int Y 1 이전 열차 노선 ID
1-3-3-26-2 laneName string Y 1 이전 열차 노선명
1-3-3-26-3 laneNameKor string Y 1 이전 열차 노선명 국문
(다국어 서비스 시 표출)
1-3-3-26-4 laneNameJpnKata string N 1 이전 열차 노선명 일문 가타카나
(다국어 서비스 일문[lang=2]일 경우 표출)
1-3-3-26-5 isExpressLane string Y 1 이전 열차 급행 노선 여부(Y/N)
1-3-3-26-6 departureTime string Y 1 이전 열차 출발시간(HH:mm:ss)
1-3-3-26-7 wayName string Y 1 이전 열차 행선지명
1-3-3-26-8 wayNameKor string N 1 이전 열차 행선지명 국문
(다국어 서비스 시 표출)
1-3-3-26-9 wayNameJpnKata string N 1 이전 열차 행선지명 일문 가타카나
(다국어 서비스 일문[lang=2]일 경우 표출)
1-3-3-27 nextTrain 확장노드 N 1 동일 구간 다음 열차 정보
다음 열차 존재 시 제공
1-3-3-27-1 laneID int Y 1 다음 열차 노선 ID
1-3-3-27-2 laneName string Y 1 다음 열차 노선명
1-3-3-27-3 laneNameKor string N 1 다음 열차 노선명 국문
(다국어 서비스 시 표출)
1-3-3-27-4 laneNameJpnKata string N 1 다음 열차 노선명 일문 가타카나
(다국어 서비스 일문[lang=2]일 경우 표출)
1-3-3-27-5 isExpressLane string Y 1 다음 열차 급행 노선 여부(Y/N)
1-3-3-27-6 departureTime string Y 1 다음 열차 출발시간 (HH:mm:ss)
1-3-3-27-7 wayName string Y 1 다음 열차 행선지명
1-3-3-27-8 wayNameKor string N 1 다음 열차 행선지명 국문
(다국어 서비스 시 표출)
1-3-3-27-9 wayNameJpnKata string N 1 다음 열차 행선지명 일문 가타카나
(다국어 서비스 일문[lang=2]일 경우 표출)

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 검색 입력값 오류
-9 잘못된 역 ID가 입력되었습니다.
-99 검색결과가 없습니다.

대중교통 길찾기 v1.7(Public Transit Route Search)

대중교통 길찾기 정보를 리턴합니다.
* 도시간 길찾기 결과 포맷이 새로워진 대중교통 길찾기 v1.8 사용을 권장합니다. 대중교통 길찾기 v1.8 바로가기
* 다국어 출력 데이터중 lane 요소가 국문 및 레퍼런스 문서와 출력형태가 달라 2019.07.17 부로 국문 및 레퍼런스 문서와 동일하게 수정하였으며
   요청 URI가 변경되었습니다. (searchPubTransPath → searchPubTransPathR)
* 2019.07.17 이전 API인 https://api.odsay.com/v1/api/searchPubTransPath는 변경없이 계속 서비스 됩니다.
* 경로 검색 결과에 도시간 경로가 반환될 경우, 아래와 같이 경로 API 호출 추가 필요
   - 출발지 -> 출발 터미널(시외, 고속, 열차, 항공 등) 이동을 위한 도시내 경로 API 호출
   - 도착지 -> 도착 터미널(시외, 고속, 열차, 항공 등) 이동을 위한 도시내 경로 API 호출

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/searchPubTransPathR json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 SX Y 출발지 X좌표 (경도좌표) SX=126.926493082645
2 SY Y 출발지 Y좌표 (위도좌표) SY=37.6134436427887
3 EX Y 도착지 X좌표 (경도좌표) EX=127.126936754911
4 EY Y 도착지 Y좌표 (위도좌표) EY=37.5004198786564
5 OPT N 경로검색결과 정렬방식
0: 추천경로, 1 타입별정렬
ex) 지하철, 버스, 버스+지하철, 지하철+버스, 버스+지하철+버스
OPT = 0
6 SearchType N 도시간 이동/도시내 이동을 선택한다. 도시내 이동/도시간 이동을 구분검색한다.
0 입력시 도시내검색
(도시내검색에서 도시간검색결과 있을경우 활용)
7 SearchPathType N 도시 내 경로수단을 지정한다. 0: 모두(default)
1: 지하철
2: 버스

• 출력 데이터 (도시내 길찾기)(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 searchType int Y 1 결과 구분 (도시내 or 도시간 직통 or 도시간 환승)
0-도시내, 1-도시간 직통, 2-도시간 환승
1-2 outTrafficCheck int Y 1 도시간 "직통" 탐색 결과 유무(환승 X)
0-False, 1-True
1-3 busCount int Y 1 버스 결과 개수
1-4 subwayCount int Y 1 지하철 결과 개수
1-5 subwayBusCount int Y 1 “버스+지하철” 결과 개수
1-6 pointDistance double Y 1 출발지(SX, SY)와 도착지(EX, EY)의 직선 거리 (미터)
1-7 startRadius int Y 1 출발지 반경
1-8 endRadius int Y 1 도착지 반경
1-9 path 확장노드 Y 1...n 결과 리스트 확장 노드
1-9-1 pathType int Y 1 결과 종류
1-지하철, 2-버스, 3-버스+지하철
1-9-2 info 확장노드 Y 1 요약 정보 확장 노드
1-9-2-1 trafficDistance double Y 1 도보를 제외한 총 이동 거리
1-9-2-2 totalWalk int Y 1 총 도보 이동 거리
1-9-2-3 totalTime int Y 1 총 소요시간
1-9-2-4 payment int Y 1 총 요금
1-9-2-5 busTransitCount int Y 1 버스 환승 카운트
1-9-2-6 subwayTransitCount int Y 1 지하철 환승 카운트
1-9-2-7 mapObj string Y 1 보간점 API를 호출하기 위한 파라미터 값
1-9-2-8 firstStartStation string Y 1 최초 출발역/정류장
1-9-2-9 lastEndStation string Y 1 최종 도착역/정류장
1-9-2-10 totalStationCount int Y 1 총 정류장 합
1-9-2-11 busStationCount int Y 1 버스 정류장 합
1-9-2-12 subwayStationCount int Y 1 지하철 정류장 합
1-9-2-13 totalDistance double Y 1 총 거리
1-9-3 subPath 확장노드 Y 1...n 이동 교통 수단 정보 확장 노드
1-9-3-1 trafficType int Y 1 이동 수단 종류 (도보, 버스, 지하철)
1-지하철, 2-버스, 3-도보
1-9-3-2 distance double Y 1 이동 거리
1-9-3-3 sectionTime int Y 1 이동 소요 시간
1-9-3-4 stationCount int Y/N 1 이동하여 정차하는 정거장 수(지하철, 버스 경우만 필수)
1-9-3-5 lane 확장노드 Y/N 1...n 교통 수단 정보 확장 노드
1-9-3-5-1 name string Y/N 1 지하철 노선명 (지하철인 경우에만 필수)
1-9-3-5-2 busNo string Y/N 1 버스 번호 (버스인 경우에만 필수)
1-9-3-5-3 type int Y/N 1 버스 타입 (버스인 경우에만 필수,최하단 참조)
1-9-3-5-4 busID int Y/N 1 버스 코드 (버스인 경우에만 필수)
1-9-3-5-5 subwayCode int Y/N 1 지하철 노선 번호 (지하철인 경우에만 필수)
1-9-3-5-6 subwayCityCode int Y/N 1 지하철 도시코드 (지하철인 경우에만 필수)
1-9-3-6 startName string Y 1 승차 정류장/역명
1-9-3-7 startX double Y 1 승차 정류장/역 X 좌표
1-9-3-8 startY double Y 1 승차 정류장/역 Y 좌표
1-9-3-9 endName string Y 1 하차 정류장/역명
1-9-3-10 endX double Y 1 하차 정류장/역 X 좌표
1-9-3-11 endY double Y 1 하차 정류장/역 Y 좌표
1-9-3-12 way string Y/N 1 방면 정보 (지하철인 경우에만 필수)
1-9-3-13 wayCode int Y/N 1 방면 정보 코드(지하철의 첫번째 경로에만 필수)
1 : 상행, 2: 하행
1-9-3-14 door string Y/N 1 지하철 빠른 환승 위치 (지하철인 경우에만 필수)
1-9-3-15 startID int Y 1 출발 정류장/역 코드
1-9-3-16 endID int Y 1 도착 정류장/역 코드
1-9-3-17 startExitNo string N 1 지하철 들어가는 출구 번호
(지하철인 경우에만 사용되지만 해당 태그가 없을 수도 있다.)
1-9-3-18 startExitX double N 1 지하철 들어가는 출구 X좌표(지하철인 경우에 만 사용되지만 해당 태그가 없을 수도 있다.)
1-9-3-19 startExitY double N 1 지하철 들어가는 출구 Y좌표(지하철인 경우에 만 사용되지만 해당 태그가 없을 수도 있다.)
1-9-3-20 endExitNo string N 1 지하철 나가는 출구 번호(지하철인 경우에만 사용되지만 해당 태그가 없을 수도 있다.)
1-9-3-21 endExitX double N 1 지하철 나가는 출구 X좌표(지하철인 경우에만 사용되지만 해당 태그가 없을 수도 있다.)
1-9-3-22 endExitY double N 1 지하철 나가는 출구 Y좌표(지하철인 경우에만 사용되지만 해당 태그가 없을 수도 있다.)
1-9-3-23 passStopList 확장노드 Y 1 경로 상세구간 정보 확장 노드(국문에 한하여 제공)
1-9-3-23-1 stations 확장노드 Y 1...n 정류장 정보 그룹노드
1-9-3-23-1-1 index int Y 1 정류장 순번
1-9-3-23-1-2 stationID int Y 1 정류장 ID
1-9-3-23-1-3 stationName string Y 1 정류장 명칭
1-9-3-23-1-4 x string Y 1 정류장 X좌표
1-9-3-23-1-5 y string Y 1 정류장 Y좌표
1-9-3-23-1-6 isNonStop string Y/N 1 미정차 정류장 여부 Y/N(버스인 경우에만 필수)

• 출력 데이터(도시간 길찾기-직통)(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 searchType int Y 1 결과 구분 (도시내 or 도시간 직통 or 도시간 환승)
0-도시내, 1-도시간 직통
1-2 localSearch int Y 1 도시내 탐색 결과 확인
1이라면 도시내 검색 결과 있음
0- False, 1-true
1-3 startCID int Y 1 출발지 도시 코드
1-4 endCID int Y 1 도착지 도시 코드
1-5 startCityName string Y 1 출발지 도시 이름
1-6 endCityName string Y 1 출발지 도시 이름
1-7 pointDistance double Y 1 출발지(SX, SY)와 도착지(EX, EY)의 직선 거리 (미터)
1-8 totalCount int Y 1 총 결과 개수
1-9 trainRequest 확장노드 Y 1 기차 탐색 결과 상위 노드
1-9-1 count int Y 1 기차 탐색 결과 개수
1-9-2 OBJ 확장노드 N 0...n 기차 탐색 결과 리스트
1-9-2-1 startSTN string Y 1 출발역명
1-9-2-2 startID int Y 1 출발역 코드
1-9-2-3 SX double Y 1 출발역 X 좌표
1-9-2-4 SY double Y 1 출발역 Y 좌표
1-9-2-5 endSTN string Y 1 도착역명
1-9-2-6 endID int Y 1 도착역 코드
1-9-2-7 EX double Y 1 도착역 X 좌표
1-9-2-8 EY double Y 1 도착역 Y 좌표
1-9-2-9 time int Y 1 이동 소요 시간
1-9-2-10 payment int Y 1 요금
1-9-2-11 trainType int Y 1 기차 종류 코드
1-9-2-12 mapOBJ string Y/N 1 경로그래프 정보를 호출하기 위한 파라미터 값
1-9-2-13 distance int Y 1 거리(미터), 0인경우 거리정보 없음
1-10 exBusRequest 확장 노드 Y 1 고속버스 탐색 결과 상위 노드
1-10-1 Count int Y 1 고속버스 탐색 결과 개수
1-10-2 OBJ 확장 노드 N 0...n 고속버스 탐색 결과 리스트
1-10-2-1 startSTN string Y 1 출발 터미널 명
1-10-2-2 startID int Y 1 출발 터미널 코드
1-10-2-3 SX double Y 1 출발 터미널 X 좌표
1-10-2-4 SY double Y 1 출발 터미널 Y 좌표
1-10-2-5 endSTN string Y 1 도착 터미널 명
1-10-2-6 endID int Y 1 도착 터미널 코드
1-10-2-7 EX double Y 1 도착 터미널 X 좌표
1-10-2-8 EY double Y 1 도착 터미널 Y 좌표
1-10-2-9 time int Y 1 이동 소요 시간
1-10-2-10 payment int Y 1 요금
1-10-2-11 mapOBJ string Y/N 1 경로그래프 정보를 호출하기 위한 파라미터 값
1-10-2-12 distance int Y 1 거리(미터), 0인경우 거리정보 없음
1-11 outBusRequest 확장 노드 Y 1 시외버스 탐색 결과 상위 노드
1-11-1 count int Y 1 시외버스 탐색 결과 개수
1-11-2 OBJ 확장 노드 N 0...n 시외버스 탐색 결과 리스트
1-11-2-1 startSTN string Y 1 출발 터미널 명
1-11-2-2 startID int Y 1 출발 터미널 코드
1-11-2-3 SX double Y 1 출발 터미널 X 좌표
1-11-2-4 SY double Y 1 출발 터미널 Y 좌표
1-11-2-5 endSTN string Y 1 도착 터미널 명
1-11-2-6 endID int Y 1 도착 터미널 코드
1-11-2-7 EX double Y 1 도착 터미널 X 좌표
1-11-2-8 EY double Y 1 도착 터미널 Y 좌표
1-11-2-9 time int Y 1 이동 소요 시간
1-11-2-10 payment int Y 1 요금
1-11-2-11 mapOBJ string Y/N 1 경로그래프 정보를 호출하기 위한 파라미터 값
1-11-2-12 distance int Y 1 거리(미터), 0인경우 거리정보 없음
1-12 airRequest 확장노드 Y 1 항공 탐색 결과 상위 노드
1-12-1 count int Y 1 항공 탐색 결과 개수
1-12-2 OBJ 확장노드 N 0...n 항공 탐색 결과 리스트
1-12-2-3 startSTN string Y 1 출발 공항 명
1-12-2-4 startID int Y 1 출발 공항 코드
1-12-2-5 SX double Y 1 출발 공항 X 좌표
1-12-2-6 SY double Y 1 출발 공항 Y 좌표
1-12-2-7 endSTN string Y 1 도착 공항 명
1-12-2-8 endID int Y 1 도착 공항 코드
1-12-2-9 EX double Y 1 도착 공항 X 좌표
1-12-2-10 EY double Y 1 도착 공항 Y 좌표
1-12-2-11 time int Y 1 이동 소요 시간
1-12-2-12 payment int Y 1 요금
1-12-2-13 mapOBJ string Y/N 1 경로그래프 정보를 호출하기 위한 파라미터 값
1-12-2-14 distance int Y 1 공항간 직선거리(미터), 0인경우 거리정보 없음

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락
3 출발지 정류장이 없습니다.
4 도착지 정류장이 없습니다.
5 출, 도착지 정류장이 없습니다.
6 서비스 지역이 아닙니다.
-98 출, 도착지가 700m이내입니다.
-99 검색결과가 없습니다.

대중교통 길찾기 v1.8(Public Transit Route Search)

대중교통 길찾기 정보를 리턴합니다.
* 2020.09.24 도시간 길찾기 결과 중 열차 환승을 지원하는 길찾기 결과를 제공합니다. 이전 버전의 가이드를 확인하시려면 여기를 클릭하세요.
* 경로 검색 결과에 도시간 경로가 반환될 경우, 아래와 같이 경로 API 호출 추가 필요
   - 출발지 -> 출발 터미널(시외, 고속, 열차, 항공 등) 이동을 위한 도시내 경로 API 호출
   - 도착지 -> 도착 터미널(시외, 고속, 열차, 항공 등) 이동을 위한 도시내 경로 API 호출

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/searchPubTransPathT json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 SX Y 출발지 X좌표 (경도좌표) SX=126.926493082645
2 SY Y 출발지 Y좌표 (위도좌표) SY=37.6134436427887
3 EX Y 도착지 X좌표 (경도좌표) EX=127.126936754911
4 EY Y 도착지 Y좌표 (위도좌표) EY=37.5004198786564
5 OPT N 경로검색결과 정렬방식
0: 추천경로, 1 타입별정렬
ex) 지하철, 버스, 버스+지하철, 지하철+버스, 버스+지하철+버스
OPT = 0
6 SearchType N 도시간 이동/도시내 이동을 선택한다. 도시내 이동/도시간 이동을 구분검색한다.
0 입력시 도시내검색
(도시내검색에서 도시간검색결과 있을경우 활용)
7 SearchPathType N 도시 내 경로수단을 지정한다. 0: 모두(default)
1: 지하철
2: 버스

• 출력 데이터 (도시내 길찾기)(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 searchType int Y 1 결과 구분 (도시내 or 도시간 직통 or 도시간 환승)
0-도시내, 1-도시간 직통, 2-도시간 환승
1-2 outTrafficCheck int Y 1 도시간 "직통" 탐색 결과 유무(환승 X)
0-False, 1-True
1-3 busCount int Y 1 버스 결과 개수
1-4 subwayCount int Y 1 지하철 결과 개수
1-5 subwayBusCount int Y 1 “버스+지하철” 결과 개수
1-6 pointDistance double Y 1 출발지(SX, SY)와 도착지(EX, EY)의 직선 거리 (미터)
1-7 startRadius int Y 1 출발지 반경
1-8 endRadius int Y 1 도착지 반경
1-9 path 확장노드 Y 1...n 결과 리스트 확장 노드
1-9-1 pathType int Y 1 결과 종류
1-지하철, 2-버스, 3-버스+지하철
1-9-2 info 확장노드 Y 1 요약 정보 확장 노드
1-9-2-1 trafficDistance double Y 1 도보를 제외한 총 이동 거리
1-9-2-2 totalWalk int Y 1 총 도보 이동 거리
1-9-2-3 totalTime int Y 1 총 소요시간
1-9-2-4 payment int Y 1 총 요금
1-9-2-5 busTransitCount int Y 1 버스 환승 카운트
1-9-2-6 subwayTransitCount int Y 1 지하철 환승 카운트
1-9-2-7 mapObj string Y 1 보간점 API를 호출하기 위한 파라미터 값
1-9-2-8 firstStartStation string Y 1 최초 출발역/정류장
1-9-2-9 firstStartStationKor string Y 1 최초 출발역/정류장 국문
(다국어 서비스 시 표출)
1-9-2-10 firstStartStationJpnKata string Y 1 최초 출발역/정류장 일문(가타카나)
(lang = 2 인 경우 표출)
1-9-2-11 lastEndStation string Y 1 최종 도착역/정류장
1-9-2-12 lastEndStationKor string Y 1 최종 도착역/정류장 국문
(다국어 서비스 시 표출)
1-9-2-13 lastEndStationJpnKata string Y 1 최종 도착역/정류장 일문(가타카나)
(lang = 2 인 경우 표출)
1-9-2-14 totalStationCount int Y 1 총 정류장 합
1-9-2-15 busStationCount int Y 1 버스 정류장 합
1-9-2-16 subwayStationCount int Y 1 지하철 정류장 합
1-9-2-17 totalDistance double Y 1 총 거리
1-9-2-18 checkIntervalTime int Y 1 배차간격 체크 기준 시간(분)
1-9-2-19 checkIntervalTimeOverYn String Y 1 배차간격 체크 기준시간을 초과하는 노선이 존재하는지 여부(Y/N)
1-9-2-20 totalIntervalTime int Y 1 전체 배차간격 시간(분)
1-9-3 subPath 확장노드 Y 1...n 이동 교통 수단 정보 확장 노드
1-9-3-1 trafficType int Y 1 이동 수단 종류 (도보, 버스, 지하철)
1-지하철, 2-버스, 3-도보
1-9-3-2 distance double Y 1 이동 거리
1-9-3-3 sectionTime int Y 1 이동 소요 시간
1-9-3-4 stationCount int Y/N 1 이동하여 정차하는 정거장 수(지하철, 버스 경우만 필수)
1-9-3-5 lane 확장노드 Y/N 1...n 교통 수단 정보 확장 노드
1-9-3-5-1 name string Y/N 1 지하철 노선명 (지하철인 경우에만 필수)
1-9-3-5-2 nameKor string Y/N 1 지하철 노선명 국문
(다국어 서비스 시 지하철인 경우 표출)
1-9-3-5-3 nameJpnKata string Y/N 1 지하철 노선명 일문(가타카나)
(lang = 2 이면서 지하철인 경우 표출)
1-9-3-5-4 busNo string Y/N 1 버스 번호 (버스인 경우에만 필수)
1-9-3-5-5 busNoKor string Y/N 1 버스 번호 국문
(다국어 서비스 시 버스인 경우 표출)
1-9-3-5-6 busNoJpnKata string Y/N 1 버스 번호 일문(가타카나)
(lang = 2 이면서 버스인 경우 표출)
1-9-3-5-7 type int Y/N 1 버스 타입 (버스인 경우에만 필수,최하단 참조)
1-9-3-5-8 busID int Y/N 1 버스 코드 (버스인 경우에만 필수)
1-9-3-5-9 busLocalBlID string Y/N 1 각 지역 버스노선 ID (BIS 제공지역인 경우에만 필수)
1-9-3-5-10 busCityCode int Y/N 1 운수회사 승인 도시코드 (버스인 경우에만 필수)
1-9-3-5-11 busProviderCode int Y/N 1 BIS 코드 (BIS 제공지역인 경우에만 필수)
1-9-3-5-12 subwayCode int Y/N 1 지하철 노선 번호 (지하철인 경우에만 필수)
1-9-3-5-13 subwayCityCode int Y/N 1 지하철 도시코드 (지하철인 경우에만 필수)
1-9-3-6 intervalTime int Y 1 평균 배차간격(분)
1-9-3-7 startName string Y 1 승차 정류장/역명
1-9-3-8 startNameKor string Y 1 승차 정류장/역명 국문
(다국어 서비스 시 표출)
1-9-3-9 startNameJpnKata string Y 1 승차 정류장/역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-9-3-10 startX double Y 1 승차 정류장/역 X 좌표
1-9-3-11 startY double Y 1 승차 정류장/역 Y 좌표
1-9-3-12 endName string Y 1 하차 정류장/역명
1-9-3-13 endNameKor string Y 1 하차 정류장/역명 국문
(다국어 서비스 시 표출)
1-9-3-14 endNameJpnKata string Y 1 하차 정류장/역명 일문(가타카나)
(lang = 2 인 경우 표출)
1-9-3-15 endX double Y 1 하차 정류장/역 X 좌표
1-9-3-16 endY double Y 1 하차 정류장/역 Y 좌표
1-9-3-17 way string Y/N 1 방면 정보 (지하철인 경우에만 필수)
1-9-3-18 wayCode int Y/N 1 방면 정보 코드(지하철의 첫번째 경로에만 필수)
1 : 상행, 2: 하행
1-9-3-19 door string Y/N 1 지하철 빠른 환승 위치 (지하철인 경우에만 필수)
1-9-3-20 startID int Y 1 출발 정류장/역 코드
1-9-3-21 startStationCityCode int Y/N 1 출발 정류장 도시코드 (버스인 경우에만 필수)
1-9-3-22 startStationProviderCode int Y/N 1 출발 정류장 BIS 코드 (BIS 제공지역인 경우에만 필수)
1-9-3-23 startLocalStationID string Y/N 1 각 지역 출발 정류장 ID (BIS 제공지역인 경우에만 필수)
1-9-3-24 startArsID string Y/N 1 각 지역 출발 정류장 고유번호 (BIS 제공지역인 경우에만 필수)
1-9-3-25 endID int Y 1 도착 정류장/역 코드
1-9-3-26 endStationCityCode int Y/N 1 도착 정류장 도시코드 (버스인 경우에만 필수)
1-9-3-27 endStationProviderCode int Y/N 1 도착 정류장 BIS 코드 (BIS 제공지역인 경우에만 필수)
1-9-3-28 endLocalStationID string Y/N 1 각 지역 도착 정류장 ID (BIS 제공지역인 경우에만 필수)
1-9-3-29 endArsID string Y/N 1 각 지역 도착 정류장 고유번호 (BIS 제공지역인 경우에만 필수)
1-9-3-30 startExitNo string N 1 지하철 들어가는 출구 번호
(지하철인 경우에만 사용되지만 해당 태그가 없을 수도 있다.)
1-9-3-31 startExitX double N 1 지하철 들어가는 출구 X좌표(지하철인 경우에 만 사용되지만 해당 태그가 없을 수도 있다.)
1-9-3-32 startExitY double N 1 지하철 들어가는 출구 Y좌표(지하철인 경우에 만 사용되지만 해당 태그가 없을 수도 있다.)
1-9-3-33 endExitNo string N 1 지하철 나가는 출구 번호(지하철인 경우에만 사용되지만 해당 태그가 없을 수도 있다.)
1-9-3-34 endExitX double N 1 지하철 나가는 출구 X좌표(지하철인 경우에만 사용되지만 해당 태그가 없을 수도 있다.)
1-9-3-35 endExitY double N 1 지하철 나가는 출구 Y좌표(지하철인 경우에만 사용되지만 해당 태그가 없을 수도 있다.)
1-9-3-36 passStopList 확장노드 Y 1 경로 상세구간 정보 확장 노드
1-9-3-36-1 stations 확장노드 Y 1...n 정류장 정보 그룹노드
1-9-3-36-1-1 index int Y 1 정류장 순번
1-9-3-36-1-2 stationID int Y 1 정류장 ID
1-9-3-36-1-3 stationName string Y 1 정류장 명칭
1-9-3-36-1-4 stationNameKor string Y 1 정류장 명칭 국문
(다국어 서비스 시 표출)
1-9-3-36-1-5 stationNameJpnKata string Y 1 정류장 명칭 일문(가타카나)
(lang = 2 인 경우 표출)
1-9-3-36-1-6 stationCityCode int Y/N 1 정류장 도시코드 (버스인 경우에만 필수)
1-9-3-36-1-7 stationProviderCode int Y/N 1 BIS 코드 (BIS 제공지역인 경우에만 필수)
1-9-3-36-1-8 localStationID string Y/N 1 각 지역 정류장 ID (BIS 제공지역인 경우에만 필수)
1-9-3-36-1-9 arsID string Y/N 1 각 지역 정류장 고유번호 (BIS 제공지역인 경우에만 필수)
1-9-3-36-1-10 x string Y 1 정류장 X좌표
1-9-3-36-1-11 y string Y 1 정류장 Y좌표
1-9-3-36-1-12 isNonStop string Y/N 1 미정차 정류장 여부 Y/N(버스인 경우에만 필수)

• 출력 데이터(도시간 길찾기)(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 searchType int Y 1 결과 구분 (도시내 or 도시간)
0-도시내, 1-도시간
1-2 busCount int Y 1 고속/시외버스 결과개수
1-3 trainCount int Y 1 열차 결과 개수
1-4 airCount int Y 1 항공 결과 개수
1-5 mixedCount int Y 1 시외교통 수단 복합 이용 결과 개수
1-6 path 확장노드 Y 1...n 결과 리스트 확장 노드
1-6-1 pathType int Y 1 결과종류
11-열차, 12-고속/시외버스, 13-항공, 20-시외교통 복합(열차+고속버스 등)
1-6-2 info 확장노드 Y 1 요약 정보 확장 노드
1-6-2-1 totalTime int Y 1 시외교통 총 소요시간
1-6-2-2 totalPayment int Y 1 시외교통 총 요금
1-6-2-3 transitCount int Y 1 이용하는 시외교통 수
1-6-2-4 firstStartStation string Y 1 최초 출발역/터미널/공항
1-6-2-5 firstStartStationKor string Y 1 최초 출발역/터미널/공항 국문
(다국어 서비스 시 표출)
1-6-2-6 firstStartStationJpnKata string Y 1 최초 출발역/터미널/공항 일문(가타카나)
(lang = 2 인 경우 표출)
1-6-2-7 lastEndStation string Y 1 최종 출발역/터미널/공항
1-6-2-8 lastEndStationKor string Y 1 최종 출발역/터미널/공항 국문
(다국어 서비스 시 표출)
1-6-2-9 lastEndStationJpnKata string Y 1 최종 출발역/터미널/공항 일문(가타카나)
(lang = 2 인 경우 표출)
1-6-2-10 totalDistance int Y 1 시외교통 총 이동거리
1-6-3 subPath 확장노드 Y 1...n 이동 교통수단 정보 확장 노드
1-6-3-1 trafficType int Y 1 이동 수단 종류
4-열차, 5-고속버스, 6-시외버스, 7-항공
1-6-3-2 trainType int Y/N 1 열차 종류(열차인 경우에만 필수)
1-KTX, 2-새마을, 3-무궁화, 4-누리로
5-통근, 6-ITX, 7-ITX-청춘, 8-SRT
1-6-3-3 distance int Y 1 이동거리 (미터)
1-6-3-4 sectionTime int Y 1 이동시간 (분)
1-6-3-5 payment int Y 1 요금
1-6-3-6 trainSpSeatYn string Y/N 1 열차내 특실 존재여부 Y/N (열차인 경우에만 필수)
1-6-3-7 trainSpSeatPayment int Y/N 1 열차내 특실 요금(열차인 경우에만 필수)
1-6-3-8 startName string Y 1 출발 역/터미널/공항 명칭
1-6-3-9 startNameKor string Y 1 출발 역/터미널/공항 명칭 국문
(다국어 서비스 시 표출)
1-6-3-10 startNameJpnKata string Y 1 출발 역/터미널/공항 명칭 일문(가타카나)
(lang = 2 인 경우 표출)
1-6-3-11 endName string Y 1 도착 역/터미널/공항 명칭
1-6-3-12 endNameKor string Y 1 도착 역/터미널/공항 명칭 국문
(다국어 서비스 시 표출)
1-6-3-13 endNameJpnKata string Y 1 도착 역/터미널/공항 명칭 일문(가타카나)
(lang = 2 인 경우 표출)
1-6-3-14 startID int Y 1 출발 역/터미널/공항 코드
1-6-3-15 endID int Y 1 도착 역/터미널/공항 코드
1-6-3-16 startCityCode int Y 1 출발 역/터미널/공항 도시코드
1-6-3-17 endCityCode int Y 1 도착 역/터미널/공항 도시코드
1-6-3-18 startX double Y 1 출발 역/터미널/공항 X 좌표
1-6-3-19 startY double Y 1 출발 역/터미널/공항 Y 좌표
1-6-3-20 endX double Y 1 도착 역/터미널/공항 X 좌표
1-6-3-21 endY double Y 1 도착 역/터미널/공항 Y 좌표
1-6-3-22 intervalTime int Y 1 평균 배차간격(분)
1-6-3-23 intervalCount int Y 1 운행 횟수

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락
3 출발지 정류장이 없습니다.
4 도착지 정류장이 없습니다.
5 출, 도착지 정류장이 없습니다.
6 서비스 지역이 아닙니다.
-98 출, 도착지가 700m이내입니다.
-99 검색결과가 없습니다.

지하철역 환승 정보 조회(Subway Station Transfer Information)

지하철역 환승 정보를 리턴합니다.

매서드 요청 URI 출력 포맷
GET/POST http://api.odsay.com/v1/api/subwayTransitInfo json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 stationID Y 지하철 환승 정보를 조회 할 역코드 stationID=133

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 count int Y 1 환승 개수
1-2 transitTotalInfo 확장노드 Y 1...n 환승 정보 리스트
1-2-1 takeStationID int Y 1 타고온 역 ID
1-2-2 takeLaneName string Y 1 타고온 노선명
1-2-3 takeLaneNameKor string N 1 타고온 노선명 국문
(다국어 서비스 시 표출)
1-2-4 takeLaneNameJpnKata string N 1 타고온 노선명 일문(가타카나)
(lang = 2 인 경우 표출)
1-2-5 takeLaneID int Y 1 타고온 노선 ID
1-2-6 takeLaneDirection string Y 1 타고온 노선 방면
1-2-7 exStationID int Y 1 환승 할 역 ID
1-2-8 exLaneName string Y 1 환승 할 노선명
1-2-9 exLaneNameKor string N 1 환승 할 노선명 국문
(다국어 서비스 시 표출)
1-2-10 exLaneNameJpnKata string N 1 환승 할 노선명 일문(가타카나)
(lang = 2 인 경우 표출)
1-2-11 exLaneID int Y 1 환승 할 노선 ID
1-2-12 exLaneDirection string Y 1 환승 할 노선 방면
1-2-13 fastTrainInfo string Y 1 환승 정보
1-2-14 FastTrain int Y 1 빠른환승 열차번호
1-2-15 FastFastDoor int Y 1 빠른환승 문 번호
1-2-16 FastTrainNum int Y 1 전체 열차 칸 수

Console에서 예시 확인하기»

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

고속버스 터미널 검색(Express Bus Terminal)

고속버스 터미널 정보를 리턴합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/expressBusTerminals json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 CID N 도시코드 CID=1000
2 terminalName N 터미널명 terminalName=서울
※ CID와 terminalName 두 파라미터중 하나는 반드시 넣으셔야 합니다.

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최상위 노드
1-1 stationID int Y 1 출발 터미널 ID
1-2 stationName string Y 1 출발 터미널명
1-3 stationNameKor string N 1 출발 터미널명 국문
(다국어 서비스 시 표출)
1-4 stationNameJpnKata string N 1 출발 터미널명 일문(가타카나)
(lang = 2 인 경우 표출)
1-5 x double Y 1 출발 터미널 X좌표
1-6 y double Y 1 출발 터미널 Y좌표
1-7 haveDestinationTerminals boolean Y 1 도착지 터미널 존재 여부(true: 존재, false: 미존재)
1-8 destinationTerminals 확장노드 N 0...n 도착지 터미널 상위 노드
1-8-1 stationID int Y 1 도착 터미널 ID
1-8-2 stationName string Y 1 도착 터미널명
1-8-3 stationNameKor string N 1 도착 터미널명 국문
(다국어 서비스 시 표출)
1-8-4 stationNameJpnKata string N 1 도착 터미널명 일문(가타카나)
(lang = 2 인 경우 표출)
1-8-5 x double Y 1 도착 터미널 X좌표
1-8-6 y double Y 1 도착 터미널 Y좌표

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류

시외버스 터미널 검색(Intercity Bus Terminal)

시외버스 터미널 정보를 리턴합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/intercityBusTerminals json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 CID N 도시코드 CID=1000
2 terminalName N 터미널명 terminalName=서울
※ CID와 terminalName 두 파라미터중 하나는 반드시 넣으셔야 합니다.

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최상위 노드
1-1 stationID int Y 1 출발 터미널 ID
1-2 stationName string Y 1 출발 터미널명
1-3 stationNameKor string N 1 출발 터미널명 국문
(다국어 서비스 시 표출)
1-4 stationNameJpnKata string N 1 출발 터미널명 일문(가타카나)
(lang = 2 인 경우 표출)
1-5 x double Y 1 출발 터미널 X좌표
1-6 y double Y 1 출발 터미널 Y좌표
1-7 haveDestinationTerminals boolean Y 1 도착지 터미널 존재 여부(true: 존재, false: 미존재)
1-8 destinationTerminals 확장노드 N 0...n 도착지 터미널 상위 노드
1-8-1 stationID int Y 1 도착 터미널 ID
1-8-2 stationName string Y 1 도착 터미널명
1-8-3 stationNameKor string N 1 도착 터미널명 국문
(다국어 서비스 시 표출)
1-8-4 stationNameJpnKata string N 1 도착 터미널명 일문(가타카나)
(lang = 2 인 경우 표출)
1-8-5 x double Y 1 도착 터미널 X좌표
1-8-6 y double Y 1 도착 터미널 Y좌표

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류

도시코드 조회(City Code)

도시코드(CID)를 리턴합니다.

매서드 요청 URI 출력 포맷
GET/POST http://api.odsay.com/v1/api/searchCID json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 cityName N 조회할 도시이름(한글)
검색하는 글자를 포함하는 결과를 호출한다.
빈값 입력시 모든 도시코드를 호출한다.

ex) '양주' 검색 결과값 : 양주,남양주
cityName=서울

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최 상위 노드
1-1 CID 확장노드 Y 1 각 도시
1-1-1 cityRegion String Y 1 도시의 행정구
1-1-2 cityName String Y 1 도시의 이름
1-1-3 cityNameKor String N 1 도시의 이름 국문
(다국어 서비스 시 표출)
1-1-4 cityNameJpnKata String N 1 도시의 이름 일문(가타카나)
(lang = 2 인 경우 표출)
1-1-5 cityCode String Y 1 도시의 코드

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 입력값 누락

기차역 터미널 조회(Train Station Terminal)

기차역 터미널 정보를 리턴합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/trainTerminals json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 CID N 도시코드 CID=1000
2 terminalName N 터미널명 terminalName=서울
※ CID와 terminalName 두 파라미터중 하나는 반드시 넣으셔야 합니다.

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최상위 노드
1-1 stationID int Y 1 출발 터미널 ID
1-2 stationName string Y 1 출발 터미널명
1-3 stationNameKor string N 1 출발 터미널명 국문
(다국어 서비스 시 표출)
1-4 stationNameJpnKata string N 1 출발 터미널명 일문(가카타나)
(lang = 2 인 경우 표출)
1-5 x double Y 1 출발 터미널 X좌표
1-6 y double Y 1 출발 터미널 Y좌표
1-7 haveDestinationTerminals boolean Y 1 도착지 터미널 존재 여부(true: 존재, false: 미존재)
1-8 arrivalTerminals 확장노드 N 0...n 도착지 터미널 상위 노드
1-8-1 stationID int Y 1 도착 터미널 ID
1-8-2 stationName string Y 1 도착 터미널명
1-8-3 stationNameKor string N 1 도착 터미널명 국문
(다국어 서비스 시 표출)
1-8-4 stationNameJpnKata string N 1 도착 터미널명 일문(가타카나)
(lang = 2 인 경우 표출)
1-8-5 x double Y 1 도착 터미널 X좌표
1-8-6 y double Y 1 도착 터미널 Y좌표

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류

반경 내 버스/지하철 정류장 및 버스노선 조회(Bus/Subway Stop & Bus Route within Radius)

지정된 포인트와 반경을 가지고 대중교통 정류장 및 노선 POI정보를 검색합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/pointBusStation json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=0
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 x Y x좌표(경위도) x=126.900933
2 y Y y좌표(경위도) y=37.533059
3 radius N 반경(m) (default:250) radius=250

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최상위 노드
1-1 count int Y 1 정류장 POI 개수
1-2 lane 확장노드 Y 1...n 정류장 POI 리스트
1-2-1 stationClass int Y 1 대중교통 POI종류
(1: 버스정류장, 2: 지하철역 3. 기차역,
4: 고속터미널, 5: 공항, 6: 시외버스터미널, 7:항만)
1-2-2 stationID int Y 1 정류장 POI ID
1-2-3 stationName string Y 1 정류장 POI 이름
1-2-4 stationNameKor string N 1 정류장 POI 이름 국문
(다국어 서비스 시 표출)
1-2-5 stationNameJpnKata string N 1 정류장 POI 이름 일문(가타카나)
(lang = 2 인 경우 표출)
1-2-6 x double Y 1 x좌표(경위도)
1-2-7 y double Y 1 y좌표(경위도)
1-2-8 subwayLaneName string N 1 노선명
(stationClass 2 인 경우만)
1-2-9 subwayLaneNameKor string N 1 노선명 국문
(stationClass 2 인 경우만)
(다국어 서비스 시 표출)
1-2-10 subwayLaneNameJpnKata string N 1 노선명 일문(가타카나)
(stationClass 2 인 경우만)
(lang = 2 인 경우 표출)
1-2-11 subwayLaneCity string N 1 노선지역명
(stationClass 2 인 경우만)
1-2-12 subwayLaneCityKor string N 1 노선지역명 국문
(stationClass 2 인 경우만)
(다국어 서비스 시 표출)
1-2-13 subwayLaneCityJpnKata string N 1 노선지역명 일문(가타카나)
(stationClass 2 인 경우만)
(lang = 2 인 경우 표출)
1-2-14 subwayLaneType int N 1 노선종류
- 문서하단 지하철노선타입 참조
(stationClass 2 인 경우만)
1-2-15 busOnlyCentralLane int N 1 버스전용 중앙차로 정류장 해당 여부
(0: 비해당, 1: 해당)
(stationClass 1 인 경우만)
1-2-16 busList 확장노드 N 0...n 통과 버스노선 리스트
1-2-16-1 busID int Y 1 버스노선 ID
1-2-16-2 type int Y 1 노선종류
1-2-16-3 busNo string Y 1 버스노선 이름
1-2-16-4 busNoKor string N 1 버스노선 이름 국문
(다국어 서비스 시 표출)
1-2-16-5 busNoJpnKata string N 1 버스노선 이름 일문(가타카나)
(lang = 2 인 경우 표출)

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류

대중교통 접근성 영역 조회(Public Transit Accessibility Area Search)

대중교통으로 일정 시간내에 도달할 수 있는 폴리곤 영역을 조회한다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/searchPubTransIsochrone json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 x Y 경도 (WGS84) x=126.9009
2 y Y 위도 (WGS84) y=37.5323
3 searchTime Y 검색 시간 (단위:분)
[범위: 10 ~ 60]
searchTime=30
4 searchMethod Y 이동수단
(2: 버스, 3: 지하철, 4: 버스+지하철)
searchMethod=4

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최상위 노드
1-1 geojson 확장노드 Y 1 GeoJSON 데이트
데이터가 존재하지 않는 경우 null
1-1-1 type string N 1 GeoJSON 타입 (FeatureCollection)
1-1-2 features 확장노드 N 1...n GeoJSON Feature 리스트
1-1-2-1 geometry 확장노드 N 1 GeoJSON Feature Geometry
1-1-2-1-1 coordinates double[] N 1...n GeoJSON Feature Geometry 좌표 정보
(Polygon 포맷의 경위도 좌표역)
예: [[[126.8978001,37.5218922],[126.8996098,37.5219091],...]]
1-1-2-1-2 type string N 1 GeoJSON Feature Geometry 타입
(Polygon, MultiPolygon)
1-1-2-2 type String N 1 GeoJSON Feature 타입 (Feature)
1-1-2-3 properties 확장노드 N 1 GeoJSON Feature 속성 정보
1-1-2-3-1 x string N 1 검색 경도
1-1-2-3-2 y string N 1 검색 위도
1-1-2-3-3 searchTime int N 1 검색 시간
1-1-2-3-4 searchMethod int N 1 검색 이동수단

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 정보 누락 오류

멀티모달 대중교통 길찾기(Multi-modal Route Search)

여러 대중교통 수단을 사용한 길찾기 결과를 반환한다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/maasRP json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 SX Y 출발지 경도 (WGS84) SX=126.926493082645
2 SY Y 출발지 위도 (WGS84) SY=37.6134436427887
3 EX Y 도착지 경도 (WGS84) EX=127.126936754911
4 EY Y 도착지 위도 (WGS84) EY=37.5004198786564
5 SearchTime Y 출발시간 (yyyyMMddHHmm) SearchTime=202605111500
6 SearchMethod Y 교통수단 (콤마로 구분하여 복수지정 가능. 예]1,2)
(1:도보, 2:대중교통, 3:대중교통+자전거, 4:자전거)
SearchMethod=2,3
7 SearchPTRadius N 출도착지 주변 자전거 스테이션 검색 반경
(단위:m)(Default: 100m)(SearchMode=3인 경우 사용)
SearchPTRadius=100
8 ExceptBicycleDist N 자전거 이동거리가 기준거리 이내이면 결과에서 제외
(단위:m)(Default: 500m)(SearchMode=3인 경우 사용)

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최상위 노드
1-1 walk_pathCnt int N 1 도보 길찾기 경로 갯수
(pathType=1 인 경우)
1-2 publicTransit_pathCnt int N 1 대중교통 길찾기 경로 갯수
(pathType=2 인 경우)
1-3 publicTransitPTBicycle_pathCnt int N 1 대중교통+자전거 길찾기 경로 갯수
(pathType=3 인 경우)
1-4 paths 확장노드 Y 1...n 경로 결과 리스트
1-4-1 pathType int Y 1 경로 종류
(1:도보경로, 2:대중교통경로, 3:대중교통+자전거경로,
4:자전거경로)
1-4-2 pathSubType int Y 1 경로 세부 이용 수단
(0:도보, 1:지하철, 2:버스, 3:지하철+버스,
4:시외교통, 5:자전거)
1-4-3 totalTime int Y 1 소요시간 (단위:분)
상세구간(rps) 목록의 duration 합
1-4-4 totalDistance int Y 1 이동거리 (단위:m)
1-4-5 totalPayment int N 1 대중교통 이용요금 (단위:원)
(pathType=2 인 경우)
1-4-6 totalIntervalTime string N 1 대중교통 평균 배차간격 (단위:분)
1-4-7 checkIntervalTime int N 1 대중교통 배차간격 체크 기준시간 (단위:분)
(pathType=2 인 경우)
1-4-8 checkIntervalTimeOverYn string N 1 대중교통 배차간격을 초과하는 노선이 포함되어 있는지 여부
(Y/N)(pathType=2 인 경우)
1-4-9 mapObj string N 1 대중교통 이용 노선의 그래픽 호출 정보
(pathType=2 인 경우)
1-4-10 walkParam string N 1 도보 구간 호출을 위한 파라미터 정보
(pathType=2 인 경우)
1-4-11 startDateTime string N 1 출발시간 (pathType=2,3 인 경우)
1-4-12 endDateTime string N 1 도착시간 (pathType=2,3 인 경우)
1-4-13 walkOpt string N 1 도보 길찾기 옵션 (pathType=1 인 경우)
(short:최단, wide:큰길우선, recom:추천)
1-4-14 sectionInfo 확장노드 N 1...n 구간(도시간)별 요약정보
(pathType=2 인 경우)
1-4-14-1 sectionIdx int Y 1 구간 인덱스 (0부터 시작)
1-4-14-2 startRpsIdx int Y 1 경로구간 인덱스 시작 위치
(rps.routes.rseq)
1-4-14-3 endRpsIdx int Y 1 경로구간 인덱스 종료 위치
(rps.routes.rseq)
1-4-14-4 distance int Y 1 구간 거리 (단위:m)
1-4-14-5 time int Y 1 구간 소요 시간 (단위:분)
1-4-14-6 payment int Y 1 구간 소요 요금 (단위:원)
1-4-14-7 cityName string N 1 구간 도시명
1-4-15 rps 확장노드 Y 1...n 경로 구간 리스트
※ 이동수단 종류별 rps 항목이 달라 이동 수단 별로 정리

• 출력 데이터 (rps-도보,자전거)(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1-4-15-1 trafficType int Y 1 이동 수단 종류
(3:도보, 20:자전거)
1-4-15-2 duration int Y 1 구간 소요시간 (단위:분)
1-4-15-3 distance int Y 1 구간 이동거리 (단위:m)
1-4-15-4 startDateTime string N 1 구간 출발 시간 (yyyyMMddHHmm)
1-4-15-5 endDateTime string N 1 구간 도착 시간 (yyyyMMddHHmm)
1-4-15-6 routes 확장노드 Y 1...n RP 세부 구간 정보
1-4-15-6-1 rseq int Y 1 단위구간 순서 (1부터 시작)
1-4-15-6-2 LINK_ID string Y 1 링크 ID
1-4-15-6-3 LENGTH int Y 1 링크 길이 (단위:m)
1-4-15-6-4 DURATION int Y 1 링크 소요시간 (단위:초)
1-4-15-6-5 LINK_TYPE int Y 1 링크 타입
(1:보행자길, 2:횡단보도, 3:육교, 4:지하철역사출입구 지하층연결로,
5:지하도출입구 지하층연결로, 6:교량, 7:고가도로, 8:지하도록,
9:자동차전용도로, 10:터널, 11:지하보행로, 12:계단,
13:버스중앙차선정류장, 14:공원, 15:광장, 16:공개공지)
1-4-15-6-6 ROAD_NAME string Y 1 도로명
1-4-15-6-7 ROAD_TYPE int Y 1 도로 종류
(1:보도, 2:자전거 도로, 3:보도+자전거 혼용 도로)
1-4-15-6-8 crossXYInfos 확장노드 N 1...n 출도착지점과 링크간의 직선 정보
1-4-15-6-8-1 x double N 1 X 좌표 (WGS84)
1-4-15-6-8-2 y double N 1 Y 좌표 (WGS84)
1-4-15-6-9 xyInfos 확장노드 Y 1 링크 좌표셋 정보
1-4-15-6-9-1 x double Y 1 X 좌표 (WGS84)
1-4-15-6-9-2 y double Y 1 Y 좌표 (WGS84)
1-4-15-6-10 guides 확장노드 Y 1...n RP 안내 정보
1-4-15-6-10-1 gseq int Y 1 안내 포인트 순서 (1부터 시작)
1-4-15-6-10-2 LINK_IDs string Y 1 안내 포인트가 해당되는 링크 ID들
1-4-15-6-10-3 GUIDE_TYPE int Y 1 안내 종류
(1:보행자길, 2:횡단보도, 3:육교, 4:지하철역사출입구 지하층연결로,
5:지하도출입구 지하층연결로, 6:교량, 11:지하보행로, 12:계단,
13:버스중앙차선정류장, 14:공원, 15:광장)
1-4-15-6-10-4 LENGTH int Y 1 안내 구간 길이 (단위:m)
1-4-15-6-10-5 ToANGLE int Y 1 링크 진행 방향기준 분기 각도
(양수값. TURN 방향 참고)
1-4-15-6-10-6 TURN int Y 1 진행 방향 (0:직진, 1:왼쪽:, -1:오른쪽)
1-4-15-6-10-7 GUIDANCE string Y 1 안내 문구
1-4-15-6-10-8 POINT 확장노드 Y 1...n 안내 포인트 정보
1-4-15-6-10-8-1 x double Y 1 X 좌표 (WGS84)
1-4-15-6-10-8-2 y double Y 1 Y 좌표 (WGS84)
1-4-15-6-11 rentalPTStation 확장노드 N 1 개인이동수단 대여소
(trafficType>=20 인 경우)
1-4-15-6-11-1 rentalKind int Y 1 대여소 종류 (1:자전거대여소)
1-4-15-6-11-2 ptStationId String Y 1 대여소 ID
1-4-15-6-11-3 ptStationBrand string Y 1 대여소 브랜드
1-4-15-6-11-4 ptStationNo string N 1 대여소 번호
1-4-15-6-11-5 ptStationName string Y 1 대여소 명
1-4-15-6-11-6 longitude double Y 1 대여소 X 좌표 (WGS84)
1-4-15-6-11-7 latitude double Y 1 대여소 Y 좌표 (WGS84)
1-4-15-6-11-8 distance int Y 1 조회위치기준 직선거리 (단위:m)
1-4-15-6-12 returnPTStation 확장노드 N 1 개인이동수단 반납소
(trafficType>=20 인 경우)
1-4-15-6-12-1 rentalKind int Y 1 반납소 종류 (1:자전거대여소)
1-4-15-6-12-2 ptStationId string Y 1 반납소 ID
1-4-15-6-12-3 ptStationBrand string Y 1 반납소 브랜드
1-4-15-6-12-4 ptStationNo string N 1 반납소 번호
1-4-15-6-12-5 ptStationName string Y 1 반납소 명
1-4-15-6-12-6 longitude double Y 1 반납소 X 좌표 (WGS84)
1-4-15-6-12-7 latitude double Y 1 반납소 Y 좌표 (WGS84)
1-4-15-6-12-8 distance int Y 1 조회위치기준 직선거리 (단위:m)

• 출력 데이터 (rps-대중교통[공통])(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1-4-15-1 trafficType int Y 1 이동 수단 종류
(1:지하철, 2:버스, 4:열차,
5:고속버스, 6:시외버스, 7:항공)
1-4-15-2 trafficSubType int Y 1 이동 수단 분류
(1:KTX, 2:새마을, 3:무궁화, 4:누리호,
5:통근, 6:ITX, 7:ITX-청춘, 8:SRT)
1-4-15-3 duration int Y 1 구간 소요시간 (단위:분)
1-4-15-4 distance int Y 1 구간 이동거리 (단위:m)
1-4-15-5 waitingTime int N 1 탑승 대기시간 (단위:분)
1-4-15-6 startDateTime string N 1 구간 출발 시간 (yyyyMMddHHmm)
1-4-15-7 endDateTime string N 1 구간 도착 시간 (yyyyMMddHHmm)
1-4-15-8 startName string Y 1 출발지 명
1-4-15-9 startNameKor string N 1 출발지 명 국문
(다국어 서비스 시 제공)
1-4-15-10 startNameJpnKata string N 1 출발지 명 일문 카나카나
(다국어 서비스 lang=2(일문) 인 경우 제공)
1-4-15-11 startID int Y 1 출발지 ID
1-4-15-12 startLocalStationID string N 1 출발지 BIS ID
(trafficType=2 인 경우)
1-4-15-13 startStationCityCode int N 1 출발 정류장 도시코드
(trafficType=2 인 경우)
1-4-15-14 startStationProviderCode int N 1 출발 정류장 BIS BusProvider 코드
(trafficType=2 인 경우)
1-4-15-15 startArsID string N 1 출발지 ARS ID
(trafficType=2 인 경우)
1-4-15-16 startX double Y 1 출발지 X 좌표 (WGS84)
1-4-15-17 startY double Y 1 출발지 Y 좌표 (WGS84)
1-4-15-18 endName string Y 1 도착지 명
1-4-15-19 endNameKor string N 1 도착지 명 국문
(다국어 서비스 시 제공)
1-4-15-20 endNameJpnKata string N 1 도착지 명 일문 카타카나
(다국어 서비스 lang=2(일문) 인 경우 제공)
1-4-15-21 endID int Y 1 도착지 ID
1-4-15-22 endLocalStationID string N 1 도착지 BIS ID
(trafficType=2 인 경우)
1-4-15-23 endStationCityCode int N 1 도착 정류장 도시코드
(trafficType=2 인 경우)
1-4-15-24 endStationProviderCode int N 1 도착 정류장 BIS Provider 코드
(trafficType=2 인 경우)
1-4-15-25 endArsID string N 1 도착지 ARS ID
(trafficType=2 인 경우)
1-4-15-26 endX double Y 1 도착지 X 좌표 (WGS84)
1-4-15-27 endY double Y 1 도착지 Y 좌표 (WGS84)
1-4-15-28 intervalTime int Y 1 평일 기준 평균 배차간격 (단위:분)
1-4-15-29 graph string Y 1 구간 노선 그래프
(XY 좌표는 공백으로 구분, XY 좌표간에는 | 로 구분)
예) 126.951967 37.543518|126.954176 37.542546
1-4-15-30 passStopList 확장노드 N 1 노선 경유 정류장 정보
1-4-15-30-1 stations 확장노드 N 1...n 노선 경유 정류장 리스트
1-4-15-30-1-1 index int Y 1 정류장 순번
1-4-15-30-1-2 stationID int Y 1 정류장 ID
1-4-15-30-1-3 localStationID string N 1 정류장 BIS ID
(trafficType=2 인 경우)
1-4-15-30-4 stationCityCode int N 1 정류장 도시코드
(trafficType=2 인 경우)
1-4-15-30-5 stationProviderCode int N 1 정류장 BIS Provider 코드
(trafficType=2 인 경우)
1-4-15-30-6 arsID string N 1 정류장 ARS ID
(trafficType=2 인 경우)
1-4-15-30-7 isNonStop string N 1 정차 정류장 여부 Y/N
(trafficType=2 인 경우)
1-4-15-30-8 stationName string Y 1 정류장 명
(trafficType=2 인 경우)
1-4-15-30-9 stationNameKor string N 1 정류장 명 국문
(trafficType=2 인 경우)
(다국어 서비스 시 제공)
1-4-15-30-10 stationNameJpnKata string N 1 정류장 명 일문 카타카나
(trafficType=2 인 경우)
(다국어 서비스 lang=2(일문) 인 경우 제공)
1-4-15-30-11 x double Y 1 정류장 X 좌표 (WGS84)
1-4-15-30-12 y double Y 1 정류장 Y 좌표 (WGS84)

• 출력 데이터 (rps-대중교통[버스])(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1-4-15-1 lane 확장노드 N 1 노선 정보
(trafficType=2 인 경우)
1-4-15-1-1 busNo string Y 1 버스 노선 번호
(trafficType=2 인 경우)
1-4-15-1-2 busNoKor string N 1 버스 노선 번호 국문
(trafficType=2 인 경우)
(다국어 서비스 시 제공)
1-4-15-1-3 busNoJpnKata string N 1 버스 노선 번호 일문 카타카나
(trafficType=2 인 경우)
(다국어 서비스 lang=2(일문) 인 경우 제공)
1-4-15-1-4 type int Y 1 노선 버스 타입 (trafficType=2 인 경우)
문서하단 버스노선 타입 참조
1-4-15-1-5 busID string Y 1 노선 버스 ID
(trafficType=2 인 경우)
1-4-15-1-6 busLocalBlID string N 1 노선 BIS ID
(trafficType=2 인 경우)
1-4-15-1-7 busCityCode int N 1 운수회사 승인 도시코드
(trafficType=2 인 경우)
1-4-15-1-8 busProviderCode int N 1 노선 BIS Provider 코드
(trafficType=2 인 경우)
1-4-15-1-9 busLaneColor string N 1 버스 노선 색상값
(trafficType=2 인 경우)

• 출력 데이터 (rps-대중교통[지하철])(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1-4-15-1 way string N 1 방면 정보
(trafficType=1 인 경우)
1-4-15-2 wayCode int N 1 방면 정보 코드
(trafficType=1 인 경우)
(1:상행, 2:하행)
1-4-15-3 door string N 1 지하철 빠른 환승 위치
(trafficType=1 인 경우)
1-4-15-4 startExitNo string N 1 지하철 들어가는 출구 번호
(trafficType=1 인 경우)
1-4-15-5 startExitX double N 1 지하철 들어가는 출구 X 좌표 (WGS84)
(trafficType=1 인 경우)
1-4-15-6 startExitY double N 1 지하철 들어가는 출구 Y 좌표 (WGS84)
(trafficType=1 인 경우)
1-4-15-7 endExitNo string N 1 지하철 나가는 출구 번호
(trafficType=1 인 경우)
1-4-15-8 endExitX double N 1 지하철 나가는 출구 X 좌표 (WGS84)
(trafficType=1 인 경우)
1-4-15-9 lane 확장노드 N 1...n 지하철 노선 정보
(trafficType=1 인 경우)
1-4-15-9-1 name string Y 1 지하철 노선명
(trafficType=1 인 경우)
1-4-15-9-2 nameKor string N 1 지하철 노선명 국문
(trafficType=1 인 경우)
(다국어 서비스 시 제공)
1-4-15-9-3 nameJpnKata string N 1 지하철 노선명 일문 카타카나
(trafficType=1 인 경우)
(다국어 서비스 lang=2(일문) 인 경우 제공)
1-4-15-9-4 subwayCode int Y 1 지하철 노선 코드
(trafficType=1 인 경우)
문서하단 지하철노선타입 참조
1-4-15-9-5 subwayCityCode int Y 1 지하철 도시코드
(trafficType=1 인 경우)

• 출력 데이터 (rps-대중교통[시외])(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1-4-15-1 payment int N 1 시외교통 요금 (단위:원)
(trafficType=4,5,6,7 인 경우)
1-4-15-2 trainSpSeatYn string N 1 열차내 특실 존재여부 Y/N (열차인 경우에만 필수)
(trafficType=4,5,6,7 인 경우)
1-4-15-3 trainSpSeatPayment int N 1 열차내 특실 요금 (열차인 경우에만 필수)
(trafficType=4,5,6,7 인 경우)
1-4-15-4 startCityCode int N 1 출발 역/터미널/공항 도시코드
(trafficType=4,5,6,7 인 경우)
1-4-15-5 endCityCode int N 1 도착 역/터미널/공항 도시코드
(trafficType=4,5,6,7 인 경우)

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
400 검색 데이터 없음
401 필수 정보 누락 오류

열차 노선도 길찾기(Train Route Search)

기차역 간 열차 길찾기 정보를 반환한다.
* 출도착 기차역 사이 열차만 사용하여 갈 수 있는 경로를 탐색한다.
* 열차 1회 환승 경로까지만 탐색하며 환승 시 출도착 시간 간격은 30분이다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/searchTrainPath json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 SID Y 출발역 코드 SID=3300128
2 EID Y 도착역 코드 EID=3300108
3 weekDay N 출발 요일
(0:일, 1:월, 2:화, 3:수, 4:목, 5:금, 6:토
default = 현재 요일)
weekDay=1
4 departureHour N 출발 시간 (0 ~ 23)
default = 현재 시간
departureHour=9

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최상위 노드
1-1 path 확장노드 Y 1...n 경로 목록
1-1-1 info 확장노드 Y 1 요약 정보
1-1-1-1 trainTravelTime int Y 1 총 열차 운행 시간 (단위:분)
1-1-1-2 trainTravelDistance int Y 1 총 열차 운행 거리 (단위:m)
1-1-1-3 trainNormalPayment int Y 1 총 열차 이용 비용 (단위:원)
1-1-1-4 firstStationId int Y 1 최초 승차역 ID
1-1-1-5 firstStationName string Y 1 최초 승차역 명
1-1-1-6 firstStationNameKor string N 1 최초 승차역 명 국문
(다국어 서비스 시 제공)
1-1-1-7 firstStationNameJpnKata string N 1 최초 승차역 명 일문 카타카나
(다국어 서비스 lang=2[일문] 인 경우 제공)
1-1-1-8 lastStationId int Y 1 최종 하차역 ID
1-1-1-9 lastStationName string Y 1 최종 하차역 명
1-1-1-10 lastStationNameKor string N 1 최종 하차역 명 국문
(다국어 서비스 시 제공)
1-1-1-11 lastStationNameJpnKata string N 1 최종 하차역 명 일문 카타카나
(다국어 서비스 lang=2[일문] 인 경우 제공)
1-1-1-12 stopStationCount int Y 1 총 정차역 수
1-1-1-13 transitCount int Y 1 열차 이용 횟수
1-1-1-14 otherWeekDay int Y 1 현재 검색조건으로 탐색된 경로가 없어
경로가 존재하는 다른 요일로 탐색한 요일 값
- 현재 검색 조건으로 탐색 : -1
- 다른 요일로 탐색한 경우 : 0~6 (일~토)
1-1-2 subPath 확장노드 Y 1...n 상세 경로 목록
1-1-2-1 trainType int Y 1 열차 종류
(1:KTX, 2:새마을, 3:무궁화, 4:누리로,
5:통근, 6:ITX, 7:ITX-청춘, 8:SRT)
1-1-2-2 trainName string Y 1 열차 종류 명
1-1-2-3 trainId string Y 1 열차 ID
1-1-2-4 sectionTime int Y 1 운행 시간 (단위:분)
1-1-2-5 distance int Y 1 운행 거리 (단위:m)
1-1-2-6 startCityCode int Y 1 출발 도시 코드
1-1-2-7 endCityCode int Y 1 도착 도시 코드
1-1-2-8 startID int Y 1 출발역 ID
1-1-2-9 startName string Y 1 출발역 명
1-1-2-10 startNameKor string N 1 출발역 명 국문
(다국어 서비스 시 제공)
1-1-2-11 startNameJpnKata string N 1 출발역 명 일문 카타카나
(다국어 서비스 lang=2[일문] 인 경우 제공)
1-1-2-12 startX double Y 1 출발역 X 좌표 (WGS84)
1-1-2-13 startY double Y 1 출발역 Y 좌표 (WGS84)
1-1-2-14 endID int Y 1 도착역 ID
1-1-2-15 endName string Y 1 도착역 명
1-1-2-16 endNameKor string N 1 도착역 명 국문
(다국어 서비스 시 제공)
1-1-2-17 endNameJpnKata string N 1 도착역 명 일문 카타카나
(다국어 서비스 lang=2[일문] 인 경우 제공)
1-1-2-18 endX double Y 1 도착역 X 좌표 (WGS84)
1-1-2-19 endY double Y 1 도착역 Y 좌표 (WGS84)
1-1-2-20 normalPayment int Y 1 열차 일반좌석 비용
1-1-2-21 specialPayment int Y 1 열차 특실좌석 비용
1-1-2-22 departureTime string Y 1 열차 출발 시간 (HH:mm)
1-1-2-23 arrivalTime string Y 1 열차 도착 시간 (HH:mm)
1-1-2-24 passStopList 확장노드 Y 1 통행역 목록
1-1-2-24-1 stations 확장노드 Y 1...n 통행역 정보
1-1-2-24-1-1 idx int Y 1 역 index
1-1-2-24-1-2 stationID string Y 1 역 ID
1-1-2-24-1-3 stationName string Y 1 역 명
1-1-2-24-1-4 stationNameKor string N 1 역 명 국문
(다국어 서비스 시 제공)
1-1-2-24-1-5 stationNameJpnKata string N 1 역 명 일문 카타카나
(다국어 서비스 lang=2[일문] 인 경우 제공)
1-1-2-24-1-6 departureTime string N 1 열차 출발 시간 (HH:mm)
(역에 정차하지 않는 경우 값 없음)
1-1-2-24-1-7 trainLineName string Y 1 철도 노선 명
1-1-2-24-1-8 isStop string Y 1 열차 정차 여부 Y/N
1-1-2-24-1-9 x double Y 1 억 X 좌표 (WGS84)
1-1-2-24-1-10 y double Y 1 역 Y 좌표 (WGS84)
1-1-2-25 scheduleList 확장노드 Y 1...n 열차 배차 시간표
(현재 조회된 시간 이후 출발 열차)
1-1-2-25-1 departureTime string Y 1 출발 시간 (HH:mm)
1-1-2-25-2 arrivalTime string Y 1 도착 시간 (HH:mm)
1-1-2-25-3 sectionTime int Y 1 열차 운행 시간 (단위:분)
1-1-2-25-4 normalPayment int Y 1 열차 일반좌석 비용
1-1-2-25-5 specialPayment int Y 1 열차 특실좌석 비용
1-1-2-26 vertices 확장노드 Y 1...n 열차 운행 경로
1-1-2-26-1 x double Y 1 운행 경로 X 좌표 (WGS84)
1-1-2-26-2 y double Y 1 운행 경로 Y 좌표 (WGS84)

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-9 필수 파라미터 누락
-99 경로 없음

도보 접근성 영역 조회(Walk Accessibility Area Search)

도보로 일정 시간내에 도달할 수 있는 폴리곤 영역을 조회한다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/searchWalkIsochrone json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 x Y 경도 (WGS84) x=126.9009
2 y Y 위도 (WGS84) y=37.5323
3 searchTime Y 검색 시간 (단위:분)
[범위: 10 ~ 60]
searchTime=30

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최상위 노드
1-1 geojson 확장노드 Y 1 GeoJSON 데이트
데이터가 존재하지 않는 경우 null
1-1-1 type string N 1 GeoJSON 타입 (FeatureCollection)
1-1-2 features 확장노드 N 1...n GeoJSON Feature 리스트
1-1-2-1 geometry 확장노드 N 1 GeoJSON Feature Geometry
1-1-2-1-1 coordinates double[] N 1...n GeoJSON Feature Geometry 좌표 정보
(Polygon 포맷의 경위도 좌표역)
예: [[[126.8978001,37.5218922],[126.8996098,37.5219091],...]]
1-1-2-1-2 type string N 1 GeoJSON Feature Geometry 타입
(Polygon, MultiPolygon)
1-1-2-2 type String N 1 GeoJSON Feature 타입 (Feature)
1-1-2-3 properties 확장노드 N 1 GeoJSON Feature 속성 정보
1-1-2-3-1 x string N 1 검색 경도
1-1-2-3-2 y string N 1 검색 위도
1-1-2-3-3 searchTime int N 1 검색 시간

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류
-8 필수 입력값 형식 및 범위 오류
-9 필수 정보 누락 오류

도보 길찾기(Walk Route Search)

도보 길찾기 경로를 탐색한다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/searchWalkPathV2 json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 opt Y 탐색 옵션
(reco:추천, short:최단, wide:큰길)
opt=reco,wide
2 loc Y 출도착 좌표셋
sx,sy,ex,ey@sx1,sy1,ex1,ey1@...
(@로 구분되는 다수의 출도착지 호출 가능)
loc=127.0947697,37.5368523,
127.1065285,37.5226263

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최상위 노드
1-1 path 확장노드 Y 1...n 경로 목록 정보
(출도착 좌표섹 경로 결과)
1-1-1 hasPathResult boolean Y 1 경로 탐색 성공 여부
1-1-2 errorCode string N 1 탐색 실패 시 에러 코드
400: 데이터가 존재하지 않습니다.
401: 필수정보에 오류가 있습니다.
402: 출도착 좌표셋에 오류가 있습니다.
403: 출도착 좌표가 동일합니다.
409: 도보길찾기는 직선거리 기준 30km 이내여야 합니다.
411: 출발지 링크 선정에 실패했습니다.
412: 도착지 링크 선정에 실패했습니다.
413: 출도착지 링크 선정에 실패했습니다.
414: 길찾기 결과가 없습니다.
1-1-3 speedKMPerHour double Y 1 시간당 이동 속도 정보 (단위:km/h)
1-1-4 recommend 확장노드 N 1 추천 경로 정보
(opt=reco, 추천 경로 조회 시)
1-1-4-1 summary 확장노드 Y 1 요약 정보
1-1-4-1-1 start 확장노드 Y 1 출발지 정보
1-1-4-1-1-1 x double Y 1 출발지 위치 - 경도 (WGS84)
1-1-4-1-1-2 y double Y 1 출발지 위치 위도 (WGS84)
1-1-4-1-2 end 확장노드 Y 1 도착지 정보
1-1-4-1-2-1 x double Y 1 도착지 위치 경도 (WGS84)
1-1-4-1-2-2 y double Y 1 도착지 위치 위도 (WGS84)
1-1-4-1-3 distance int Y 1 이동거리 (단위:m)
1-1-4-1-4 duration int Y 1 소요시간 (단위:초)
1-1-4-1-5 bound 확장노드 Y 1 지도 영역 정보
1-1-4-1-5-1 leftTop 확장노드 Y 1 왼쪽 최상단 위치 정보
1-1-4-1-5-1-1 x double Y 1 왼쪽 최상단 위치 경도 (WGS84)
1-1-4-1-5-1-2 y double Y 1 왼쪽 최상단 위치 위도 (WGS84)
1-1-4-1-5-2 rightBottom 확장노드 Y 1 오른쪽 최하단 위치 정보
1-1-4-1-5-2-1 x double Y 1 오른쪽 최하단 위치 경도 (WGS84)
1-1-4-1-5-2-2 y double Y 1 오른쪽 최하단 위치 위도 (WGS84)
1-1-4-2 routes 확장노드 Y 1...n 구간 경로 정보
1-1-4-2-1 type int Y 1 링크 구분
(0:미정의, 11:보도, 12:차량겸용도로,
13:자전거 겸용도로, 14:보행자 전용도로)
1-1-4-2-2 facility int Y 1 시설물 정보
(0:미정의, 1:횡단보도, 2:육교, 3:경사로, 4:계단,
5:엘리베이터, 6:교량, 7:고가도로, 8:지하도로, 9:터널
10:지하보행로, 11:버스중앙차선정류장, 12:연결통로(토끼굴)
13:지하철역사출입구 연결로, 14:지하도출입구 연결로, 15:차로)
1-1-4-2-3 distance int Y 1 이동 거리 (단위:m)
1-1-4-2-4 duration int Y 1 이동 시간 (단위:초)
1-1-4-2-5 coordinate 확장노드 Y 1 링크 구간 좌표 정보
1-1-4-2-5-1 x double Y 1 경도 (WGS84)
1-1-4-2-5-2 y double Y 1 위도 (WGS84)
1-1-4-3 guides 확장노드 Y 1...n 구간 안내 정보
1-1-4-3-1 routeIndex int Y 1 구간 경로정보의 index 정보
1-1-4-3-2 angle int Y 1 회전각 정보
1-1-4-3-3 turn int Y 1 회전 정보
(-1:오른쪽, 0:직진, 1:왼쪽)
1-1-4-3-4 facility int Y 1 시설물 정보
(0:미정의, 1:횡단보도, 2:육교, 3:경사로, 4:계단,
5:엘리베이터, 6:교량, 7:고가도로, 8:지하도로, 9:터널,
10:지하보행로, 11:버스중앙차선정류장, 12:연결통로(토끼굴),
13:지하철역사출입구 연결로, 14:지하도출입구 연결로, 15:차로)
1-1-4-3-5 guidance string Y 1 안내 문구
1-1-4-3-6 point 확장노드 Y 1 안내 지점 위치 정보
1-1-4-3-6-1 x double Y 1 안내 지점 경도 (WGS84)
1-1-4-3-6-2 y double Y 1 안내 지점 위도 (WGS84)
1-1-5 shortest 확장노드 N 1 최단 경로 정보
(opt=short 포함, 최단 경로 조회 시)
1-1-5-1 summary 확장노드 Y 1 요약정보
1-1-5-1-1 start 확장노드 Y 1 출발지 정보
1-1-5-1-1-1 x double Y 1 출발지 위치 경도 (WGS84)
1-1-5-1-1-2 y double Y 1 출발지 위치 위도 (WGS84)
1-1-5-1-2 end 확장노드 Y 1 도착지 정보
1-1-5-1-2-1 x double Y 1 도착지 위치 경도 (WGS84)
1-1-5-1-2-2 y double Y 1 도착지 위치 위도 (WGS84)
1-1-5-1-3 distance int Y 1 이동 거리 (단위:m)
1-1-5-1-4 duration int Y 1 소요 시간 (단위:초)
1-1-5-1-5 bound 확장노드 Y 1 지도 영역 정보
1-1-5-1-5-1 leftTop 확장노드 Y 1 왼쪽 최상단 위치 정보
1-1-5-1-5-1-1 x double Y 1 왼쪽 최상단 위치 경도 (WGS84)
1-1-5-1-5-1-2 y double Y 1 왼쪽 최상단 위치 위도 (WGS84)
1-1-5-1-5-2 rightBottom 확장노드 Y 1 오른쪽 최하단 위치 정보
1-1-5-1-5-2-1 x double Y 1 오른쪽 최하단 위치 경도 (WGS84)
1-1-5-1-5-2-2 y double Y 1 오른쪽 최하단 위치 위도 (WGS84)
1-1-5-2 routes 확장노드 Y 1...n 구간 경로 정보
1-1-5-2-1 type int Y 1 링크 구분
(0:미정의, 11:보도, 12:차량 겸용도로,
13:자전거 겸용도로, 14:보행자 전용도로)
1-1-5-2-2 facility int Y 1 시설물 정보
(0:미정의, 1:횡단보도, 2:육교, 3:경사로, 4:계단,
5:엘리베이터, 6:교량, 7:고가도로, 8:지하도로, 9:터널,
10:지하보행로, 11:버스중앙차선정류장, 12:연결통로(토끼굴),
13:지하철역사출입구 연결로, 14:지하도출입구 연결로, 15:차로)
1-1-5-2-3 distance int Y 1 이동 거리 (단위:m)
1-1-5-2-4 duration int Y 1 이동 시간 (단위:초)
1-1-5-2-5 coordinate 확장노드 Y 1...n 링크 구간 좌표 정보
1-1-5-2-5-1 x double Y 1 경도 (WGS84)
1-1-5-2-5-2 y double Y 1 위도 (WGS84)
1-1-5-3 guides 확장노드 Y 1...n 구간 안내 정보
1-1-5-3-1 routeIndex int Y 1 가간 경로정보의 index
1-1-5-3-2 angle int Y 1 회전 각도 정보
1-1-5-3-3 turn int Y 1 회전 정보
(-1:오른쪽, 0:직진, 1:왼쪽)
1-1-5-3-4 facility int Y 1 시설물 정보
(0:미정의, 1:횡단보도, 2:육교, 3:경사로, 4:계단,
5:엘리베이터, 6:교량, 7:고가도로, 8:지하도로, 9:터널,
10:지하보행로, 11:버스중앙차선정류장, 12:연결통로(토끼굴),
13:지하철역사출입구 연결로, 14:지하도출입구 연결로, 15:차로)
1-1-5-3-5 guidance string Y 1 안내 문구
1-1-5-3-6 point 확장노드 Y 1 안내 지점 정보
1-1-5-3-6-1 x double Y 1 안내 지점 경도 (WGS84)
1-1-5-3-6-2 y double Y 1 안내 지점 위도 (WGS84)
1-1-6 wide 확장노드 N 1 큰길 우선 경로 정보
(opt=wide 포함, 큰길 우선 경로 조회 시)
1-1-6-1 summary 확장노드 Y 1 요약 정보
1-1-6-1-1 start 확장노드 Y 1 출발지 정보
1-1-6-1-1-1 x double Y 1 출발지 위치 경로 (WGS84)
1-1-6-1-1-2 y double Y 1 출발지 위치 위도 (WGS84)
1-1-6-1-2 end 확장노드 Y 1 도착지 정보
1-1-6-1-2-1 x double Y 1 출발지 위치 경도 (WGS84)
1-1-6-1-2-2 y double Y 1 출발지 위치 위도 (WGS84)
1-1-6-1-3 distance int Y 1 이동 거리 (단위:m)
1-1-6-1-4 duration int Y 1 소요시간 (단위:초)
1-1-6-1-5 bound 확장노드 Y 1 지도 영역 정보
1-1-6-1-5-1 leftTop 확장노드 Y 1 왼쪽 최상단 위치 정보
1-1-6-1-5-1-1 x double Y 1 왼쪽 최상단 위치 경도 (WGS84)
1-1-6-1-5-1-2 y double Y 1 왼쪽 최상단 위치 위도 (WGS84)
1-1-6-1-5-2 rightBottom 확장노드 Y 1 오른쪽 최하단 위치 정보
1-1-6-1-5-2-1 x double Y 1 오른쪽 최하단 위치 경도 (WGS84)
1-1-6-1-5-2-2 y double Y 1 오른쪽 최하단 위치 위도 (WGS84)
1-1-6-2 routes 확장노드 Y 1...n 구간 경로 정보
1-1-6-2-1 type int Y 1 링크 구분
(0:미정의, 1: 보도, 12:차량 겸용도로,
13:자전거 겸용도로, 14:보행자 전용도로)
1-1-6-2-2 facility int Y 1 시설물 정보
(0:미정의, 1:횡단보도, 2:육교, 3:경사로, 4:계단,
5:엘리베이터, 6:교량, 7:고가도로, 8:지하도로, 9:터널,
10:지하보행로, 11:버스중앙차선정류장, 12:연결통로(토끼굴),
13:지하철역사출입구 연결로, 14:지하도출입구 연결로, 15:차로)
1-1-6-2-3 distance int Y 1 이동 거리 (단위:m)
1-1-6-2-4 duration int Y 1 이동 시간 (단위:초)
1-1-6-2-5 coordinate 확장노드 Y 1...n 링크 구간 좌표 정보
1-1-6-2-5-1 x double Y 1 경도 (WGS84)
1-1-6-2-5-2 y double Y 1 위도 (WGS84)
1-1-6-3 guides 확장노드 Y 1...n 구간 안내 정보
1-1-6-3-1 routeIndex int Y 1 구간 경로정보의 index
1-1-6-3-2 angle int Y 1 회전 각도 정보
1-1-6-3-3 turn int Y 1 회전 정보
(-1:오른쪽, 0:직진, 1:왼쪽)
1-1-6-3-4 facility int Y 1 시설물 정보
(0:미정의, 1:횡단보도, 2:육교, 3:경사로, 4:계단,
5:엘리베이터, 6:교량, 7:고가도로, 8:지하도로, 9:터널,
10:지하보행로, 11:버스중앙차선정류장, 12:연결통로(토끼굴),
13:지하철역사출입구 연결로, 14:지하도출입구 연결로, 15:차로)
1-1-6-3-5 guidance string Y 1 안내 문구
1-1-6-3-6 point 확장노드 Y 1 안내 지점 정보
1-1-6-3-6-1 x double Y 1 안내 지점 경도 (WGS84)
1-1-6-3-6-2 y double Y 1 안내 지점 위도 (WGS84)

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류

자전거 길찾기(Bike Route Search)

자전거 길찾기 추천경로를 조회합니다.

매서드 요청 URI 출력 포맷
GET/POST https://api.odsay.com/v1/api/searchBikePathV2 json, xml

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0 , 영문:1, 일문:2, 중문(간체):3, 중문(번체):4, 베트남어:5)
* 베트남어의 경우 수도권에 한하여 제공
default = 0
lang=1
공통 output N 출력포맷(json, xml)
default = json
output=xml
1 loc Y 출도착 좌표셋
sx,sy,ex,ey@sx1,sy1,ex1,ey1@...
(@로 구분되는 다수의 출도착지 호출 가능)
loc=127.0947697,37.5368523,
127.1065285,37.5226263

• 출력 데이터(Output Data)

번호 요소 데이터 타입 필수값 출력개수 설명
1 result 확장노드 Y 1 데이터를 포함하는 최상위 노드
1-1 path 확장노드 Y 1...n 경로 목록 정보
(출도착 좌표셋 경로 결과)
1-1-1 hasPathResult boolean Y 1 경로 탐색 성공 여부
1-1-2 errorCode string N 1 탐색 실패시 에러코드
400: 데이터가 존재하지 않습니다.
401: 필수정보에 오류가 있습니다.
402: 출도착 좌표셋에 오류가 있습니다.
403: 출도착 좌표가 동일합니다.
411: 출발지 링크 선정에 실패했습니다.
412: 도착지 링크 선정에 실패했습니다.
413: 출도착지 링크 선정에 실패했습니다.
414: 길찾기 결과가 없습니다.
1-1-3 speedKMPerHour double Y 1 시간당 이동 속도 정보(km/h)
1-1-4 recommend 확장노드 Y 1 추천 경로 정보
1-1-4-1 summary 확장노드 Y 1 요약 정보
1-1-4-1-1 start 확장노드 Y 1 출발지 정보
1-1-4-1-1-1 x double Y 1 출발지 위치 - 경도 (WGS84)
1-1-4-1-1-2 y double Y 1 출발지 위치 - 위도 (WGS84)
1-1-4-1-2 end 확장노드 Y 1 도착지 정보
1-1-4-1-2-1 x double Y 1 도착지 위치 - 경도 (WGS84)
1-1-4-1-2-2 y double Y 1 도착지 위치 - 위도 (WGS84)
1-1-4-1-3 distance int Y 1 이동거리 (단위:m)
1-1-4-1-4 duration int Y 1 소요시간 (단위:초)
1-1-4-1-5 bound 확장노드 Y 1 지도 영역 정보
1-1-4-1-5-1 leftTop 확장노드 Y 1 왼쪽 최상단 위치 정보
1-1-4-1-5-1-1 x double Y 1 왼쪽 최상단 위치 경도 (WGS84)
1-1-4-1-5-1-2 y double Y 1 왼쪽 최상단 위치 위도 (WGS84)
1-1-4-1-5-2 rightBottom 확장노드 Y 1 오른쪽 최하단 위치 정보
1-1-4-1-5-2-1 x double Y 1 오른쪽 최하단 위치 경도 (WGS84)
1-1-4-1-5-2-2 y double Y 1 오른쪽 최하단 위치 위도 (WGS84)
1-1-4-2 routes 확장노드 Y 1...n 구간 경로 정보
1-1-4-2-1 type int Y 1 링크 구분
(0:미정의, 21:자전거 전용도로,
22:자전거 보행자 겸용도로, 23:자전거 전용차로)
1-1-4-2-2 facility int Y 1 시설물 정보
(0:미정의, 1:횡단보도, 2:육교, 3:경사로, 4:계단,
5:엘리베이터, 6:교량, 7:고가도로, 8:지하도로, 9:터널,
10:지하보행로, 11:버스중앙차선정류장, 12:연결통로(토끼굴),
13:지하철역사출입구 연결로, 14:지하도출입구 연결로, 15:차로)
1-1-4-2-3 distance int Y 1 이동 거리 (단위:m)
1-1-4-2-4 duration int Y 1 이동 시간 (단위:초)
1-1-4-2-5 coordinate 확장노드 Y 1...n 링크 구간 좌표 정보
1-1-4-2-5-1 x double Y 1 경도 (WGS84)
1-1-4-2-5-2 y double Y 1 위도 (WGS84)
1-1-4-3 guides 확장노드 Y 1...n 구간 안내 정보
1-1-4-3-1 routeIndex int Y 1 구간 경로 정보의 index 정보
1-1-4-3-2 angle int Y 1 회전 각도 정보
1-1-4-3-3 turn int Y 1 회전 정보
(-1:오른쪽, 0:직진, 1:왼쪽)
1-1-4-3-4 facility int Y 1 시설물 정보
(0:미정의, 1:횡단보도, 2:육교, 3:경사로, 4:계단,
5:엘리베이터, 6:교량, 7:고가도로, 8:지하도로, 9:터널,
10:지하보행로, 11:버스중앙차선정류장, 12:연결통로(토끼굴),
13:지하철역사출입구 연결로, 14:지하도출입구 연결로, 15:도로)
1-1-4-3-5 guidance string Y 1 안내 문구
1-1-4-3-6 point 확장노드 Y 1 안내 지점 정보
1-1-4-3-6-1 x double Y 1 안내 지점 위치 경도 (WGS84)
1-1-4-3-6-2 y double Y 1 안내 지점 위치 위도 (WGS84)

Console에서 예시 확인하기 »

• 에러 코드(Error Code)

코드 메시지
500 서버 내부 오류

지하철 노선도(Subway Map)

JavaScript 기반으로 지하철 노선도를 웹 서비스 및 애플리케이션에 연동할 수 있도록 제공합니다.
전체 데모 보기 »

매서드 요청 URI 출력 포맷
GET https://api.odsay.com/v1/api/subway/sdk.js JavaScript

• 파라미터(Parameter)

번호 파라미터 필수값 설명 예시
공통 apiKey Y 발급된 키 apiKey=xxxxxxxxxxx
공통 lang N 결과 언어 선택
(국문:0, 영문:1, 일문:2, 중문(간체):3, 중문(번체):4)
※ 베트남어는 미제공
default = 0
lang=1
1 CID N 도시 코드
(수도권:1000, 부산:7000, 대구:4000, 광주:5000, 대전:3000)
default = 1000
CID=1000

• 시작하기(Getting Started)

단계 내용
1. 노선도 영역 생성 지하철 노선도를 표시할 HTML 요소를 생성합니다.
해당 요소는 이후 초기화 코드에서 동일한 id로 참조됩니다.

<div id="map" style="width:100%; height:350px;"></div>
                        
2. 노선도 SDK 로드 지하철 노선도 JavaScript API(SDK)를 사용하기 위해 스크립트를 로드합니다.
API Key를 포함해야 하며, callback 함수는 SDK 로드 완료 후 자동 호출됩니다.

<script type="text/javascript"
src="https://api.odsay.com/v1/api/subway/sdk.js?apiKey={YOUR_API_KEY}&callback=initSubway"></script>
                        
3. 노선도 초기화 SDK 로드 완료 후 Subway 객체를 생성하여 노선도를 초기화합니다.
초기 옵션을 통해 언어 및 도시 코드를 설정할 수 있습니다.
노선도를 생성할 때는 HTML 요소의 id 또는 DOM 요소를 직접 전달할 수 있습니다.

function initSubway() {
    // 노선도를 삽입할 HTML 요소 (id 또는 DOM 요소 모두 가능)
    var mapDiv = document.getElementById('map');

    var map = new odsay.maps.Subway(mapDiv, {
        lang: 1,
        CID: 1000
    });
}
                        

• API 명세(API Reference)

구분 메서드 설명
Map 상태
(Map State)
getCID() 노선도의 도시 코드를 반환합니다.

Returns
Number : 도시 코드
getLang() 노선도의 언어 코드를 반환합니다.

Returns
Number : 언어 코드
Map 제어
(Map Control)
setCID(CID) 노선도의 도시 코드를 설정합니다.

호출 예시
map.setCID(7000); // 부산으로 설정
                        
Parameters
CID (Number) : 도시 코드 (1000: 수도권, 7000: 부산, 4000: 대구, 5000: 광주, 3000: 대전) (필수)
setLang(lang) 노선도의 언어 코드를 설정합니다.

호출 예시
map.setLang(1); // 영문으로 설정
                        
Parameters
lang (Number) : 언어 코드 (0: 국문, 1: 영문, 2: 일문, 3: 중문간체, 4: 중문번체) (필수)
zoomIn() 노선도를 확대합니다.
zoomOut() 노선도를 축소합니다.
setLevel(level) 노선도의 확대 레벨을 설정합니다.

Parameters
level (Number) : 노선도 레벨 (1~4, 숫자가 클수록 확대) (필수)
setCenter(stationID, option) 노선도의 중심을 설정합니다.
지정된 지하철역으로 이동하며 옵션으로 확대 여부를 제어할 수 있습니다.

호출 예시
map.setCenter(222, { zoomIn: true }); // 강남역(222)으로 이동 후 확대
                        
Parameters
stationID (Number) : 지하철역 ID (필수)
option (Object) : 추가 옵션 (선택)
└ zoomIn (Boolean) : 확대 여부 (true: 확대)
setBounds(stationIDs) 지정된 지하철역 ID 배열을 기준으로 노선도의 범위와 확대 레벨을 자동 조정합니다.

호출 예시
map.setBounds([
    11721, 11720, 11719, 11718, 11717,
    11716, 11715, 11714, 11713, 11712, 11711
]);
                        
Parameters
stationIDs (Array<Number>) : 지하철역 ID 목록 (필수)
resize() 노선도의 크기와 중심 좌표를 컨테이너 영역에 맞게 재조정합니다.
브라우저 또는 컨테이너 크기 변경 시 자동으로 반영되며, 필요 시 수동으로 호출할 수 있습니다.
마커
(Marker)
addMarker(markerType, stationID, option) 노선도에 마커를 추가합니다.
지정된 지하철역 위치로 중심이 자동 이동합니다.

호출 예시
// 강남역(222)을 출발역으로 지정
map.addMarker('s', 222, {
    icon: {
        url: '../images/icon-start.svg',
        size: {
            width: 32,
            height: 42
        },
        anchor: {
            x: 16,
            y: 42
        }
    }
});
                        
Parameters
markerType (String) : 마커 타입 (s: 출발, e: 도착, m: 경유) (필수)
stationID (Number) : 지하철역 ID (필수)
option (Object) : 추가 옵션 (선택)
└ icon (Object) : 마커 아이콘 (미지정 시 기본 아이콘 적용)
└ url (String) : 아이콘 이미지 URL
└ size (Object) :
아이콘 크기
- width (Number) : 너비
- height (Number) : 높이
└ anchor (Object) :
기준 위치(px)
- x (Number) : 기준점 X 좌표
- y (Number) : 기준점 Y 좌표
- ※ x, y 모두 지정된 경우에만 적용됩니다

Notes
마커 및 컨텍스트 메뉴 표시하기 가이드
getMarkerInfo(markerType) 마커의 정보를 반환합니다.

호출 예시
map.getMarkerInfo('s'); // 출발 마커 정보 조회
                        
Parameters
markerType (String) : 마커 타입 (s: 출발, e: 도착, m: 경유) (필수)

Returns
Object | null

Object (마커 정보)
└ stationID (Number) : 지하철역 ID
└ stationName (String) : 지하철역 이름

null : 마커 정보가 존재하지 않는 경우
removeMarker(markerType) 마커를 삭제합니다.
성공, 실패(미존재) 여부를 반환합니다.

Parameters
markerType (String) : 마커 타입 (s: 출발, e: 도착, m: 경유) (필수)

Returns
Boolean : 성공, 실패(미존재) 여부
removeMarkerAll() 노선도 위 모든 마커를 삭제합니다.
hideMarker(markerType) 마커를 숨깁니다.

Parameters
markerType (String) : 마커 타입 (s: 출발, e: 도착, m: 경유) (필수)
showMarker(markerType) 숨긴 마커를 다시 표시합니다.

Parameters
markerType (String) : 마커 타입 (s: 출발, e: 도착, m: 경유) (필수)

(Station)
searchStation(stationName) 이름으로 지하철역을 검색합니다.

호출 예시
const result = await map.searchStation('인천');
                        
Parameters
stationName (String) : 지하철역 이름 (필수)

Returns
Promise<StationSearchResponse>
※ 모든 결과는 성공/실패 모두 Promise resolve로 반환됩니다.

대중교통 정류장 검색 출력 데이터 참조
getStationInfo(stationID) 지하철역 세부 정보를 반환합니다.

호출 예시
const result = await map.getStationInfo(222); // 강남역(222) 세부 정보 조회
                        
Parameters
stationID (Number) : 지하철역 ID (필수)

Returns
Promise<StationInfoResponse>
※ 모든 결과는 성공/실패 모두 Promise resolve로 반환됩니다.

지하철역 세부 정보 조회 출력 데이터 참조
getStationTransitInfo(stationID) 지하철역 환승 정보를 반환합니다.

호출 예시
const result = await map.getStationTransitInfo(222); // 강남역(222) 환승 정보 조회
                        
Parameters
stationID (Number) : 지하철역 ID (필수)

Returns
Promise<TransitInfoResponse>
※ 모든 결과는 성공/실패 모두 Promise resolve로 반환됩니다.

지하철역 환승 정보 조회 출력 데이터 참조
노선
(Line)
lineHighlight(subPath) 노선도에 지정된 구간 정보(subPath)를 기준으로 경로를 표시합니다.
성공, 실패 여부를 반환합니다.

호출 예시
// 수도권 의정부역 → 강남역 경로 조회
const result = await map.searchSubwayPath(111, 222).result;

// 결과 중 첫 번째 경로를 노선도에 표시
map.lineHighlight(result.path[0].subPath);
                        
Parameters
subPath (Array<Object>) : 경로 검색 결과에서 반환된 구간 정보 (필수)

Returns
Boolean : 성공, 실패 여부
lineHighlightByType(type) 노선도에 지정된 노선(예: 1호선)의 전체 경로를 표시합니다.
성공, 실패 여부를 반환합니다.

호출 예시
map.lineHighlightByType(1); // 수도권 1호선 표시
                        
Parameters
type (Number) : 노선 타입 (필수)
※ 코드 정의 지하철 노선 타입 참조

Returns
Boolean : 성공, 실패 여부
removeLine() 표시된 노선 경로를 제거합니다.
성공, 실패(미존재) 여부를 반환합니다.

Returns
Boolean : 성공, 실패(미존재) 여부
isLineShow() 노선 표시 여부를 확인합니다.
존재, 미존재 여부를 반환합니다.

Returns
Boolean : 존재, 미존재 여부
경로
(Path)
searchSubwayPath(sid, eid, option) 지하철 경로 검색 결과를 반환합니다.
출·도착역이 모두 지정된 경우 자동으로 수행되며, 수동 호출도 가능합니다.
동일한 출·도착역 기준에서 탐색 조건만 변경하는 경우 setSubwayPathSearchOption 함수를 사용합니다.

호출 예시
// 수도권 의정부역 → 강남역 경로 조회
const result = await map.searchSubwayPath(111, 222);
                        
Parameters
sid (Number) : 출발 지하철역 ID (필수)
eid (Number) : 도착 지하철역 ID (필수)
option (Object) : 추가 옵션 (선택)
└ mid (Number) : 경유 지하철역 ID
└ mode (Number) :
탐색 모드 옵션
- 1: 출발시간 기준
- 2: 도착시간 기준
- 3: 첫차 기준
- 4: 막차 기준
- default = 1
└ day (Number) :
요일 옵션
- 1: 평일
- 2: 토요일
- 3: 공휴일/일요일
- default = 1
└ time (String) :
탐색 기준 시간 (HHmm)
- default = 현재 시간

Returns
Promise<SubwayPathResponse>
※ 모든 결과는 성공/실패 모두 Promise resolve로 반환됩니다.

시간표 기반 지하철 경로검색 조회 출력 데이터 참조
setSubwayPathSearchOption(mode, day, time) 탐색 조건을 설정하고 해당 조건으로 지하철 경로를 재검색합니다.
출·도착역이 이미 설정된 상태에서만 사용할 수 있으며, searchSubwayPath 호출 이후 탐색 조건 변경 시 사용됩니다.

호출 예시
// 현재 출발/도착역 기준으로 출발 시간을 평일 12:40으로 설정 후 경로 조회
const result = await map.setSubwayPathSearchOption(1, 1, '1240');
                        
Parameters
mode (Number) : 탐색 모드 (필수)
- 1: 출발시간 기준
- 2: 도착시간 기준
- 3: 첫차 기준
- 4: 막차 기준
day (Number) : 요일 (필수)
- 1: 평일
- 2: 토요일
- 3: 공휴일/일요일
time (String) : 탐색 기준 시간 (HHmm) (필수)

Returns
Promise<SubwayPathResponse>
※ 모든 결과는 성공/실패 모두 Promise resolve로 반환됩니다.

시간표 기반 지하철 경로검색 조회 출력 데이터 참조
컨텍스트 메뉴
(Context Menu)
addContextMenu(stationID, option) 지정한 역에 컨텍스트 메뉴를 표시합니다.

호출 예시
// 강남역(222)에 커스텀 컨텍스트 메뉴 표시
map.addContextMenu(222, {
    content: '<div>커스텀 메뉴 HTML</div>',
    pixelOffset: { x: 0, y: -12 }
});
                        
Parameters
stationID (Number) : 지하철역 ID (필수)
option (Object) : 추가 옵션 (선택)
└ content (String | HTMLElement) :
컨텍스트 메뉴 콘텐츠 (미지정 시 기본 메뉴 적용)
└ pixelOffset (Object) :
위치 보정(px)
- x (Number) : x 방향 오프셋
- y (Number) : y 방향 오프셋
- ※ x, y 모두 지정된 경우에만 적용됩니다

Notes
마커 및 컨텍스트 메뉴 표시하기 가이드
removeContextMenu() 컨텍스트 메뉴를 삭제합니다.
성공, 실패(미존재) 여부를 반환합니다.

Returns
Boolean : 성공, 실패(미존재) 여부
이벤트
(Event)
addEvent(type, handler) 노선도에서 발생하는 특정 이벤트(type)를 감지하여 처리할 핸들러를 등록합니다.

Parameters
type (String) : 이벤트 이름 (필수)
handler (Function) : 이벤트 처리 함수 (필수)
※ 하단 이벤트 타입(Event Type) 참조

• 이벤트 타입(Event Type)

Type Callback Arguments 설명
ready result (Object) 노선도의 지역 또는 언어가 변경된 경우 발생

Arguments
└ CID (Number) : 도시 코드
└ lang (Number) : 언어 코드
start_changed result (Object) 출발역이 지정(마커 추가)된 경우 발생

Arguments
└ CID (Number) : 도시 코드
└ stationID (Number) : 지하철역 ID
└ stationName (String) : 지하철역 이름
└ stationCoord (Array<Number>) : 지하철역 좌표 [x, y]
└ exOBJ (Object) : 환승역 정보 (환승역이 존재하는 경우에만 포함)
└ station (Array<Object>) : 환승역 목록
- stationID (Number) : 지하철역 ID
- stationName (String) : 지하철역 이름
- type (Number) : 노선 타입
- laneName (String) : 노선명
- laneCity (String) : 노선 지역명
end_changed result (Object) 도착역이 지정(마커 추가)된 경우 발생

Arguments
└ CID (Number) : 도시 코드
└ stationID (Number) : 지하철역 ID
└ stationName (String) : 지하철역 이름
└ stationCoord (Array<Number>) : 지하철역 좌표 [x, y]
└ exOBJ (Object) : 환승역 정보 (환승역이 존재하는 경우에만 포함)
└ station (Array<Object>) : 환승역 목록
- stationID (Number) : 지하철역 ID
- stationName (String) : 지하철역 이름
- type (Number) : 노선 타입
- laneName (String) : 노선명
- laneCity (String) : 노선 지역명
middle_changed result (Object) 경유역이 지정(마커 추가)된 경우 발생

Arguments
└ CID (Number) : 도시 코드
└ stationID (Number) : 지하철역 ID
└ stationName (String) : 지하철역 이름
└ stationCoord (Array<Number>) : 지하철역 좌표 [x, y]
└ exOBJ (Object) : 환승역 정보 (환승역이 존재하는 경우에만 포함)
└ station (Array<Object>) : 환승역 목록
- stationID (Number) : 지하철역 ID
- stationName (String) : 지하철역 이름
- type (Number) : 노선 타입
- laneName (String) : 노선명
- laneCity (String) : 노선 지역명
detail_clicked result (Object) 기본 컨텍스트 메뉴에서 상세 버튼을 클릭한 경우 발생
※ 커스텀 컨텍스트 메뉴에서는 발생하지 않음

Arguments
result (Object) : 지하철역 세부 정보와 환승 정보가 병합된 결과
※ 기본 정보 구조 : 지하철역 세부 정보 조회 출력 데이터 참조
※ 환승 정보 구조 : 지하철역 환승 정보 조회 출력 데이터 참조

└ transitInfo 필드로 환승 정보가 포함됩니다.
path_changed result (Object) 출발역과 도착역이 모두 지정되어 경로 검색이 가능한 상태가 되면 발생
이벤트 발생 시 경로 검색이 자동으로 수행되며 결과가 반환됩니다.
검색 결과 중 첫 번째 경로가 노선도에 기본 표시됩니다.

Arguments
시간표 기반 지하철 경로검색 조회 출력 데이터 참조
path_init coord (Array<Number>) 경로 하이라이팅 상태(lineHighlight 실행 상태)에서 노선도를 클릭한 경우 발생
해당 이벤트 발생 시 화면에 표시된 모든 마커와 경로 라인이 초기화됩니다.

Arguments
└ coord (Array<Number>) : 클릭한 좌표 [x, y]
line_init coord (Array<Number>) 노선 하이라이팅 상태(lineHighlightByType 실행 상태)에서 노선도를 클릭한 경우 발생
해당 이벤트 발생 시 화면에 표시된 경로 라인만 초기화되며, 마커는 유지됩니다.

Arguments
└ coord (Array<Number>) : 클릭한 좌표 [x, y]
click result (Object) 노선도를 클릭한 경우 발생
클릭 대상이 지하철역일 경우 해당 역 정보가 포함됩니다.

Arguments
└ type (Number) : 구분 코드 (0: 정보없음, 1: 지하철역)
└ mouseCoord (Array<Number>) : 클릭 좌표 [x, y]
└ preventContextMenu (Function) : 기본 컨텍스트 메뉴를 차단하는 함수
※ 지하철역 클릭 시 기본 컨텍스트 메뉴가 자동 표시됨
※ 해당 함수를 호출하면 기본 메뉴가 차단되고 사용자 정의 메뉴를 표시할 수 있음
└ stationID (Number) : 지하철역 ID (지하철역 클릭 시에만 포함)
└ stationCoord (Array<Number>) : 지하철역 좌표 [x, y] (지하철역 클릭 시에만 포함)

코드정의(Code Definition)

코드 정의표 입니다.

• 지하철 빠른 환승정리(Fast Subway Transfer Arrangement)

type 종류
0-0 모든 객차 모든 문
-1 - -1 정산 후 승차(공항철도)
-2 - -2 데이터 수집 중

• 도시간경로 시외교통정보 타입(Intercity Traffic Information Type)

type 종류
3 기차
4 고속버스
5 항공
6 시외버스

• 열차 타입(Train Type)

type 종류
1 KTX
2 새마을
3 무궁화
4 누리로
5 통근
6 ITX
7 ITX-청춘
8 SRT

• 고속/시외버스 타입(Express/Intercity Bus Type)

type 종류
1 일반
2 우등
3 프리미엄
4 심야 일반
5 심야 우등
6 심야 프리미엄
7 주말 프리미엄
8 주말심야 프리미엄

• 버스노선 타입(Bus Route Type)

type 노선명 type 노선명
1 일반 13 순환
2 좌석 14 광역
3 마을버스 15 급행
4 직행좌석 16 관광버스
5 공항버스 20 농어촌버스
6 간선급행 22 경기도 시외형버스
10 외곽 26 급행간선
11 간선 30 한강버스
12 지선

• 버스 혼잡도(Bus Congestion Type)

type 종류
-1 데이터 없음
1 여유
2 보통
3 혼잡
4 매우 혼잡

• 지하철 노선 타입(Subway Line Type)

type 노선명 type 노선명
1 수도권 1호선 114 서해선
2 수도권 2호선 115 김포골드라인
3 수도권 3호선 116 수인분당선
4 수도권 4호선 117 신림선
5 수도권 5호선 21 인천 1호선
6 수도권 6호선 22 인천 2호선
7 수도권 7호선 31 대전 1호선
8 수도권 8호선 41 대구 1호선
9 수도권 9호선 42 대구 2호선
91 GTX-A 43 대구 3호선
101 공항철도 48 대경선
102 자기부상철도 51 광주 1호선
104 경의중앙선 71 부산 1호선
107 에버라인 72 부산 2호선
108 경춘선 73 부산 3호선
109 신분당선 74 부산 4호선
110 의정부경전철 78 동해선
112 경강선 79 부산-김해경전철
113 우이신설선

• 도시코드(CID)(City Code)

CityCode 도시명 CityCode 도시명 CityCode 도시명
1000 서울 1010 성남 1020 고양
1030 안양 1040 안산 1050 부천
1060 과천 1070 하남 1080 구리
1090 의정부 1100 수원 1110 광주
1120 남양주 1130 용인 1140 시흥
1150 파주 1160 광명 1170 김포
1180 가평군 1190 양평군 1200 연천군
1210 오산 1220 평택 1230 화성
1240 동두천 1250 양주 1260 포천
1270 안성 1280 군포 1290 의왕
1300 이천 1310 여주 2000 인천
3000 대전 3010 계룡 3020 공주
3030 논산 3040 보령 3050 서산
3060 아산 3070 천안 3080 금산군
3090 당진군 3100 부여군 3110 서천군
3120 연기군 3130 예산군 3140 청양군
3150 태안군 3160 홍성군 3300 세종시
4000 대구 4010 경산 4020 경주
4030 구미 4040 김천 4050 문경
4060 상주 4070 안동 4080 영주
4090 영천 4100 포항 4110 고령군
4120 군위군 4130 봉화군 4140 성주군
4150 영덕군 4160 영양군 4170 예천군
4180 울릉군 4190 울진군 4200 의성군
4210 청도군 4220 청송군 4230 칠곡군
5000 광주 5010 광양 5020 나주
5030 목포 5040 순천 5050 여수
5060 강진군 5070 고흥군 5080 곡성군
5090 구례군 5100 담양군 5110 무안군
5120 보성군 5130 신안군 5140 영광군
5150 영암군 5160 완도군 5170 장성군
5180 장흥군 5190 진도군 5200 함평군
5210 해남군 5220 화순군 6000 울산
7000 부산 7010 거제 7020 김해
7030 마산 7040 밀양 7050 사천
7060 양산 7070 진주 7080 진해
7090 창원 7100 통영 7110 거창군
7120 고성군 7130 남해군 7140 산청군
7150 의령군 7160 창녕군 7170 하동군
7180 함안군 7190 함양군 7200 합천군
8000 제주 8010 서귀포 8020 남제주군
8030 북제주군 9000 전주 9010 군산
9020 김제 9030 남원 9040 익산
9050 정읍 9060 고창군 9070 무주군
9080 무안군 9090 순창군 9100 완주군
9110 임실군 9120 장수군 9130 진안군
10000 속초 10010 원주 10020 강릉
10030 동해 10040 태백 10050 삼척
10060 평창군 10070 홍천군 10080 횡성군
10090 영월군 10100 정선군 10110 철원군
10120 화천군 10130 양구군 10140 인제군
10150 고성군 10160 양양군 10170 춘천
11000 청주 11010 충주 11020 제천
11030 보은군 11040 옥천군 11050 영동군
11060 진천군 11070 괴산군 11080 음성군
11090 단양군 11100 증평군 11110 청원군

• BIS 코드(busProvider)(Bus Information System Provider Code)

ProviderCode 제공지역 ProviderCode 제공지역 ProviderCode 제공지역
2 경기도 3 대전 4 서울
5 군산 6 인천 7 울산
8 광주 9 경기마을버스 10 서울마을버스
11 부산 12 창원 13 대구
14 경산 15 제주도 16 세종
17 청주 18 포항 19 거제
20 아산 21 천안 22 춘천
23 강릉 25 원주 26 양산
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 부여군
70 충주