Travelpayouts

https://support.travelpayouts.com/hc/en-us/
Admin
Travelpayouts is an affiliate platform that allows partners to earn money by promoting travel brands...
Tokens:185,232
Snippets:2,356
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Initialize and setup project

Source: https://support.travelpayouts.com/hc/en-us/articles/17203770656530-Preparing-to-work-with-the-configuration-file-and-accessing-data-for-iOS

Navigate to the project directory and run initialization commands to install dependencies and apply configuration changes.

```bash
cd /path/to/travel-app-ios
```

```bash
fastlane initialize
```

```bash
fastlane setup
```

--------------------------------

### Example API Request

Source: https://support.travelpayouts.com/hc/en-us/articles/360016375920-GetTransfer-API

A concrete example of a GET request with query parameters for points, passenger count, date, currency, and distance units.

```http
GET /api/route_info?points[]=<lat,long>&points[]=<lat,long>&with_prices=true&pax=2&date_to=2025-11-15T18:30:00+07:00&currency=USD&distance_unit=km
```

--------------------------------

### Customized Footer Links Example

Source: https://support.travelpayouts.com/hc/en-us/articles/360024025611-Terms-of-Use-Privacy-Policy-and-Cookie-Policy-for-White-Label

Example of how to replace default paths with your own absolute URLs.

```html
<a href="https://yourdomain.com/terms" target="_blank">Terms of Service</a>
<a href="https://yourdomain.com/privacy" target="_blank">Privacy Policy</a>
<a href="https://yourdomain.com/cookie-policy" target="_blank">Cookie Policy</a>
```

--------------------------------

### Complete Podfile configuration example

Source: https://support.travelpayouts.com/hc/en-us/articles/20517133472658-SDK-Configuration-for-iOS

A full example of a Podfile configured for the Travelpayouts SDK, including source, platform, target, and post-install hooks.

```ruby
source 'https://github.com/CocoaPods/Specs.git'

platform :ios, '14.0'
target 'MyApplication' do
  pod 'WLSDK/Flights', '1.2.0'
end

# Various post-install hooks

post_install do |installer|
 installer.pods_project.targets.each do |target|
  target.build_configurations.each do |config|
   config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '14.0'
   config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
  end
 end
end
```

--------------------------------

### String Replacement Key Example

Source: https://support.travelpayouts.com/hc/en-us/articles/20517133472658-SDK-Configuration-for-iOS

Example of a key-value pair in a .strings file for text replacement.

```text
"departure_airport_placeholder" = "Departure airport";
```

--------------------------------

### GET /locations/topdestinations

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

Returns a list of destinations most searched, clicked on, or booked from a specified starting point.

```APIDOC
## GET /locations/topdestinations

### Description
Returns a list of destinations most searched, clicked on, or booked from the starting point defined by the term parameter.

### Method
GET

### Endpoint
/locations/topdestinations

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your personal apikey (HTTP Basic authentication header).
- **term** (string) - Required - Identifier of the start point (slug or id).
- **locale** (string) - Optional - Desired locale output (e.g., en-US).
- **location_types** (string) - Optional - Desired location output types (e.g., airport, city).
- **limit** (integer) - Optional - Desired number of results (default: 10).
- **active_only** (boolean) - Optional - Display only active locations (default: true).
- **sort** (string) - Optional - Desired order of output (e.g., name or -name).
- **source_popularity** (string) - Optional - Metric for popularity: searches, bookings, or clicks (default: searches).

### Response
#### Success Response (200)
- **locations** (array) - List of destination objects.
- **meta** (object) - Metadata regarding the request.

#### Response Example
{
  "locations": [
    {
      "id": "LCY",
      "int_id": "9625",
      "active": true,
      "code": "LCY",
      "name": "London City Airport",
      "slug": "london-city-airport",
      "alternative_names": [],
      "rank": "0",
      "timezone": "Europe/London",
      "city": {
        "id": "london_gb",
        "name": "London",
        "code": "LON",
        "slug": "london",
        "subdivision": "null",
        "autonomous_territory": "null",
        "country": {
          "id": "GB",
          "name": "United Kingdom",
          "slug": "united-kingdom",
          "code": "GB"
        },
        "region": {
          "id": "northern",
          "name": "Northern Europe",
          "slug": "northern-europe"
        },
        "continent": {
          "id": "europe",
          "name": "Europe",
          "slug": "europe",
          "code": "EU"
        }
      }
    }
  ],
  "meta": {
    "locale": "",
    "status": ""
  }
}
```

--------------------------------

### Response example for GET /locations/slug

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

The JSON response structure returned when querying a location by its SEO slug.

```json
{
  "locations": [
    {
      "id": "LCY",
      "int_id": "9625",
      "active": true,
      "code": "LCY",
      "name": "London City Airport",
      "slug": "london-city-airport",
      "alternative_names": [],
      "rank": "0",
      "timezone": "Europe/London",
      "city": {
        "id": "london_gb",
        "name": "London",
        "code": "LON",
        "slug": "london",
        "subdivision": "null",
        "autonomous_territory": "null",
        "country": {
          "id": "GB",
          "name": "United Kingdom",
          "slug": "united-kingdom",
          "code": "GB"
        },
        "region": {
          "id": "northern",
          "name": "Northern Europe",
          "slug": "northern-europe"
        },
        "continent": {
          "id": "europe",
          "name": "Europe",
          "slug": "europe",
          "code": "EU"
        }
      },
      "location": {
        "lon": "0.054167",
        "lat": "51.505"
      },
      "alternative_departure_points": [
        "id: LHR",
        "distance: 35.8",
        "duration: 1.4"
      ],
      "type": "airport"
    }
  ],
  "meta": {
    "locale": "",
    "status": ""
  }
}
```

--------------------------------

### Install Homebrew and Fastlane

Source: https://support.travelpayouts.com/hc/en-us/articles/17203770656530-Preparing-to-work-with-the-configuration-file-and-accessing-data-for-iOS

Commands to install the Homebrew package manager and the Fastlane tool for project automation.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

```bash
brew install fastlane
```

--------------------------------

### Search flight tickets by price response example

Source: https://support.travelpayouts.com/hc/en-us/articles/203956163-Aviasales-Data-API

Example JSON response returned by the search_by_price_range endpoint.

```json
{
 	"currency": "eur",
 	"data": [
 		{
 			"departure_at": "2024-11-03",
 			"destination_airport": "BCN",
 			"destination_code": "BCN",
 			"destination_name": "Barcelona",
 			"duration": 90,
 			"link": "/BCN0311LON1?t=DP16359621001635967500000000LHRBCN_2560c41c52a83fba3afad4d8770d1ee9_6088\u0026search_date=28052024\u0026expected_price_uuid=0cd8aa16-9169-4099-9076-574fbee7da8a\u0026expected_price_currency=rub",
 			"origin_airport": "LHR",
 			"origin_code": "LON",
 			"origin_name": "London",
 			"price": 588,
 			"transfers": 0
 		}
 	],
 	"success": true
}
```

--------------------------------

### Top destinations hashtags lookup response

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

Example JSON response structure for the GET /locations/tophashtags endpoint.

```json
{
  "meta": {
    "locale": {
      "code": "en-US",
      "status": "Locale not specified, using default."
    }
  },
  "hashtags": [
    "sightseeing",
    "activities",
    "famous cities",
    "family fun",
    "beach",
    "events"
  ],
  "last_refresh": 1611573691
}
```

--------------------------------

### GET /locations/tophashtags

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

Returns a list of popular destination hashtags based on search, booking, or click activity from a specified starting point.

```APIDOC
## GET /locations/tophashtags

### Description
Returns a list of destinations' hashtags most searched / clicked on / booked from the starting point `term`.

### Method
GET

### Endpoint
/locations/tophashtags

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your personal apikey (HTTP Basic authentication header).
- **term** (string) - Required - Identifier of the start point.
- **limit** (integer) - Optional - Desired number of results in the output (default: 10).
- **source_popularity** (string) - Optional - Based on 'searches' (default), 'bookings' or 'clicks'.
- **fallback_popularity** (string) - Optional - Based on 'searches', 'bookings' or 'clicks'. Used if not enough results are returned by `source_popularity`.

### Response
#### Success Response (200)
- **meta** (object) - Metadata regarding the request.
- **hashtags** (array) - List of popular hashtags.
- **last_refresh** (integer) - Timestamp of the last data refresh.
```

--------------------------------

### GET /locations/hashtag

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

Returns a list of destinations most searched, clicked on, or booked from a starting point, filtered by a specific hashtag.

```APIDOC
## GET /locations/hashtag

### Description
Returns a list of destinations most searched / clicked on / booked from the starting point `term` that are tagged with the specified `hashtag`.

### Method
GET

### Endpoint
/locations/hashtag

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your personal apikey (HTTP Basic authentication header).
- **hashtag** (string) - Required - Hashtag that the returned location have to be tagged with.
- **term** (string) - Optional - Identifier of the location the returned locations should be part of.
- **month** (integer) - Optional - The month in which the hashtag should be valid. Multiple values are allowed.
- **locale** (string) - Optional - Desired locale output.
- **limit** (integer) - Optional - Desired number of results in the output (default: 10).
- **active_only** (boolean) - Optional - Display all active locations (default: true).
- **sort** (string) - Optional - Desired order of the output (e.g., 'name' or '-name').

### Response
#### Success Response (200)
- **locations** (array) - List of destination objects.
- **meta** (object) - Metadata regarding the request.
```

--------------------------------

### Transfer Offers Example Response

Source: https://support.travelpayouts.com/hc/en-us/articles/360016375920-GetTransfer-API

A concrete example of a successful JSON response containing transfer offer details.

```json
{
 	"result": "success",
 	"data": {
 		"offers": [
 			{
 				"id": 409761,
 				"wifi": false,
 				"refreshments": false,
 				"safety_partition": false,
 				"with_name_sign": false,
 				"charger": false,
 				"wheelchair": false,
 				"carrier": {
 					"id": 143,
 					"approved": false,
 					"ratings": {
 						"driver": 3.0,
 						"vehicle": 3.1,
 						"communication": 3.4,
 						"average": 3.2
 					},
 					"rated_offers_count": 8,
 					"years_of_work": 4,
 					"languages": [
 						{
 							"code": "en",
 							"title": "English"
 						},
						{
 							"code": "fr",
 							"title": "Français"
 						}
 					]
 				},
 				"vehicle": {
 					"id": 4786,
 					"name": "Toyota Auris, 2020",
 					"model": "Toyota Auris",
 					"transport_type_id": "economy",
 					"year": 2020,
 					"color": "beige",
 					"registration_number": "HH67676",
 					"pax_max": 4,
 					"luggage_max": 4,
 					"brand_name": "Toyota",
 					"model_name": "Auris",
 					"new_luxury": false,
 					"photos": [
 						"/files/fc60bd204366e1132c8ca97e23dfcc1b",
 						"/files/c1949e43693f8369ac39b8b3b8545089"
 					]
 				}
 			}
 		]
 	}
}
```

--------------------------------

### Response example for location search by radius

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

Example JSON response structure returned by the /locations/radius endpoint.

```json
{
  "locations": [
    {
      "id": "LCY",
      "int_id": "9625",
      "active": true,
      "code": "LCY",
      "name": "London City Airport",
      "slug": "london-city-airport",
      "alternative_names": [],
      "rank": "0",
      "timezone": "Europe/London",
      "city": {
        "id": "london_gb",
        "name": "London",
        "code": "LON",
        "slug": "london",
        "subdivision": "null",
        "autonomous_territory": "null",
        "country": {
          "id": "GB",
          "name": "United Kingdom",
          "slug": "united-kingdom",
          "code": "GB"
        },
        "region": {
          "id": "northern",
          "name": "Northern Europe",
          "slug": "northern-europe"
        },
        "continent": {
          "id": "europe",
          "name": "Europe",
          "slug": "europe",
          "code": "EU"
        },
        "location": {
          "lat": "50.132625",
          "lon": "14.977992"
        },
        "alternative_departure_points": [
          "id: BRQ",
          "distance: 200",
          "duration: 2.5"
      ],
      "type": "bus_station"
    },
      }
  ],
  "meta": {
    "locale": "",
    "status": ""
  }
}
```

--------------------------------

### Affiliate Deep Link Construction

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

Example of a constructed affiliate link using the custom_url parameter.

```text
https://c111.travelpayouts.com/click?shmarker=YOUR_PARTNER_ID.YOUR_SUB_ID&promo_id=5000&source_type=customlink&type=click&custom_url=https%3A%2F%2Fwww.kiwi.com%2Fdeep%3Ffrom%3DPRG%26to%3DBVA%26departure%3D12-12-2018%26flightsId%3D3973635228307542_0%257C3920858677740250_0%257C3961540602430384_0%257C3935152321765312_0%257C4002222539678644_0%257C3945047937951749_0%26price%3D141.0%26passengers%3D1%26affilid%3Dkayak_en%26lang%3Den%26currency%3DEUR%26booking_token%3D0T6hZkC4xKvv6vKoCqxJiDnXpXzE1Q844kKHQbBBq1cR5mkiRNPibvoHzTrfY7MZPQbf1%2F4e%2F21RfgFdGAADFMrFvX1EDcgeBAeHQn44Dd6%2FB6dPsBRAbT7yZVB4pioK2Kf5Z7nxo09m7Eqo27tYMi1%2FyNvb3FUVasR6uCl%2FnQ0n98DejUnXBAFk33z5ibw8yp242I1Yb8Ih16Vgp6jxXwNbTziPn%2FAa%2FVbg0VLEvMJtDbYlYUwv6eI7wrSRM45ioBcmAxXvlf0gsHoAcdFCVIS%2B9o7wHlD0udR%2BIWGdNyNTCFtrRjORBG9P%2FNJI4DiwhMDvyitnt9CXopfzEfU2hRxlVlBv8mITqMu25UVQrYGA%2BcTEabZ5HItc3S6xtc3fvBelH%2F8Oz%2BGU12zgS%2BHazZCf%2F0UzGvL7Qt9RZzw8F5TUoq9cSqd84oa4PJr0NXFXIUmw3O0kacwcUUMfvXaOEWj9DU6ssy7U0JXYOZXZyRhzlifOqNICVuaHnKzKDBVfPVrDMfoADAxYpGvzOGtM57v5ek96xP3v98%2BwjyDSSTMxFL1yEzCO9qKLMP1i48%2BtkVVyjZZXFJwVcV%2BhuFMIBnDWNQ84cUuLm3Qg2%2B1TSG%2Bxh8AEyanRglNSQvQNMFi5CWJyDAwoE5%2Bt5xdJUP9m50ju6cFMgWO02C1lGyzH4uI4pTU4i5b%2FjLwbRd6KUznC5SrZMRNjF6fa1Q99ZcUQ%2FE2gMpeX0aPusblt21L78na857JqEKdHShXpROThkCk9ohIYecKA0%2BWGmkU0yIlQuOxPhYq6I1SuNYWg%2F%2BsPLBzzJ%2B5x6ecXMVCvqYTU69mm%26type2%3Dsalesman
```

--------------------------------

### GET /locations/anything

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

Retrieves location details based on a specified key and value pair.

```APIDOC
## GET /locations/anything

### Description
Get locations specified by any of the following fields for example — id, int_id, code, icao, name, slug, etc.

### Method
GET

### Endpoint
/locations/anything

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your personal apikey (HTTP Basic authentication header).
- **key** (string) - Required - The field in the response to filter by (e.g., int_id).
- **value** (string) - Required - The value of the field selected in the key.
- **locale** (string) - Optional - Desired locale output (e.g., en-US).
- **active_only** (boolean) - Optional - Default value = true. Displays all active locations.

### Response
#### Success Response (200)
- **locations** (array) - List of location objects matching the criteria.
- **meta** (object) - Metadata regarding the request status and locale.

#### Response Example
{
  "locations": [
    {
      "id": "LCY",
      "int_id": "9625",
      "active": true,
      "code": "LCY",
      "name": "London City Airport",
      "slug": "london-city-airport",
      "alternative_names": [],
      "rank": "0",
      "timezone": "Europe/London",
      "city": {
        "id": "london_gb",
        "name": "London",
        "code": "LON",
        "slug": "london",
        "subdivision": "null",
        "autonomous_territory": "null",
        "country": {
          "id": "GB",
          "name": "United Kingdom",
          "slug": "united-kingdom",
          "code": "GB"
        },
        "region": {
          "id": "northern",
          "name": "Northern Europe",
          "slug": "northern-europe"
        },
        "continent": {
          "id": "europe",
          "name": "Europe",
          "slug": "europe",
          "code": "EU"
        }
      }
    }
  ],
  "meta": {
    "locale": "",
    "status": ""
  }
}
```

--------------------------------

### API Response Example

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

A sample JSON response object returned by the Kiwi.com affiliate API, containing flight search results, pricing, and route information.

```json
{
  "search_id": "0e00b78e-91bb-449d-a1af-f5e626b3b602",
  "data": [
    {
      "id": "22ee0f6b491f000063ba729a_0",
      "nightsInDest": null,
      "duration": {
        "departure": 11220,
        "return": 0,
        "total": 11220
      },
      "flyFrom": "LGA",
      "cityFrom": "New York",
      "cityCodeFrom": "NYC",
      "countryFrom": {
        "code": "US",
        "name": "United States"
      },
      "flyTo": "MIA",
      "cityTo": "Miami",
      "cityCodeTo": "MIA",
      "countryTo": {
        "code": "US",
        "name": "United States"
      },
      "distance": 1770.31,
      "routes": [
        "- LGA\n- MIA"
      ],
      "airlines": [
        "AA"
      ],
      "pnr_count": 1,
      "has_airport_change": false,
      "technical_stops": 0,
      "price": 69,
      "bags_price": {
        "1": 36.96
      },
      "baglimit": {
        "hand_width": 23,
        "hand_height": 36,
        "hand_length": 56,
        "hand_weight": 10,
        "hold_width": 28,
        "hold_height": 52,
        "hold_length": 78,
        "hold_dimensions_sum": 158,
        "hold_weight": 23
      },
      "availability": {
        "seats": 7
      },
      "facilitated_booking_available": true,
      "conversion": {
        "EUR": 69
      },
      "quality": 142.86648200000002,
      "booking_token": "BpnCkNqQQCgJsFyvZChbweyYDAMPOZcG4hMj2jZ--xOulHSxYCwzukDf03iLflxdO07awWun1on4u4FKnJOfbHSp5EvfgUAIkdp6L_YnT8aLVM5gczx8mZ5tpGjPnu9_zaSnYouW41gQd2jF73dMmOoGC_mDNYSq1GZqA3VEU_DUWRjyuyEx2x9pnM5jEy4ujc1ENlEoFPcSyaqqPuIB7_CAALOWKuQqyNoMUNjxAN-d3caz9gn5XyUAxeF8EXSFddGVPQYkxJTlxN_s5uD3bxWtvfutujpEVKoUlNxdV0sBuOogQqCMvZhqlPLBcgA2SbfG9dZY-YC1yuP-nMPX3t7yYfpshni7aQ-G6YXI0KN4Lve3lw2m9FluWFMRVvPlyeicA-1IYxIxL5GUfg96OYr7HfLY40nmqA--IydcjsWLPOI8zYNoi4KMr6YTM0t_XuMGBUwLTjd51Zx-sm_R7tMZ2HHCTEtwTKhFQCNx3WN9MDsTZS5KfrLD73BzHUWWMBMEZ4ux2qJLH3XBeJKzovOGmMzHA-KRBetC5oocLyFshFijM53AWF2yyuJ1-XPEgPvg72qkrOMjtRi2cpYWS1Ig_tqPOUlkpPZmZsWp-cRJdGH2TxmwRrn8cB0uEvkkB",
      "transfers": [],
      "type_flights": [
        "deprecated"
      ],
      "fare": {
        "adults": 34.5,
        "children": 34.5,
        "infants": 34.5
      },
      "price_dropdown": {
        "base_fare": 69,
        "fees": 0
      },
      "virtual_interlining": false,
      "route": [
        {
          "fare_basis": "O7ALZNB3",
          "fare_category": "M",
          "fare_classes": "B",
          "fare_family": "",
          "last_seen": "2021-01-24T02:09:10.000Z",
          "refresh_timestamp": "2021-01-24T02:09:10.000Z",
          "return": 0,
          "bags_recheck_required": false,
          "guarantee": false,
          "id": "22ee0f6b491f000063ba729a_0",
          "combination_id": "22ee0f6b491f000063ba729a",
          "cityTo": "Miami",
          "cityFrom": "New York",
          "cityCodeFrom": "NYC",
          "cityCodeTo": "MIA",
          "flyTo": "MIA",
          "flyFrom": "LGA",
          "airline": "AA",
          "operating_carrier": "AA",
          "equipment": "738",
          "flight_no": 1249,
          "vehicle_type": "aircraft",
          "operating_flight_no": "1249",
          "local_arrival": "2021-04-02T09:07:00.000Z",
          "utc_arrival": "2021-04-02T13:07:00.000Z",
          "local_departure": "2021-04-02T06:00:00.000Z",
          "utc_departure": "2021-04-02T10:00:00.000Z"
        }
      ],
      "local_arrival": "2021-04-02T09:07:00.000Z",
      "utc_arrival": "2021-04-02T13:07:00.000Z",
      "local_departure": "2021-04-02T06:00:00.000Z",
      "utc_departure": "2021-04-02T10:00:00.000Z"
    }
  ],
  "connections": [],
  "time": 1,
  "currency": "EUR",
  "currency_rate": 1,
  "fx_rate": 1,
  "refresh": [],
  "del": 0,
  "ref_tasks": [],
  "search_params": {
    "flyFrom_type": "airport",
    "to_type": "airport",
    "seats": {
      "passengers": 2,
      "adults": 1,
      "children": 1,
      "infants": 0
    }
  },
  "all_stopover_airports": [],
  "all_airlines": []
}
```

--------------------------------

### API Search Response Example

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

Represents the JSON structure returned by the search API, containing search parameters, currency data, and flight results.

```json
{
  "search_params": {
    "to_type": "country",
    "flyFrom_type": "airport",
    "seats": {
      "infants": 0,
      "passengers": 1,
      "adults": 1,
      "children": 0
    }
  },
  "currency_rate": 1,
  "refresh": [],
  "connections": [],
  "currency": "EUR",
  "del": 2.080468,
  "all_airlines": [],
  "time": 1,
  "all_stopover_airports": [],
  "data": {
    "kastoria_gr": {
      "sort_value": 312,
      "segments_count": 3
    },
    "thessaloniki_gr": {
      "sort_value": 205,
      "segments_count": 4
    }
  },
  "search_id": "78007495-13cf-49ec-9147-95fd4bdd856f"
}
```

--------------------------------

### GET /v2/search

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

Performs a flight search based on departure, arrival, and date parameters.

```APIDOC
## GET /v2/search

### Description
Performs a single flight search to retrieve available flight options based on the provided criteria.

### Method
GET

### Endpoint
tequila-api.kiwi.com/v2/search

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your personal apikey provided via HTTP Basic authentication header.
- **fly_from** (string) - Required - Kiwi API ID of the departure location (airport code, city ID, country code, etc.).
- **fly_to** (string) - Required - Kiwi API ID of the arrival location.
- **dateFrom** (string) - Required - Start date of the search in dd/mm/YYYY format.
- **dateTo** (string) - Required - End date of the search in dd/mm/YYYY format.
```

--------------------------------

### API Response Structure

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

Example JSON response returned by the Kiwi.com affiliate API containing search parameters and flight data.

```json
{
  "search_params": {
    "to_type": "country",
    "flyFrom_type": "airport",
    "seats": {
      "infants": 0,
      "passengers": 1,
      "adults": 1,
      "children": 0
    }
  },
  "currency_rate": 1,
  "refresh": [],
  "connections": [],
  "currency": "EUR",
  "del": 2.44155,
  "all_airlines": [],
  "time": 1,
  "all_stopover_airports": [],
  "data": {
    "kastoria_gr": {
      "duration": 196500,
      "rating": 312,
      "price": 312,
      "segments_count": 3
    },
    "samos_gr": {
      "duration": 186600,
      "rating": 283,
      "price": 283,
      "segments_count": 3
    }
  },
  "search_id": "78007495-13cf-49ec-9147-95fd4bdd856f"
}
```

--------------------------------

### Flight Search Response

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

Example of the JSON response structure returned by the flight search API.

```APIDOC
### Response Example
{
  "response": {
    "value": {
      "baglimit": {
        "hand_height": "None",
        "hand_length": "None",
        "hand_weight": "None",
        "hand_width": "None",
        "hold_weight": 20
      },
      "bags_price": {
        "1": 150,
        "2": 300
      },
      "booking_token": "...",
      "currency": "EUR",
      "deep_link": "https://www.kiwi.com/deep?...",
      "facilitated_booking_available": false,
      "price": 141,
      "route": [
        {
          "airlines": ["FR"],
          "cityFrom": "Prague",
          "cityTo": "Paris"
        }
      ]
    }
  }
}
```

--------------------------------

### API Response Structure

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

Example JSON response returned by the Kiwi.com affiliate API, containing search parameters, currency information, and city-specific data.

```json
{
  "search_params": {
    "to_type": "country",
    "flyFrom_type": "airport",
    "seats": {
      "infants": 0,
      "passengers": 1,
      "adults": 1,
      "children": 0
    }
  },
  "currency_rate": 1,
  "refresh": [],
  "connections": [],
  "currency": "EUR",
  "del": 2.080468,
  "all_airlines": [],
  "time": 1,
  "all_stopover_airports": [],
  "data": {
    "kastoria_gr": 312,
    "samos_gr": 283,
    "plaka_gr": 247,
    "rhodes_gr": 194,
    "ioannina_gr": 247,
    "kozani_gr": 312,
    "parikia_gr": 249,
    "kastellorizo_gr": 337,
    "kalymnos_gr": 310,
    "preveza_gr": 254,
    "alexandroupoli_gr": 284,
    "cephalonia_gr": 176,
    "volos_gr": 333,
    "corfu_gr": 190,
    "kasos_gr": 341,
    "zakynthos-island_gr": 263,
    "heraklion_gr": 248,
    "kalamata_gr": 259,
    "astypalaia_gr": 309,
    "santorini_gr": 225,
    "kos_gr": 224,
    "mytilene_gr": 271,
    "lemnos_gr": 282,
    "patras_gr": 334,
    "athens_gr": 191,
    "chania_gr": 208,
    "kythira_gr": 252,
    "chios_gr": 247,
    "icaria_gr": 286,
    "mykonos_gr": 197,
    "skiathos_gr": 271,
    "karpathos_gr": 252,
    "leros_gr": 308,
    "sitia_gr": 294,
    "kavala_gr": 279,
    "naxos_gr": 252,
    "syros_gr": 294,
    "skyros_gr": 238,
    "thessaloniki_gr": 205
  },
  "search_id": "78007495-13cf-49ec-9147-95fd4bdd856f"
}
```

--------------------------------

### Flight Data API Response Example

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

A JSON object representing the structure of a flight search result from the Kiwi.com API.

```json
{
  "countryFrom": {
    "code": "CZ",
    "name": "Czechia"
  },
  "countryTo": {
    "code": "FR",
    "name": "France"
  },
  "distance": 875.17,
  "flyFrom": "PRG",
  "flyTo": "BVA",
  "has_airport_change": false,
  "id": "3973635228307542_0|3920858677740250_0",
  "local_arrival": "2018-12-12T20:30:00.000Z",
  "local_departure": "2018-12-12T07:05:00.000Z",
  "pnr_count": 2,
  "quality": 177.333035,
  "rank": 0.0193,
  "route": [
    {
      "airline": "FR",
      "bags_recheck_required": false,
      "cityFrom": "Prague",
      "cityTo": "Rome",
      "combination_id": "3973635228307542",
      "equipment": "None",
      "fare_basis": "WZLDIS2",
      "fare_classes": "W",
      "fare_family": "",
      "flight_no": 8332,
      "flyFrom": "PRG",
      "flyTo": "CIA",
      "guarantee": false,
      "id": "3973635228307542_0",
      "last_seen": "2018-11-08T13:55:30.000Z",
      "local_arrival": "2018-12-12T08:55:00.000Z",
      "local_departure": "2018-12-12T07:05:00.000Z",
      "operating_carrier": "None",
      "refresh_timestamp": "2018-11-08T13:55:30.000Z",
      "return": 0,
      "utc_arrival": "2018-12-12T07:55:00.000Z",
      "utc_departure": "2018-12-12T06:05:00.000Z",
      "vehicle_type": "aircraft"
    },
    {
      "airline": "FR",
      "bags_recheck_required": true,
      "cityFrom": "Rome",
      "cityTo": "Paris",
      "combination_id": "3920858677740250",
      "equipment": "None",
      "fare_basis": "NZ1499DC",
      "fare_classes": "N",
      "fare_family": "",
      "flight_no": 9635,
      "flyFrom": "CIA",
      "flyTo": "BVA",
      "guarantee": true,
      "id": "3920858677740250_0",
      "last_seen": "2018-11-08T14:43:32.000Z",
      "local_arrival": "2018-12-12T20:30:00.000Z",
      "local_departure": "2018-12-12T18:15:00.000Z",
      "operating_carrier": "None",
      "refresh_timestamp": "2018-11-08T14:43:32.000Z",
      "return": 0,
      "utc_arrival": "2018-12-12T19:30:00.000Z",
      "utc_departure": "2018-12-12T17:15:00.000Z",
      "vehicle_type": "aircraft"
    }
  ],
  "transfers": [],
  "type_flights": [
    "lcc-FR"
  ],
  "utc_arrival": "2018-12-12T19:30:00.000Z",
  "utc_departure": "2018-12-12T06:05:00.000Z"
}
```

--------------------------------

### GET /aggregation_search/price_per_city

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

Retrieves aggregated flight prices per city.

```APIDOC
## GET /aggregation_search/price_per_city

### Description
Retrieves aggregated flight prices per city. Note that the response is G-zipped and requires unpacking (Content-Encoding: gzip).

### Method
GET

### Endpoint
/aggregation_search/price_per_city
```

--------------------------------

### GET /locations/query

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

Search for locations based on a query string, useful for suggestions and resolving location data.

```APIDOC
## GET /locations/query

### Description
Type of request used mainly for suggestions (based on incomplete names) to search, suggest and resolve locations.

### Method
GET

### Endpoint
tequila-api.kiwi.com/locations/query

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your personal apikey (HTTP Basic authentication header).
- **term** (string) - Required - Searched term (for suggestions). Expects a full IATA code or partial name.
- **locale** (string) - Optional - Desired locale output (e.g., en-US, de-DE).
- **location_types** (string) - Optional - Desired location output (e.g., station, airport, city, country).
- **limit** (integer) - Optional - Desired number of results in the output (default: 10).
- **active_only** (boolean) - Optional - Displays all active locations (default: true).
- **sort** (string) - Optional - Desired order of the output (e.g., 'name' or '-name').

### Response
#### Success Response (200)
- **locations** (array) - List of location objects.
- **meta** (object) - Metadata regarding the request status and locale.

#### Response Example
{
  "locations": [
    {
      "id": "LCY",
      "int_id": "9625",
      "active": true,
      "code": "LCY",
      "name": "London City Airport",
      "slug": "london-city-airport",
      "alternative_names": [],
      "rank": "0",
      "timezone": "Europe/London",
      "city": {
        "id": "london_gb",
        "name": "London",
        "code": "LON",
        "slug": "london",
        "subdivision": "null",
        "autonomous_territory": "null",
        "country": {
          "id": "GB",
          "name": "United Kingdom",
          "slug": "united-kingdom",
          "code": "GB"
        },
        "region": {
          "id": "northern",
          "name": "Northern Europe",
          "slug": "northern-europe"
        },
        "continent": {
          "id": "europe",
          "name": "Europe",
          "slug": "europe",
          "code": "EU"
        }
      }
    }
  ],
  "meta": {
    "locale": "",
    "status": ""
  }
}
```

--------------------------------

### GET /locations/slug

Source: https://support.travelpayouts.com/hc/en-us/articles/360019237899-Kiwi-com-affiliate-program-API

Retrieves location details based on a specific SEO slug.

```APIDOC
## GET /locations/slug

### Description
Retrieves location information such as airports, cities, or countries using their exact SEO slug code.

### Method
GET

### Endpoint
/locations/slug

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your personal apikey (HTTP Basic authentication header).
- **term** (string) - Required - The exact slug code of the location (e.g., albany-new-york-united-states).
- **locale** (string) - Optional - Desired language of the results (e.g., en-US).
- **active_only** (boolean) - Optional - Default value is true. Displays all active locations.

### Response
#### Success Response (200)
- **locations** (array) - List of location objects matching the slug.
- **meta** (object) - Metadata containing locale and status information.

#### Response Example
{
  "locations": [
    {
      "id": "LCY",
      "int_id": "9625",
      "active": true,
      "code": "LCY",
      "name": "London City Airport",
      "slug": "london-city-airport",
      "alternative_names": [],
      "rank": "0",
      "timezone": "Europe/London",
      "city": {
        "id": "london_gb",
        "name": "London",
        "code": "LON",
        "slug": "london",
        "subdivision": "null",
        "autonomous_territory": "null",
        "country": {
          "id": "GB",
          "name": "United Kingdom",
          "slug": "united-kingdom",
          "code": "GB"
        },
        "region": {
          "id": "northern",
          "name": "Northern Europe",
          "slug": "northern-europe"
        },
        "continent": {
          "id": "europe",
          "name": "Europe",
          "slug": "europe",
          "code": "EU"
        }
      },
      "location": {
        "lon": "0.054167",
        "lat": "51.505"
      },
      "alternative_departure_points": [
        "id: LHR",
        "distance: 35.8",
        "duration: 1.4"
      ],
      "type": "airport"
    }
  ],
  "meta": {
    "locale": "",
    "status": ""
  }
}
```
Tokens:
Raw