aviation-api
Version:
[](https://travis-ci.org/cristobal-io/aviation-api)
2 lines (1 loc) • 24.1 kB
JSON
[
{
"type": "get",
"url": "/airlines/:type/:value/:method",
"title": "Get specific airline data.",
"version": "0.0.1",
"name": "GetAirlineData",
"group": "Airlines",
"parameter": {
"fields": {
"airlines": [
{
"group": "airlines",
"type": "String",
"optional": false,
"field": "type",
"description": "<p>name | logoLink | iata | icao | callsign | website.</p>"
},
{
"group": "airlines",
"type": "String",
"optional": false,
"field": "value",
"description": "<p>the value according to the type specified.</p>"
},
{
"group": "airlines",
"type": "String",
"optional": false,
"field": "method",
"description": "<p>name | logoLink | iata | icao | callsign | website</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8081/airlines/airline_id/American_Airlines/website",
"type": "json"
}
],
"success": {
"examples": [
{
"title": "American Airlines website",
"content": "HTTP/1.1 200 OK\nX-Powered-By: Express\nContent-Type: application/json\nConnection: keep-alive\nContent-Length: 19\n\n\"http://www.aa.com\"",
"type": "json"
}
]
},
"filename": "src/index.js",
"groupTitle": "Airlines"
},
{
"type": "get",
"url": "/airlines/destinations/:airline_id",
"title": "Get destinations from airline_id.",
"version": "0.0.1",
"name": "GetAirlineDestinations",
"group": "Airlines",
"parameter": {
"fields": {
"airlines": [
{
"group": "airlines",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>of the airline.</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i 'http://localhost:8081/airlines/destinations/American_Airlines'",
"type": "json"
}
],
"success": {
"examples": [
{
"title": "American Airlines Destinations",
"content": "HTTP/1.1 200 OK\nX-Powered-By: Express\nContent-Type: application/json\nConnection: keep-alive\nContent-Length: 49841\n[\n\n{\"airline_id\":\"American_Airlines\",\n\"airport_id\":\"V._C._Bird_International_Airport\",\n\"latitude\":\"17°08′12″N\",\n\"longitude\":\"061°47′35″W\",\n\"name\":\"V. C. Bird International Airport\",\n\"nickname\":\"ANU\",\n\"iata\":\"ANU\",\n\"icao\":\"TAPA\",\n\"dd_latitude\":17.136666666666667,\n\"dd_longitude\":-61.793055555555554,\n\"airlines_flying\":14},\n\n{\"airline_id\":\"American_Airlines\",\n\"airport_id\":\"Ministro_Pistarini_International_Airport\",\n\"latitude\":\"34°49′20″S\",\n\"longitude\":\"58°32′09″W\",\n\"name\":\"Ministro Pistarini International Airport\",\n\"nickname\":\"Aeropuerto Internacional Ministro Pistarini\",\n\"iata\":\"EZE\",\n\"icao\":\"SAEZ\",\n\"dd_latitude\":-34.82222222222222,\n\"dd_longitude\":-58.53583333333333,\n\"airlines_flying\":47},\n\n{\"airline_id\":\"American_Airlines\",\n\"airport_id\":\"Queen_Beatrix_International_Airport\",\n\"latitude\":\"12°30′05″N\",\n\"longitude\":\"70°00′55″W\",\n\"name\":\"Queen Beatrix International Airport\",\n\"nickname\":\"Internationale luchthaven Koningin Beatrix\\nAeropuerto Internacional Reina Beatrix\",\n\"iata\":\"AUA\",\n\"icao\":\"TNCA\",\n\"dd_latitude\":12.501388888888888,\n\"dd_longitude\":-70.01527777777778,\n\"airlines_flying\":28}\n// until complete all the destinations.\n]",
"type": "json"
}
]
},
"filename": "src/index.js",
"groupTitle": "Airlines"
},
{
"type": "get",
"url": "/airlines/?airline_id=:airline_id",
"title": "Get airlines from airline_id.",
"version": "0.0.1",
"name": "GetAirlines",
"description": "<p>Your retrieve the information of an airline, as a param you can use the wildcard '%'</p>",
"group": "Airlines",
"parameter": {
"fields": {
"airlines": [
{
"group": "airlines",
"type": "String",
"optional": false,
"field": "airline_id",
"description": "<p>airline_id of the airline.</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i 'http://localhost:8081/airlines/?airline_id=American_Airlines'",
"type": "json"
}
],
"success": {
"examples": [
{
"title": "American Airlines",
"content": "HTTP/1.1 200 OK\nX-Powered-By: Express\nContent-Type: application/json\nConnection: keep-alive\nContent-Length: 280\n[{\"airline_id\":\"American_Airlines\",\n\"name\":\"American Airlines, Inc.\",\n\"logo_url\":\"//upload.wikimedia.org/wikipedia/en/thumb/2/23/American_Airlines_logo_2013.svg/300px-American_Airlines_logo_2013.svg.png\",\n\"iata\":\"AA\",\n\"icao\":\"AAL\",\n\"callsign\":\"AMERICAN\",\n\"website\":\"http://www.aa.com\"}]",
"type": "json"
}
]
},
"filename": "src/index.js",
"groupTitle": "Airlines"
},
{
"type": "get",
"url": "/airlines/data/?name=:name",
"title": "Get cities from name.",
"version": "0.0.1",
"name": "QueryAirlineCities",
"group": "Airlines",
"parameter": {
"fields": {
"airlines": [
{
"group": "airlines",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>of the airline.</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i 'http://localhost:8081/airlines/cities/?name=American%Airlines%'",
"type": "json"
}
],
"success": {
"examples": [
{
"title": "American Airlines cities",
"content": "HTTP/1.1 200 OK\nX-Powered-By: Express\nContent-Type: application/json\nConnection: keep-alive\nContent-Length: 17685\n[{\"airport_id\":\"V._C._Bird_International_Airport\",\"name\":\"American Airlines, Inc.\",\"city_id\":\"St._John%27s,_Antigua_and_Barbuda\"},\n{\"airport_id\":\"Ministro_Pistarini_International_Airport\",\"name\":\"American Airlines, Inc.\",\"city_id\":\"Buenos_Aires\"},\n{\"airport_id\":\"Queen_Beatrix_International_Airport\",\"name\":\"American Airlines, Inc.\",\"city_id\":\"Oranjestad,_Aruba\"},\n{\"airport_id\":\"Sydney_Airport\",\"name\":\"American Airlines, Inc.\",\"city_id\":\"Sydney\"},\n{\"airport_id\":\"Lynden_Pindling_International_Airport\",\"name\":\"American Airlines, Inc.\",\"city_id\":\"Nassau,_Bahamas\"},\n{\"airport_id\":\"Grantley_Adams_International_Airport\",\"name\":\"American Airlines, Inc.\",\"city_id\":\"Bridgetown,_Barbados\"},\n\n// until complete all the cities.\n]",
"type": "json"
}
]
},
"filename": "src/index.js",
"groupTitle": "Airlines"
},
{
"type": "get",
"url": "/airport/iata/:iata",
"title": "Airport data with the IATA code.",
"version": "0.0.1",
"name": "GetAirportByIata",
"group": "Airports",
"parameter": {
"fields": {
"airports": [
{
"group": "airports",
"type": "String",
"size": "3",
"optional": false,
"field": "iata",
"description": "<p>IATA code identification of the airport.</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8081/airport/iata/SFO",
"type": "json"
}
],
"success": {
"examples": [
{
"title": "SFO",
"content": "HTTP/1.1 200 OK\nX-Powered-By: Express\nContent-Type: application/json\nConnection: keep-alive\nContent-Length: 247\n{\n\"location\":\"37°37′08″N 122°22′30″W\",\n\"airport_id\":\"San_Francisco_International_Airport\",\n\"latitude\":\"37°37′08″N\",\n\"longitude\":\"122°22′30″W\",\n\"name\":\"San Francisco International Airport\",\n\"nickname\":\"SFO\",\n\"iata\":\"SFO\",\n\"icao\":\"KSFO\"}",
"type": "json"
}
]
},
"filename": "src/index.js",
"groupTitle": "Airports"
},
{
"type": "get",
"url": "/airport/icao/:icao",
"title": "Airport data with the ICAO code.",
"version": "0.0.1",
"name": "GetAirportByIcao",
"group": "Airports",
"parameter": {
"fields": {
"airports": [
{
"group": "airports",
"type": "String",
"size": "4",
"optional": false,
"field": "icao",
"description": "<p>ICAO code identification of the airport.</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8081/airport/icao/KSFO",
"type": "json"
}
],
"success": {
"examples": [
{
"title": "KSFO",
"content": "HTTP/1.1 200 OK\nX-Powered-By: Express\nContent-Type: application/json\nConnection: keep-alive\nContent-Length: 247\n{\n\"location\":\"37°37′08″N 122°22′30″W\",\n\"airport_id\":\"San_Francisco_International_Airport\",\n\"latitude\":\"37°37′08″N\",\n\"longitude\":\"122°22′30″W\",\n\"name\":\"San Francisco International Airport\",\n\"nickname\":\"SFO\",\n\"iata\":\"SFO\",\n\"icao\":\"KSFO\"}",
"type": "json"
}
]
},
"filename": "src/index.js",
"groupTitle": "Airports"
},
{
"type": "get",
"url": "/airport/data/:type/:value/:method",
"title": "Airport data.",
"version": "0.0.1",
"name": "GetAirportData",
"group": "Airports",
"parameter": {
"fields": {
"airports": [
{
"group": "airports",
"type": "String",
"optional": false,
"field": "type",
"description": "<p>airport_id | name | latitude | longitude | nickname | iata | icao.</p>"
},
{
"group": "airports",
"type": "String",
"optional": false,
"field": "value",
"description": "<p>the value according to the type specified.</p>"
},
{
"group": "airports",
"type": "String",
"optional": true,
"field": "method",
"description": "<p>airport_id | name | location | latitude | longitude | nickname | iata | icao</p> <p>if we leave the method empty, the full airport data will be returned.</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8081/airport/data/iata/SFO/location",
"type": "json"
}
],
"success": {
"examples": [
{
"title": "SFO location",
"content": "HTTP/1.1 200 OK\nX-Powered-By: Express\nContent-Type: application/json\nConnection: keep-alive\nContent-Length: 34\n\n\"37°37′08″N 122°22′30″W\"",
"type": "json"
}
]
},
"filename": "src/index.js",
"groupTitle": "Airports"
},
{
"type": "get",
"url": "/airports/runways/?name=:name",
"title": "Airport runways from name.",
"version": "0.0.1",
"name": "GetAirportRunways",
"group": "Airports",
"parameter": {
"fields": {
"airports": [
{
"group": "airports",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>of the origin.</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i 'http://localhost:8081/airports/runways/?name=San%Francisco%'",
"type": "json"
}
],
"success": {
"examples": [
{
"title": "100 km radius from SFO",
"content": "HTTP/1.1 200 OK\nX-Powered-By: Express\nContent-Type: application/json\nConnection: keep-alive\nContent-Length: 457\n[{\"name\":\"San Francisco International Airport\",\"direction\":\"10L/28R\",\"ft\":\"11,870\",\"m\":\"3,618\",\"surface\":\"Asphalt\"},\n{\"name\":\"San Francisco International Airport\",\"direction\":\"10R/28L\",\"ft\":\"11,381\",\"m\":\"3,469\",\"surface\":\"Asphalt\"},\n{\"name\":\"San Francisco International Airport\",\"direction\":\"1R/19L\",\"ft\":\"8,650\",\"m\":\"2,637\",\"surface\":\"Asphalt\"},\n{\"name\":\"San Francisco International Airport\",\"direction\":\"1L/19R\",\"ft\":\"7,650\",\"m\":\"2,332\",\"surface\":\"Asphalt\"}]",
"type": "json"
}
]
},
"filename": "src/index.js",
"groupTitle": "Airports"
},
{
"type": "get",
"url": "/airport/city/:airport_id",
"title": "City from airport_id.",
"version": "0.0.1",
"name": "GetCity",
"group": "Airports",
"parameter": {
"fields": {
"airports": [
{
"group": "airports",
"type": "String",
"optional": false,
"field": "airport_id",
"description": "<p>exact airport_id.</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8081/airport/city/San_Jose_International_Airport",
"type": "json"
}
],
"success": {
"examples": [
{
"title": "SFO location",
"content": "HTTP/1.1 200 OK\nX-Powered-By: Express\nContent-Type: application/json\nDate: Sat, 18 Jun 2016 14:13:15 GMT\nConnection: keep-alive\nContent-Length: 20\n\nSan_Jose,_California",
"type": "json"
}
]
},
"filename": "src/index.js",
"groupTitle": "Airports"
},
{
"type": "get",
"url": "/airport/airlines/:airport_id",
"title": "airlines from airport_id.",
"version": "0.0.1",
"name": "GetCity",
"group": "Airports",
"parameter": {
"fields": {
"airports": [
{
"group": "airports",
"type": "String",
"optional": false,
"field": "airport_id",
"description": "<p>(accepts wildcard) airport_id.</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8081/airport/airlines/San_Jose_International_Airport",
"type": "json"
}
],
"success": {
"examples": [
{
"title": "SFO airlines",
"content": "HTTP/1.1 200 OK\nX-Powered-By: Express\nContent-Type: application/json\nConnection: keep-alive\nContent-Length: 880\n\n[\n {\n \"airline_id\": \"Air_Canada\",\n \"name\": \"Air Canada\",\n \"logo_url\": \"//upload.wikimedia.org/wikipedia/commons/thumb/2/24/Air_Canada_Logo.svg/250px-Air_Canada_Logo.svg.png\",\n \"iata\": \"AC\",\n \"icao\": \"ACA\",\n \"callsign\": \"AIR CANADA\",\n \"website\": \"http://aircanada.com\"\n },\n {\n \"airline_id\": \"Air_China\",\n \"name\": \"Air China\\n中国国际航空公司\\nZhōngguó Guójì Hángkōng Gōngsī\",\n \"logo_url\": \"//upload.wikimedia.org/wikipedia/en/thumb/9/97/Air_China_Logo.svg/250px-Air_China_Logo.svg.png\",\n \"iata\": \"CA\",\n \"icao\": \"CCA\",\n \"callsign\": \"AIR CHINA\",\n \"website\": \"http://www.airchina.com\"\n },\n {\n \"airline_id\": \"Alaska_Airlines\",\n \"name\": \"Alaska Airlines\",\n \"logo_url\": \"//upload.wikimedia.org/wikipedia/en/thumb/b/b3/Alaska_Airlines_Logo.png/300px-Alaska_Airlines_Logo.png\",\n \"iata\": \"AS\",\n \"icao\": \"ASA\",\n \"callsign\": \"ALASKA\",\n \"website\": \"https://www.alaskaair.com\"\n },\n ....\n]",
"type": "json"
}
]
},
"filename": "src/index.js",
"groupTitle": "Airports"
},
{
"type": "get",
"url": "/airports/radius/?airport_id=:airport_id&radius=:radius",
"title": "Airports in a radius.",
"version": "0.0.1",
"name": "GetRadiusAirports",
"group": "Airports",
"parameter": {
"fields": {
"airports": [
{
"group": "airports",
"type": "String",
"optional": false,
"field": "airport_id",
"description": "<p>of the origin.</p>"
},
{
"group": "airports",
"type": "Number",
"optional": false,
"field": "radius",
"description": "<p>in km</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i 'http://localhost:8081/airports/radius/?airport_id=San_Francisco_International_Airport&radius=100'",
"type": "json"
}
],
"success": {
"examples": [
{
"title": "100 km radius from SFO",
"content": "HTTP/1.1 200 OK\nX-Powered-By: Express\nContent-Type: application/json\nConnection: keep-alive\nContent-Length: 4125\n[\n{\"airport_id\":\"San_Francisco_International_Airport\",\"name\":\"San Francisco International Airport\",\"latitude\":\"37°37′08″N\",\"longitude\":\"122°22′30″W\",\"distance\":0},\n{\"airport_id\":\"Half_Moon_Bay_Airport\",\"name\":\"Eddie Andreini Sr. Airfield\\nHalf Moon Bay Airport\",\"latitude\":\"37°30′48″N\",\"longitude\":\"122°30′04″W\",\"distance\":16183.33},\n{\"airport_id\":\"San_Carlos_Airport_(California)\",\"name\":\"San Carlos Airport\",\"latitude\":\"37°30′43″N\",\"longitude\":\"122°14′58″W\",\"distance\":16262.58},\n{\"airport_id\":\"Oakland_International_Airport\",\"name\":\"Oakland International Airport\",\"latitude\":\"37°43′17″N\",\"longitude\":\"122°13′15″W\",\"distance\":17740.59}\n// until complete all the airports.\n]",
"type": "json"
}
]
},
"filename": "src/index.js",
"groupTitle": "Airports"
},
{
"type": "get",
"url": "/airports/data/?name=:name",
"title": "Airport data from name.",
"version": "0.0.1",
"name": "QueryAirportData",
"group": "Airports",
"parameter": {
"fields": {
"airports": [
{
"group": "airports",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>of the origin.</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i 'http://localhost:8081/airports/data/?name=San%Francisco%'",
"type": "json"
}
],
"success": {
"examples": [
{
"title": "100 km radius from SFO",
"content": "HTTP/1.1 200 OK\nX-Powered-By: Express\nContent-Type: application/json\nConnection: keep-alive\nContent-Length: 259\n[{\"airport_id\":\"San_Francisco_International_Airport\",\n\"latitude\":\"37°37′08″N\",\n\"longitude\":\"122°22′30″W\",\n\"name\":\"San Francisco International Airport\",\n\"nickname\":\"SFO\",\n\"iata\":\"SFO\",\n\"icao\":\"KSFO\",\n\"dd_latitude\":37.61888888888889,\n\"dd_longitude\":-122.375}]",
"type": "json"
}
]
},
"filename": "src/index.js",
"groupTitle": "Airports"
},
{
"type": "get",
"url": "/airports/box/?lat1=:lat1&long1=:long1&lat2=lat2&long2=long2",
"title": "Airports in a bounding box within two coordinates.",
"version": "0.0.1",
"name": "airportsBounds",
"group": "Airports",
"parameter": {
"fields": {
"airports": [
{
"group": "airports",
"type": "String",
"optional": false,
"field": "lat1",
"description": "<p>latitude of first poing.</p>"
},
{
"group": "airports",
"type": "String",
"optional": false,
"field": "long1",
"description": "<p>longitude of first poing.</p>"
},
{
"group": "airports",
"type": "String",
"optional": false,
"field": "lat2",
"description": "<p>latitude of second poing.</p>"
},
{
"group": "airports",
"type": "String",
"optional": false,
"field": "long2",
"description": "<p>longitude of second poing.</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "curl -i 'http://localhost:8081/airports/box/?lat1=38&long1=-123.5&lat2=37&long2=-122'",
"type": "json"
}
],
"success": {
"examples": [
{
"title": "SFO area box",
"content": "HTTP/1.1 200 OK\nX-Powered-By: Express\nContent-Type: application/json\nConnection: keep-alive\nContent-Length: 2038\n[\n\n{\"airport_id\":\"Buchanan_Field_Airport\",\"latitude\":\"37°59′23″N\",\"longitude\":\"122°03′25″W\",\"name\":\"Buchanan International\\nConcord Army Air Base\",\"nickname\":\"CCR\",\"iata\":\"CCR\",\"icao\":\"KCCR\",\"dd_latitude\":37.98972222222222,\"dd_longitude\":-122.05694444444444,\"airlines_flying\":0},\n{\"airport_id\":\"Half_Moon_Bay_Airport\",\"latitude\":\"37°30′48″N\",\"longitude\":\"122°30′04″W\",\"name\":\"Eddie Andreini Sr. Airfield\\nHalf Moon Bay Airport\",\"nickname\":\"HAF\",\"iata\":\"HAF\",\"icao\":\"KHAF\",\"dd_latitude\":37.513333333333335,\"dd_longitude\":-122.50111111111111,\"airlines_flying\":0},\n{\"airport_id\":\"Hayward_Executive_Airport\",\"latitude\":\"37°39′32″N\",\"longitude\":\"122°07′18″W\",\"name\":\"Hayward Executive Airport\",\"nickname\":\"(former Hayward Army Air Field)\",\"iata\":\"HWD\",\"icao\":\"KHWD\",\"dd_latitude\":37.65888888888889,\"dd_longitude\":-122.12166666666666,\"airlines_flying\":0},\n{\"airport_id\":\"Moffett_Federal_Airfield\",\"latitude\":\"37°24′54″N\",\"longitude\":\"122°02′54″W\",\"name\":\"Moffett Federal Airfield\",\"nickname\":\"NUQ\",\"iata\":\"NUQ\",\"icao\":\"KNUQ\",\"dd_latitude\":37.415,\"dd_longitude\":-122.04833333333333,\"airlines_flying\":0},\n{\"airport_id\":\"Oakland_International_Airport\",\"latitude\":\"37°43′17″N\",\"longitude\":\"122°13′15″W\",\"name\":\"Oakland International Airport\",\"nickname\":\"OAK\",\"iata\":\"OAK\",\"icao\":\"KOAK\",\"dd_latitude\":37.72138888888889,\"dd_longitude\":-122.22083333333333,\"airlines_flying\":23},\n{\"airport_id\":\"Palo_Alto_Airport\",\"latitude\":\"37°27′40″N\",\"longitude\":\"122°06′54″W\",\"name\":\"Palo Alto Airport\",\"nickname\":\"PAO\",\"iata\":\"PAO\",\"icao\":\"KPAO\",\"dd_latitude\":37.461111111111116,\"dd_longitude\":-122.115,\"airlines_flying\":0},\n{\"airport_id\":\"San_Francisco_International_Airport\",\"latitude\":\"37°37′08″N\",\"longitude\":\"122°22′30″W\",\"name\":\"San Francisco International Airport\",\"nickname\":\"SFO\",\"iata\":\"SFO\",\"icao\":\"KSFO\",\"dd_latitude\":37.61888888888889,\"dd_longitude\":-122.375,\"airlines_flying\":71},\n{\"airport_id\":\"San_Carlos_Airport_(California)\",\"latitude\":\"37°30′43″N\",\"longitude\":\"122°14′58″W\",\"name\":\"San Carlos Airport\",\"nickname\":\"SQL\",\"iata\":\"SQL\",\"icao\":\"KSQL\",\"dd_latitude\":37.511944444444445,\"dd_longitude\":-122.24944444444445,\"airlines_flying\":0}]",
"type": "json"
}
]
},
"filename": "src/index.js",
"groupTitle": "Airports"
},
{
"type": "get",
"url": "/geoip/",
"title": "Retrieves information about the user IP.",
"version": "0.1.3",
"name": "User",
"group": "GeoIp",
"examples": [
{
"title": "Example usage:",
"content": "curl -i http://localhost:8081/geoip/",
"type": "json"
}
],
"filename": "src/index.js",
"groupTitle": "GeoIp"
}
]