-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathaerodatabox.opencollection.json
More file actions
1616 lines (1616 loc) · 81.9 KB
/
Copy pathaerodatabox.opencollection.json
File metadata and controls
1616 lines (1616 loc) · 81.9 KB
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
{
"opencollection": "1.0.0",
"info": {
"name": "AeroDataBox API - Aviation and Flight API",
"version": "1.14.0.0"
},
"items": [
{
"info": {
"name": "Aircraft API",
"type": "folder"
},
"items": [
{
"info": {
"name": "AeroDataBox Single Aircraft (by Tail-number, Mode-S or ID) / TIER 1",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/aircrafts/:searchBy/:searchParam",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "searchBy",
"value": "",
"type": "path",
"description": "Criteria to search aircraft by"
},
{
"name": "searchParam",
"value": "",
"type": "path",
"description": "Value of the search criteria. If `searchBy` is: \r\n* `id`: then this field should be an ID of an aircraft (as specified in the database of this API);\r\n* `reg`: then this field should be a tail-number of an aircraft (with or without spaces or dashes, any case formats are acceptable, e.g.PH-BXO, DeMhJ), multiple matches are possible - see below;\r\n* `icao24`, then this field should be a ICAO 24-bit Mode-S address of an aircraft specified in hexadecimal format (e.g. 484161, 483EFD), multiple matches are possible - see below.\r\n\r\n*If multiple matches are possible:*\r\n\r\nThere cannot be more than one aircraft actively flying with the same tail-number or ICAO 24-bit Mode-S address at any moment of time. \r\nHowever, historically aircraft tail-numbers or addresses may be used multiple times by different aircraft.\r\nThis endpoint is supposed to return a **single** aircraft data. In case if multiple aircraft satisfy the search criteria, the best match will be chosen as follows:\r\n* If an active aircraft is found according to the requested critera, it is returned.\r\n* Otherwise, an aircraft that used requested tail-number/address the most recently is returned. \r\n* If usage time may not be determined, the aircraft stored in the database the most recently is returned."
},
{
"name": "withImage",
"value": "",
"type": "query",
"description": "Should include aircraft image (default: false)."
},
{
"name": "withRegistrations",
"value": "",
"type": "query",
"description": "Should include the history of aircraft registrations (default: false)."
}
]
},
"docs": "*Returns:* Single aircraft, *best* matching specified search criteria, if found. Please note that all found aircraft will be impersonated with registration information matching the requested tail number or Mode-S even though an aircraft might be flying under a different registration right now."
},
{
"info": {
"name": "AeroDataBox Single Aircraft Registration History (by Tail-number, Mode-S or ID) / TIER 1",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/aircrafts/:searchBy/:searchParam/registrations",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "searchBy",
"value": "",
"type": "path",
"description": "Criteria to search aircraft by"
},
{
"name": "searchParam",
"value": "",
"type": "path",
"description": "Value of the search criteria. If `searchBy` is: \r\n* `id`, then this field should be an ID of an aircraft (as specified in the database of this API);\r\n* `reg`, then this field should be a tail-number of an aircraft (with or without spaces or dashes, any case formats are acceptable, e.g.PH-BXO, DeMhJ), multiple matches are possible - see below;\r\n* `icao24`, then this field should be a ICAO 24-bit Mode-S address of an aircraft specified in hexadecimal format (e.g. 484161, 483EFD), multiple matches are possible - see below.\r\n\r\n*If multiple matches are possible:* see similar remark to `Single aircraft` endpoint."
}
]
},
"docs": "*Returns:* A list of all known registrations of a single aircraft, *best* matching specified search criteria, if found"
},
{
"info": {
"name": "AeroDataBox Aircraft by Tail-number, Mode-S or ID / TIER 1",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/aircrafts/:searchBy/:searchParam/all",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "searchBy",
"value": "",
"type": "path",
"description": "Criteria to search aircraft by"
},
{
"name": "searchParam",
"value": "",
"type": "path",
"description": "Value of the search criteria. If `searchBy` is: \r\n* `id`, then this field should be an ID of an aircraft (as specified in the database of this API);\r\n* `reg`, then this field should be a tail-number of an aircraft (with or without spaces or dashes, any case formats are acceptable, e.g.PH-BXO, DeMhJ);\r\n* `icao24`, then this field should be a ICAO 24-bit Mode-S address of an aircraft specified in hexadecimal format (e.g. 484161, 483EFD)."
},
{
"name": "withImage",
"value": "",
"type": "query",
"description": "Should include aircraft image (default: false)."
},
{
"name": "withRegistrations",
"value": "",
"type": "query",
"description": "Should include the history of aircraft registrations (default: false)."
}
]
},
"docs": "*Returns:* A list of all aircraft ever matched the requested criteria. Please note that all found aircraft will be impersonated with registration information matching the requested tail number or Mode-S even though an aircraft might be flying under a different registration right now."
},
{
"info": {
"name": "AeroDataBox Airline Fleet / Aircraft List by Airline Code (BETA) / TIER 3",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/airlines/:airlineCode/aircrafts",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "airlineCode",
"value": "",
"type": "path",
"description": "3-character ICAO-code of the airliner (e.g., KLM, ACA); or\r\n2-character IATA-code of the airline (e.g., KL, AC).\r\n \r\nPlease note that more than one active airline may have the same IATA code, therefore IATA codes are not recommended for this endpoint."
},
{
"name": "pageSize",
"value": "",
"type": "query",
"description": "The number of returned records will be capped at this value.\r\nMust be a positive value and not exceed the limit stipulated by your pricing plan."
},
{
"name": "pageOffset",
"value": "",
"type": "query",
"description": "The number of records to skip before listing a page of records. In conjunction with `pageSize` effectively determines the page number (default - 0)."
},
{
"name": "withRegistrations",
"value": "",
"type": "query",
"description": "Should include the history of aircraft registrations (default: false)."
}
]
},
"docs": "*Returns:* A paged list of aircraft in the fleet of the specified airline. \r\n\r\nThat will include *active* aircraft currently flying in an *active* airline, verfified through more than one source.\r\nUnconfirmed sightings of an aircraft will not qualify said aircraft to be listed in the fleet."
},
{
"info": {
"name": "AeroDataBox Aircraft Image by Tail-number / TIER 2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/aircrafts/reg/:reg/image/beta",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "reg",
"value": "",
"type": "path",
"description": "Tail-number of the aircraft (full, stripped and any case formats are acceptable)."
}
]
},
"docs": "**What is the aircraft photo?**\r\n\r\nAircraft images are being searched in external sources by certain criteria without any manual intervention. \r\nTherefore, false matches may be returned. Only images with licenses approved for commercial use are returned. Please be advised that you may be required to mention author attribution before using the image.\r\n\r\n*Returns:* Image data with medium-sized direct image URL and licence approved for commercial use\r\nis returned."
},
{
"info": {
"name": "AeroDataBox Search Active Aircraft Tail Numbers by Term / TIER 2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/aircrafts/search/term",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "q",
"value": "",
"type": "query",
"description": "Search term (min. 4 non whitespace characters length)"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of items to be returned (max. 10, defaut = 5)"
}
]
},
"docs": "*Returns:* List of active aircraft registrations with tail numbers starting from the term."
}
]
},
{
"info": {
"name": "Airport API",
"type": "folder"
},
"items": [
{
"info": {
"name": "AeroDataBox Airport by Code / TIER 1",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/airports/:codeType/:code",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "codeType",
"value": "",
"type": "path",
"description": "Type of code to search airport by (`iata` or `icao`)"
},
{
"name": "code",
"value": "",
"type": "path",
"description": "If `codeType` is:\r\n* `icao`, then this field must be a 4-character ICAO-code of the airport (e.g.: EHAM, KLAX, UUEE, etc.);\r\n* `iata`, then this field must be a 3-character IATA-code of the airport (e.g.: AMS, SFO, LAX, etc.).\r\n\r\nFull, stripped and any case formats are acceptable."
},
{
"name": "withRunways",
"value": "",
"type": "query",
"description": "Include runways data (default - false)"
},
{
"name": "withTime",
"value": "",
"type": "query",
"description": "Include current local time (default - false)"
}
]
},
"docs": "At the moment airports having both ICAO and IATA code are present in database only.\r\n\r\n*Returns*: Single airport data, if found."
},
{
"info": {
"name": "AeroDataBox Airport Runways / TIER 1",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/airports/:codeType/:code/runways",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "codeType",
"value": "",
"type": "path",
"description": "Type of code to search airport by (`iata` or `icao`)"
},
{
"name": "code",
"value": "",
"type": "path",
"description": "If `codeType` is:\r\n* `icao`, then this field must be a 4-character ICAO-code of the airport (e.g.: EHAM, KLAX, UUEE, etc.);\r\n* `iata`, then this field must be a 3-character IATA-code of the airport (e.g.: AMS, SFO, LAX, etc.).\r\n\r\nFull, stripped and any case formats are acceptable."
}
]
},
"docs": "**Which runways does this airport have?**\r\n\r\nAt the moment airports having both ICAO and IATA code are present in database only.\r\n\r\n*Returns*: Collection of runway data items."
},
{
"info": {
"name": "AeroDataBox Search Airports by Location / TIER 2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/airports/search/location",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "lat",
"value": "",
"type": "query",
"description": "Latitude location coordinate in decimal format (between -90 and 90)"
},
{
"name": "lon",
"value": "",
"type": "query",
"description": "Longitude location coordinate in decimal format (between -180 and 180)"
},
{
"name": "radiusKm",
"value": "",
"type": "query",
"description": "Radius of search around specified location in kilometers (max. 1000 km)"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of airports to be returned (max. 250)"
},
{
"name": "withFlightInfoOnly",
"value": "",
"type": "query",
"description": "If set to true, will only return airports which have flight data (scheduled or live) available. Default = false."
}
]
},
"docs": "**What are the airports closest to the location?**\r\n\r\nAt the moment airports having both ICAO and IATA code and flight schedules are present available only.\r\n\r\n*Returns:* A list of airports found within the specified radius around the specified location."
},
{
"info": {
"name": "AeroDataBox Search Airports by IP Address Geolocation / TIER 2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/airports/search/ip",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "q",
"value": "",
"type": "query",
"description": "A valid public IP v4 address"
},
{
"name": "radiusKm",
"value": "",
"type": "query",
"description": "Radius of search around specified location in kilometers (max. 1000 km)"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of airports to be returned (max. 250)"
},
{
"name": "withFlightInfoOnly",
"value": "",
"type": "query",
"description": "If set to true, will only return airports which have flight data (scheduled or live) available. Default = false."
}
]
},
"docs": "**What are the airports closest to the customer, based on their IP address?**\r\n**What are the airports closest to the location determined (geo-located) by a IP address?**\r\n\r\nThis endpoint determines the location by the IP address provided and then returns the list of the nearest airports\r\nin the same way as `Search airports by location` endpoint does. \r\n\r\nPlease note:\r\n* IP geo-location is not a precise method and it determines an approximate location only.\r\n* At the moment airports having both "
},
{
"info": {
"name": "AeroDataBox Search Airports by Free Text / TIER 2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/airports/search/term",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "q",
"value": "",
"type": "query",
"description": "Search query (min. 3 non whitespace characters length)"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of airports to be returned (max. 250, defaut = 10)"
},
{
"name": "withFlightInfoOnly",
"value": "",
"type": "query",
"description": "If set to true, will only return airports which have flight data (scheduled or live) available. Default = false."
},
{
"name": "withSearchByCode",
"value": "",
"type": "query",
"description": "If set to true, will attempt to interpret short words within the search query as IATA or ICAO code\r\nand prioritize exact matches by these codes (they will appear higher than others). \r\nOtherwise, the search by code will be completely excluded (only the name of an airport or its city will be searched). \r\nDefault = true."
}
]
},
"docs": "At the moment airports having both ICAO and IATA code and flight schedules are present available only.\r\n\r\n*Returns:* List of airports with names and city names (and IATA/ICAO code, if enabled) matching the search term."
}
]
},
{
"info": {
"name": "Flight Alert API",
"type": "folder"
},
"items": [
{
"info": {
"name": "AeroDataBox Create Web-hook Subscription / TIER 4",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/subscriptions/webhook/:subjectType/:subjectId",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "subjectType",
"value": "",
"type": "path",
"description": "Subject type"
},
{
"name": "subjectId",
"value": "",
"type": "path",
"description": "Subject ID. If `subjectType` is: \r\n* `FlightByNumber`, then this field must be a flight number (with or without spaces, IATA or ICAO, any case formats are acceptable, e.g. KL1395, Klm 1395);\r\n* `FlightByAirportIcao`, then this field must be a 4-character ICAO-code of the airport where flights are operated (e.g.: EHAM, KLAX, UUEE, etc.);"
},
{
"name": "useCredits",
"value": "",
"type": "query",
"description": "THIS IS A TEMPORARY MIGRATION PARAMETER FOR EASIER TRANSITION. \r\nDefault value: false.\r\nSet to true to create a web-hook subscription under the new, credit-based billing model.In this case, the call will be free of charge despite Tier 4.\r\nAfter transition this parameter will be ignored as all subscriptions will be created as credit-based and you will be able to remove it."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "*This endpoitns is a part of Flight alert PUSH API currently powered by webhooks. \r\nIf you are running your own web service, you can subscribe to flights by number or airport code. \r\nAfter that, your HTTP endpoint will be called (notified) whenever the flight information gets \r\nupdated.*\r\n\r\nCreates a web-hook subscription on a subject (e.g., flight alerts by number or by airport code).\r\nReturns information about created subscription. Subscription ID contained in it\r\ncan be used to refresh or re"
},
{
"info": {
"name": "AeroDataBox Get Web-hook Subscription / FREE TIER",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/subscriptions/webhook/:subscriptionId",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "subscriptionId",
"value": "",
"type": "path",
"description": "Subscription ID"
}
]
},
"docs": "*This endpoint is a part of Flight alert PUSH API currently powered by webhooks. \r\nIf you are running your own web service, you can subscribe to flights by number or airport code. \r\nAfter that, your HTTP endpoint will be called (notified) whenever the flight information gets \r\nupdated.*\r\n\r\nGets information about an existing active web-hook subscription."
},
{
"info": {
"name": "AeroDataBox Remove Web-hook Subscription / FREE TIER",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/subscriptions/webhook/:subscriptionId",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "subscriptionId",
"value": "",
"type": "path",
"description": "Subscription ID"
}
]
},
"docs": "*This endpoitns is a part of Flight alert PUSH API currently powered by webhooks. \r\nIf you are running your own web service, you can subscribe to flights by number or airport code. \r\nAfter that, your HTTP endpoint will be called (notified) whenever the flight information gets \r\nupdated.*\r\n\r\nRemoves the subscription"
},
{
"info": {
"name": "AeroDataBox List Web-hook Subscriptions / FREE TIER",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/subscriptions/webhook",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
]
},
"docs": "*This endpoitns is a part of Flight alert PUSH API currently powered by webhooks. \r\nIf you are running your own web service, you can subscribe to flights by number or airport code. \r\nAfter that, your HTTP endpoint will be called (notified) whenever the flight information gets \r\nupdated.*\r\n\r\nGet the list of existing active web-hook subscriptions"
},
{
"info": {
"name": "AeroDataBox Refresh Web-hook Subscription (DEPRECATED) / TIER 4",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/subscriptions/webhook/:subscriptionId/refresh",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "subscriptionId",
"value": "",
"type": "path",
"description": "Subscription ID"
},
{
"name": "useCredits",
"value": "",
"type": "query",
"description": "THIS IS A TEMPORARY MIGRATION PARAMETER FOR EASIER TRANSITION. \r\nDefault value: false.\r\nSet to true to refresh an existing web-hook subscription under the new, credit-based billing model. In this case, the call will be free of charge despite Tier 4."
}
]
},
"docs": " *This endpoitns is a part of Flight alert PUSH API currently powered by webhooks. \r\n If you are running your own web service, you can subscribe to flights by number or airport code. \r\n After that, your HTTP endpoint will be called (notified) whenever the flight information gets \r\n updated.*\r\n \r\n Refreshes an existing web-hook subscription\r\n \r\n If the subscription had an expiration date-time set when created, this endpoint \r\n will extend it by the same period of time as the one it was originall"
},
{
"info": {
"name": "AeroDataBox Get Web-hook Subscription Balance / FREE TIER",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/subscriptions/balance",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
]
},
"docs": "The current web-hook subscription balance information.\r\nThis is separate from your API marketplace quota and is used solely for billing of web-hook subscriptions.\r\nFor more details about how flight alert API billing works, refer to our guide at https://aerodatabox.com/flight-alert-api-2026/"
},
{
"info": {
"name": "AeroDataBox Refill Web-hook Subscription Balance / TIER 1",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/subscriptions/balance/refill",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Performs refill operation on the web-hook subscription balance by the specified amount of credits.\r\nThis balance is separate from your API marketplace quota and is used solely for billing of web-hook subscriptions.\r\n\r\nIn the request body, you specify how many credits you want to add. This is a variable-rate endpoint and the amount of API units \r\ndeducted from your API quota depends on the amount of flight alerts credits requested.\r\nThe conversion rate is: 1 credit = 1 API unit.\r\n\r\nAdditional lim"
}
]
},
{
"info": {
"name": "Flight API",
"type": "folder"
},
"items": [
{
"info": {
"name": "AeroDataBox Flight Status (single Day) / TIER 2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/flights/:searchBy/:searchParam",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "searchBy",
"value": "",
"type": "path",
"description": "Criteria to search flight by"
},
{
"name": "searchParam",
"value": "",
"type": "path",
"description": "Value of the search criteria. If `searchBy` is: \r\n* `number`, then this field shoud be Flight number (with or without spaces, IATA or ICAO, any case formats are acceptable, e.g. KL1395, Klm 1395)\r\n* `callsign`, then this field should be ATC call-sign of the flight (with or without spaces, any case formats are acceptable, e.g.AFL1482, nca 008X);\r\n* `reg`, then this field should be Aircraft tail-number (with or without spaces or dashes, any case formats are acceptable, e.g.PH-BXO, DeMhJ);\r\n* `icao24`, then this field should be Aircraft ICAO 24-bit Mode-S address specified in hexadecimal format (e.g. 484161, 483EFD)."
},
{
"name": "dateLocalRole",
"value": "",
"type": "query",
"description": "* If set to `Both` (default, recommended for best results) then the dateLocal parameter shall be considered as both departure and arrival date. If a flight departs OR arrives on that date (in the local timezone of the origin or destination, respectively), it will be returned.\r\n* If set to `Departure` then the dateLocal parameter shall be considered as departure date only. Only the flights departing on that date (in the local timezone of origin) will be returned.\r\n* If set to `Arrival` then the dateLocal parameter shall be considered as arrival date only. Only the flights arriving on that date (in the local timezone of destination) will be returned."
},
{
"name": "withAircraftImage",
"value": "",
"type": "query",
"description": "Should include aircraft image (default: false).\r\n\r\nAircraft images are being searched in external sources by certain criteria without any manual intervention. \r\nTherefore, false matches may be returned. Only images with licenses approved for commercial use are returned. \r\nPlease be advised that you may be required to mention author attribution before using the image."
},
{
"name": "withLocation",
"value": "",
"type": "query",
"description": "Should include real-time positional data, e.g.: location, speed, altitude, etc., if available (default: false)."
},
{
"name": "withFlightPlan",
"value": "",
"type": "query",
"description": "Should include the flight plan filed with the ATC for the flight (default: false).\r\n\r\n* NOTE 1: Generally availabe to flights departing from, arriving to or crossing the mainland U.S. airspace.\r\n* NOTE 2: Only available on Basic and Ultra, Ultra-2 and Mega pricing plans.\r\n* NOTE 3: If set to true and the flight plan is found for one or more flights returned, **the request will be billed as 2 requests** against your API quota (except on Mega plan)."
}
]
},
"docs": "**What is the status of a specific flight?**\r\n**What is the historical status or schedule of a specific flight on a specific date in past or in future?**\r\n\r\nThis endpoint returns data about a specific flight live flight status (if the flight is within the coverage and not in distant future), \r\nor flight schedule data otherwise.\r\n\r\nIf `dateLocal` is specified, gets data about flight(s) departing or arriving on the day specified (local time).\r\nOtherwise, gets data about the status of flight(s) op"
},
{
"info": {
"name": "AeroDataBox Flight Status (single Day) / TIER 2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/flights/:searchBy/:searchParam/:dateLocal",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "searchBy",
"value": "",
"type": "path",
"description": "Criteria to search flight by"
},
{
"name": "searchParam",
"value": "",
"type": "path",
"description": "Value of the search criteria. If `searchBy` is: \r\n* `number`, then this field shoud be Flight number (with or without spaces, IATA or ICAO, any case formats are acceptable, e.g. KL1395, Klm 1395)\r\n* `callsign`, then this field should be ATC call-sign of the flight (with or without spaces, any case formats are acceptable, e.g.AFL1482, nca 008X);\r\n* `reg`, then this field should be Aircraft tail-number (with or without spaces or dashes, any case formats are acceptable, e.g.PH-BXO, DeMhJ);\r\n* `icao24`, then this field should be Aircraft ICAO 24-bit Mode-S address specified in hexadecimal format (e.g. 484161, 483EFD)."
},
{
"name": "dateLocal",
"value": "",
"type": "path",
"description": "Local date of departure or arrival (in format: YYYY-MM-DD, e.g.: 2019-08-29). Maximum/minimum allowable date is determined by the current data coverage limitations and your pricing plan."
},
{
"name": "dateLocalRole",
"value": "",
"type": "query",
"description": "* If set to `Both` (default, recommended for best results) then the dateLocal parameter shall be considered as both departure and arrival date. If a flight departs OR arrives on that date (in the local timezone of the origin or destination, respectively), it will be returned.\r\n* If set to `Departure` then the dateLocal parameter shall be considered as departure date only. Only the flights departing on that date (in the local timezone of origin) will be returned.\r\n* If set to `Arrival` then the dateLocal parameter shall be considered as arrival date only. Only the flights arriving on that date (in the local timezone of destination) will be returned."
},
{
"name": "withAircraftImage",
"value": "",
"type": "query",
"description": "Should include aircraft image (default: false).\r\n\r\nAircraft images are being searched in external sources by certain criteria without any manual intervention. \r\nTherefore, false matches may be returned. Only images with licenses approved for commercial use are returned. \r\nPlease be advised that you may be required to mention author attribution before using the image."
},
{
"name": "withLocation",
"value": "",
"type": "query",
"description": "Should include real-time positional data, e.g.: location, speed, altitude, etc., if available (default: false)."
},
{
"name": "withFlightPlan",
"value": "",
"type": "query",
"description": "Should include the flight plan filed with the ATC for the flight (default: false).\r\n\r\n* NOTE 1: Generally availabe to flights departing from, arriving to or crossing the mainland U.S. airspace.\r\n* NOTE 2: Only available on Basic and Ultra, Ultra-2 and Mega pricing plans.\r\n* NOTE 3: If set to true and the flight plan is found for one or more flights returned, **the request will be billed as 2 requests** against your API quota (except on Mega plan)."
}
]
},
"docs": "**What is the status of a specific flight?**\r\n**What is the historical status or schedule of a specific flight on a specific date in past or in future?**\r\n\r\nThis endpoint returns data about a specific flight live flight status (if the flight is within the coverage and not in distant future), \r\nor flight schedule data otherwise.\r\n\r\nIf `dateLocal` is specified, gets data about flight(s) departing or arriving on the day specified (local time).\r\nOtherwise, gets data about the status of flight(s) op"
},
{
"info": {
"name": "AeroDataBox Flight History and Schedule (range of Days) / TIER 3",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/flights/:searchBy/:searchParam/:dateFromLocal/:dateToLocal",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "searchBy",
"value": "",
"type": "path",
"description": "Criteria to search flight by"
},
{
"name": "searchParam",
"value": "",
"type": "path",
"description": "Value of the search criteria. If `searchBy` is: \r\n* `number`, then this field shoud be Flight number (with or without spaces, IATA or ICAO, any case formats are acceptable, e.g. KL1395, Klm 1395)\r\n* `callsign`, then this field should be ATC call-sign of the flight (with or without spaces, any case formats are acceptable, e.g.AFL1482, nca 008X);\r\n* `reg`, then this field should be Aircraft tail-number (with or without spaces or dashes, any case formats are acceptable, e.g.PH-BXO, DeMhJ);\r\n* `icao24`, then this field should be Aircraft ICAO 24-bit Mode-S address specified in hexadecimal format (e.g. 484161, 483EFD)."
},
{
"name": "dateFromLocal",
"value": "",
"type": "path",
"description": "Beginning of the range of local dates of departure or arrival (in format: YYYY-MM-DD, e.g.: 2019-08-29). Maximum/minimum allowable value is determined by the current data coverage limitations and your pricing plan."
},
{
"name": "dateToLocal",
"value": "",
"type": "path",
"description": "End of the range of local dates of departure or arrival (in format: YYYY-MM-DD, e.g.: 2019-08-29). Maximum/minimum allowable value is determined by the current data coverage limitations and your pricing plan. This date must be bigger than the dateFromLocal. The maximum difference between this date and dateFromLocal is limited and is determined by your pricing plan (ranging from 7 to 30 days as per moment of writing)."
},
{
"name": "dateLocalRole",
"value": "",
"type": "query",
"description": "* If set to `Both` (default, recommended for best results) then the dateFromLocal and dateToLocal parameters shall be considered as both departure and arrival dates. If a flight departs OR arrives on dates within the specified range (in the local timezone of the origin or destination, respectively), it will be returned.\r\n* If set to `Departure` then the dateFromLocal and dateToLocal parameters shall be considered as departure dates only. Only the flights departing on dates within the specified rang(in the local timezone of origin) will be returned.\r\n* If set to `Arrival` then the dateFromLocal and dateToLocal parameters shall be considered as arrival dates only. Only the flights arriving on dates within the specified rangd (in the local timezone of destination) will be returned."
}
]
},
"docs": "**What is the history or schedule of a specific flight within a specific range of dates in past or in future?**\r\n\r\nThis endpoint is the similar to the `Flight status` endpoint. \r\nThe only difference is that instead of returning the flight data on a single date, it returns the data over a range of dates, thus\r\nallowing to get insights on the flight history or schedule within the specified range.\r\n\r\nAll limitations and considerations applicable to `Flight status` endpoint are applicable to this en"
},
{
"info": {
"name": "AeroDataBox Flight Departure Dates / TIER 2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/flights/:searchBy/:searchParam/dates",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "searchBy",
"value": "",
"type": "path",
"description": "Criteria to search flight by"
},
{
"name": "searchParam",
"value": "",
"type": "path",
"description": "Value of the search criteria. If **searchBy** is: \r\n* `number`, then this field shoud be Flight number (with or without spaces, IATA or ICAO, any case formats are acceptable, e.g. KL1395, Klm 1395)\r\n* `callsign`, then this field should be ATC call-sign of the flight (with or without spaces, any case formats are acceptable, e.g.AFL1482, nca 008X);\r\n* `reg`: then this field should be Aircraft tail-number (with or without spaces or dashes, any case formats are acceptable, e.g.PH-BXO, DeMhJ);\r\n* `icao24`, then this field should be Aircraft ICAO 24-bit Mode-S address specified in hexadecimal format (e.g. 484161, 483EFD)."
}
]
},
"docs": "**On which days the flight operates?** or **What is the flight schedule?**\r\n\r\nFlight can be searched by:\r\n* flight number it's being operated under; or\r\n* ATC-callsign it's being operated under; or\r\n* tail-number of the aircraft it's being operated by; or\r\n* Mode-S 24-bit ICAO Transponder address of the aircraft it's being operated by.\r\n\r\n*Returns:* Array of local departure dates in (YYYY-MM-DD) format for flights operated under speified call-sign and within the time range specified."
},
{
"info": {
"name": "AeroDataBox Flight Departure Dates / TIER 2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/flights/:searchBy/:searchParam/dates/:fromLocal/:toLocal",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "searchBy",
"value": "",
"type": "path",
"description": "Criteria to search flight by"
},
{
"name": "searchParam",
"value": "",
"type": "path",
"description": "Value of the search criteria. If **searchBy** is: \r\n* `number`, then this field shoud be Flight number (with or without spaces, IATA or ICAO, any case formats are acceptable, e.g. KL1395, Klm 1395)\r\n* `callsign`, then this field should be ATC call-sign of the flight (with or without spaces, any case formats are acceptable, e.g.AFL1482, nca 008X);\r\n* `reg`: then this field should be Aircraft tail-number (with or without spaces or dashes, any case formats are acceptable, e.g.PH-BXO, DeMhJ);\r\n* `icao24`, then this field should be Aircraft ICAO 24-bit Mode-S address specified in hexadecimal format (e.g. 484161, 483EFD)."
},
{
"name": "fromLocal",
"value": "",
"type": "path",
"description": "Beginning of the search range (local time, format: YYYY-MM-DD)"
},
{
"name": "toLocal",
"value": "",
"type": "path",
"description": "End of the search range (local time, format: YYYY-MM-DD)"
}
]
},
"docs": "**On which days the flight operates?** or **What is the flight schedule?**\r\n\r\nFlight can be searched by:\r\n* flight number it's being operated under; or\r\n* ATC-callsign it's being operated under; or\r\n* tail-number of the aircraft it's being operated by; or\r\n* Mode-S 24-bit ICAO Transponder address of the aircraft it's being operated by.\r\n\r\n*Returns:* Array of local departure dates in (YYYY-MM-DD) format for flights operated under speified call-sign and within the time range specified."
},
{
"info": {
"name": "AeroDataBox FIDS (airport Departures and Arrivals) - by Local Time Range / TIER 2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/flights/airports/:codeType/:code/:fromLocal/:toLocal",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "codeType",
"value": "",
"type": "path",
"description": "Type of code to search airport by (`iata` or `icao`)"
},
{
"name": "code",
"value": "",
"type": "path",
"description": "If `codeType` is:\r\n* `icao`, then this field must be a 4-character ICAO-code of the airport (e.g.: EHAM, KLAX, UUEE, etc.);\r\n* `iata`, then this field must be a 3-character IATA-code of the airport (e.g.: AMS, SFO, LAX, etc.).\r\n\r\nFull, stripped and any case formats are acceptable."
},
{
"name": "fromLocal",
"value": "",
"type": "path",
"description": "Beginning of the search range (local time, format: YYYY-MM-DDTHH:mm)"
},
{
"name": "toLocal",
"value": "",
"type": "path",
"description": "End of the search range (local time, format: YYYY-MM-DDTHH:mm). Must be more than beginning of the search range by no more than 12 hours."
},
{
"name": "direction",
"value": "",
"type": "query",
"description": "Direction of flights: Arrival, Departure or Both (default)"
},
{
"name": "withLeg",
"value": "",
"type": "query",
"description": "If set to true, the result will include movement information from airport opposite in this flight leg (airport of origin for arriving flight or airport of destination for departing flight).\r\nIn this case, Movement property will be replaced with Departure and Arrival properties for each flight.\r\nDefault: false."
},
{
"name": "withCancelled",
"value": "",
"type": "query",
"description": "If set to true, result will include cancelled, divered, likely cancelled (CanceledUncertain) flights.\r\nDefault: true."
},
{
"name": "withCodeshared",
"value": "",
"type": "query",
"description": "If set to true, the result will include flights with all code-shared statuses.\r\nOtherwise, code-sharing flights will be exclued. For airports, where no information about code-share statuses\r\nof flights are supplied (all flights are CodeshareStatus=Unknown), complex filtering will be applied \r\nto determine which flights are likely to be operational (caution: false results are possible)."
},
{
"name": "withCargo",
"value": "",
"type": "query",
"description": "If set to true, the result will include cargo flights (subject to availability)."
},
{
"name": "withPrivate",
"value": "",
"type": "query",
"description": "If set to true, the result will include private flights (subject to availability)."
},
{
"name": "withLocation",
"value": "",
"type": "query",
"description": "If set to true, each currently active flight within the result will be populated \r\nwith its present real-time location, altitude, speed and track (subject to availability)."
}
]
},
"docs": "**What are current departures or arrivals at the airport?** or **What is the flight schedule at the airport?** or **What is flight history at the airport?**\r\n\r\nFlights may contain live updates with corresponding information related to the actual progress of the flight \r\n(including actual/estimated arrival/departure times). In this case this endpoint serves as a FIDS endpoint. \r\nPresense of live updates is subject to data coverage: not all airports have this coverage in our system.\r\n\r\nOtherwise f"
},
{
"info": {
"name": "AeroDataBox FIDS (airport Departures and Arrivals) - by Relative Time / by Current Time / TIER 2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://prod.api.market/api/v1/aedbx/aerodatabox/flights/airports/:codeType/:code",
"headers": [
{
"name": "x-api-market-key",
"value": ""
}
],
"params": [
{
"name": "codeType",
"value": "",
"type": "path",
"description": "Type of code to search airport by (`iata` or `icao`)"
},
{
"name": "code",
"value": "",
"type": "path",
"description": "If `codeType` is:\r\n* `icao`, then this field must be a 4-character ICAO-code of the airport (e.g.: EHAM, KLAX, UUEE, etc.);\r\n* `iata`, then this field must be a 3-character IATA-code of the airport (e.g.: AMS, SFO, LAX, etc.).\r\n\r\nFull, stripped and any case formats are acceptable."
},
{
"name": "offsetMinutes",
"value": "",
"type": "query",
"description": "Beginning of the search range expressed in minutes relative to the current time at the airport (default: `-120`)"
},
{
"name": "durationMinutes",
"value": "",
"type": "query",