The Flight Labs API was built to provide a simple way of accessing global aviation data for real-time and historical flights as well as allow customers to tap into an extensive data set of airline routes and other up-to-date aviation-related information.
Quickstart
Requests to the REST API are made using a straightforward HTTP GET URL structure and responses are provided in lightweight JSON format.
Example API Request:
https://app.goflightlabs.com/flights?access_key=YOUR_ACCESS_KEY
# Retrieve Countries
This API endpoint offers a list of countries along with essential details such as country code, market, currency title, currency code, and currency symbol.
Example API Request:
https://app.goflightlabs.com/retrieveCountries?access_key=YOUR_ACCESS_KEY
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Your API access key, which can be found in your acccount dashboard. |
Example API Response:
{
"country": "Andorra",
"countryCode": "AD",
"market": "es-ES",
"currencyTitle": "Euro",
"currency": "EUR",
"currencySymbol": "€",
"site": "www.skyscanner.net"
},
{
"country": "United Arab Emirates",
"countryCode": "AE",
"market": "en-US",
"currencyTitle": "United Arab Emirates Dirham",
"currency": "AED",
"currencySymbol": "AED",
"site": "www.skyscanner.ae"
},
{
"country": "Afghanistan",
"countryCode": "AF",
"market": "en-GB",
"currencyTitle": "Afghan Afghani",
"currency": "AFN",
"currencySymbol": "AFN",
"site": "www.skyscanner.net"
},
# Retrieve DestinationsOrHotel
This API endpoint facilitates the retrieval of a list of destinations and hotels located at the specified location.
Example API Request:
https://app.goflightlabs.com/retrieveDestinationsOrHotels?access_key=YOUR_ACCESS_KEY&query=Hilton
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Your API access key, which can be found in your acccount dashboard. |
query |
[Required] destinations/hotels name. |
Example API Response:
{
"hierarchy": "Beaufort County|South Carolina|United States",
"location": "32.2163159915, -80.7526080072",
"score": 1.7212256115947226,
"entityName": "Hilton Head Island",
"entityId": "27542048",
"entityType": "city",
"suggestItem": "{strong}Hilton{/strong} Head Island, Beaufort County, South Carolina, United States",
"class": "City",
"pois": null
}
# Retrieve Hotel
This API endpoint offers hotel information based on the provided entityId (obtained from the retrieveDestinationsOrHotels endpoint), along with check-in and check-out dates.
Example API Request:
https://app.goflightlabs.com/retrieveHotel?access_key=YOUR_ACCESS_KEY&entityId=27542048&checkin=2024-08-10&checkout=2024-08-11
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Your API access key, which can be found in your acccount dashboard. |
entityId |
[Required] Extract the entityId code from the retrieveDestinationsOrHotels endpoint. |
checkin |
[Required] Date of Check In. Format: YYYY-MM-DD. |
checkout |
[Required] Date of Check Out. Format: YYYY-MM-DD. |
adults |
[Optional] Number of adults (aged 18 and over) Default value: 1. |
rooms |
[Optional] Customize results based on the number of desired rooms. |
limit |
[Optional] Control the quantity of results displayed per request. |
offset |
[Optional] Navigate through results with a specified starting position. |
sortBy |
[Optional] Possible values: -relevance, -price, price, distance, -hotel_rating, -stars, stars. |
currency |
[Optional] Desired currency. For example USD. Can be obtained from the endpoint retrieveCountries. |
market |
[Optional] For example en-US. Can be obtained from the endpoint retrieveCountries. |
countryCode |
[Optional] For example US. Can be obtained from the endpoint retrieveCountries. |
Example API Response:
{
"searchStatus": {
"completionPercentage": 80,
"status": "PENDING",
"searchId": "c42d36b8e9af44a612904caecb395a519aa9fc63a92c39cb070a6c4ebf5d78ca",
"firstPageStatus": "PENDING"
},
"hotels": [
{
"hotelId": "106005202",
"heroImage": "https://d2xf5gjipzd8cd.cloudfront.net/available/960093366/960093366_WxH.jpg",
"name": "The Manhattan at Times Square",
"stars": 4,
"brandIds": [],
"distance": "3.53 miles from downtown",
"relevantPoiDistance": "1.69 miles from Central Park",
"coordinates": [
-73.9826404,
40.7622856
],
"price": "$106",
"cug": {
"cugWithoutLabel": null,
"rawType": "general",
"type": "general",
"icons": [],
"discount": "12% off",
"priceWithoutDiscount": "$120",
"rawDiscountPercentage": 12
},
"cheapestOfferPartnerId": "d_ct",
"cheapestOfferRateId": "eyJtaW5pX3ByaWNlX3Jvb21faWQiOiIxNDIwMTgwMzEyIiwicmF0ZV9pZCI6IjE0MjAxODAzMTIiLCJhZHVsdHMiOm51bGwsImF1dGhvcml6YXRpb25faW5mbyI6W3siQ29kZSI6IlB1YmxpY1BhcmFtZXRlciIsIlZhbHVlIjoiSDRzSUFBQUFBQUFBQUdWUjIyckRNQXo5RjcrdUdYTHU5SzJYbFFVQ0M2UjVXc2J3SEtjemRlUGlPSU5RK3UrVGszWmpEUHdnbnlQcEhFa1hrcTJyWjIyRjJrbGxoU0ZMY3FuSlNqWTFXVklcL2htUlJrODJuNE1lczJ6SXJFSzJKRDM3Z1FlcjVVSk03XC9UTFlcL3p5ZGVUMTAxb3diM2N4MFZjNncwWDFmOWNKTTRHNlZsMDh6UHZSV240UXBqRDRMWTBla1g5SFNcL2J0QmxZTTJEcVlBaTE4aW15eERlSDFETU5lY3FWbE9kTzgzeFVJeDIycHptbUNwK3drczUxRURtb2FSYTFmcXdYRHhKNldhVW1yQ2xKS3M0Mkp3XC95dFo0R1JkTDNzck9qNFdSbW9qN1lqNzg1RlIrcEJ0TVVhTDRFT1NVTTh0QlZJSUlBS0lxQmNtdElHV2lpQnRlUmkzXC9JUDZQT1N0QUtDTVJrR01QZkF3aGU2bk50TU1IanVmRWM1eEFTdGo1QmRUZTNrU1R2Qm4zM3VBNWZRZVVmY0JVb3l3UXA3WFN2UGo3UTVaazZObkxJdWRDSk9OcytrdVRhN2YwQWJSbWcwQ0FBQT0ifSx7IkNvZGUiOiJNaW5QcmljZV9QYXJ0bmVyX2RhdGEiLCJWYWx1ZSI6Ikg0c0lBQUFBQUFBQUFFM1F5MDdETUJBRjBIK1pkUnZOK0psMEN4VmloNmpZWldOY3A3V1VPRkhxb3FJcVwvODQ0cUlLbHo5eDV5SGNZWW5xYm93K3ZxUnRoQlwvZTJ5RlJrSHNlaGhSMkwrenF0d3FcL2Eya3BwMUVyWlRRczV1eHVqRXFheUZxVmNzZlRGSXpNcGdWU2pKRkhVNVREMUxxMFZ5U3dRaStjeHVcLzR4dmJHeXNxcFJoTGhPbnk1VFVWTkpVeE1WYzhkcm45bHdLWUU0aEV0MlF3bVJhUWk1VDVNVXB0Um01OE82ckFWbVhtY3RiUVVLaVh3UzZwTGNLa3RIN0NqSXV2UEtkUDZUaEZlK0M0amtTRXZUd2dJYjZPTHRuYVwvZnB4enpOMzhJakhNOHhlVDZwK3M4aCtUWjRQRHl6TWxIWVhcL3paNWRPQVhhNmtycHVOdUN2bHp3T1wveG8rRHFYaGxcL1wvaXRxS0dqRjZXSDcrRzJhS1pBUUFBIn1dfQ==",
"rawPrice": 106,
"rating": {
"description": "Good",
"count": 12408,
"value": "7.0",
"color": "colorKolkata"
},
"reviewSummary": {
"description": "Good",
"count": 12408,
"formatCount": "12,408",
"value": "3.5",
"formatValue": "3.5",
"color": "colorKolkata",
"taImage": "https://www.tripadvisor.com/img/cdsi/img2/ratings/traveler/3.5-64600-4.png",
"confidenceBadge": {
"type": "location",
"score": 4.5,
"icon": "thumbs-up",
"color": {
"light": "colorMonteverde",
"dark": "colorMonteverde"
},
"message": "Hotel location is rated 4.5/5"
}
},
"cheapestOffer": "dbook",
"offerTypes": "dbookAndMeta",
"guestType": null,
"exclusiveDealLabel": "Exclusive price - save $5.00",
"pricesFrom": "11 prices from",
"images": [
"https://d2xf5gjipzd8cd.cloudfront.net/available/960093366/960093366_WxH.jpg",
"https://d2xf5gjipzd8cd.cloudfront.net/available/960093348/960093348_WxH.jpg",
"https://d2xf5gjipzd8cd.cloudfront.net/available/208609874/208609874_WxH.jpg"
],
"otherRates": [
{
"partnerId": "d_sg",
"partnerName": "Easytrip",
"rawPrice": 111,
"price": "$111"
},
{
"partnerId": "h_hc",
"partnerName": "Hotels.com",
"rawPrice": 117,
"price": "$117"
},
{
"partnerId": "h_xp",
"partnerName": "Expedia",
"rawPrice": 117,
"price": "$117"
},
{
"partnerId": "h_tc",
"partnerName": "Travelocity",
"rawPrice": 117,
"price": "$117"
},
{
"partnerId": "h_pr",
"partnerName": "Priceline",
"rawPrice": 117,
"price": "$117"
},
{
"partnerId": "h_ei",
"partnerName": "Edreams",
"rawPrice": 117,
"price": "$117"
},
{
"partnerId": "h_bc",
"partnerName": "Booking.com",
"rawPrice": 117,
"price": "$117"
},
{
"partnerId": "h_ad",
"partnerName": "Agoda",
"rawPrice": 127,
"price": "$127"
},
{
"partnerId": "h_pi",
"partnerName": "Prestigia",
"rawPrice": 131,
"price": "$131"
},
{
"partnerId": "h_gt",
"partnerName": "Getaroom",
"rawPrice": 159,
"price": "$159"
}
],
"priceDescription": "$106 for 1 night",
"taxPolicy": "Taxes and fees not included",
"rateFeatures": [],
"cheapestOfferPartnerName": "Trip.com"
}
],
"nightsForPrice": "Per night",
"filters": [
{
"type": "price_buckets",
"title": "Price",
"values": [
{
"id": "PR_BK_0",
"label": "PR_BK_0",
"minPrice": 0,
"maxPrice": 100,
"count": 0
},
{
"id": "PR_BK_1",
"label": "PR_BK_1",
"minPrice": 100,
"maxPrice": 200,
"count": 0
},
{
"id": "PR_BK_2",
"label": "PR_BK_2",
"minPrice": 200,
"maxPrice": 300,
"count": 0
},
{
"id": "PR_BK_3",
"label": "PR_BK_3",
"minPrice": 300,
"maxPrice": 400,
"count": 0
},
{
"id": "PR_BK_4",
"label": "PR_BK_4",
"minPrice": 400,
"maxPrice": 500,
"count": 0
},
{
"id": "PR_BK_5",
"label": "PR_BK_5",
"minPrice": 500,
"maxPrice": null,
"count": 0
}
]
}
],
"sortOptions": [
{
"optionName": "Best",
"type": "-relevance"
},
{
"optionName": "Price (high to low)",
"type": "-price"
},
{
"optionName": "Price (low to high)",
"type": "price"
},
{
"optionName": "Distance from downtown",
"type": "distance"
},
{
"optionName": "Guest rating",
"type": "-hotel_rating"
},
{
"optionName": "Stars (5 to 1)",
"type": "-stars"
},
{
"optionName": "Stars (1 to 5)",
"type": "stars"
}
],
"closedUserGroupDeals": [],
"pricePolicy": "Taxes and fees not included",
"mapBoundary": {
"n_e_lat": 40.788703464,
"s_w_lat": 40.6674195496,
"n_e_lng": -73.93479468000001,
"s_w_lng": -74.01323832
},
"hotelPivot": null,
"medianMinPrice": null,
"entity": {
"centroid": {
"type": "Point",
"coordinates": [
-73.9282670243,
40.6940959901
]
},
"name": "New York",
"official_center": {
"type": "Point",
"coordinates": [
-74.0059731,
40.7143528
]
},
"entity_type": "City",
"entity_id": "27537542",
"levelOfEntityType": "PoliticalTypes"
},
"location": [
{
"entity_id": "44294285",
"entity_type": "FirstLevelNationAdministrativeDivision",
"name": "New York"
},
{
"entity_id": "29475437",
"entity_type": "Nation",
"name": "United States"
}
],
"priceType": "per",
"localCurrency": "USD",
"hotelsCoordinates": [
{
"longitude": -73.9826404,
"latitude": 40.7622856,
"hotelId": "106005202"
}
],
"hotelsRegion": null,
"totalHotels": 0,
"totalHotelsFiltered": 0,
"pois": [
{
"image_url": null,
"sub_poi_type": "Airport",
"name": "New York John F. Kennedy",
"type": "Transportation",
"is_extend": null,
"coordinate": [
-73.7781176,
40.6412215
],
"id": 95565058
}
],
"discountAnalysis": {
"couponHotels": [],
"couponRanks": [],
"couponAmounts": [],
"discountPercentage": null,
"couponType": null,
"hasCugDeal": true,
"cugHotels": [
"106005202",
"106100311",
"46997565",
"205559857",
"115638640",
"106034174",
"47221771",
"203871631",
"205592768",
"139440694",
"139252283",
"129842609"
],
"cugRanks": [
0,
1,
2,
3,
4,
6,
11,
15,
16,
17,
18,
19
],
"cugAmounts": [
12,
20,
null,
11,
6,
null,
21,
10,
13,
12,
11,
14
]
},
"outBoundIndex": -1,
"partners": [
"Booking.com",
"Trip.com",
"Hotels.com",
"Hyatt",
"Expedia",
"IHG"
],
"covidFilter": {
"title": "",
"filterOptions": [],
"switcherOptions": []
},
"poiFilter": {
"entity": null,
"defaultPoiItem": null,
"poiFilterTitle": "From where?",
"poiRecommendCardTitle": "Search for hotels close to",
"poiTypeIconMapping": {
"Beach": "beach",
"Landmark": "landmark",
"Entertainment": "bar",
"Shopping": "deals",
"Transportation": "cars",
"Education": "education"
},
"translations": {
"Beach": "Beach",
"Landmark": "Landmark",
"Entertainment": "Entertainment",
"Shopping": "Shopping",
"Transportation": "Transportation",
"Education": "Education"
},
"quickSelectOptions": [
{
"image_url": "https://d2xf5gjipzd8cd.cloudfront.net/POI/206568798/1737108/1737108_WxH.jpg",
"sub_poi_type": "TouristAttraction",
"name": "Central Park",
"type": "Landmark",
"coordinate": "-73.9653556,40.7828649",
"id": "206568798",
"icon": "landmark"
}
],
"allOptions": [
{
"image_url": "https://d2xf5gjipzd8cd.cloudfront.net/POI/206568798/1737108/1737108_WxH.jpg",
"sub_poi_type": "TouristAttraction",
"name": "Central Park",
"type": "Landmark",
"coordinate": "-73.9653556,40.7828649",
"id": "206568798",
"icon": "landmark"
}
],
"clusterList": [
[
{
"image_url": "https://d2xf5gjipzd8cd.cloudfront.net/POI/206568798/1737108/1737108_WxH.jpg",
"sub_poi_type": "TouristAttraction",
"name": "Central Park",
"type": "Landmark",
"coordinate": "-73.9653556,40.7828649",
"id": "206568798",
"icon": "landmark"
}
],
[
{
"image_url": "https://d2xf5gjipzd8cd.cloudfront.net/POI/206569613/1738477/1738477_WxH.jpg",
"sub_poi_type": "TouristAttraction",
"name": "Empire State Building",
"type": "Landmark",
"coordinate": "-73.9856644,40.7484405",
"id": "206569613",
"icon": "landmark"
}
],
[
{
"image_url": null,
"sub_poi_type": "LeisureCenterBuilding",
"name": "Webster Hall",
"type": "Entertainment",
"coordinate": "-73.9891566,40.7317767",
"id": "208540504",
"icon": "bar"
}
],
[
{
"image_url": null,
"sub_poi_type": "ShoppingMall",
"name": "Loro Piana",
"type": "Shopping",
"coordinate": "-73.9688239,40.7670723",
"id": "208480784",
"icon": "deals"
}
],
[
{
"image_url": null,
"sub_poi_type": "School",
"name": "Mark Twain IS 239 for the Gifted and Talented",
"type": "Education",
"coordinate": "-73.9929576,40.5783183",
"id": "210795792",
"icon": "education"
}
]
],
"QUICKSELECT_OPTIONS_LIMIT": 4
},
"QUICKFILTER_OFFSET": 10,
"QUICKFILTER_MIN_RESULTS": 10,
"POICARD_OFFSET": 8,
"POICARD_MIN_RESULTS": 14,
"requestId": "4d189a57-a8a9-4419-ae12-09cdb1adaa54",
"searchByCurrentLocation": false,
"warningCrisis": null
}
# Retrieve Hotel Details
This API endpoint allows you to retrieve comprehensive details of a hotel based on the provided parameters: hotelId and entityId. By utilizing this endpoint, you can access all relevant information about a specific hotel associated with the given identifiers.
Example API Request:
https://app.goflightlabs.com/retrieveHotelDetails?access_key=YOUR_ACCESS_KEY&hotelId=47012976&entityId=27542048
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Your API access key, which can be found in your acccount dashboard. |
hotelId |
[Required] Can be found on the retrieveHotel endpoint. |
entityId |
[Required] Can be found on the retrieveHotel endpoint. |
currency |
[Optional] Desired currency. For example USD. Can be obtained from the endpoint retrieveCountries. |
market |
[Optional] For example en-US. Can be obtained from the endpoint retrieveCountries. |
countryCode |
[Optional] For example US. Can be obtained from the endpoint retrieveCountries. |
# Retrieve Hotel Prices
This API endpoint allows you to retrieve hotel prices based on the provided parameters: hotelId, entityId, Check-In date, and Check-Out date. It provides the flexibility to obtain accurate pricing information for specific hotels and date ranges.
Example API Request:
https://app.goflightlabs.com/retrieveHotelPrices?access_key=YOUR_ACCESS_KEY&hotelId=106005202&entityId=27537542&checkin=2024-08-11&checkout=2024-08-12&adults=1&rooms=1
HTTP GET Request Parameters:
Object | Description |
---|---|
access_key |
[Required] Your API access key, which can be found in your acccount dashboard. |
hotelId |
[Required] Can be found on the retrieveHotel endpoint. |
entityId |
[Required] Can be found on the retrieveHotel endpoint. |
checkin |
[Required] Date of Check In. Format: YYYY-MM-DD. |
checkout |
[Required] Date of Check Out. Format: YYYY-MM-DD. |
adults |
[Optional] Number of adults (aged 18 and over) Default value: 1. |
rooms |
[Optional] Customize results based on the number of desired rooms. |
childrenAges |
[Optional] Specify ages of children. |
currency |
[Optional] Desired currency. For example USD. Can be obtained from the endpoint retrieveCountries. |
market |
[Optional] For example en-US. Can be obtained from the endpoint retrieveCountries. |
countryCode |
[Optional] For example US. Can be obtained from the endpoint retrieveCountries. |