-
Notifications
You must be signed in to change notification settings - Fork 60
/
Copy pathopenapi.yaml
2039 lines (1878 loc) · 66.4 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: felix@triptix.tech
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://api.transitous.org
paths:
/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: via
in: query
required: false
description: |
List of via stops to visit (only stop IDs, no coordinates allowed for now).
Also see the optional parameter `viaMinimumStay` to set a set a minimum stay duration for each via stop.
schema:
type: array
maxItems: 2
items:
type: string
explode: false
- name: viaMinimumStay
in: query
required: false
description: |
Optional. If not set, the default is `0,0` - no stay required.
For each `via` stop a minimum stay duration in minutes.
The value `0` signals that it's allowed to stay in the same trip.
This enables via stays without counting a transfer and can lead
to better connections with less transfers. Transfer connections can
still be found with `viaMinimumStay=0`.
schema:
default: [ 0, 0 ]
type: array
maxItems: 2
items:
type: integer
explode: false
- name: time
in: query
required: false
description: |
Optional. Defaults to the current time.
Departure time ($arriveBy=false) / arrival date ($arriveBy=true),
schema:
type: string
format: date-time
- 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: maxTravelTime
in: query
required: false
description: |
The maximum travel time in minutes.
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: integer
- name: minTransferTime
in: query
required: false
description: |
Optional. Default is 0 minutes.
Minimum transfer time for each transfer in minutes.
schema:
type: integer
default: 0
- name: additionalTransferTime
in: query
required: false
description: |
Optional. Default is 0 minutes.
Additional transfer time reserved for each transfer in minutes.
schema:
type: integer
default: 0
- name: transferTimeFactor
in: query
required: false
description: |
Optional. Default is 1.0
Factor to multiply minimum required transfer times with.
Values smaller than 1.0 are not supported.
schema:
type: number
default: 1.0
- name: maxMatchingDistance
in: query
required: false
description: |
Optional. Default is 25 meters.
Maximum matching distance in meters to match geo coordinates to the street network.
schema:
type: number
default: 25
- name: pedestrianProfile
in: query
required: false
description: |
Optional. Default is `FOOT`.
Accessibility profile to use for pedestrian routing in transfers
between transit connections, on the first mile, and last mile.
schema:
$ref: '#/components/schemas/PedestrianProfile'
default: FOOT
- name: useRoutedTransfers
in: query
required: false
description: |
Optional. Default is `false`.
Whether to use transfers routed on OpenStreetMap data.
schema:
type: boolean
default: false
- name: detailedTransfers
in: query
required: true
description: |
- true: Compute transfer polylines and step instructions.
- false: Only return basic information (start time, end time, duration) for transfers.
schema:
type: boolean
default: true
- name: transitModes
in: query
required: false
description: |
Optional. Default is `TRANSIT` which allows all transit modes (no restriction).
Allowed modes for the transit part. If empty, no transit connections will be computed.
For example, this can be used to allow only `METRO,SUBWAY,TRAM`.
schema:
default:
- TRANSIT
type: array
items:
$ref: '#/components/schemas/Mode'
explode: false
- name: directModes
in: query
required: false
description: |
Optional. Default is `WALK` which will compute walking routes as direct connections.
Modes used for direction connections from start to destination without using transit.
Results will be returned on the `direct` key.
Note: Direct connections will only be returned on the first call. For paging calls, they can be omitted.
Note: Transit connections that are slower than the fastest direct connection will not show up.
This is being used as a cut-off during transit routing to speed up the search.
To prevent this, it's possible to send two separate requests (one with only `transitModes` and one with only `directModes`).
Only non-transit modes such as `WALK`, `BIKE`, `CAR`, `BIKE_SHARING`, etc. can be used.
schema:
default:
- WALK
type: array
items:
$ref: '#/components/schemas/Mode'
explode: false
- name: preTransitModes
in: query
required: false
description: |
Optional. Default is `WALK`. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directModes`).
A list of modes that are allowed to be used from the `from` coordinate to the first transit stop. Example: `WALK,BIKE_SHARING`.
schema:
default:
- WALK
type: array
items:
$ref: '#/components/schemas/Mode'
explode: false
- name: postTransitModes
in: query
required: false
description: |
Optional. Default is `WALK`. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directModes`).
A list of modes that are allowed to be used from the last transit stop to the `to` coordinate. Example: `WALK,BIKE_SHARING`.
schema:
default:
- WALK
type: array
items:
$ref: '#/components/schemas/Mode'
explode: false
- name: directRentalFormFactors
in: query
required: false
description: |
Experimental. Expect unannounced breaking changes (without version bumps).
Optional. Only applies to direct connections.
A list of vehicle type form factors that are allowed to be used for direct connections.
If empty (the default), all form factors are allowed.
Example: `BICYCLE,SCOOTER_STANDING`.
schema:
type: array
items:
$ref: '#/components/schemas/RentalFormFactor'
explode: false
- name: preTransitRentalFormFactors
in: query
required: false
description: |
Experimental. Expect unannounced breaking changes (without version bumps).
Optional. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalFormFactors`).
A list of vehicle type form factors that are allowed to be used from the `from` coordinate to the first transit stop.
If empty (the default), all form factors are allowed.
Example: `BICYCLE,SCOOTER_STANDING`.
schema:
type: array
items:
$ref: '#/components/schemas/RentalFormFactor'
explode: false
- name: postTransitRentalFormFactors
in: query
required: false
description: |
Experimental. Expect unannounced breaking changes (without version bumps).
Optional. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalFormFactors`).
A list of vehicle type form factors that are allowed to be used from the last transit stop to the `to` coordinate.
If empty (the default), all form factors are allowed.
Example: `BICYCLE,SCOOTER_STANDING`.
schema:
type: array
items:
$ref: '#/components/schemas/RentalFormFactor'
explode: false
- name: directRentalPropulsionTypes
in: query
required: false
description: |
Experimental. Expect unannounced breaking changes (without version bumps).
Optional. Only applies to direct connections.
A list of vehicle type form factors that are allowed to be used for direct connections.
If empty (the default), all propulsion types are allowed.
Example: `HUMAN,ELECTRIC,ELECTRIC_ASSIST`.
schema:
type: array
items:
$ref: '#/components/schemas/RentalPropulsionType'
explode: false
- name: preTransitRentalPropulsionTypes
in: query
required: false
description: |
Experimental. Expect unannounced breaking changes (without version bumps).
Optional. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalPropulsionTypes`).
A list of vehicle propulsion types that are allowed to be used from the `from` coordinate to the first transit stop.
If empty (the default), all propulsion types are allowed.
Example: `HUMAN,ELECTRIC,ELECTRIC_ASSIST`.
schema:
type: array
items:
$ref: '#/components/schemas/RentalPropulsionType'
explode: false
- name: postTransitRentalPropulsionTypes
in: query
required: false
description: |
Experimental. Expect unannounced breaking changes (without version bumps).
Optional. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalPropulsionTypes`).
A list of vehicle propulsion types that are allowed to be used from the last transit stop to the `to` coordinate.
If empty (the default), all propulsion types are allowed.
Example: `HUMAN,ELECTRIC,ELECTRIC_ASSIST`.
schema:
type: array
items:
$ref: '#/components/schemas/RentalPropulsionType'
explode: false
- name: directRentalProviders
in: query
required: false
description: |
Experimental. Expect unannounced breaking changes (without version bumps).
Optional. Only applies to direct connections.
A list of rental providers that are allowed to be used for direct connections.
If empty (the default), all providers are allowed.
schema:
type: array
items:
type: string
- name: preTransitRentalProviders
in: query
required: false
description: |
Experimental. Expect unannounced breaking changes (without version bumps).
Optional. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalProviders`).
A list of rental providers that are allowed to be used from the `from` coordinate to the first transit stop.
If empty (the default), all providers are allowed.
schema:
type: array
items:
type: string
- name: postTransitRentalProviders
in: query
required: false
description: |
Experimental. Expect unannounced breaking changes (without version bumps).
Optional. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalProviders`).
A list of rental providers that are allowed to be used from the last transit stop to the `to` coordinate.
If empty (the default), all providers are allowed.
schema:
type: array
items:
type: string
- 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: true
- 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: requireBikeTransport
in: query
required: false
schema:
type: boolean
default: false
description: |
Optional. Default is `false`.
If set to `true`, all used transit trips are required to allow bike carriage.
- 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
- name: maxDirectTime
in: query
required: false
description: |
Optional. Default is 30min which is `1800`.
Maximum time in seconds for direct connections.
schema:
type: integer
default: 1800
minimum: 0
- name: fastestDirectFactor
in: query
required: false
description: |
Optional. Experimental. Default is `1.0`.
Factor with which the duration of the fastest direct connection is multiplied.
Values > 1.0 allow connections that are slower than the fastest direct connection to be found.
schema:
type: number
default: 1.0
minimum: 0
- name: timeout
in: query
required: false
description: Optional. Query timeout in seconds.
schema:
type: integer
minimum: 0
- name: passengers
in: query
required: false
description: Optional. Experimental. Number of passengers (e.g. for ODM or price calculation)
schema:
type: integer
minimum: 1
- name: luggage
in: query
required: false
description: |
Optional. Experimental. Number of luggage pieces; base unit: airline cabin luggage (e.g. for ODM or price calculation)
schema:
type: integer
minimum: 1
- name: withFares
in: query
required: false
description: Optional. Experimental. If set to true, the response will contain fare information.
schema:
type: boolean
default: false
responses:
'200':
description: routing result
content:
application/json:
schema:
type: object
required:
- requestParameters
- debugOutput
- from
- to
- direct
- itineraries
- previousPageCursor
- nextPageCursor
properties:
requestParameters:
description: "the routing query"
type: object
additionalProperties:
type: string
debugOutput:
description: "debug statistics"
type: object
additionalProperties:
type: integer
from:
$ref: '#/components/schemas/Place'
to:
$ref: '#/components/schemas/Place'
direct:
description: |
Direct trips by `WALK`, `BIKE`, `CAR`, etc. without time-dependency.
The starting time (`arriveBy=false`) / arrival time (`arriveBy=true`) is always the queried `time` parameter (set to \"now\" if not set).
But all `direct` connections are meant to be independent of absolute times.
type: array
items:
$ref: '#/components/schemas/Itinerary'
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/one-to-many:
get:
tags:
- routing
summary: |
Street routing from one to many places or many to one.
The order in the response array corresponds to the order of coordinates of the \`many\` parameter in the query.
operationId: oneToMany
parameters:
- name: one
in: query
required: true
description: geo location as latitude;longitude
schema:
type: string
- name: many
in: query
required: true
description: geo locations as latitude;longitude,latitude;longitude,...
schema:
type: array
items:
type: string
- name: mode
in: query
required: true
description: |
routing profile to use (currently supported: \`WALK\`, \`BIKE\`, \`CAR\`)
schema:
$ref: '#/components/schemas/Mode'
- name: max
in: query
required: true
description: maximum travel time in seconds
schema:
type: number
- name: maxMatchingDistance
in: query
required: true
description: maximum matching distance in meters to match geo coordinates to the street network
schema:
type: number
- name: arriveBy
in: query
required: true
description: |
true = many to one
false = one to many
schema:
type: boolean
responses:
200:
description: |
A list of durations.
If no path was found, the object is empty.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Duration'
/api/experimental/one-to-all:
get:
tags:
- routing
summary: |
Computes all reachable locations from a given stop within a set duration.
Each result entry will contain the fastest travel duration and the number of connections used.
operationId: oneToAll
parameters:
- name: one
in: query
required: true
description: stop id of the starting or ending stop
schema:
type: string
- name: time
in: query
required: false
description: |
Optional. Defaults to the current time.
Departure time ($arriveBy=false) / arrival date ($arriveBy=true),
schema:
type: string
format: date-time
- name: maxTravelTime
in: query
required: true
description: maximum travel time in minutes
schema:
type: integer
- name: arriveBy
in: query
required: false
description: |
true = all to one
false = one to all
schema:
type: boolean
default: false
- 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: minTransferTime
in: query
required: false
description: |
Optional. Default is 0 minutes.
Minimum transfer time for each transfer in minutes.
schema:
type: integer
default: 0
- name: additionalTransferTime
in: query
required: false
description: |
Optional. Default is 0 minutes.
Additional transfer time reserved for each transfer in minutes.
schema:
type: integer
default: 0
- name: transferTimeFactor
in: query
required: false
description: |
Optional. Default is 1.0
Factor to multiply minimum required transfer times with.
Values smaller than 1.0 are not supported.
schema:
type: number
default: 1.0
- name: useRoutedTransfers
in: query
required: false
description: |
Optional. Default is `false`.
Whether to use transfers routed on OpenStreetMap data.
schema:
type: boolean
default: false
- name: pedestrianProfile
in: query
required: false
description: |
Optional. Default is `FOOT`.
Accessibility profile to use for pedestrian routing in transfers
between transit connections and the first and last mile respectively.
schema:
$ref: '#/components/schemas/PedestrianProfile'
default: FOOT
- name: transitModes
in: query
required: false
description: |
Optional. Default is `TRANSIT` which allows all transit modes (no restriction).
Allowed modes for the transit part. If empty, no transit connections will be computed.
For example, this can be used to allow only `METRO,SUBWAY,TRAM`.
schema:
default:
- TRANSIT
type: array
items:
$ref: '#/components/schemas/Mode'
explode: false
- name: requireBikeTransport
in: query
required: false
schema:
type: boolean
default: false
description: |
Optional. Default is `false`.
If set to `true`, all used transit trips are required to allow bike carriage.
responses:
200:
description: |
The starting position and a list of all reachable stops
If no paths are found, the reachable list is empty.
content:
application/json:
schema:
$ref: '#/components/schemas/Reachable'
/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
- name: type
in: query
required: false
description: |
Optional. Default is all types.
Only return results of the given type.
For example, this can be used to allow only `ADDRESS` and `STOP` results.
schema:
$ref: '#/components/schemas/LocationType'
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
- name: type
in: query
required: false
description: |
Optional. Default is all types.
Only return results of the given types.
For example, this can be used to allow only `ADDRESS` and `STOP` results.
schema:
$ref: '#/components/schemas/LocationType'
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)
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: time
in: query
required: false
description: |
Optional. Defaults to the current time.
schema:
type: string
format: date-time
- 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: direction
in: query
required: false
schema:
type: string
enum:
- EARLIER
- LATER
description: |
This parameter will be ignored in case `pageCursor` is set.
Optional. Default is
- `LATER` for `arriveBy=false`
- `EARLIER` for `arriveBy=true`
The response will contain the next `n` arrivals / departures
in case `EARLIER` is selected and the previous `n`
arrivals / departures if `LATER` is selected.
- name: mode
in: query
schema:
type: array
items:
$ref: '#/components/schemas/Mode'
default:
- TRANSIT
description: |
Optional. Default is all transit modes.
Only return arrivals/departures of the given modes.
- name: n
in: query
schema:
type: integer
required: true
description: the number of events
- name: radius
in: query
schema:
type: integer