The Geo Search API (GeoSearchRQ) is used to retrieve a list of properties around a search location using a radius or a neighborhood search. It can also be used to locate car rental locations, airports, and hotels.
Overview
Geo Search enables you to define different types of location resolutions, including:
- Search hotels
- Car rental locations
- Airports by geocode (latitude and longitude)
- Polygon ID
- Airport code
- Point of interest (POI)
- Hotel codes
- Rail stations
- Sabre ID
- Global ID
Within the request is a parameter that allows you to define a required search radius of up to 200 miles, or 321 kilometers, along with the defined unit of measure (miles or kilometers).
Search details
Hotel | Rail | Polygon | Geo Code |
---|---|---|---|
Address | Address | ||
Airport Code | Airport Code | ||
Geo Code | |||
Hotel Code | |||
Place Name | |||
POI | POI | ||
Polygon ID | |||
Latitude and Longitude | |||
Rail Station Name | Rail Station Name | ||
Search in a predefined area or neighborhood (for example, downtown Dallas) to return concise search results. | |||
CHAIN |
|||
LOCALAREA |
The response will contain:
- Property ID
- Property name
- Property address, including latitude and longitude
- Chain information
The response includes identified Airports, Hotels, or Car Rental Locations and the straight-line distance between these resolved locations. If the search is by polygon ID, the response will include the hotels that fall within the requested polygon.
Reference point types
Below are the ref point types and value context combinations Geo Search currently supports:
Search by | Refpoint Type | Value Context | Description |
---|---|---|---|
Polygon | 37 | CODE | In the Value field, provide the polygon ID |
Airport Code | 6 | CODE | In the Value field, provide the airport code |
Hotel Code | 11 | CODE | In the Value field, provide the hotel id |
POI | 16 | NAME | In the Value field, provide the POI name |
Rail | 7 | NAME | In the Value field, provide the rail station |
Search by RefPoint
example:
<RefPoint Value="DFW" ValueContext="CODE" RefPointType="6" StateProv="TX" CountryCode="US"/>
Note: In this example, we're searching for an airport using the three-letter IATA airport code as the
Value
.
<RefPoint Value="272513" ValueContext="CODE" RefPointType="11"/>
Note: In this example, we're searching for an Hotel using the Hotel code as the
Value
.
<RefPoint Value="park" ValueContext="NAME" RefPointType="16" CountryCode="US"/>
Note: In this example, we're searching using the Point of Interest as the
Value
andCountryCode
as the mandatory field.
<RefPoint Value="HAMILTON CENTRAL" ValueContext="NAME" RefPointType="7"/>
Note: In this example, we're searching for station using the Railway Station Name as the
Value
.
<RefPoint Value="200005318" ValueContext="CODE" RefPointType="37"/>
Note: In this example, we're searching using the Polygon Id as the
Value
.
Search by AddressRef
example:
<AddressRef Street="Hidden Ridge" City="irving" Zip="75038" County="Dallas" State="TX" Country="USA"/>
Note:
Country
is mandatory.
Search by GeoCode
example:
<GeoCode Latitude="0.0" Longitude="0.0"/>
Note:
Latitude
andLongitude
are mandatory.
GeoAttributes
The Geo Search V4 API also provides two types of filters in the name of GeoAttributes to narrow down the returned hotel properties.
- Chain - e.g.: EN
- Local Area - e.g. : Stuttgart greater area
<Attributes Name="CHAIN" Value="EN"/>
<Attributes Name="LOCALAREA" Value="Stuttgart greater area"/>
</GeoAttributes>
Note: You can give a maximum of twenty chain/local areas or chain and local areas as filters.
The Geo Search V4 API also provides a filter in the name of GeoAttributes to narrow down the returned CAR properties.
- Vendor - e.g.: ZI
<Attributes Name="VENDOR" Value="ZI"/>
</GeoAttributes>
Note: You can give a maximum of twenty vendors as filters.
Samples
Search by HOTEL
as CATEGORY
example:
Sample Request
<GeoRef Radius="5" UOM="MI" MaxResults="300" Offset="1" Category="HOTEL" ReturnNonAggregatorPropertiesOnly="false" LenientSearch="false" MaxSearchResults="5000">
<AddressRef Street="Hidden Ridge" City="irving" PostalCode="75038" County="Dallas" StateProv="TX" CountryCode="US"/>
</GeoRef>
</GeoSearchRQ>
Sample Response
<ns14:GeoSearchResult Latitude="32.881352" Direction="N" Longitude="-96.961089" Distance="0.29">
<ns14:Name>Extended Stay America-dallas-las Colinas-carnaby St.</ns14:Name>
<ns14:Id>100128624</ns14:Id>
<ns14:Street>5315 Carnaby Street</ns14:Street>
<ns14:Zip>75038</ns14:Zip>
<ns14:City>Irving</ns14:City>
<ns14:State>TX</ns14:State>
<ns14:Country>US</ns14:Country>
<ns14:ConfidenceFactor>1</ns14:ConfidenceFactor>
<ns14:Attributes>
<ns14:Attribute Value="EA" Name="CHAIN"/>
<ns14:Attribute Value="42006" Name="SABRE_ID"/>
</ns14:Attributes>
</ns14:GeoSearchResult>
</ns14:GeoSearchResults>
Search by CAR
as CATEGORY
example:
Sample Request
<GeoRef Radius="5" UOM="MI" MaxResults="500" Offset="1" Category="CAR" ReturnNonAggregatorPropertiesOnly="false" LenientSearch="false" MaxSearchResults="5000">
<AddressRef Street="Hidden Ridge" City="irving" PostalCode="75038" County="Dallas" StateProv="TX" CountryCode="US"/>
</GeoRef>
</GeoSearchRQ>
Sample Response
<ns14:GeoSearchResult Latitude="32.875136" Direction="E" Longitude="-96.94318" Distance="0.95">
<ns14:Name>DFWW99 IRVING CONVENTION CENTE</ns14:Name>
<ns14:Id>ETDFWW099</ns14:Id>
<ns14:Street>500 LAS COLINAS BLVD W</ns14:Street>
<ns14:Zip>75039-3717</ns14:Zip>
<ns14:City>IRVING</ns14:City>
<ns14:State>TX</ns14:State>
<ns14:Country>US</ns14:Country>
<ns14:ConfidenceFactor>1</ns14:ConfidenceFactor>
<ns14:Attributes>
<ns14:Attribute Value="ET" Name="VENDOR"/>
</ns14:Attributes>
</ns14:GeoSearchResult>
</ns14:GeoSearchResults>
Search by CAR
as CATEGORY
with filter by VENDOR
example:
Sample Request
<GeoRef Radius="5" UOM="MI" MaxResults="300" Offset="1" Category="CAR" ReturnNonAggregatorPropertiesOnly="false" LenientSearch="false" MaxSearchResults="5000">
<AddressRef Street="Hidden Ridge" City="irving" PostalCode="75038" County="Dallas" StateProv="TX" CountryCode="US"/>
</GeoRef>
<GeoAttributes>
<Attributes Name="VENDOR" Value="ZD"/>
</GeoAttributes>
</GeoSearchRQ>
Sample Response
<ns13:GeoSearchResult Latitude="32.884887" Direction="N" Longitude="-96.958854" Distance="0.51">
<ns13:Name>DFWW04 WINGATE INN LAS COLINAS</ns13:Name>
<ns13:Id>ZDDFWW004</ns13:Id>
<ns13:Street>850 W WALNUT HILL LN SUITE 127</ns13:Street>
<ns13:Zip>75038-2611</ns13:Zip>
<ns13:City>IRVING</ns13:City>
<ns13:State>TX</ns13:State>
<ns13:Country>US</ns13:Country>
<ns13:ConfidenceFactor>1</ns13:ConfidenceFactor>
<ns13:Attributes>
<ns13:Attribute Value="ZD" Name="VENDOR"/>
</ns13:Attributes>
</ns13:GeoSearchResult>
Search by RAIL
as CATEGORY
example:
Sample Request
<GeoRef Radius="20" UOM="MI" MaxResults="1" Offset="1" Category="RAIL" ReturnNonAggregatorPropertiesOnly="false" LenientSearch="false" MaxSearchResults="5000">
<AddressRef Street="Hidden Ridge" City="irving" PostalCode="75038" County="Dallas" StateProv="TX" CountryCode="US"/>
</GeoRef>
</GeoSearchRQ>
Sample Response
<ns14:GeoSearchResult Latitude="32.776094" Direction="SE" Longitude="-96.807235" Distance="11.27">
<ns14:Name>Dallas</ns14:Name>
<ns14:Id>DAL</ns14:Id>
<ns14:State>TX</ns14:State>
<ns14:ConfidenceFactor>1</ns14:ConfidenceFactor>
</ns14:GeoSearchResult>
</ns14:GeoSearchResults>
Search by AIR
as CATEGORY
example:
Sample Request
<GeoRef Radius="5" UOM="MI" MaxResults="1" Offset="1" Category="AIR" ReturnNonAggregatorPropertiesOnly="false" LenientSearch="false" MaxSearchResults="5000">
<AddressRef Street="Hidden Ridge" City="irving" PostalCode="75038" County="Dallas" StateProv="TX" CountryCode="US"/>
</GeoRef>
</GeoSearchRQ>
Sample Response
<ns14:GeoSearchResult Latitude="32.896111" Direction="W" Longitude="-97.041111" Distance="4.91">
<ns14:Name>Dallas Fort Worth Intl</ns14:Name>
<ns14:Id>DFW</ns14:Id>
<ns14:City>Dallas</ns14:City>
<ns14:State>TX</ns14:State>
<ns14:Country>US</ns14:Country>
<ns14:ConfidenceFactor>1</ns14:ConfidenceFactor>
</ns14:GeoSearchResult>
</ns14:GeoSearchResults>