forked from mority/icc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
1091 lines (1026 loc) · 35.1 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
title: MOTIS API
description: This is the MOTIS routing API.
contact:
email: [email protected]
license:
name: MIT
url: https://opensource.org/license/mit
version: v1
externalDocs:
description: Find out more about MOTIS
url: https://github.com/motis-project/motis
servers:
- url: https://europe.motis-project.de
paths:
/api/v1/reverse-geocode:
get:
tags:
- geocode
summary: Translate coordinates to the closest address(es)/places/stops.
operationId: reverseGeocode
parameters:
- name: place
in: query
required: true
description: latitude, longitude in degrees
schema:
type: string
responses:
200:
description: A list of guesses to resolve the coordinates to a location
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Match'
/api/v1/geocode:
get:
tags:
- geocode
summary: Autocompletion & geocoding that resolves user input addresses including coordinates
operationId: geocode
parameters:
- name: text
in: query
required: true
description: the (potentially partially typed) address to resolve
schema:
type: string
- name: language
in: query
required: false
description: |
language tags as used in OpenStreetMap
(usually ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
schema:
type: string
responses:
200:
description: A list of guesses to resolve the text to a location
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Match'
/api/v1/trip:
get:
tags:
- timetable
summary: Get a trip as itinerary
operationId: trip
parameters:
- name: tripId
in: query
schema:
type: string
required: true
description: trip identifier (e.g. from an itinerary leg or stop event)
- name: date
in: query
schema:
type: string
required: true
description: |
Service date as specified in the source dataset.
Can be taken from an itinerary leg or stop event.
Not that for GTFS the first departure time can be greater than 24:00:00
which means that the service date is shifted by the offset (first departure / 24h).
A valid use case for this are stay seated transfers expressed by `block_id`.
Example: a train with first departure at 25:00:00 on 9th of Oct 2024
has the 8th of Oct 2024 as service date.
responses:
200:
description: the requested trip as itinerary
content:
application/json:
schema:
$ref: '#/components/schemas/Itinerary'
/api/v1/stoptimes:
get:
tags:
- timetable
summary: Get the next N departures or arrivals of a stop sorted by time
operationId: stoptimes
parameters:
- name: stopId
in: query
schema:
type: string
required: true
description: stop id of the stop to retrieve departures/arrivals for
- name: date
in: query
required: false
description: |
Optional. Defaults to the current date.
Departure date ($arriveBy=false) / arrival date ($arriveBy=true), format: 06-28-2024
schema:
type: string
- name: time
in: query
required: false
description: |
Optional. Defaults to the current time.
Format:
- 12h format: 7:06pm
- 24h format: 19:06
schema:
type: string
- name: arriveBy
in: query
required: false
schema:
type: boolean
default: false
description: |
Optional. Default is `false`.
- `arriveBy=true`: the parameters `date` and `time` refer to the arrival time
- `arriveBy=false`: the parameters `date` and `time` refer to the departure time
- name: n
in: query
schema:
type: integer
required: true
description: the number of events
- name: pageCursor
in: query
required: false
description: |
Use the cursor to go to the next "page" of stop times.
Copy the cursor from the last response and keep the original request as is.
This will enable you to search for stop times in the next or previous time-window.
schema:
type: string
responses:
200:
description: A list of guesses to resolve the text to a location
content:
application/json:
schema:
type: object
required:
- stopTimes
- previousPageCursor
- nextPageCursor
properties:
stopTimes:
description: list of stop times
type: array
items:
$ref: '#/components/schemas/StopTime'
previousPageCursor:
description: |
Use the cursor to get the previous page of results. Insert the cursor into the request and post it to get the previous page.
The previous page is a set of stop times BEFORE the first stop time in the result.
type: string
nextPageCursor:
description: |
Use the cursor to get the next page of results. Insert the cursor into the request and post it to get the next page.
The next page is a set of stop times AFTER the last stop time in this result.
type: string
/api/v1/plan:
get:
tags:
- routing
summary: Computes optimal connections from one place to another.
operationId: plan
parameters:
- name: fromPlace
in: query
required: true
description: \`latitude,longitude,level\` tuple in degrees OR stop id
schema:
type: string
- name: toPlace
in: query
required: true
description: \`latitude,longitude,level\` tuple in degrees OR stop id
schema:
type: string
- name: date
in: query
required: false
description: |
Optional. Defaults to the current date.
Departure date ($arriveBy=false) / arrival date ($arriveBy=true), format: 06-28-2024
schema:
type: string
- name: time
in: query
required: false
description: |
Optional. Defaults to the current time.
Meaning depending on `arriveBy`
- Departure time for `arriveBy=false`
- Arrival time for `arriveBy=true`
Format:
- 12h format: 7:06pm
- 24h format: 19:06
schema:
type: string
- name: maxTransfers
in: query
required: false
description: |
The maximum number of allowed transfers.
If not provided, the routing uses the server-side default value
which is hardcoded and very high to cover all use cases.
*Warning*: Use with care. Setting this too low can lead to
optimal (e.g. the fastest) journeys not being found.
If this value is too low to reach the destination at all,
it can lead to slow routing performance.
schema:
type: integer
- name: maxHours
in: query
required: false
description: |
The maximum travel time in hours.
If not provided, the routing to uses the value
hardcoded in the server which is usually quite high.
*Warning*: Use with care. Setting this too low can lead to
optimal (e.g. the least transfers) journeys not being found.
If this value is too low to reach the destination at all,
it can lead to slow routing performance.
schema:
type: number
- name: minTransferTime
in: query
required: false
description: Minimum transfer time for each transfer.
schema:
type: integer
- name: transferTimeFactor
in: query
required: false
description: Factor to multiply transfer times with.
schema:
type: integer
default: 1
- name: wheelchair
in: query
description: Whether the trip must be wheelchair accessible.
required: false
schema:
type: boolean
default: false
- name: mode
in: query
required: false
description: |
A comma separated list of allowed modes.
Default if not provided: `WALK,TRANSIT`
schema:
default:
- WALK
- TRANSIT
type: array
minItems: 1
items:
$ref: '#/components/schemas/Mode'
explode: false
- name: numItineraries
in: query
required: false
description: |
The minimum number of itineraries to compute.
This is only relevant if `timetableView=true`.
The default value is 5.
schema:
type: integer
default: 5
- name: pageCursor
in: query
required: false
description: |
Use the cursor to go to the next "page" of itineraries.
Copy the cursor from the last response and keep the original request as is.
This will enable you to search for itineraries in the next or previous time-window.
schema:
type: string
- name: timetableView
in: query
required: false
description: |
Optional. Default is `true`.
Search for the best trip options within a time window.
If true two itineraries are considered optimal
if one is better on arrival time (earliest wins)
and the other is better on departure time (latest wins).
In combination with arriveBy this parameter cover the following use cases:
`timetable=false` = waiting for the first transit departure/arrival is considered travel time:
- `arriveBy=true`: event (e.g. a meeting) starts at 10:00 am,
compute the best journeys that arrive by that time (maximizes departure time)
- `arriveBy=false`: event (e.g. a meeting) ends at 11:00 am,
compute the best journeys that depart after that time
`timetable=true` = optimize "later departure" + "earlier arrival" and give all options over a time window:
- `arriveBy=true`: the time window around `date` and `time` refers to the arrival time window
- `arriveBy=false`: the time window around `date` and `time` refers to the departure time window
schema:
type: boolean
default: false
- name: arriveBy
in: query
required: false
schema:
type: boolean
default: false
description: |
Optional. Default is `false`.
- `arriveBy=true`: the parameters `date` and `time` refer to the arrival time
- `arriveBy=false`: the parameters `date` and `time` refer to the departure time
- name: searchWindow
in: query
required: false
description: |
Optional. Default is 2 hours which is `7200`.
The length of the search-window in seconds. Default value two hours.
- `arriveBy=true`: number of seconds between the earliest departure time and latest departure time
- `arriveBy=false`: number of seconds between the earliest arrival time and the latest arrival time
schema:
type: integer
default: 7200
minimum: 0
- name: maxPreTransitTime
in: query
required: false
description: |
Optional. Default is 15min which is `900`.
Maximum time in seconds for the first street leg.
schema:
type: integer
default: 900
minimum: 0
- name: maxPostTransitTime
in: query
required: false
description: |
Optional. Default is 15min which is `900`.
Maximum time in seconds for the last street leg.
schema:
type: integer
default: 900
minimum: 0
responses:
'200':
description: routing result
content:
application/json:
schema:
type: object
required:
- requestParameters
- debugOutput
- date
- from
- to
- itineraries
- previousPageCursor
- nextPageCursor
properties:
requestParameters:
description: "the routing query"
type: object
additionalProperties:
type: string
debugOutput:
description: "debug statistics"
type: object
additionalProperties:
type: string
date:
description: "The time and date of travel"
type: integer
from:
$ref: '#/components/schemas/Place'
to:
$ref: '#/components/schemas/Place'
itineraries:
description: list of itineraries
type: array
items:
$ref: '#/components/schemas/Itinerary'
previousPageCursor:
description: |
Use the cursor to get the previous page of results. Insert the cursor into the request and post it to get the previous page.
The previous page is a set of itineraries departing BEFORE the first itinerary in the result for a depart after search. When using the default sort order the previous set of itineraries is inserted before the current result.
type: string
nextPageCursor:
description: |
Use the cursor to get the next page of results. Insert the cursor into the request and post it to get the next page.
The next page is a set of itineraries departing AFTER the last itinerary in this result.
type: string
/api/v1/levels:
get:
tags:
- map
summary: Get all available levels for a map section
operationId: levels
parameters:
- name: min
in: query
required: true
description: latitude,longitude pair of the lower right coordinate
schema:
type: string
- name: max
in: query
required: true
description: latitude,longitude pair of the upper left coordinate
schema:
type: string
responses:
'200':
description: array of available levels
content:
application/json:
schema:
type: array
items:
type: number
/api/debug/footpaths:
get:
tags:
- debug
summary: Prints all footpaths of a timetable location (track, bus stop, etc.)
operationId: footpaths
parameters:
- name: id
in: query
required: true
description: location id
schema:
type: string
responses:
'200':
description: list of outgoing footpaths of this location
content:
application/json:
schema:
type: object
required:
- place
- footpaths
properties:
place:
$ref: '#/components/schemas/Place'
footpaths:
description: all outgoing footpaths of this location
type: array
items:
$ref: '#/components/schemas/Footpath'
components:
schemas:
Area:
description: Administrative area
type: object
required:
- name
- admin_level
- matched
properties:
name:
type: string
description: Name of the area
admin_level:
type: number
description: |
[OpenStreetMap `admin_level`](https://wiki.openstreetmap.org/wiki/Key:admin_level)
of the area
matched:
type: boolean
description: Whether this area was matched by the input text
default:
type: boolean
description: Whether this area should be displayed as default area (area with admin level closest 7)
Token:
description: Matched token range (from index, length)
type: array
minItems: 2
maxItems: 2
items:
type: number
Match:
description: GeoCoding match
type: object
required:
- type
- name
- id
- lat
- lon
- level
- tokens
- areas
- score
properties:
type:
description: location type
type: string
enum:
- ADDRESS
- PLACE
- STOP
tokens:
description: list of non-overlapping tokens that were matched
type: array
items:
$ref: '#/components/schemas/Token'
name:
description: name of the location (transit stop / PoI / address)
type: string
id:
description: unique ID of the location
type: string
lat:
description: latitude
type: number
lon:
description: longitude
type: number
level:
description: |
level according to OpenStreetMap
(at the moment only for public transport)
type: number
street:
description: street name
type: string
house_number:
description: house number
type: string
zip:
description: zip code
type: string
areas:
description: list of areas
type: array
items:
$ref: '#/components/schemas/Area'
score:
description: score according to the internal scoring system (the scoring algorithm might change in the future)
type: number
Mode:
description: |
# Street modes
- `WALK`: Walking some or all of the way of the route.
- `BIKE`: Cycling for the entirety of the route or taking a bicycle onto the public transport (if enabled) and cycling from the arrival station to the destination.
- `BIKE_RENTAL`: Taking a rented, shared-mobility bike for part or the entirety of the route.
- `BIKE_TO_PARK`: Leaving the bicycle at the departure station and walking from the arrival station to the destination. This mode needs to be combined with at least one transit mode otherwise it behaves like an ordinary bicycle journey.
- `CAR`: Driving your own car the entirety of the route. This can be combined with transit, where will return routes with a Kiss & Ride component. This means that the car is not parked in a permanent parking area but rather the passenger is dropped off (for example, at an airport) and the driver continues driving the car away from the drop off location.
- `CAR_PARK` | `CAR_TO_PARK`: Driving a car to the park-and-ride facilities near a station and taking publictransport. This mode needs to be combined with at least one transit mode otherwise, it behaves like an ordinary car journey.
- `CAR_HAILING`: Using a car hailing app like Uber or Lyft to get to a train station or all the way to the destination.
- `CAR_PICKUP`: Walking to a pickup point along the road, driving to a drop-off point along the road, and walking the rest of the way. This can include various taxi-services or kiss & ride.
- `CAR_RENTAL`: Walk to a car rental point, drive to a car rental drop-off point and walk the rest of the way. This can include car rental at fixed locations or free-floating services.
- `FLEXIBLE`: Encompasses all types of on-demand and flexible transportation for example GTFS Flex or NeTEx Flexible Stop Places.
- `SCOOTER_RENTAL`: Walking to a scooter rental point, riding a scooter to a scooter rental drop-off point, and walking the rest of the way. This can include scooter rental at fixed locations or free-floating services.
# Transit modes
- `TRANSIT`: translates to `RAIL,SUBWAY,TRAM,BUS,FERRY,AIRPLANE,COACH`
- `TRAM`: trams
- `SUBWAY`: subway trains
- `FERRY`: ferries
- `AIRPLANE`: airline flights
- `BUS`: short distance buses (does not include `COACH`)
- `COACH`: long distance buses (does not include `BUS`)
- `RAIL`: translates to `HIGHSPEED_RAIL,LONG_DISTANCE_RAIL,NIGHT_RAIL,REGIONAL_RAIL,REGIONAL_FAST_RAIL`
- `METRO`: metro trains
- `HIGHSPEED_RAIL`: long distance high speed trains (e.g. TGV)
- `LONG_DISTANCE`: long distance inter city trains
- `NIGHT_RAIL`: long distance night trains
- `COACH`: long distance buses
- `REGIONAL_FAST_RAIL`: regional express routes that skip low traffic stops to be faster
- `REGIONAL_RAIL`: regional train
type: string
enum:
# === Street ===
- WALK
- BIKE
- CAR
- BIKE_RENTAL
- BIKE_TO_PARK
- CAR_TO_PARK
- CAR_HAILING
- CAR_SHARING
- CAR_PICKUP
- CAR_RENTAL
- FLEXIBLE
- SCOOTER_RENTAL
# === Transit ===
- TRANSIT
- TRAM
- SUBWAY
- FERRY
- AIRPLANE
- METRO
- BUS
- COACH
- RAIL
- HIGHSPEED_RAIL
- LONG_DISTANCE
- NIGHT_RAIL
- REGIONAL_FAST_RAIL
- REGIONAL_RAIL
- OTHER
StopTime:
description: departure or arrival event at a stop
type: object
required:
- mode
- time
- delay
- realTime
- route
- headsign
- agencyId
- agencyName
- agencyUrl
- routeColor
- routeTextColor
- routeType
- routeId
- tripId
- serviceDate
- routeShortName
- source
properties:
mode:
$ref: '#/components/schemas/Mode'
description: Transport mode for this leg
time:
type: integer
description: |
The offset from the scheduled arrival time of the boarding stop in this leg.
Scheduled time of arrival at boarding stop = endTime - arrivalDelay
delay:
type: integer
description: |
The offset from the scheduled departure time of the boarding stop in this leg.
Scheduled time of departure at boarding stop = startTime - departureDelay
realTime:
description: Whether there is real-time data about this leg
type: boolean
route:
description: |
For transit legs, the route of the bus or train being used.
For non-transit legs, the name of the street being traversed.
type: string
headsign:
description: |
For transit legs, the headsign of the bus or train being used.
For non-transit legs, null
type: string
agencyId:
type: string
agencyName:
type: string
agencyUrl:
type: string
routeColor:
type: string
routeTextColor:
type: string
routeType:
type: string
routeId:
type: string
tripId:
type: string
serviceDate:
type: string
routeShortName:
type: string
source:
description: Filename and line number where this trip is from
type: string
VertexType:
type: string
description: |
- `NORMAL` - latitude / longitude coordinate or address
- `BIKESHARE` - bike sharing station
- `BIKEPARK` - bike parking
- `TRANSIT` - transit stop
enum:
- NORMAL
- BIKESHARE
- BIKEPARK
- TRANSIT
Place:
type: object
required:
- name
- lat
- lon
- level
properties:
name:
description: name of the transit stop / PoI / address
type: string
stopId:
description: The ID of the stop. This is often something that users don't care about.
type: string
lat:
description: latitude
type: number
lon:
description: longitude
type: number
level:
description: level according to OpenStreetMap
type: number
arrivalDelay:
type: integer
description: |
The offset from the scheduled arrival time of the boarding stop in this leg.
Scheduled time of arrival at boarding stop = endTime - arrivalDelay
departureDelay:
type: integer
description: |
The offset from the scheduled departure time of the boarding stop in this leg.
Scheduled time of departure at boarding stop = startTime - departureDelay
arrival:
description: arrival time, format = unixtime in milliseconds
type: integer
departure:
description: departure time, format = unixtime in milliseconds
type: integer
track:
description: track/platform information, if available
type: string
vertexType:
$ref: '#/components/schemas/VertexType'
RelativeDirection:
type: string
enum:
- DEPART
- HARD_LEFT
- LEFT
- SLIGHTLY_LEFT
- CONTINUE
- SLIGHTLY_RIGHT
- RIGHT
- HARD_RIGHT
- CIRCLE_CLOCKWISE
- CIRCLE_COUNTERCLOCKWISE
- ELEVATOR
- UTURN_LEFT
- UTURN_RIGHT
AbsoluteDirection:
type: string
enum:
- NORTH
- NORTHEAST
- EAST
- SOUTHEAST
- SOUTH
- SOUTHWEST
- WEST
- NORTHWEST
StepInstruction:
type: object
required:
- relativeDirection
- absoluteDirection
- distance
- streetName
- exit
- stayOn
- area
- lon
- lat
properties:
relativeDirection:
$ref: '#/components/schemas/RelativeDirection'
absoluteDirection:
$ref: '#/components/schemas/AbsoluteDirection'
distance:
description: The distance in meters that this step takes.
type: number
streetName:
description: The name of the street.
type: string
exit:
description: When exiting a highway or traffic circle, the exit name/number.
type: string
stayOn:
description: |
Indicates whether or not a street changes direction at an intersection.
type: boolean
area:
description: |
This step is on an open area, such as a plaza or train platform,
and thus the directions should say something like "cross"
type: boolean
lon:
description: The longitude of start of the step
type: number
lat:
description: The latitude of start of the step
type: number
EncodedPolyline:
type: object
required:
- points
- length
properties:
points:
description: The encoded points of the polyline.
type: string
length:
description: The number of points in the string
type: integer
LevelEncodedPolyline:
type: object
required:
- from_level
- to_level
- polyline
properties:
from_level:
description: level where this segment starts, based on OpenStreetMap data
type: number
to_level:
description: level where this segment starts, based on OpenStreetMap data
type: number
osm_way:
description: OpenStreetMap way index
type: integer
polyline:
$ref: '#/components/schemas/EncodedPolyline'
Leg:
type: object
required:
- mode
- startTime
- endTime
- departureDelay
- arrivalDelay
- realTime
- distance
- duration
- from
- to
- legGeometry
properties:
mode:
$ref: '#/components/schemas/Mode'
description: Transport mode for this leg
from:
$ref: '#/components/schemas/Place'
to:
$ref: '#/components/schemas/Place'
duration:
description: Leg duration in seconds
type: integer
startTime:
type: integer
description: leg departure time, format = unixtime in milliseconds
endTime:
type: integer
description: leg arrival time, format = unixtime in milliseconds
departureDelay:
type: integer
description: |
The offset from the scheduled departure time of the boarding stop in this leg.
Scheduled time of departure at boarding stop = startTime - departureDelay
arrivalDelay:
type: integer
description: |
The offset from the scheduled arrival time of the boarding stop in this leg.
Scheduled time of arrival at boarding stop = endTime - arrivalDelay
realTime:
description: Whether there is real-time data about this leg
type: boolean
distance:
description: The distance traveled while traversing this leg in meters.
type: number
interlineWithPreviousLeg:
description: For transit legs, if the rider should stay on the vehicle as it changes route names.
type: boolean
route:
description: |
For transit legs, the route of the bus or train being used.
For non-transit legs, the name of the street being traversed.
type: string
headsign:
description: |
For transit legs, the headsign of the bus or train being used.
For non-transit legs, null
type: string
agencyName:
type: string
agencyUrl:
type: string
routeColor:
type: string
routeTextColor:
type: string
routeType:
type: string
routeId:
type: string
agencyId:
type: string
tripId:
type: string
serviceDate:
type: string
routeShortName:
type: string
source:
description: Filename and line number where this trip is from
type: string
intermediateStops:
description: |