Sign in
Data

Autocomplete for geographical locations - used to power customer location auto completes.

post/autocomplete

Query parameters

Querystring

Freetext autocomplete query

CountryCodestring

Optional 2-letter country code to restrict matches to a single country

BlockCountryCodestring

Optional 2-letter country code to block matches from a single country

TopQuerystring

Text for top locations match (not used for standard autocomplete)

SearchType1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15

Enumerator defining type of search:<br>1=Flights, 2=Accommodation, 3=Packages, 4=TicketsAttractions, 5=Transfers, 6=AirportExtras, 7=Insurance, 8=CarRental, 9=Visas, 10=Tours, 11=DynamicPackaging, 12=CustomExtra, 13=Cruise, 14=TicketAccommodation, 15=TicketAccommodationFlight

Optional search type (optimises the returned locations for the specified type)

GeographyType1 | 2 | 3 | 4 | 5 | 6

Enumerator defining type of a geographical place:<br>1=Country, 2=City, 3=Airport, 4=PointOfInterest, 5=Property, 6=Port

Optional geography type (restricts the returned locations to the specified type)

LinkGeography1 | 2 | 3 | 4 | 5 | 6

Enumerator defining type of a geographical place:<br>1=Country, 2=City, 3=Airport, 4=PointOfInterest, 5=Property, 6=Port

Optional geography type of linked location (not used for standard autocomplete)

LinkIdstring

Optional id of linked location (not used for standard autocomplete)

MinStarRatingnumber double

Minimum star rating for property matches (0-5)

BlockLevelinteger

Location block level based on geographical/political restrictions (0 = most restrictive, 2 = least restrictive)

ListIDinteger

Optional custom location list identifier (when using this parameter you must authenticate with the API)

Splitboolean

Splits the name into top level and parent (if false all are combined in name field)

IsLocListAdminboolean

Internal use for location list admin tools customisation (default false)

Numericboolean

Return numeric ids only (default false)

Languagestring required

2-letter language code (default is en)

MaxItemsinteger

Maximum items to return (default 20, max 50)

ShowSupplierboolean

Show supplier

Response

Success - returns the list of matching geographical locations.

idstring nullable

Unique geography identifier (id:type).

isValidatedboolean nullable

If location is validated (internal use only).

type1 | 2 | 3 | 4 | 5 | 6

Enumerator defining type of a geographical place:<br>1=Country, 2=City, 3=Airport, 4=PointOfInterest, 5=Property, 6=Port

namestring nullable

Name of location.

parentNamestring nullable

Name of location.

countryCodestring nullable

2-letter country code.

iataCodestring nullable

3-letter airport or city code.

iataCitystring nullable

3-letter city code.

iataGroupCodesstring nullable

Comma-delimited list of group codes

latitudenumber double

Latitude of location.

longitudenumber double

Longitude of location.

priorityinteger

Priority of location.

priorityOriginalinteger

Original priority (unmodified by matching algorithm)

gmtOffsetinteger

GMT time offset.

distanceOverridenumber double nullable

Distance/radius override (miles).

ratingnumber double nullable

Star rating (if property)

refstring nullable

Unique reference (if property).

imageUrlstring nullable

Optional image url.

summarystring nullable

Optional summary description.

eventDatestring date-time nullable

Event date (if event).

eventEndDatestring date-time nullable

Event end date (if event).

daysBeforeinteger nullable

Optional days before setting.

nightsinteger nullable

Optional nights setting.

settingsobject nullable

Optional array of additional settings.

supplier0 | 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

Enumerator defining supplier types:<br>0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom

translationsobject nullable

Translations (only used internally)

Changes

No recorded changes to this endpoint across all 1 revision of this API.