-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yml
3095 lines (3080 loc) · 154 KB
/
swagger.yml
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
swagger: "2.0"
info:
title: "Amadeus Travel Innovation Sandbox"
version: "1.2"
contact:
name: Amadeus Innovation and Research
url: "https://sandbox.amadeus.com"
license:
name: Amadeus Travel Innovation Sandbox License
url: "https://sandbox.amadeus.com/terms-use"
host: api.sandbox.amadeus.com
basePath: /v1.2
schemes:
- https
produces:
- application/json
paths:
/flights/inspiration-search:
get:
operationId: Flight Inspiration Search
summary: Flight Inspiration Search - Go beyond the traditional search by origin, destination and dates to meet the needs of travelers looking for suggestions and a search experience that reflects the way they choose their trip. This can help you answer the question "Where can I go within a given travel budget?"
description: |
<p>The Inspiration Flight Search allows you to find the prices of one-way and return flights from an origin city without necessarily having a destination, or even a flight date, in mind. The search doesn't return a distinct set of price options, but rather, can tell you the price of flying from a given city to some destination, for a trip of a given duration, that falls within a given date range.</p>
<p>The search is based on our Extreme Search platform, which continually caches a large number of flight search results from a list of origin cities to a variety of destinations. Since it's a cached search, the response time is fast, but not all origin airports are available. Here is <a href="https://github.com/amadeus-travel-innovation-sandbox/sandbox-content/blob/master/flight-search-cache-origin-destination.csv">a list of the currently supported origin-destination IATA location pairs</a>. We try to keep this list as fresh as possible for you, but be aware that it may not always be exactly up-to-date and it can change without warning.</p>
<p>Despite this limitation don't underestimate the power of this API. Thanks to its quick response speed you can easily pair it with other APIs to provide a low fare and inspiration for any destination. For example, you can could combine it with a event search API and suggest a total price to see go and see an concert or a game in a selection of cities.</p>
parameters:
- name: apikey
in: query
description: API Key provided for your account, to identify you for API access. Make sure to keep this API key secret.
required: true
type: string
- name: origin
in: query
description: <a href="https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code">IATA code</a> of the city from which the traveler will depart. See the location and airport interfaces for more information.
required: true
type: string
default: "NYC"
- name: destination
in: query
description: <a href="https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code">IATA code</a> of the city to which the traveler is going
required: false
type: string
default: "LAX"
- name: departure_date
in: query
description: Range of dates between which the traveler could depart. Dates are specified in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> yyyy-MM-dd date format. Ranges are inclusive and ranges of months will apply from the start to the end of the month. If just a single date is specified, only that date will be searched. By default, the date range starts today and applies up to 361 in the future is applied. Past dates are generally not supported, future dates should be in the next 361 days, although results start to become sparse after about 6 months in the future, as airlines may still be defining their schedules. The default is to search all future dates available.
required: false
type: string
default: "2016-11-16--2016-11-26"
- name: one-way
in: query
required: false
type: boolean
default: false
description: When set to true, the query will be for a single trip from the origin to the destination. When this parameter is not provided, or is set to false, the query is for a round trip from the origin to the destination and back again.
- name: duration
in: query
description: The allowed duration or range of durations of the trip, in days. This parameter must not be set if the one-way parameter is set to true.
required: false
type: string
default: "1--15"
- name: direct
in: query
description: Limit the search to results that do not require the passenger to change plane?
required: false
type: boolean
default: false
- name: max_price
in: query
description: "Maximum price of trips to find in the result set, in the currency specified for this origin and destination pair in the cache contents spreadsheet. So, for example, if the origin is NYC, and the max price is 400, this means 400 USD. If the origin is PAR, and the max price is 400, this means 400 EUR. By default, no limit is applied"
required: false
type: string
format: Integer
- name: aggregation_mode
in: query
description: "Specifies the granularity of results to be found. DESTINATION is the default and finds one result per city. COUNTRY finds one result per country, DAY finds on result for every day in the date range, WEEK finds one result for every week in the date range. Note that specifying a small granularity but a large search scope may result in a huge output. For some very large outputs, the API may refuse to provide a result."
required: false
type: string
responses:
200:
description: Valid Search Response
schema:
$ref: "#/definitions/ExtremeSearchResponse"
default:
description: Client or server error
schema:
$ref: "#/definitions/Error"
/flights/extensive-search:
get:
operationId: Flight Extensive Search
summary: Flight Extensive Search - Build travel searches based on very flexible and open range of dates. You can use it to answer questions such as "When is the best date to fly...". It's built on Amadeus' Featured Results technology, which returns thousands of results (prices, itineraries and dates) in a matter of milliseconds. Results are available over half a calendar year with a 1 to 15 day stay duration
description: |
<p>The Extensive Flight Search allows you to find the prices of one-way or return flights between two airports over a large number of dates, and for a large variety of stay durations. The search doesn't return exact itineraries, but rather tells you the best price for a flight on a given day, for a stay of a given duration.</p>
<p>The search is based on our Extreme Search platform, which continually caches a large number of flight search results from a list of origin cities to a variety of destinations. Since it's a cached search, the response time is fast, but not all origin airports are available. Here is <a href="https://github.com/amadeus-travel-innovation-sandbox/sandbox-content/blob/master/flight-search-cache-origin-destination.csv">a list of the currently supported origin-destination IATA location pairs</a>. We try to keep this list as fresh as possible for you, but be aware that it may not always be exactly up-to-date and it can change without warning.</p>
<p>That said, a price graph like this provides a powerful bargin shopping tool - allowing travelers with flexible itineraries to identify days on which they can get the cheapest flights to their destinations.</p>
parameters:
- name: apikey
in: query
description: API Key provided for your account, to identify you for API access. Make sure to keep this API key secret.
required: true
type: string
- name: origin
in: query
description: <a href="https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code">IATA code</a> of the city from which the traveler will depart. See the location and airport interfaces for more information.
required: true
type: string
default: "FRA"
- name: destination
in: query
description: <a href="https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code">IATA code</a> of the city to which the traveler is going
required: true
type: string
default: "LON"
- name: departure_date
in: query
description: |
Range of dates between which the traveler could depart. Dates are specified in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> yyyy-MM-dd date format. Ranges are inclusive and ranges of months will apply from the start to the end of the month. If just a single date is specified, only that date will be searched. By default, the date range starts today and applies up to 361 in the future is applied. Past dates are generally not supported, future dates should be in the next 361 days, although results start to become sparse after about 6 months in the future, as airlines may still be defining their schedules. The default is to search all future dates available.
required: false
type: string
default: "2016-11-16--2016-11-26"
- name: one-way
in: query
required: false
type: boolean
default: false
description: When set to true, the query will be for a single trip from the origin to the destination. When this parameter is not provided, or is set to false, the query is for a round trip from the origin to the destination and back again.
- name: duration
in: query
description: The allowed duration or range of durations of the trip, in days. This parameter must not be set if the one-way parameter is set to true.
required: false
type: string
default: "1--15"
- name: direct
in: query
description: Limit the search to results that do not require the passenger to change plane?
required: false
type: boolean
default: false
- name: max_price
in: query
description: "Maximum price of trips to find in the result set, in the currency specified for this origin and destination pair in the cache contents spreadsheet. So, for example, if the origin is NYC, and the max price is 400, this means 400 USD. If the origin is PAR, and the max price is 400, this means 400 EUR. By default, no limit is applied"
required: false
type: string
default: "950"
- name: aggregation_mode
in: query
description: "Specifies the granularity of results to be found. DAY is the default when one-way is true finds a result for departure date in the date range. STAY is the default otherwise and finds all round trip permutations for this route withim the given date range. DESTINATION finds one result, only the cheapest price for this route over the provided date range. WEEK finds the cheapest result for every week in the date range. Note that specifying a small granularity but a large search scope may result in a huge output. For some very large outputs, the API may refuse to provide a result."
required: false
type: string
default: "DAY"
responses:
200:
description: Valid Search Response
schema:
$ref: "#/definitions/ExtremeSearchResponse"
default:
description: Client or server error
schema:
$ref: "#/definitions/Error"
/flights/low-fare-search:
get:
operationId: Flight Low-Fare Search
summary: Flight Low-Fare Search - Find the cheapest one way or return itineraries and fares between two airports at specific dates.
description: |
<p>This is the low fare search engine Amadeus uses to retrieve the best price for flights, based on our latest Master Pricer Travel Board technology. This document describes how to make a low fare search and how to handle the returned messages.</p>
<p>The message is composed of multiple results for given request. A result is defined by a unique combination of price, tax, passenger type, fare type, cabin, and availability for each requested segment.</p>
<p>A result is then composed of single or multiple itineraries. Each itinerary is composed of an outbound leg, and, if a return date was specified, an inbound leg. Each leg is composed of a list of one or more flights, that the traveller will be required to take in order to get from the origin airport to the destination airport.</p>
parameters:
- name: apikey
in: query
description: API Key provided for your account, to identify you for API access. Make sure to keep this API key secret.
required: true
type: string
- name: origin
in: query
description: City code from which the traveler will depart. See the location and airport interfaces for more information.
required: true
type: string
default: "BOS"
- name: destination
in: query
description: <a href="https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code">IATA code</a> of the city to which the traveler is going
required: true
type: string
default: "LON"
- name: departure_date
in: query
description: The date on which the traveler will depart from the origin to go to the destination. You can specify a date range of up to 2 days. For a larger date range, use the Extensive Search. Dates are specified in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> yyyy-MM-dd date format and separated by --.
required: true
format: string
type: string
default: "2016-11-25"
- name: return_date
in: query
description: The date on which the traveler will depart from the destination to return to the origin. If this parameter is not specified, the search will find only one-way trips. If this, or the return_by parameter are specified, only return trips are found. You can specify a date range of up to 2 days.
required: false
type: string
default: "2016-11-28"
- name: arrive_by
in: query
description: The datetime by which the outbound flight should arrive, based on local time at the destination airport. Date-times are specified in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> yyyy-MM-ddTHH:mm date format
required: false
type: string
default: "2016-11-25T16:00"
- name: return_by
in: query
description: The time by which the inbound flight should arrive, based on local time at the airport specified as the origin parameter
required: false
type: string
default: "2016-11-28T08:00"
- name: adults
in: query
description: "The number of adult (age 12 and over) passengers traveling on this flight."
required: false
type: integer
default: 1
- name: children
in: query
description: "The number of child (younger than age 12 on date of departure) passengers traveling on this flight who will each have their own separate seat"
required: false
type: integer
default: 0
- name: infants
in: query
description: "The number of infant (younger than age 2 on date of departure) passengers traveling on this flight. Infants travel in the lap of an adult passenger, and thus the number of infants must not exceed the number of adults."
required: false
type: integer
default: 0
- name: include_airlines
in: query
description: If specified, all results will include at least one flight where one or more of these airlines is the marketing carrier. This behaves as an OR function. Airlines are specified using <a href="https://en.wikipedia.org/wiki/Airline_codes"><a href="https://en.wikipedia.org/wiki/Airline_codes">IATA airline code</a>s</a>.
required: false
type: array
items:
type: string
collectionFormat: csv
- name: exclude_airlines
in: query
description: If specified, no results will include any flights where any of these airlines is the marketing carrier. Airlines are specified using <a href="https://en.wikipedia.org/wiki/Airline_codes"><a href="https://en.wikipedia.org/wiki/Airline_codes">IATA airline code</a>s</a>.
required: false
type: array
items:
type: string
collectionFormat: csv
- name: nonstop
in: query
description: Setting this to true will find only flights that do not require the passenger to change from one flight to another
required: false
type: boolean
default: false
- name: max_price
in: query
description: "Maximum price of trips to find in the result set, in USD (US dollars) unless some other currency code is specified. By default, no limit is applied"
required: false
type: integer
default: 980
- name: currency
in: query
description: The preferred <a href="https://en.wikipedia.org/wiki/ISO_4217">currency</a> for the results
required: false
type: string
default: "USD"
- name: travel_class
in: query
description: "Searches for results where the majority of the itinerary flight time should be in a the specified cabin class or higher"
required: false
type: string
default: "ECONOMY"
- name: number_of_results
in: query
description: "The number of results to display. This will not be strictly interpreted but used as a guideline to display a useful number of results. By default, the number of results is dynamically determined. A maximum of 250 results will be displayed."
required: false
type: integer
default: 5
responses:
200:
description: Valid Search Response
schema:
$ref: "#/definitions/LowFareSearchResponse"
default:
description: Client or server error
schema:
$ref: "#/definitions/Error"
/flights/affiliate-search:
get:
operationId: Flight Affiliate Search
summary: Flight Affiliate Search - Use Travel Audience Connect's affiliate network API to search flights from our list of partners and provides deep-links to allow the user to book directly on the airline website.
description: |
<p>The Flight Affiliate Search API combines Amadeus' flight search technology with Travel Audience's Connect API partners to provide a unique flight search, where all results come with deep-links to book the flight at a partner's website. The API will let you easily provide the traveler with a path to book flights from your application.</p>
<p>Travel Audience Connect partners include
<ul>
<li><a href="http://www.cityjet.com/">CityJet</a>, <a href="https://www.aireuropa.com/en/flights">Air Europa</a> and <a href="http://www.flytap.com/">TAP</a> in Western Europe,</li>
<li><a href="http://uralairlines.com/">Ural Airlines</a> in Russia, </li>
<li><a href="http://www.avianca.com.br/">Avianca Brazil</a> and</li>
<li><a href="http://www.jal.com/">JAL</a> in East Asia</li>
</ul>
</p>
<p>Only Travel Audience Connect partner airlines are searched. For an up-to-date list of routes, see the route maps on each partners respective websites above. You can earn commission using the deep links provided in the search results if you sign up for an account at <a href="http://connect.travelaudience.com/">connect.travelaudience.com</a>.</p>
parameters:
- name: apikey
in: query
description: API Key provided for your account, to identify you for API access. Make sure to keep this API key secret.
required: true
type: string
- name: origin
in: query
description: City code from which the traveler will depart. See the location and airport interfaces for more information.
required: true
type: string
default: "LON"
- name: destination
in: query
description: <a href="https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code">IATA code</a> of the city to which the traveler is going
required: true
type: string
default: "DUB"
- name: departure_date
in: query
description: "The date on which the traveler will depart from the origin to go to the destination. The maximum scope for a date range is 2 days, for a larger scope, use the Extensive Search! "
required: true
type: string
default: "2016-11-25"
- name: return_date
in: query
description: "The date on which the traveler will depart from the destination to return to the origin. If this parameter is not specified, the search will find only one-way trips. If this, or the return_by parameter are specified, only return trips are found"
required: false
type: string
default: "2016-11-28"
- name: adults
in: query
description: "The number of adult (age 12 and over) passengers traveling on this flight."
required: false
type: integer
default: 1
- name: children
in: query
description: "The number of child (younger than age 12 on date of departure) passengers traveling on this flight who will each have their own separate seat"
required: false
type: integer
default: 0
- name: infants
in: query
description: "The number of infant (younger than age 2 on date of departure) passengers traveling on this flight. Infants travel in the lap of an adult passenger, and thus the number of infants must not exceed the number of adults."
required: false
type: integer
default: 0
- name: include_merchants
in: query
description: If specified, all results will include at least one flight where one or more of these airlines is the marketing carrier. Airlines are specified using <a href="https://en.wikipedia.org/wiki/Airline_codes"><a href="https://en.wikipedia.org/wiki/Airline_codes">IATA airline code</a>s</a>
required: false
type: array
items:
type: string
collectionFormat: csv
- name: exclude_merchants
in: query
description: If specified, no results will include any flights where any of these airlines is the marketing carrier. Airlines are specified using <a href="https://en.wikipedia.org/wiki/Airline_codes"><a href="https://en.wikipedia.org/wiki/Airline_codes">IATA airline code</a>s</a>
required: false
type: array
items:
type: string
collectionFormat: csv
- name: max_price
in: query
description: "Maximum price of trips to find in the result set, in USD (US dollars) unless some other currency code is specified. By default, no limit is applied"
required: false
type: integer
default: 980
- name: currency
in: query
description: The preferred <a href="https://en.wikipedia.org/wiki/ISO_4217">currency</a> for the results
required: false
type: string
default: "EUR"
- name: mobile
in: query
description: "Setting this to true will show mobile web deeplinks "
required: false
type: boolean
default: false
responses:
200:
description: Valid Search Response
schema:
$ref: "#/definitions/AffiliateSearchResponse"
default:
description: Client or server error
schema:
$ref: "#/definitions/Error"
/location/{code}:
get:
operationId: Location Information
summary: Location Information - Find more information about any IATA city or airport location code. With this API, you can find information such as city and airport names and locations, as well as information on timezones and airport usage.
description: |
<p>This service retrieves the location information corresponding to a IATA city or airport code.</p>
<p>When provided with an <a href="https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code">IATA code</a>, the service determines whether this code could relate to a city code, an airport code or both. If the city could contain multiple airports, it will return all possible airports that correspond to that city code.</p>
<p>This API is based on the Amadeus supported <a href="http://opentraveldata.github.io/geobases">Geobases</a> open-source project. If you wish to make your own database with all IATA location information, in order to get faster reponses, you can download the latest raw data from their <a href="https://github.com/opentraveldata/opentraveldata/blob/master/opentraveldata/optd_por_public.csv">github page</a>.</p>
parameters:
- name: apikey
in: query
description: API Key provided for your account, to identify you for API access. Make sure to keep this API key secret.
required: true
type: string
- name: code
in: path
description: IATA location code for which further information is required
required: true
type: string
default: BOS
responses:
200:
description: Valid Location lookup Response
schema:
$ref: "#/definitions/LocationResponse"
default:
description: Client or server error
schema:
$ref: "#/definitions/Error"
/airports/autocomplete:
get:
operationId: Airport Autocomplete
summary: Airport Autocomplete - Find an IATA location code for flight search based on a city or airport name using the term parameter. By only using the country parameter, this API is also able to find all the IATA location codes associated with a country. Both term and country parameters can be used together to filter the results accordingly. The API is fully JQuery-Autocomplete compatible to enable you to quickly build a drop-down list for your users to find the right airport easily.
description: |
<p>Using the term parameter and given the start of any word in an airport's official name, a city name, or the start of an <a href="https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code">IATA code</a>, this API provides the full name and IATA location code of the city or airport, for use in flight searches. Only major cities and civilian airports with several commercial flights per week are included by default. The response provides up to 20 possible matches, sorted by importance, in a <a href="http://jqueryui.com/autocomplete/">JQuery UI Autocomplete</a> compatible format. <a href="https://github.com/amadeus-travel-innovation-sandbox/sandbox-content/blob/master/airport-autocomplete-template.html">This sample implementation</a> using JQuery UI may help. This API uses data from the <a href="https://github.com/opentraveldata/opentraveldata/blob/master/opentraveldata/optd_por_public.csv">OpenTravelData</a> project.
</p>
<p>By only using the country parameter, this API is also able to find all the IATA location codes associated with a country. Both term and country parameters can be used together to filter the results accordingly.
</p>
<p>The value returned is the IATA location code. The label returned is always in UTF-8 format, with the airport official name (which is often in the native language), in the format of English City Name (if not already included in the airport name).</p>
parameters:
- name: apikey
in: query
description: API Key provided for your account, to identify you for API access. Make sure to keep this API key secret.
required: true
type: string
- name: term
in: query
description: Search keyword that should represent the start of a word in a city or airport name.
required: false
type: string
default: "Ban"
- name: country
in: query
description: Identified a country based of a <a href="https://en.wikipedia.org/wiki/ISO_3166-2#Current_codes">ISO 3166-1 alpha-2 code</a>
required: false
type: string
default: "US"
- name: all_airports
in: query
description: Boolean to include or not all airports, no matter their traffic rank. False by default, to only display relevant airports.
required: false
type: boolean
default: false
responses:
200:
description: Valid Search Response
schema:
type: array
items:
$ref: "#/definitions/AirportAutocompleteResponse"
default:
description: Client or server error
schema:
$ref: "#/definitions/Error"
/airports/nearest-relevant:
get:
operationId: Nearest Relevant Airport
summary: Nearest Relevant Airport - Find the most useful nearby airport to a given location.
description: |
<p>This service gives the most relevant airports in a radius of 500 km around the given coordinates. The relevance of an airport is computed by dividing the number of airport movements (take offs and landings) by the distance from the point. This causes the relevance of an airport to increase exponentially as you approach it.</p>
<p>To minimize response time, all distances are computed as a <a href="http://en.wikipedia.org/wiki/Great-circle_distance">great-circle distance</a> from the provided coordinates to the airport coordinates, and thus do not take into account traffic conditions, international boundaries, mountains, water, or other elements that might make the a nearby airport hard to reach.</p>
<p>Only civilian airports with at least several commercial flights per week are included in the results.</p>
<p>The result is a list of airports sorted by decreasing relevance. It always contains the nearest airport with significant commercial traffic. You can freely download the <a href="https://github.com/opentraveldata/opentraveldata/blob/master/opentraveldata/optd_por_public.csv">point of reference information</a> used by this API from the <a href="https://github.com/opentraveldata/opentraveldata">Open Travel Data</a> project.</p>
parameters:
- name: apikey
in: query
description: API Key provided for your account, to identify you for API access. Make sure to keep this API key secret.
required: true
type: string
- name: latitude
in: query
description: Latitude location to be at the center of your search circle.
required: true
type: string
default: "46.6734"
- name: longitude
in: query
description: Longitude location to be at the center of your search circle.
required: true
type: string
default: "-71.7412"
responses:
200:
description: Valid Search Response
schema:
type: array
items:
$ref: "#/definitions/NearestAirport"
default:
description: Client or server error
schema:
$ref: "#/definitions/Error"
/hotels/search-airport:
get:
operationId: Hotel Airport Search
summary: Hotel Airport Search - Locate the cheapest available rooms near a given airport, for a given stay period. This API is ideal if you want to connect flight and hotels. Provide an IATA airport code, as well as the check-in and check-out dates, and get a list of up to 140 properties (names, codes, image, amenities) with their locations and rates. Optional parameters such as currency and maximum rates, amenities or hotel chain codes are also available and can be used to narrow down the results. More optional parameters such as show_sold_out & rooms can be used to show sold out rooms and all available rooms.
description: |
<p>A fast Hotel shopping API to see which hotels are available in a given area, on a given day and displays their lowest prices. With this API you can find out the price of the cheapest daily rate for all hotels near a given airport.</p>
<p>This API allows you to quickly see the locations of hotels near a given airport, and what prices in that area look like. Note that hotel images are not available to users outside of Amadeus, as we are not licensed to redistribute them. The API is based on our high-speed hotel pricing cache, which is also used to power the <a href="https://hotelsearchengine.amadeus.com/">Amadeus Hotel Search Engine</a> application. Results are returned very quickly, response times are generally under 2s. Our cache has great global coverage and is constantly refreshed with the latest prices.</p>
parameters:
- name: apikey
in: query
description: API Key provided for your account, to identify you for API access. Make sure to keep this API key secret.
required: true
type: string
- name: location
in: query
description: <a href="https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code">IATA airport code</a> for hotel availability is required requested.
required: true
type: string
default: "BOS"
- name: check_in
in: query
description: "Date on which the guest will begin their stay in the hotel. Past availability is not displayed, future availability becomes less useful from about 6 months from the current date."
required: true
type: string
default: "2016-11-15"
- name: check_out
in: query
description: "Date on which the guest will end their stay in the hotel."
required: true
type: string
default: "2016-11-16"
- name: radius
in: query
description: Radius around the center to look for hotels in kilometers (km).
required: false
type: integer
default: 42
- name: lang
in: query
description: "The preferred language of the content related to each hotel. Content will be returned in this language if available."
required: false
type: string
default: "EN"
- name: currency
in: query
description: The preferred <a href="https://en.wikipedia.org/wiki/ISO_4217">currency</a> for the results
required: false
type: string
default: "USD"
- name: chain
in: query
description: "Narrows the hotel search to a given hotel provider. The hotel chain is indicated by the first two characters of the property code."
required: false
type: string
default: "6C"
- name: max_rate
in: query
description: "The maximum amount per night that any hotel in the shopping response should cost. This is calculated by dividing the total price of the stay for the given dates by the number of nights specified falling between the check_in and check_out dates."
required: false
type: number
default: 500
- name: number_of_results
in: query
description: "The maximum number of hotels to return in the results set. Hotels are ordered by total price, so if more than the given maximum number of hotels are available, only the cheapest options are returned."
required: false
type: integer
default: 20
- name: all_rooms
in: query
description: "This option if enabled will return all hotel room rates, not just the lowest room rate. Note: This will have an impact on the response time due to the larger messages returned."
required: false
type: boolean
default: false
- name: show_sold_out
in: query
description: This option if enabled will return hotel names and addresses even if rooms are sold out (closed properties)
required: false
type: boolean
default: false
- name: amenity
in: query
description: |
Hotel <a href="hotels-api-supported-amenities-filter">amenities filter</a> to search narrow down hotels with certain amenities. For example: amenity=POOL. (Note: multiple amenities can be used in searches: amenity=PARKING&amenity=RESTAURANT&amenity=PETS_ALLOWED).
required: false
type: array
items:
type: string
collectionFormat: multi
responses:
200:
description: Valid Search Response
schema:
$ref: "#/definitions/HotelSearchResponse"
default:
description: Client or server error
schema:
$ref: "#/definitions/Error"
/hotels/search-circle:
get:
operationId: Hotel Geosearch by circle
summary: Hotel Geosearch by Circle API - Locate the cheapest available rooms within a given radius of a defined point for a given stay period.
description: |
<p>A fast Hotel shopping API to see which hotels are available in a given area, on a given day and displays their lowest prices. With this API you can find out the price of the cheapest daily rate for all hotels within a specified radius of a point.</p>
<p>This API allows you to quickly see the hotel locations in a region, and what prices in that area look like, as well as the check-in and check-out dates, and get list of up to 140 properties (names, codes, image, amenities) with their locations and rates. Optional parameters such as currency and maximum rates, amenities or hotel chain codes are also available and can be used to narrow down the results. More optional parameters such as show_sold_out & rooms can be used to show sold out rooms and all available rooms. </p>
<p>The API is based on our high-speed hotel pricing cache, which is also used to power the <a href="https://hotelsearchengine.amadeus.com/">Amadeus Hotel Search Engine</a> application. Results are returned very quickly, response times are generally under 2s. Our cache has great global coverage and is constantly refreshed with the latest prices.</p>
parameters:
- name: apikey
in: query
description: API Key provided for your account, to identify you for API access. Make sure to keep this API key secret.
required: true
type: string
- name: latitude
in: query
description: Latitude of the center of the search.
required: true
type: number
default: 36.0857
- name: longitude
in: query
description: Longitude of the center of the search.
required: true
type: number
default: -115.1541
- name: radius
in: query
description: Radius around the center to look for hotels in kilometers (km).
required: true
type: integer
default: 42
- name: check_in
in: query
description: "Date on which the guest will begin their stay in the hotel. Past availability is not displayed, future availability becomes less useful from about 6 months from the current date."
required: true
type: string
default: "2016-11-15"
- name: check_out
in: query
description: "Date on which the guest will end their stay in the hotel."
required: true
type: string
default: "2016-11-16"
- name: lang
in: query
description: "The preferred language of the content related to each hotel. Content will be returned in this language if available."
required: false
type: string
default: "EN"
- name: currency
in: query
description: The preferred <a href="https://en.wikipedia.org/wiki/ISO_4217">currency</a> for the results
required: false
type: string
default: "USD"
- name: chain
in: query
description: "Narrows the hotel search to a given hotel provider. The hotel chain is indicated by the first two characters of the property code."
required: false
type: string
default: "6C"
- name: max_rate
in: query
description: "The maximum amount per night that any hotel in the shopping response should cost. This is calculated by dividing the total price of the stay for the given dates by the number of nights specified falling between the check_in and check_out dates."
required: false
type: number
default: 500
- name: number_of_results
in: query
description: "The maximum number of hotels to return in the results set. Hotels are ordered by total price, so if more than the given maximum number of hotels are available, only the cheapest options are returned."
required: false
type: integer
default: 20
- name: all_rooms
in: query
description: "This option if enabled will return all hotel room rates, not just the lowest room rate. Note: This will have an impact on the response time due to the larger messages returned."
required: false
type: boolean
default: false
- name: show_sold_out
in: query
description: This option if enabled will return hotel names and addresses even if rooms are sold out (closed properties)
required: false
type: boolean
default: false
- name: amenity
in: query
description: |
Hotel <a href="hotels-api-supported-amenities-filter">amenities filter</a> to search narrow down hotels with certain amenities. For example: amenity=POOL. (Note: multiple amenities can be used in searches: amenity=PARKING&amenity=RESTAURANT&amenity=PETS_ALLOWED).
required: false
type: array
items:
type: string
collectionFormat: multi
responses:
200:
description: Valid Search Response
schema:
$ref: "#/definitions/HotelSearchResponse"
default:
description: Client or server error
schema:
$ref: "#/definitions/Error"
/hotels/search-box:
get:
operationId: Hotel Geosearch by box
summary: Hotel Geosearch by box - Locate the cheapest available rooms within a given rectangular region for a given stay period. It's ideal for displaying results on a map.
description: |
<p>A fast Hotel shopping API to see which hotels are available in a given area, on a given day and displays their lowest prices. With this API you can find out the price of the cheapest daily rate for all hotels within a specified geographical region.</p>
<p>This API allows you to quickly see the hotel locations in a region, and what prices in that area look like, as well as the check-in and check-out dates, and get a list of up to 140 properties (names, codes, image, amenities) with their locations and rates. Optional parameters such as currency and maximum rates, amenities or hotel chain codes are also available and can be used to narrow down the results. More optional parameters such as show_sold_out & rooms can be used to show sold out rooms and all available rooms.</p>
<p>The API is based on our high-speed hotel pricing cache, which is also used to power the <a href="https://hotelsearchengine.amadeus.com/">Amadeus Hotel Search Engine</a> application. Results are returned very quickly, response times are generally under 2s. Our cache has great global coverage and is constantly refreshed with the latest prices.</p>
parameters:
- name: apikey
in: query
description: API Key provided for your account, to identify you for API access. Make sure to keep this API key secret.
required: true
type: string
- name: south_west_corner
in: query
description: The coordinates of the south-west corner of the search box.
required: true
type: string
default: "38.8675,-77.1457"
- name: north_east_corner
in: query
description: The coordinates of the north-east corner of the search box.
required: true
type: string
default: "38.9072,-77.0632"
- name: check_in
in: query
description: "Date on which the guest will begin their stay in the hotel. Past availability is not displayed, future availability becomes less useful from about 6 months from the current date."
required: true
type: string
default: "2016-11-15"
- name: check_out
in: query
description: "Date on which the guest will end their stay in the hotel."
required: true
type: string
default: "2016-11-16"
- name: lang
in: query
description: "The preferred language of the content related to each hotel. Content will be returned in this language if available."
required: false
type: string
default: "EN"
- name: currency
in: query
description: The preferred <a href="https://en.wikipedia.org/wiki/ISO_4217">currency</a> for the results
required: false
type: string
default: "USD"
- name: chain
in: query
description: "Narrows the hotel search to a given hotel provider. The hotel chain is indicated by the first two characters of the property code."
required: false
type: string
default: "6C"
- name: max_rate
in: query
description: "The maximum amount per night that any hotel in the shopping response should cost. This is calculated by dividing the total price of the stay for the given dates by the number of nights specified falling between the check_in and check_out dates."
required: false
type: number
default: 500
- name: number_of_results
in: query
description: "The maximum number of hotels to return in the results set. Hotels are ordered by total price, so if more than the given maximum number of hotels are available, only the cheapest options are returned."
required: false
type: integer
default: 20
- name: all_rooms
in: query
description: "This option if enabled will return all hotel room rates, not just the lowest room rate. Note: This will have an impact on the response time due to the larger messages returned."
required: false
type: boolean
default: false
- name: show_sold_out
in: query
description: This option if enabled will return hotel names and addresses even if rooms are sold out (closed properties)
required: false
type: boolean
default: false
- name: amenity
in: query
description: |
Hotel <a href="hotels-api-supported-amenities-filter">amenities filter</a> to search narrow down hotels with certain amenities. For example: amenity=POOL. (Note: multiple amenities can be used in searches: amenity=PARKING&amenity=RESTAURANT&amenity=PETS_ALLOWED).
required: false
type: array
items:
type: string
collectionFormat: multi
responses:
200:
description: Valid Search Response
schema:
$ref: "#/definitions/HotelSearchResponse"
default:
description: Client or server error
schema:
$ref: "#/definitions/Error"
/hotels/{property_code}:
get:
operationId: Hotel Property Code Search
summary: Hotel Property Code Search - Find out more room and rate information once you have found your preferred hotel.
description: |
<p>This API allows you to quickly see the detailed information of a single hotel, including descriptions, address, GPS location, amenities, awards, lowest priced room and all room prices and booking information. </p>
<p>This API gives you more information on a specific property. Optional parameters such as show_sold_out & rooms can be used to show sold out rooms and all available rooms. </p>
<p>The API is based on our high-speed hotel pricing cache, which is also used to power the <a href="https://hotelsearchengine.amadeus.com/">Amadeus Hotel Search Engine</a> application. Results are returned very quickly, response times are generally under 2s. Our cache has great global coverage and is constantly refreshed with the latest prices.</p>
parameters:
- name: apikey
in: query
description: API Key provided for your account, to identify you for API access. Make sure to keep this API key secret.
required: true
type: string
- name: property_code
in: path
description: A Hotel property code based on 2 letter chain code + 3 letter <a href="https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code">IATA code</a> of the city + 3 char property unique id.
required: true
type: string
default: "BWDCA133"
- name: check_in
in: query
description: "Date on which the guest will begin their stay in the hotel. Past availability is not displayed, future availability becomes less useful from about 6 months from the current date."
required: true
type: string
default: "2016-11-14"
- name: check_out
in: query
description: "Date on which the guest will end their stay in the hotel."
required: true
type: string
default: "2016-11-15"
- name: lang
in: query
description: "The preferred language of the content related to each hotel. Content will be returned in this language if available."
required: false
type: string
default: "EN"
- name: currency
in: query
description: The preferred <a href="https://en.wikipedia.org/wiki/ISO_4217">currency</a> for the results
required: false
type: string
default: "USD"
- name: all_rooms
in: query
description: "This option if enabled will return all hotel room rates, not just the lowest room rate. Note: This will have an impact on the response time due to the larger messages returned."
required: false
type: boolean
default: true
- name: show_sold_out
in: query
description: This option if enabled will return hotel names and addresses even if rooms are sold out (closed properties)
required: false
type: boolean
default: false
responses:
200:
description: Valid Lookup Response
schema:
$ref: "#/definitions/HotelPropertyResponse"
default:
description: Client or server error
schema:
$ref: "#/definitions/Error"
/cars/search-airport:
get:
operationId: Car Rental Airport Search
summary: Car Rental Airport Search - Find car rental providers and rates when you provide an airport code, as well as the pick-up and drop-off dates. Optional parameters such as currency and rental provider codes are also available and can be used to narrow down the results. This API is an ideal pairing with the flight and hotel search to provide ground transportation options at the destination.
description: |
<p>With this API you can find out the price and type of car, for all car rental providers, near a specified airport.</p>
<p>You can quickly see the locations of car providers near a given airport, and what cars are available to rent, and at what prices. This API is based on our car pricing service that gets live availability from car providers, and is used to power a variety of airline and travel agency websites.</p>
<p>Results are validated from car providers, and thus response times may take up to 10 seconds (response times are typically about 5s), and the number of concurrent calls is throttled per user to avoid flooding our provider's systems. However, this means the final result is guaranteed to be live and accurate.</p>
<p>The configuration of this API allows search for car rentals in the rental location where the car is picked up (at the start of the rental), is the same as the one where it will be dropped off.</p>
parameters:
- name: apikey
in: query
description: API Key provided for your account, to identify you for API access. Make sure to keep this API key secret.
required: true
type: string
- name: location
in: query
description: The <a href="https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code">IATA code</a> of the airport at which the car will be rented.
required: true
type: string
default: "NCE"
- name: pick_up
in: query
description: "Date on which the car rental will be collected from the car rental location. If no time is provided, a default value of 09:00 is used. Past availability is not displayed, future availability becomes less useful from about 6 months from the current date."
required: true
type: string
default: "2016-11-07"
- name: drop_off
in: query
description: "Date at which the car rental will end and the car will be returned to the rental location. If no time is provided, a default value of 17:00 is used."
required: true
type: string
default: "2016-11-08"
- name: lang
in: query
description: "The preferred language of the content related to each car rental. Content will be returned in this language if available."
required: false
type: string
default: "EN"
- name: currency
in: query
description: The preferred <a href="https://en.wikipedia.org/wiki/ISO_4217">currency</a> to use when displaying prices and rates related to the car rental.
required: false
type: string
default: "USD"
- name: provider
in: query
description: "2 character car rental provider code. You may provide this parameter more than once. "
required: false
type: string
default: "ZI"
- name: rate_class
in: query
description: "Allows to request specific rate types."
required: false
type: string
default: "ALL"
- name: rate_plan
in: query
description: "Qualifies the rate depending on the pickup date and the rental duration."
required: false
type: string
default: "DAILY"
- name: rate_filter
in: query
description: "Defines the types of rates to be returned in the output"
required: false
type: string
default: "ESTIMATED"
enum: [AVAILABLE, ESTIMATED, ALL]
- name: vehicle
in: query
description: "Specifies the type of vehicle to be rented. If selected, the results set will include only vehicles that match these type descriptions. The enumerations above correspond to ACRISS Pseudo Codes, and you may also provide an ACRISS pseudo code directly. If specifying a vehicle-specific ACRISS code, you may provide this parameter up to 3 times."
required: false
type: array
items:
type: string
collectionFormat: multi
responses:
200:
description: Valid Search Response
schema:
$ref: "#/definitions/CarSearchResponse"
default:
description: Client or server error
schema:
$ref: "#/definitions/Error"
/cars/search-circle:
get:
operationId: Car Rental Geosearch
summary: Car Rental Geosearch - Locate car rental providers and available vehicles when you define a circular area with one coordinate and radius, as well as the pick-up and drop-off dates. Optional parameters such as currency and rental provider codes are also available and can be used to narrow down the results. This API is an ideal pairing with the flight and hotel search to provide ground transportation options at the destination.
description: |
<p>With this API you can find out the price and type of car, for all car rental providers, in a specified geographical location.</p>
<p>You can quickly see the locations of car providers near a given point, and what cars are available to rent, and at what prices. This API is based on our car pricing service that gets live availability from car providers, and is used to power a variety of airline and travel agency websites.</p>
<p>Results are validated from car providers, and thus response times may take up to 10 seconds (response times are typically about 5s), and the number of concurrent calls is throttled per user to avoid flooding our provider's systems. However, this means the final result is guaranteed to be live and accurate.</p>
<p>The configuration of this API allows search for car rentals in the rental location where the car is picked up (at the start of the rental), is the same as the one where it will be dropped off. </p>
parameters:
- name: apikey
in: query
description: API Key provided for your account, to identify you for API access. Make sure to keep this API key secret.
required: true
type: string
- name: latitude
in: query
description: Latitude of the center of the search.
required: true
type: number
default: 35.1504
- name: longitude
in: query
description: Longitude of the center of the search.
required: true
type: number
default: -114.57632
- name: radius
in: query
description: Radius around the center to look for hotels in kilometers (km).
required: true
type: integer
default: 42
- name: pick_up
in: query
description: "Date on which the car rental will be collected from the car rental location. If no time is provided, a default value of 09:00 is used. Past availability is not displayed, future availability becomes less useful from about 6 months from the current date."
required: true