버스노선 조회(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-3 | lane | 확장 노드 | Y | 1...n | 버스노선 정보 리스트 |
| 1-3-1 | busNo | string | Y | 1 | 버스번호 |
| 1-3-2 | busID | int | Y | 1 | 버스노선ID |
| 1-3-3 | localBusID | string | Y | 1 |
각 지역버스노선 ID 수도권 : busCityCode가 1000 인 경우 서울, 그 외에는 경기 실시간 사용 울산시 : 노선하나에 상행노선ID, 하행노선ID 모두제공 Ex) 상행ID/하행ID 형태. |
| 1-3-4 | type | int | Y | 1 | 버스노선 종류 문서하단 버스노선타입 참조 |
| 1-3-5 | busCityName | string | Y | 1 | 운수회사 승인 도시이름 |
| 1-3-6 | busCityCode | int | Y | 1 | 운수회사 승인 도시코드 |
| 1-3-7 | busStartPoint | string | Y | 1 | 버스노선 기점 |
| 1-3-8 | busEndPoint | string | Y | 1 | 버스노선 종점 |
| 1-3-9 | busFirstTime | string | Y | 1 | 첫차시간 |
| 1-3-10 | busLastTime | string | Y | 1 | 막차시간 |
| 1-3-11 | busInterval | string | Y | 1 | 운행간격(분) or 운행횟수(#1) |
| 1-3-12 | mainBusStop | string | N | 1 | 주요 버스정류장 |
| 1-3-13 | bus_Ep_FirstTime | string | Y | 1 | 종점기준 첫차 |
| 1-3-14 | bus_Ep_LastTime | string | Y | 1 | 종점기준 막차 |
| 1-3-15 | bus_Interval_Week | string | Y | 1 | 평일 배차간격 |
| 1-3-16 | bus_Interval_Sat | string | Y | 1 | 토요일 배차간격 |
| 1-3-17 | bus_Interval_Sun | string | Y | 1 | 일요일(공휴일) 배차간격 |
| 1-3-18 | busCompanyNameKor | string | Y | 1 | 운수회사명 |
| 1-3-19 | busCompanyID | string | Y | 1 | 운수회사ID |
• 에러 코드(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 | type | int | Y | 1 | 버스노선 종류 문서하단 버스노선타입 참조. |
| 1-4 | busCityName | string | Y | 1 | 운수회사 승인 도시이름 |
| 1-5 | busCityCode | int | Y | 1 | 운수회사 승인 도시코드 |
| 1-6 | busStartPoint | string | Y | 1 | 버스노선 기점 |
| 1-7 | busEndPoint | string | Y | 1 | 버스노선 종점 |
| 1-8 | busFirstTime | string | Y | 1 | 첫차시간 |
| 1-9 | busLastTime | string | Y | 1 | 막차시간 |
| 1-10 | busInterval | string | Y | 1 | 운행간격(분) or 운행횟수(#1) |
| 1-11 | busTotalDistance | int | Y | 1 | 버스노선 전체 운행거리 |
| 1-12 | bus_Ep_FirstTime | string | Y | 1 | 종점기준 첫차 |
| 1-13 | bus_Ep_LastTime | string | Y | 1 | 종점기준 막차 |
| 1-14 | bus_Interval_Week | string | Y | 1 | 평일 배차간격 |
| 1-15 | bus_Interval_Sat | string | Y | 1 | 토요일 배차간격 |
| 1-16 | bus_Interval_Sun | string | Y | 1 | 일요일(공휴일) 배차간격 |
| 1-17 | bus_Interval_Rushhour | string | Y | 1 | 출퇴근시간 배차간격 |
| 1-18 | busLocalBlID | string | Y | 1 | 각 지역 버스노선 ID |
| 1-19 | station | 확장노드 | Y | 1...n | 정류장 리스트 |
| 1-19-1 | idx | int | Y | 1 | 정류장순번 |
| 1-19-2 | stationID | int | Y | 1 | 정류장 ID |
| 1-19-3 | stationName | string | Y | 1 | 정류장 이름 |
| 1-19-4 | stationDistance | long | Y | 1 | 정류장간 누적거리 (현재정류장에서 다음정류장까지) |
| 1-19-5 | stationDirection | int | Y | 1 | 상하행 구분코드 (0:없음,1:하행,2:상행) |
| 1-19-6 | arsID | string | Y | 1 | 정류장 고유번호 (0:없음) |
| 1-19-7 | x | double | Y | 1 | 정류장 x좌표(경위도) |
| 1-19-8 | y | double | Y | 1 | 정류장 y좌표(경위도) |
| 1-19-9 | localStationID | string | Y | 1 | 정류장 LocalID |
| 1-19-10 | stationCityCode | int | Y | 1 | 정류장 도시코드 |
| 1-19-11 | nonstopStation | int | Y | 1 | 미정차정류장 (0:정차, 1:미정차) |
| 1-19-12 | busOnlyCentralLane | int | Y | 1 | 버스전용 중앙차로 정류장 해당 여부 (0: 비해당, 1: 해당) |
• 에러 코드(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 | double | Y | 1 | 정류장 이름 |
| 1-2 | stationID | int | Y | 1 | 정류장 ID |
| 1-3 | x | double | Y | 1 | 정류장 x좌표(경위도) |
| 1-4 | y | double | Y | 1 | 정류장 y좌표(경위도) |
| 1-5 | lane | 확장노드 | Y | 1...n | 정류장의 버스 노선 리스트 |
| 1-5-1 | busNo | string | Y | 1 | 버스노선 번호 |
| 1-5-2 | type | int | Y | 1 | 버스노선 종류 (문서하단 버스노선타입 참조) |
| 1-5-3 | busID | int | Y | 1 | 버스노선 ID |
| 1-5-4 | busStartPoint | string | Y | 1 | 버스노선 기점 |
| 1-5-5 | busEndPoint | string | Y | 1 | 버스노선 종점 |
| 1-5-6 | busFirstTime | string | Y | 1 | 첫차시간 |
| 1-5-7 | busLastTime | string | Y | 1 | 막차시간 |
| 1-5-8 | busInterval | string | Y | 1 | 운행간격(분) or 운행횟수(#1) |
| 1-5-9 | busCityCode | int | Y | 1 | 운수회사 승인 도시코드 |
| 1-5-10 | busCityName | string | Y | 1 | 운수회사 승인 도시이름 |
| 1-5-11 | busLocalBlID | string | Y | 1 | 각 지역 버스노선 ID |
| 1-5-12 | busStationIdx | int | Y | 1 | 정류장 순번 |
| 1-5-13 | busDirectionName | string | Y | 1 | 방향/방면 명 |
| 1-5-14 | busDirectionStationID | int | Y | 1 | 방향/방면 정류장 ID |
| 1-5-15 | busDirectionType | int | Y | 1 | 방향/방면 구분 (1:방향, 2:방면) |
| 1-6 | localStationID | string | Y | 1 | 각 지역 버스정류장 ID |
| 1-7 | stationCityCode | int | Y | 1 | 정류장의 도시코드 |
| 1-8 | arsID | string | Y | 1 | 정류장 고유번호 |
| 1-9 | do | string | Y | 1 | 정류장주소 도 |
| 1-10 | gu | string | Y | 1 | 정류장주소 구 |
| 1-11 | dong | string | Y | 1 | 정류장주소 동 |
| 1-12 | busOnlyCentralLane | int | Y | 1 | 버스전용 중앙차로 정류장 해당 여부 (0: 비해당, 1: 해당) |
• 에러 코드(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 | endStationID | int | Y | 1 | 도착역ID |
| 1-5 | endStationName | string | Y | 1 | 도착역명 |
| 1-6 | station | 확장노드 | Y | 1...n | 상위노드 |
| 1-6-1 | railName | string | Y | 1 | 노선명(경부선, 호남선 등) |
| 1-6-2 | trainClass | string | Y | 1 | 열차종류(KTX, 무궁화, 새마을, 누리로, 통근, ITX, ITX-청춘, SRT) |
| 1-6-3 | trainNo | int | Y | 1 | 열차번호 |
| 1-6-4 | departureTime | string | Y | 1 | 출발시간 |
| 1-6-5 | arrivalTime | string | Y | 1 | 도착시간 |
| 1-6-6 | wasteTime | string | Y | 1 | 소요시간 |
| 1-6-7 | runDay | string | Y | 1 |
운행일 ex) 토 / 금토일 / 토일 / 화수목금토일 / 월화수목토일/ 금 / 금토 / 금일 / 월 / 매일/ 월화수목금토 |
| 1-6-8 | generalFare | 확장노드 | Y | 1 | 일반 요금 |
| 1-6-8-1 | weekday | string | N | 1 | 평일 |
| 1-6-8-2 | weekend | string | N | 1 | 주말 |
| 1-6-8-3 | holiday | string | N | 1 | 공휴일 |
| 1-6-9 | specialFare | 확장노드 | Y | 1 | 특실 요금 |
| 1-6-9-1 | weekday | string | N | 1 | 평일 |
| 1-6-9-2 | weekend | string | N | 1 | 주말 |
| 1-6-9-3 | holiday | string | N | 1 | 공휴일 |
| 1-6-10 | standingFare | 확장노드 | Y | 1 | 입석/자유석 요금 |
| 1-6-10-1 | weekday | string | N | 1 | 평일 |
| 1-6-10-2 | weekend | string | N | 1 | 주말 |
| 1-6-10-3 | holiday | string | N | 1 | 공휴일 |
| 1-6-11 | fare | 확장노드 | Y | 1 | 요금(평일 운행편인 경우 제공) |
| 1-6-11-1 | general | string | N | 1 | 일반요금 |
| 1-6-11-2 | special | string | N | 1 | 특실요금 |
| 1-6-11-3 | standing | string | N | 1 | 입석/자유석 요금 |
• 에러 코드(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 | destTerminal | string | Y | 1 | 도착 터미널명 |
| 1-4-3 | wasteTime | string | Y | 1 | 소요시간 |
| 1-4-4 | normalFare | string | Y | 1 | 일반버스 요금 |
| 1-4-5 | specialFare | string | Y | 1 | 우등버스 요금 |
| 1-4-6 | nightFare | string | Y | 1 | 심야버스 요금 |
| 1-4-7 | nightSpecialFare | string | Y | 1 | 심야 우등버스 요금 |
| 1-4-8 | schedule | string | Y | 1 | 운행시간표 |
| 1-4-9 | nightSchedule | string | Y | 1 | 심야 운행시간표 |
• 에러 코드(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 | destTerminal | string | Y | 1 | 도착 터미널명 |
| 1-4-3 | firstTime | string | Y | 1 | 첫차시간 |
| 1-4-4 | lastTime | string | Y | 1 | 막차시간 |
| 1-4-5 | interval | string | Y | 1 | 운행횟수/운행간격(두값중 하나만 존재) ex) 10/0:00 : 일 10회 운행 0/1:30 : 1:30분 간격 |
| 1-4-6 | wasteTime | string | Y | 1 | 소요시간 |
| 1-4-7 | normalFare | string | Y | 1 | 일반버스 요금 |
| 1-4-8 | nightFare | string | Y | 1 | 심야버스 요금 |
| 1-4-9 | schedule | string | Y | 1 | 운행시간표 |
| 1-4-10 | nightSchedule | string | Y | 1 | 심야 운행시간표 |
• 에러 코드(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 | endStationID | int | Y | 1 | 도착역ID |
| 1-6 | endStationName | string | Y | 1 | 도착 터미널명 |
| 1-7 | firstTime | string | Y | 1 | 첫차시간 |
| 1-8 | lastTime | string | Y | 1 | 막차시간 |
| 1-9 | schedule | 확장노드 | Y | 1...n | 운행정보 확장노드 |
| 1-9-1 | busClass | int | Y | 1 | 버스타입 1:일반 2:우등 3:프리미엄 4:심야 일반 5:심야 우등 6:심야 프리미엄 7:주말 프리미엄 8:주말심야 프리미엄 |
| 1-9-2 | departureTime | string | Y | 1 | 출발시간 |
| 1-9-3 | wasteTime | int | Y | 1 | 소요시간 |
| 1-9-4 | fare | int | Y | 1 | 요금 |
• 에러 코드(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 | endStationID | int | Y | 1 | 도착 공항 ID |
| 1-5 | endStationName | string | Y | 1 | 도착 공항명 |
| 1-6 | station | 확장 노드 | Y | 1...n | 상위노드 |
| 1-6-1 | airline | string | Y | 1 | 항공사 |
| 1-6-2 | departureTime | string | Y | 1 | 출발시각 |
| 1-6-3 | arrivalTime | string | Y | 1 | 도착시각 |
| 1-6-4 | flight | string | Y | 1 | 편명 |
| 1-6-5 | runDay | string | Y | 1 | 운항일 |
• 에러 코드(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 | busID | int | Y | 1 | 버스노선 ID |
| 1-1-3 | localBusID | string | Y | 1 | 각 지역버스노선 ID (수도권 : busCityCode : 1000 -> 서울 그 외에는 경기 실시간 사용) |
| 1-1-4 | type | int | Y | 1 | 버스노선 종류 문서하단 버스노선타입 참조 |
| 1-1-5 | busCityName | string | Y | 1 | 운수회사 승인 도시이름 |
| 1-1-6 | busCityCode | int | Y | 1 | 운수회사 승인 도시코드 |
| 1-1-7 | busStartPoint | string | Y | 1 | 버스노선 기점 |
| 1-1-8 | busEndPoint | string | Y | 1 | 버스노선 종점 |
| 1-1-9 | busFirstTime | string | Y | 1 | 첫차시간 |
| 1-1-10 | busLastTime | string | Y | 1 | 막차시간 |
| 1-1-11 | busInterval | string | Y | 1 | 운행간격(분) or 운행횟수(#1) |
• 에러 코드(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 | stationID | int | Y | 1 | 지하철역 ID |
| 1-3 | type | int | Y | 1 | 노선종류 문서하단 지하철노선타입 참조 |
| 1-4 | laneName | string | Y | 1 | 노선명 |
| 1-5 | laneCity | string | Y | 1 | 노선지역명 |
| 1-6 | x | double | Y | 1 | x좌표(경위도) |
| 1-7 | y | double | Y | 1 | y좌표(경위도) |
| 1-8 | exOBJ | 확장노드 | N | 0...1 | 환승역 리스트 |
| 1-8-1 | station | 확장노드 | N | 0...n | 환승역 |
| 1-8-1-1 | stationName | string | N | 1 | 환승역 명 |
| 1-8-1-2 | stationID | int | N | 1 | 환승역ID |
| 1-8-1-3 | type | int | N | 1 | 노선종류 * 지하철노선 |
| 1-8-1-4 | laneName | string | N | 1 | 노선명 |
| 1-8-1-5 | laneCity | string | N | 1 | 노선지역명 |
| 1-9 | prevOBJ | 확장 노드 | N | 0...1 | 이전역 리스트 |
| 1-9-1 | station | 확장 노드 | N | 1...n | 이전역 |
| 1-9-1-1 | stationName | string | N | 1 | 역 명 |
| 1-9-1-2 | stationID | int | N | 1 | 역 ID |
| 1-9-1-3 | type | int | Y | 1 | 노선종류 * 지하철노선 |
| 1-9-1-4 | laneName | string | N | 1 | 노선명 |
| 1-9-1-5 | laneCity | string | N | 1 | 노선지역명 |
| 1-9-1-6 | x | double | N | 1 | x좌표(경위도) |
| 1-9-1-7 | y | double | N | 1 | y좌표(경위도) |
| 1-10 | nextOBJ | 확장 노드 | N | 0...1 | 다음역 리스트 |
| 1-10-1 | station | 확장 노드 | N | 0…n | 다음역 |
| 1-10-1-1 | stationName | string | N | 1 | 역 명 |
| 1-10-1-2 | stationID | int | N | 1 | 역ID |
| 1-10-1-3 | type | int | N | 1 | 노선종류 * 지하철노선 |
| 1-10-1-4 | laneName | string | N | 1 | 노선명 |
| 1-10-1-5 | laneCity | string | N | 1 | 노선지역명 |
| 1-10-1-6 | x | double | N | 1 | x좌표(경위도) |
| 1-10-1-7 | y | double | N | 1 | y좌표(경위도) |
| 1-11 | defaultInfo | 확장 노드 | Y | 1 | 기본 역 정보 |
| 1-11-1 | address | string | Y | 1 | 역 주소 |
| 1-11-2 | new_address | string | N | 1 | 도로명 주소 |
| 1-11-3 | tel | string | Y | 1 | 역 전화번호 |
| 1-12 | useInfo | 확장 노드 | Y | 1 | 이용정보 |
| 1-12-1 | platform | int | Y | 1 | 플랫폼 (0:기타, 1:중앙, 2:양쪽, 3:복선(국 철), 4:일방향) |
| 1-12-2 | meetingPlace | int | Y | 1 | 만남의 장소 (0:없음, 1:있음) |
| 1-12-3 | restroom | int | Y | 1 | 화장실 (0:없음, 1:안쪽, 2:바깥, 3:환승역연 결, 4:안쪽,바깥쪽) |
| 1-12-4 | offDoor | int | Y | 1 | 내리는 문 위치 (0:왼쪽, 1:오른쪽, 2:양쪽) |
| 1-12-5 | crossOver | int | Y | 1 | 반대편 횡단 (0:기타, 1:연결안됨, 2:연결됨, 3:환승역연결) |
| 1-12-6 | publicPlace | int | Y | 1 | 현장 사무소 (0:없음, 1:있음) |
| 1-12-7 | handicapCount | int | Y | 1 | 장애인편의시설 (0:없음, 1:있음) |
| 1-12-8 | parkingCount | int | Y | 1 | 환승주차장 (0:없음, 1:있음) |
| 1-12-9 | bicycleCount | int | Y | 1 | 자전거보관소 (0:없음, 1:있음) |
| 1-12-10 | civilCount | int | Y | 1 | 민원안내 (0:없음, 1:있음) |
| 1-13 | exitInfo | 확장노드 | Y | 1 | 출구정보 |
| 1-13-1 | gate | 확장 노드 | Y | 1...n | 출구 |
| 1-13-1-1 | gateNo | string | Y | 1 | 출구번호 |
| 1-13-1-2 | gateLink | string | Y | 1...n | 주요명칭 |
| 1-13-1-3 | BUSSTOP | 확장노드 | N | 1...n | 출구별 버스정류장 정보 |
| 1-13-1-3-1 | StopName | string | Y | 1 | 버스정류장명칭 |
| 1-13-1-3-2 | StopID | string | Y | 1 | 버스정류장ID |
| 1-13-1-3-3 | Bus | 확장노드 | Y | 1...n | 버스노선정보 그룹노드 |
| 1-13-1-3-3-1 | BusNo | string | Y | 1 | 버스노선 번호 |
| 1-13-1-3-3-2 | Type | string | Y | 1 | 버스노선 타입 |
| 1-13-1-3-3-3 | BlID | string | Y | 1 | 버스노선 ID |
| 1-13-1-3-3-4 | BusCityName | string | Y | 1 | 운수회사 승인 도시 이름 |
| 1-14 | CityCode | int | Y | 1 | 도시코드 |
• 에러 코드(Error Code)
| 코드 | 메시지 |
|---|---|
| 500 | 서버 내부 오류 |
| -8 | 필수 입력값 형식 및 범위 오류 |
| -9 | 필수 입력값 누락 |
지하철역 전체 시간표 조회(Subway Station Timetable)
지하철역 전체 시간표를 리턴합니다.
| 매서드 | 요청 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 | stationID | int | Y | 1 | 지하철역 ID |
| 1-3 | type | int | Y | 1 | 노선종류 문서하단 지하철노선타입 참조 |
| 1-4 | laneName | string | Y | 1 | 노선명 |
| 1-5 | laneCity | string | Y | 1 | 노선지역명 |
| 1-6 | upWay | string | Y | 1 | 상행방향 |
| 1-7 | downWay | string | Y | 1 | 하행방향 |
| 1-8 | OrdList | 확장 노드 | Y | 1 | 평일 시간 리스트 |
| 1-8-1 | up | 확장노드 | N | 0...1 | 상행선 시간 리스트 |
| 1-8-1-1 | time | 확장 노드 | Y | 1...n | 시간별 시간 data 리스트 |
| 1-8-1-1-1 | Idx | int | Y | 1 | 시간 (5~25시 까지 , 25는 1시) |
| 1-8-1-1-2 | list | string | Y | 1 | 시간 data |
| 1-8-1-1-3 | expList | string | N | 1 | 급행시간 data |
| 1-8-1-1-4 | expSPList | string | N | 1 | 특급시간 data |
| 1-8-2 | down | 확장 노드 | N | 0...1 | 하행선 시간 리스트 |
| 1-8-2-1 | time | 확장 노드 | Y | 1 | 시간별 시간 data 리스트 |
| 1-8-2-1-1 | Idx | int | Y | 1 | 시간 (5~25시 까지 , 25는 1시) |
| 1-8-2-1-2 | list | string | Y | 1 | 시간 data |
| 1-8-2-1-3 | expList | string | N | 1 | 급행시간 data |
| 1-8-2-1-4 | expSPList | string | N | 1 | 특급시간 data |
| 1-9 | SatList | 확장 노드 | Y | 1 | 토요일 시간 리스트 |
| 1-9-1 | up | 확장 노드 | N | 0...1 | 상행선 시간 리스트 |
| 1-9-1-1 | time | 확장 노드 | Y | 1 | 시간별 시간 data 리스트 |
| 1-9-1-1-1 | Idx | int | Y | 1 | 시간 (5~25시 까지 , 25는 1시) |
| 1-9-1-1-2 | list | string | Y | 1 | 시간 data |
| 1-9-1-1-3 | expList | string | N | 1 | 급행시간 data |
| 1-9-1-1-4 | expSPList | string | N | 1 | 특급시간 data |
| 1-9-2 | down | 확장노드 | N | 0...1 | 하행선 시간 리스트 |
| 1-9-2-1 | time | 확장노드 | Y | 1 | 시간별 시간 data 리스트 |
| 1-9-2-1-1 | Idx | int | Y | 1 | 시간 (5~25시 까지 , 25는 1시) |
| 1-9-2-1-2 | list | string | Y | 1 | 시간 data |
| 1-9-2-1-3 | expList | string | N | 1 | 급행시간 data |
| 1-9-2-1-4 | expSPList | string | N | 1 | 특급시간 data |
| 1-10 | SunList | 확장노드 | Y | 1 | 일요일 시간 리스트 |
| 1-10-1 | up | 확장노드 | N | 0...1 | 상행선 시간 리스트 |
| 1-10-1-1 | time | 확장노드 | Y | 1 | 시간별 시간 data 리스트 |
| 1-10-1-1-1 | Idx | int | Y | 1 | 시간 (5~25시 까지 , 25는 1시) |
| 1-10-1-1-2 | list | string | Y | 1 | 시간 data |
| 1-10-1-1-3 | expList | string | N | 1 | 급행시간 data |
| 1-10-1-1-4 | expSPList | string | N | 1 | 특급시간 data |
| 1-10-2 | down | 확장노드 | N | 0...1 | 하행선 시간 리스트 |
| 1-10-2-1 | time | 확장노드 | Y | 1 | 시간별 시간 data 리스트 |
| 1-10-2-1-1 | Idx | int | Y | 1 | 시간 (5~25시 까지 , 25는 1시) |
| 1-10-2-1-2 | list | string | Y | 1 | 시간 data |
| 1-10-2-1-3 | expList | string | N | 1 | 급행시간 data |
| 1-10-2-1-4 | expSPList | string | N | 1 | 특급시간 data |
• 에러 코드(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 좌표 |
• 에러 코드(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-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 | stationID | int | Y | 1 | 정류장ID |
| 1-3-4 | localStationID | string | N | 1 | 각 지역버스정류장 ID - 수도권(서울,경기,인천의 경우) ARSID / 경기 지자체시스템ID /인천시 ID 구조 Ex) 89123/120000445/ICB165000355 - 경산시, 대구시의 경우 경산시 정류장ID/대구시 정류장ID 형태로 제공 됨 - 나머지 지역은 정류장 ID 단일로 제공 |
| 1-3-5 | type | int | N | 1 | 노선종류 문서하단 지하철 노선타입 참조 (stationClass 2 인 경우만) |
| 1-3-6 | laneName | string | N | 1 | 노선명 (stationClass 2 인 경우만) |
| 1-3-7 | laneCity | string | N | 1 | 노선명 (stationClass 2 인 경우만) |
| 1-3-8 | stationType | int | N | 1 | 시외버스정류장 종류 (1:시외버스터미널, 2:시외버스정류소) (stationClass 6 인 경우만) |
| 1-3-9 | x | double | Y | 1 | 정류장 x좌표(경위도) |
| 1-3-10 | y | double | Y | 1 | 정류장 y좌표(경위도) |
| 1-3-11 | CID | int | Y | 1 | 정류장 도시코드 |
| 1-3-12 | cityName | string | Y | 1 | 정류장 도시이름 |
| 1-3-13 | arsID | string | N | 1 | 정류장 고유번호(5자리) ex)xx-xxx |
| 1-3-14 | ebid | string | N | 1 | 정류장 고유번호(5자리) ex)xx-xxx |
| 1-3-15 | do | string | Y | 1 | 정류장주소 도 |
| 1-3-16 | gu | string | Y | 1 | 정류장주소 구 |
| 1-3-17 | dong | string | Y | 1 | 정류장주소 동 |
| 1-3-18 | stationDirectionName | string | N | 1 | 정류장 방면 명 (stationClass 1 인 경우만) |
| 1-3-19 | busOnlyCentralLane | int | N | 1 | 버스전용 중앙차로 정류장 해당 여부 (0: 비해당, 1: 해당) (stationClass 1 인 경우만) |
| 1-3-20 | businfo | 확장 노드 | Y | 1...n | 버스 리스트 |
| 1-3-20-1 | busNo | string | N | 1 | 버스번호 |
| 1-3-20-2 | busClass | string | N | 1 | 버스타입 |
| 1-3-20-3 | busLocalBlID | string | N | 1 | 각 지역 버스노선 ID |
• 에러 코드(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 | stationID | int | Y | 1 | 대중교통 POI ID |
| 1-2-4 | type | int | N | 1 | 노선종류 문서하단 지하철노선타입 참조 (stationClass 2 인 경우만) |
| 1-2-5 | laneName | string | N | 1 | 노선명 (stationClass 2 인 경우만) |
| 1-2-6 | laneCity | string | N | 1 | 노선지역명 (stationClass 2 인 경우만) |
| 1-2-7 | stationType | int | N | 1 | 시외버스정류장 종류 (1:시외버스터미널, 2:시외버스정류소) (stationClass 6 인 경우만) |
| 1-2-8 | x | double | Y | 1 | x좌표(경위도) |
| 1-2-9 | y | double | Y | 1 | y좌표(경위도) |
| 1-2-10 | arsID | string | Y | 1 | 정류장 고유번호 |
| 1-2-11 | ebid | string | Y | 1 | 정류장 고유번호 |
| 1-2-12 | nonstopStation | int | Y | 1 | 미정차정류장 (0:정차, 1:미정차) |
| 1-2-13 | busOnlyCentralLane | int | N | 1 | 버스전용 중앙차로 정류장 해당 여부 (0: 비해당, 1: 해당) (stationClass 1 인 경우만) |
• 에러 코드(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 | stationID | int | Y | 1 | 대중교통 POI ID |
| 1-2-4 | type | int | N | 1 | 노선종류 문서하단 지하철노선타입 참조 (stationClass 2 인 경우만) |
| 1-2-5 | laneName | string | N | 1 | 노선명 (stationClass 2 인 경우만) |
| 1-2-6 | laneCity | string | N | 1 | 노선지역명 (stationClass 2 인 경우만) |
| 1-2-7 | stationType | int | N | 1 | 시외버스정류장 종류 (1:시외버스터미널, 2:시외버스정류소) (stationClass 6 인 경우만) |
| 1-2-8 | x | double | Y | 1 | x좌표(경위도) |
| 1-2-9 | y | double | Y | 1 | y좌표(경위도) |
| 1-2-10 | arsID | string | N | 1 | 정류장 고유번호(5자리) ex)xx-xxx |
| 1-2-11 | ebid | string | N | 1 | 정류장 고유번호(5자리) ex)xx-xxx |
| 1-2-12 | busOnlyCentralLane | int | N | 1 | 버스전용 중앙차로 정류장 해당 여부 (0: 비해당, 1: 해당) (stationClass 1 인 경우만) |
• 에러 코드(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 | globalStartName | string | Y | 1 | 출발역 명 |
| 1-1-2 | globalStartID | int | Y | 1 | 출발역 ID |
| 1-1-3 | globalEndName | string | Y | 1 | 도착역 명 |
| 1-1-4 | globalEndID | int | Y | 1 | 도착역 ID |
| 1-1-5 | globalTravelTime | int | Y | 1 | 전체 운행소요시간(분) |
| 1-1-6 | globalDistance | int | Y | 1 | 전체 운행거리(km) |
| 1-1-7 | globalStationCount | int | Y | 1 | 전체 정차역 수 |
| 1-1-8 | cardfare | int | Y | 1 | 카드요금(성인기준), |
| 1-1-9 | 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 | laneName | int | Y | 1 | 승차역 호선명 |
| 1-2-1-4 | laneID | int | Y | 1 | 승차역 호선 ID |
| 1-2-1-5 | transType | int | Y | 1 | 환승역 유무(0:미환승역 1:환승역) |
| 1-2-1-6 | fastTrainInfo | string | N | 1 | 빠른 환승문 |
| 1-2-1-7 | stationCount | string | Y | 1 | 이동역 개수 |
| 1-2-1-8 | wayCode | int | Y | 1 | 방면코드 (1:상행, 2:하행) |
| 1-2-1-9 | wayName | string | Y | 1 | 방면 명 |
| 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 | startName | string | Y | 1 | 승차역 명 |
| 1-3-1-3 | exName | string | Y | 1 | 환승역 명 |
| 1-3-1-4 | exSID | int | Y | 1 | 환승역 ID |
| 1-3-1-5 | fastTrain | int | Y | 1 | 빠른 환승 객차 번호 |
| 1-3-1-6 | fastDoor | int | Y | 1 | 빠른 환승 객차 문 번호 |
| 1-3-1-7 | 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 | startX | double | Y | 1 | 출발역 X 좌표 |
| 1-4-1-4 | startY | double | Y | 1 | 출발역 Y 좌표 |
| 1-4-1-5 | endID | int | Y | 1 | 도착역 id |
| 1-4-1-6 | endName | string | Y | 1 | 도착역명 |
| 1-4-1-7 | endX | double | Y | 1 | 도착역 X 좌표 |
| 1-4-1-8 | endY | double | Y | 1 | 도착역 Y 좌표 |
| 1-4-1-9 | travelTime | int | Y | 1 | 누적 운행시간(분) |
• 에러 코드(Error Code)
| 코드 | 메시지 |
|---|---|
| 500 | 서버 내부 오류 |
| -8 | 필수 입력값 형식 및 범위 오류 |
| -9 | 필수 입력값 누락 |
대중교통 길찾기 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 | 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-2-14 | checkIntervalTime | int | Y | 1 | 배차간격 체크 기준 시간(분) |
| 1-9-2-15 | checkIntervalTimeOverYn | String | Y | 1 | 배차간격 체크 기준시간을 초과하는 노선이 존재하는지 여부(Y/N) |
| 1-9-2-16 | 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 | 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 | busLocalBlID | string | Y/N | 1 | 각 지역 버스노선 ID (BIS 제공지역인 경우에만 필수) |
| 1-9-3-5-6 | busCityCode | int | Y/N | 1 | 운수회사 승인 도시코드 (버스인 경우에만 필수) |
| 1-9-3-5-7 | busProviderCode | int | Y/N | 1 | BIS 코드 (BIS 제공지역인 경우에만 필수) |
| 1-9-3-5-8 | subwayCode | int | Y/N | 1 | 지하철 노선 번호 (지하철인 경우에만 필수) |
| 1-9-3-5-9 | 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 | startX | double | Y | 1 | 승차 정류장/역 X 좌표 |
| 1-9-3-9 | startY | double | Y | 1 | 승차 정류장/역 Y 좌표 |
| 1-9-3-10 | endName | string | Y | 1 | 하차 정류장/역명 |
| 1-9-3-11 | endX | double | Y | 1 | 하차 정류장/역 X 좌표 |
| 1-9-3-12 | endY | double | Y | 1 | 하차 정류장/역 Y 좌표 |
| 1-9-3-13 | way | string | Y/N | 1 | 방면 정보 (지하철인 경우에만 필수) |
| 1-9-3-14 | wayCode | int | Y/N | 1 | 방면 정보 코드(지하철의 첫번째 경로에만 필수) 1 : 상행, 2: 하행 |
| 1-9-3-15 | door | string | Y/N | 1 | 지하철 빠른 환승 위치 (지하철인 경우에만 필수) |
| 1-9-3-16 | startID | int | Y | 1 | 출발 정류장/역 코드 |
| 1-9-3-17 | startStationCityCode | int | Y/N | 1 | 출발 정류장 도시코드 (버스인 경우에만 필수) |
| 1-9-3-18 | startStationProviderCode | int | Y/N | 1 | 출발 정류장 BIS 코드 (BIS 제공지역인 경우에만 필수) |
| 1-9-3-19 | startLocalStationID | string | Y/N | 1 | 각 지역 출발 정류장 ID (BIS 제공지역인 경우에만 필수) |
| 1-9-3-20 | startArsID | string | Y/N | 1 | 각 지역 출발 정류장 고유번호 (BIS 제공지역인 경우에만 필수) |
| 1-9-3-21 | endID | int | Y | 1 | 도착 정류장/역 코드 |
| 1-9-3-22 | endStationCityCode | int | Y/N | 1 | 도착 정류장 도시코드 (버스인 경우에만 필수) |
| 1-9-3-23 | endStationProviderCode | int | Y/N | 1 | 도착 정류장 BIS 코드 (BIS 제공지역인 경우에만 필수) |
| 1-9-3-24 | endLocalStationID | string | Y/N | 1 | 각 지역 도착 정류장 ID (BIS 제공지역인 경우에만 필수) |
| 1-9-3-25 | endArsID | string | Y/N | 1 | 각 지역 도착 정류장 고유번호 (BIS 제공지역인 경우에만 필수) |
| 1-9-3-26 | startExitNo | string | N | 1 | 지하철 들어가는 출구 번호 (지하철인 경우에만 사용되지만 해당 태그가 없을 수도 있다.) |
| 1-9-3-27 | startExitX | double | N | 1 | 지하철 들어가는 출구 X좌표(지하철인 경우에 만 사용되지만 해당 태그가 없을 수도 있다.) |
| 1-9-3-28 | startExitY | double | N | 1 | 지하철 들어가는 출구 Y좌표(지하철인 경우에 만 사용되지만 해당 태그가 없을 수도 있다.) |
| 1-9-3-29 | endExitNo | string | N | 1 | 지하철 나가는 출구 번호(지하철인 경우에만 사용되지만 해당 태그가 없을 수도 있다.) |
| 1-9-3-30 | endExitX | double | N | 1 | 지하철 나가는 출구 X좌표(지하철인 경우에만 사용되지만 해당 태그가 없을 수도 있다.) |
| 1-9-3-31 | endExitY | double | N | 1 | 지하철 나가는 출구 Y좌표(지하철인 경우에만 사용되지만 해당 태그가 없을 수도 있다.) |
| 1-9-3-32 | passStopList | 확장노드 | Y | 1 | 경로 상세구간 정보 확장 노드 |
| 1-9-3-32-1 | stations | 확장노드 | Y | 1...n | 정류장 정보 그룹노드 |
| 1-9-3-32-1-1 | index | int | Y | 1 | 정류장 순번 |
| 1-9-3-32-1-2 | stationID | int | Y | 1 | 정류장 ID |
| 1-9-3-32-1-3 | stationName | string | Y | 1 | 정류장 명칭 |
| 1-9-3-32-1-4 | stationCityCode | int | Y/N | 1 | 정류장 도시코드 (버스인 경우에만 필수) |
| 1-9-3-32-1-5 | stationProviderCode | int | Y/N | 1 | BIS 코드 (BIS 제공지역인 경우에만 필수) |
| 1-9-3-32-1-6 | localStationID | string | Y/N | 1 | 각 지역 정류장 ID (BIS 제공지역인 경우에만 필수) |
| 1-9-3-32-1-7 | arsID | string | Y/N | 1 | 각 지역 정류장 고유번호 (BIS 제공지역인 경우에만 필수) |
| 1-9-3-32-1-8 | x | string | Y | 1 | 정류장 X좌표 |
| 1-9-3-32-1-9 | y | string | Y | 1 | 정류장 Y좌표 |
| 1-9-3-32-1-10 | 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 | lastEndStation | string | Y | 1 | 최종 출발역/터미널/공항 |
| 1-6-2-6 | 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 | endName | string | Y | 1 | 도착 역/터미널/공항 명칭 |
| 1-6-3-10 | startID | int | Y | 1 | 출발 역/터미널/공항 코드 |
| 1-6-3-11 | endID | int | Y | 1 | 도착 역/터미널/공항 코드 |
| 1-6-3-12 | startCityCode | int | Y | 1 | 출발 역/터미널/공항 도시코드 |
| 1-6-3-13 | endCityCode | int | Y | 1 | 도착 역/터미널/공항 도시코드 |
| 1-6-3-14 | startX | double | Y | 1 | 출발 역/터미널/공항 X 좌표 |
| 1-6-3-15 | startY | double | Y | 1 | 출발 역/터미널/공항 Y 좌표 |
| 1-6-3-16 | endX | double | Y | 1 | 도착 역/터미널/공항 X 좌표 |
| 1-6-3-17 | endY | double | Y | 1 | 도착 역/터미널/공항 Y 좌표 |
| 1-6-3-18 | intervalTime | int | Y | 1 | 평균 배차간격(분) |
| 1-6-3-19 | 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 | takeLaneID | int | Y | 1 | 타고온 노선 ID |
| 1-2-4 | takeLaneDirection | string | Y | 1 | 타고온 노선 방면 |
| 1-2-5 | exStationID | int | Y | 1 | 환승 할 역 ID |
| 1-2-6 | exLaneName | string | Y | 1 | 환승 할 노선명 |
| 1-2-7 | exLaneID | int | Y | 1 | 환승 할 노선 ID |
| 1-2-8 | exLaneDirection | string | Y | 1 | 환승 할 노선 방면 |
| 1-2-9 | fastTrainInfo | string | Y | 1 | 환승 정보 |
| 1-2-10 | FastTrain | int | Y | 1 | 빠른환승 열차번호 |
| 1-2-11 | FastFastDoor | int | Y | 1 | 빠른환승 문 번호 |
| 1-2-12 | FastTrainNum | int | Y | 1 | 전체 열차 칸 수 |
• 에러 코드(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 | x | double | Y | 1 | 출발 터미널 X좌표 |
| 1-4 | y | double | Y | 1 | 출발 터미널 Y좌표 |
| 1-5 | haveDestinationTerminals | boolean | Y | 1 | 도착지 터미널 존재 여부(true: 존재, false: 미존재) |
| 1-6 | destinationTerminals | 확장노드 | N | 0...n | 도착지 터미널 상위 노드 |
| 1-6-1 | stationID | int | Y | 1 | 도착 터미널 ID |
| 1-6-2 | stationName | string | Y | 1 | 도착 터미널명 |
| 1-6-3 | x | double | Y | 1 | 도착 터미널 X좌표 |
| 1-6-4 | y | double | Y | 1 | 도착 터미널 Y좌표 |
• 에러 코드(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 | x | double | Y | 1 | 출발 터미널 X좌표 |
| 1-4 | y | double | Y | 1 | 출발 터미널 Y좌표 |
| 1-5 | haveDestinationTerminals | boolean | Y | 1 | 도착지 터미널 존재 여부(true: 존재, false: 미존재) |
| 1-6 | destinationTerminals | 확장노드 | N | 0...n | 도착지 터미널 상위 노드 |
| 1-6-1 | stationID | int | Y | 1 | 도착 터미널 ID |
| 1-6-2 | stationName | string | Y | 1 | 도착 터미널명 |
| 1-6-3 | x | double | Y | 1 | 도착 터미널 X좌표 |
| 1-6-4 | y | double | Y | 1 | 도착 터미널 Y좌표 |
• 에러 코드(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 | cityCode | String | Y | 1 | 도시의 코드 |
• 에러 코드(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 | x | double | Y | 1 | 출발 터미널 X좌표 |
| 1-4 | y | double | Y | 1 | 출발 터미널 Y좌표 |
| 1-5 | haveDestinationTerminals | boolean | Y | 1 | 도착지 터미널 존재 여부(true: 존재, false: 미존재) |
| 1-6 | arrivalTerminals | 확장노드 | N | 0...n | 도착지 터미널 상위 노드 |
| 1-6-1 | stationID | int | Y | 1 | 도착 터미널 ID |
| 1-6-2 | stationName | string | Y | 1 | 도착 터미널명 |
| 1-6-3 | x | double | Y | 1 | 도착 터미널 X좌표 |
| 1-6-4 | y | double | Y | 1 | 도착 터미널 Y좌표 |
• 에러 코드(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 | x | double | Y | 1 | x좌표(경위도) |
| 1-2-5 | y | double | Y | 1 | y좌표(경위도) |
| 1-2-6 | subwayLaneName | string | N | 1 | 노선명 (stationClass 2 인 경우만) |
| 1-2-7 | subwayLaneCity | string | N | 1 | 노선지역명 (stationClass 2 인 경우만) |
| 1-2-8 | subwayLaneType | int | N | 1 | 노선종류 - 문서하단 지하철노선타입 참조 (stationClass 2 인 경우만) |
| 1-2-9 | busOnlyCentralLane | int | N | 1 | 버스전용 중앙차로 정류장 해당 여부 (0: 비해당, 1: 해당) (stationClass 1 인 경우만) |
| 1-2-10 | busList | 확장노드 | N | 0...n | 통과 버스노선 리스트 |
| 1-2-10-1 | busID | int | Y | 1 | 버스노선 ID |
| 1-2-10-2 | type | int | Y | 1 | 노선종류 |
| 1-2-10-3 | busNo | string | Y | 1 | 버스노선 이름 |
• 에러 코드(Error Code)
| 코드 | 메시지 |
|---|---|
| 500 | 서버 내부 오류 |
| -8 | 필수 입력값 형식 및 범위 오류 |
실시간 버스 위치정보 조회(Real-time Bus Location Information)Beta
특정 버스노선의 운행 버스 위치정보를 리턴합니다.
* 현재 서울 외 지역은 실시간 정보 제공 준비중입니다.
| 매서드 | 요청 URI | 출력 포맷 |
|---|---|---|
| GET/POST | https://api.odsay.com/v1/api/realtimeRoute | 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=1812 |
| 2 | busBase | N | 버스 노선 기반 정보 포함 여부 0: 실시간 정보만, 1: 노선 기반 정보 포함 |
busBase=0 |
| 3 | lowBus | N | 저상버스 필터링 0: 전체 버스, 1: 저상버스만 |
lowBus=0 |
• 출력 데이터(Output Data)
| 번호 | 요소 | 데이터 타입 | 필수값 | 출력개수 | 설명 |
|---|---|---|---|---|---|
| 1 | result | 확장노드 | Y | 1 | 데이터를 포함하는 최상위노드 |
| 1-1 | base | 확장노드 | N | 1 | 요청 파라미터 busBase=1인 경우만 존재 |
| 1-1-1 | busID | int | Y | 1 | 버스노선 코드 |
| 1-1-2 | busNo | string | Y | 1 | 버스번호 |
| 1-1-3 | type | int | Y | 1 | 버스노선 종류 (문서하단 버스노선타입 참조) |
| 1-1-4 | busCityName | string | Y | 1 | 운수회사 승인 도시이름 |
| 1-1-5 | busCityCode | int | Y | 1 | 운수회사 승인 도시코드 |
| 1-1-6 | busStartPoint | string | Y | 1 | 버스노선 기점 |
| 1-1-7 | busEndPoint | string | Y | 1 | 버스노선 종점 |
| 1-1-8 | busFirstTime | string | Y | 1 | 첫차시간 |
| 1-1-9 | busLastTime | string | Y | 1 | 막차시간 |
| 1-1-10 | busInterval | string | Y | 1 | 운행간격(분) or 운행횟수(#1) |
| 1-1-11 | busTotalDistance | int | Y | 1 | 버스노선 전체 운행거리 |
| 1-1-12 | bus_Ep_FirstTime | string | Y | 1 | 종점기준 첫차 |
| 1-1-13 | bus_Ep_LastTime | string | Y | 1 | 종점기준 막차 |
| 1-1-14 | bus_Interval_Week | string | Y | 1 | 평일 배차간격 |
| 1-1-15 | bus_Interval_Sat | string | Y | 1 | 토요일 배차간격 |
| 1-1-16 | bus_Interval_Sun | string | Y | 1 | 일요일(공휴일) 배차간격 |
| 1-1-17 | bus_Interval_Rushhour | string | Y | 1 | 출퇴근시간 배차간격 |
| 1-1-18 | busLocalBlID | string | Y | 1 | 각 지역 버스노선 ID |
| 1-1-19 | station | 확장노드 | Y | 1...n | 정류장 리스트 |
| 1-1-19-1 | idx | int | Y | 1 | 정류장순번 |
| 1-1-19-2 | stationID | int | Y | 1 | 정류장 ID |
| 1-1-19-3 | stationName | string | Y | 1 | 정류장 이름 |
| 1-1-19-4 | stationDistance | long | Y | 1 | 정류장간 누적거리 (현재 정류장에서 다음 정류장까지) |
| 1-1-19-5 | stationDirection | int | Y | 1 | 상하행 구분코드 (0:없음, 1:하행, 2:상행) |
| 1-1-19-6 | arsID | string | Y | 1 | 정류장 고유번호 (0:없음) |
| 1-1-19-7 | x | double | Y | 1 | 정류장 x좌표(경위도) |
| 1-1-19-8 | y | double | Y | 1 | 정류장 y좌표(경위도) |
| 1-1-19-9 | localStationID | string | Y | 1 | 정류장 LocalID |
| 1-1-19-10 | stationCityCode | int | Y | 1 | 정류장 도시코드 |
| 1-1-19-11 | nonstopStation | int | Y | 1 | 미정차정류장 (0:정차, 1:미정차) |
| 1-2 | real | 확장노드 | Y | 1...n | 실시간 버스 위치정보 |
| 1-2-1 | busId | string | Y | 1 | 버스노선 코드 |
| 1-2-2 | routeId | string | Y | 1 | 각 지역 버스노선 ID |
| 1-2-3 | busPlateNo | string | Y | 1 | 버스 번호판 정보 |
| 1-2-4 | fromStationId | string | Y | 1 | 버스 기준 방금 출발한 정류장 ID |
| 1-2-5 | fromStationSeq | string | Y | 1 | 전체 통과 정류장 리스트중 방금 출발한 정류장 인덱스 |
| 1-2-6 | toStationId | string | Y | 1 | 버스 기준 향하는 정류장 ID |
| 1-2-7 | toStationSeq | string | Y | 1 | 전체 통과 정류장 리스트중 향하는 정류장 인덱스 |
| 1-2-8 | busPosition | string | Y | 1 | 두 정류장 사이의 버스 위치 (1:이전 정류장 도착, 2:두 정류장 중간) |
| 1-2-9 | endBusYn | string | Y | 1 | 막차버스 여부 (Y:막차버스, N:일반버스) |
| 1-2-10 | lowBusYn | string | Y | 1 | 저상버스 여부 (Y:저상버스, N:일반버스) |
| 1-2-11 | seoulProvdTm | string | Y | 1 | 실시간정보 제공시간 ex) 2021-04-07 16:24:24 |
• 에러 코드(Error Code)
| 코드 | 메시지 |
|---|---|
| 500 | 서버 내부 오류 |
| -1 | 실시간 엔진 내부 오류 |
| -10 | 노선 정보가 없는 경우 |
| -11 | 실시간 정보 제공 지역이 아님 |
| -12 | 노선 아이디가 잘못된 경우 |
실시간 버스 도착정보 조회(Real-time Bus Arrival Information)Beta
특정 정류장의 운행 버스 도착정보를 리턴합니다.
* 현재 서울 외 지역은 실시간 정보 제공 준비중입니다.
| 매서드 | 요청 URI | 출력 포맷 |
|---|---|---|
| GET/POST | https://api.odsay.com/v1/api/realtimeStation | 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=102155 |
| 2 | routeIDs | N | 노선정보 필터링 (노선아이디를 콤마로 구분하여 필터링 가능) |
routeIDs=1210,1187 |
| 3 | stationBase | N | 정류장 기반 정보 포함 여부 0: 실시간 정보만, 1: 정류장 기반 정보 포함 |
stationBase=0 |
| 4 | lowBus | N | 저상버스 필터링 0: 전체 버스, 1: 저상버스만 |
lowBus=0 |
• 출력 데이터(Output Data)
| 번호 | 요소 | 데이터 타입 | 필수값 | 출력개수 | 설명 |
|---|---|---|---|---|---|
| 1 | result | 확장노드 | Y | 1 | 데이터를 포함하는 최상위노드 |
| 1-1 | base | 확장노드 | N | 1 | 요청 파라미터 busBase=1인 경우만 존재 |
| 1-1-1 | stationName | double | Y | 1 | 정류장 이름 |
| 1-1-2 | stationID | int | Y | 1 | 정류장 ID |
| 1-1-3 | x | double | Y | 1 | 정류장 x좌표(경위도) |
| 1-1-4 | y | double | Y | 1 | 정류장 y좌표(경위도) |
| 1-1-5 | lane | 확장노드 | Y | 1...n | 정류장의 버스 노선 리스트 |
| 1-1-5-1 | busNo | string | Y | 1 | 버스노선 번호 |
| 1-1-5-2 | type | int | Y | 1 | 버스노선 종류 (문서하단 버스노선타입 참조) |
| 1-1-5-3 | busID | int | Y | 1 | 버스노선 ID |
| 1-1-5-4 | busStartPoint | string | Y | 1 | 버스노선 기점 |
| 1-1-5-5 | busEndPoint | string | Y | 1 | 버스노선 종점 |
| 1-1-5-6 | busFirstTime | string | Y | 1 | 첫차시간 |
| 1-1-5-7 | busLastTime | string | Y | 1 | 막차시간 |
| 1-1-5-8 | busInterval | string | Y | 1 | 운행간격(분) or 운행횟수(#1) |
| 1-1-5-9 | busCityCode | int | Y | 1 | 운수회사 승인 도시코드 |
| 1-1-5-10 | busCityName | string | Y | 1 | 운수회사 승인 도시이름 |
| 1-1-5-11 | busLocalBlID | string | Y | 1 | 각 지역 버스노선 ID |
| 1-1-6 | localStationID | string | Y | 1 | 각 지역 버스정류장 ID |
| 1-1-7 | stationCityCode | int | Y | 1 | 정류장의 도시코드 |
| 1-1-8 | arsID | string | Y | 1 | 정류장 고유번호 |
| 1-1-9 | do | string | Y | 1 | 정류장주소 도 |
| 1-1-10 | gu | string | Y | 1 | 정류장주소 구 |
| 1-1-11 | dong | string | Y | 1 | 정류장주소 동 |
| 1-2 | real | 확장노드 | Y | 1...n | 실시간 버스 도착정보 |
| 1-2-1 | routeID | string | Y | 1 | 버스노선 코드 |
| 1-2-2 | routeNm | string | Y | 1 | 버스번호 |
| 1-2-3 | stationSeq | string | Y | 1 | 해당 노선의 정류장 순번(BIS 순번 기준) |
| 1-2-4 | updownFlag | string | Y | 1 | 상하행 구분 (1:상행, 2:하행) |
| 1-2-5 | localRouteId | string | Y | 1 | 각 지역 버스노선 ID |
| 1-2-6 | arrival1 | 확장노드 | N | 1 | 첫번째 버스 도착정보 |
| 1-2-6-1 | busPlateNo | string | Y | 1 | 첫번째 버스 번호판 정보 |
| 1-2-6-2 | leftStation | int | Y | 1 | 첫번째 버스 남은 정류장 수 |
| 1-2-6-3 | arrivalSec | int | Y | 1 | 첫번째 버스 도착예정시간(초) |
| 1-2-6-4 | busStatus | string | Y | 1 | 버스 운행(대기) 상태 (1:운행중, 2:차고지대기, 3:회차지대기, 이 외:운행종료) |
| 1-2-6-5 | endBusYn | string | Y | 1 | 막차버스 여부 (Y:막차버스, N:일반버스) |
| 1-2-6-6 | lowBusYn | string | Y | 1 | 저상버스 여부 (Y:저상버스, N:일반버스) |
| 1-2-6-7 | fulCarAt | string | Y | 1 | 만차 여부 (0:만차 아님, 1:만차) |
| 1-2-7 | arrival2 | 확장노드 | N | 1 | 두번째 버스 도착정보 |
| 1-2-7-1 | busPlateNo | string | Y | 1 | 두번째 버스 번호판 정보 |
| 1-2-7-2 | leftStation | int | Y | 1 | 두번째 버스 남은 정류장 수 |
| 1-2-7-3 | arrivalSec | int | Y | 1 | 두번째 버스 도착예정시간(초) |
| 1-2-7-4 | busStatus | string | Y | 1 | 버스 운행(대기) 상태 (1:운행중, 2:차고지대기, 3:회차지대기, 이 외:운행종료) |
| 1-2-7-5 | endBusYn | string | Y | 1 | 막차버스 여부 (Y:막차버스, N:일반버스) |
| 1-2-7-6 | lowBusYn | string | Y | 1 | 저상버스 여부 (Y:저상버스, N:일반버스) |
| 1-2-7-7 | fulCarAt | string | Y | 1 | 만차 여부 (0:만차 아님, 1:만차) |
• 에러 코드(Error Code)
| 코드 | 메시지 |
|---|---|
| 500 | 서버 내부 오류 |
| -1 | 실시간 엔진 내부 오류 |
| -10 | 노선 정보가 없는 경우 |
| -11 | 실시간 정보 제공 지역이 아님 |
| -12 | 정류장 아이디가 잘못된 경우 |
코드정의(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 | 간선 | ||
| 12 | 지선 |
• 지하철 노선 타입(Subway Line Type)
| type | 노선명 | type | 노선명 |
|---|---|---|---|
| 1 | 수도권 1호선 | 113 | 우이신설선 |
| 2 | 수도권 2호선 | 114 | 서해선 |
| 3 | 수도권 3호선 | 115 | 김포골드라인 |
| 4 | 수도권 4호선 | 116 | 수인분당선 |
| 5 | 수도권 5호선 | 117 | 신림선 |
| 6 | 수도권 6호선 | 21 | 인천 1호선 |
| 7 | 수도권 7호선 | 22 | 인천 2호선 |
| 8 | 수도권 8호선 | 31 | 대전 1호선 |
| 9 | 수도권 9호선 | 41 | 대구 1호선 |
| 91 | GTX-A | 42 | 대구 2호선 |
| 101 | 공항철도 | 43 | 대구 3호선 |
| 102 | 자기부상철도 | 51 | 광주 1호선 |
| 104 | 경의중앙선 | 71 | 부산 1호선 |
| 107 | 에버라인 | 72 | 부산 2호선 |
| 108 | 경춘선 | 73 | 부산 3호선 |
| 109 | 신분당선 | 74 | 부산 4호선 |
| 110 | 의정부경전철 | 78 | 동해선 |
| 112 | 경강선 | 79 | 부산-김해경전철 |
• 도시코드(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 | 충주 |