Skip to content

Latest commit

 

History

History
631 lines (602 loc) · 14.1 KB

bus.md

File metadata and controls

631 lines (602 loc) · 14.1 KB
Raw

버스 정류장 / 버스 도착 안내

아래에는 서울, 경기, 인천 지역의 버스 정류소 및 버스 도착 안내에 대하여 서술되어 있습니다.

/station

정류장 정보를 불러옵니다.

https://api.yhs.kr/bus/station

Parameter

키 설명 형태 필수 유무 기본 값 비고
name 정류소 명칭 string O
cityCode 도시 코드 integer X 1 1: 자동 설정
11: 서울 지역
12: 경기 지역
13: 인천 지역

Return

[
  {
    "displayId": 22009,
    "id": 22009,
    "name": "신분당선강남역",
    "posX": 127.0284005454,
    "posY": 37.4960417459,
    "stationId": 121000009,
    "type": 11
  }
]
  • 기본 구조
키 설명 형태 필수 유무 기본 값 비고
displayId 정류장 ID(사용자) string, List[string] X 수도권 정류장 ID(4-5자리)
id 정류장 ID string O 도착정보 조회를 위한 ID값
name 정류장 명 string O
posX 정류장 X좌표 float O
posY 정류장 Y좌표 float O
stationId 정류장 ID(개발자) string, List[string] O
type 출처 integer O 도착정보 조회를 위한 유형
1: 자동 설정(/route 용)
2: 자동 설정(버스정류소 검색용)
11: 서울 지역
12: 경기 지역
13: 인천 지역

/station/around

좌표 값을 기준으로 주변에 있는 정류장 정보를 불러옵니다.

https://api.yhs.kr/bus/station/around

Parameter

키 설명 형태 필수 유무 기본 값 비고
posX 경도 float O
posY 위도 float O
cityCode 도시 코드 integer X 1 1: 자동 설정
11: 서울 지역
12: 경기 지역
13: 인천 지역

Return

[
  {
    "distance": 100,
    "displayId": 22009,
    "id": 22009,
    "name": "신분당선강남역",
    "posX": 127.0284005454,
    "posY": 37.4960417459,
    "stationId": 121000009,
    "type": 11
  }
]
  • 기본 구조
키 설명 형태 필수 유무 기본 값 비고
displayId 정류장 ID(사용자) string, List[string] X 수도권 정류장 ID(5자리)
distance 정류장까지 거리 integer O m(미터법) 기준
id 정류장 ID string O 도착정보 조회를 위한 ID값
name 정류장 명 string O
posX 정류장 X좌표 float O
posY 정류장 Y좌표 float O
stationId 정류장 ID(개발자) string, List[string] O
type 출처 integer O 도착정보 조회를 위한 유형
1: 자동 설정
11: 서울 지역
12: 경기 지역
13: 인천 지역

/route

정류장 내 버스 도착 정보를 불러옵니다.

https://api.yhs.kr/bus/route

Parameter

키 설명 형태 필수 유무 기본 값 비고
id 정류소 ID string O /station에서 구한 id값
cityCode 도시 코드 integer O /station에서 구한 type값
11: 서울 지역
12: 경기 지역
13: 인천 지역
version 데이터모델 버전 string X v1 v2 사용 권장 / 2022년 하반기 삭제 예정

Return

[
    {
        "arrivalInfo":[
            {
                "carNumber": null,
                "congestion": null,
                "isArrival": false,
                "isFull": false,
                "lowBus": true,
                "prevCount": 5,
                "seat": null,
                "time": 436
            }
        ],
        "id": "100100409",
        "name": "421",
        "type":"1003"
    }
]
  • 기본 구조
키 설명 형태 필수 유무 기본 값 비고
arrivalInfo 도착 정보 List[ArrivalInfo] O
id 경로 ID string O
name 노선명 string O
type 노선유형 string O 아래 노선 유형 참고
  • ArrivalInfo 구조
    △는 평상시에는 필수 적으로 반환되다가, 운영이 종료되거나, 정보를 조회할 수 없을 때 null 혹은 기본 값을 반환합니다.
키 설명 형태 필수 유무 기본 값 비고
carNumber 차량 번호 string X null
congestion 혼잡도 integer X null 1: 여유
2: 보통
3: 혼잡
isArrival 도착 유무 boolean X null
isFull 만차 유무 boolean O false
lowBus 저상 버스 유무 boolean O false
prevCount 차량 위치 정보(N 번째 전 정류소) integer △ null
seat 빈 자릿수 integer X null
time 예상 도착 시간 integer △ null 초 단위
  • 노선 유형

요청를 보낼 때, Header 에다가 version 키에 v2 값을 적용했을 경우 아래의 표와 같이 작동합니다.

키 설명 지역
1101 공항버스 서울
1102 마을버스
1103 간선버스
1104 지선버스
1105 순환버스
1106 광역버스
1109 페지노선
1100 공용버스
1211 직행좌석 시내버스 경기
1212 좌석 시내버스
1213 일반 시내버스
1214 광역급행 시내버스
1215 맞춤형버스(舊 따복버스)
1216 경기순환버스
1221 직행좌석 농어촌버스
1222 좌석 농어촌버스
1223 일반 농어촌버스
1230 마을버스
1241 고속 시외버스
1242 좌석 시외버스
1243 일반 시외버스
1251 리무진 공항버스
1252 좌석 공항버스
1253 일반 공항버스
1301 지선버스 인천
1302 간선버스
1303 좌석버스
1304 광역버스
1305 리무진 버스
1306 마을버스
1307 순환버스
1308 급행간선버스
1309 지선순환버스