# How to use SearchText Use SearchText This section contains a variety of how to guides and examples for how to use SearchText APIs. **Topics** + [ # How to search for a place, POI, or business using a name ](how-to-search-for-place-poi-business.md) + [ # How to search for a place using contact information ](how-to-search-for-place-using-contact-info.md) + [ # How to search using category name or food type ](how-to-search-category-name.md) + [ # How to search for an address ](how-to-search-address.md) + [ # How to search for a place within a country ](how-to-search-place-in-country.md) + [ # How to search for contact and opening hours ](how-to-search-opening-hours.md) + [ # How to search places using query ID ](how-to-search-query-id.md) + [ # How to search in a specific language ](how-to-search-specific-language.md) # How to search for a place, POI, or business using a name Search for a place, POI, or business using a name The SearchText API allows users to search for a place, POI, or business by name, using free text input. Results can be refined by setting a bias position, which may be based on device location, IP position, or map viewport center. Alternatively, users can provide a specific city or place, with results biased based on the provided geocoordinates. ## Potential use cases + **Locate a place by name:** Retrieve locations based on place names, such as "Gas Town". + **Find points of interest (POIs):** Search for places of interest by name, such as "Stanley Park". + **Search by business name:** Locate businesses by name, like "Starbucks". ## Examples ### Search by place name ------ #### [ Sample request ] ``` { "QueryText": "Gas Town", "BiasPosition": [ -123.11336, 49.26038 ] } ``` ------ #### [ Sample response ] ``` { "ResultItems": [ { "PlaceId": "", "PlaceType": "District", "Title": "Gastown, Vancouver, BC, Canada", "Address": { "Label": "Gastown, Vancouver, BC, Canada", "Country": { "Code2": "CA", "Code3": "CAN", "Name": "Canada" }, "Region": { "Code": "BC", "Name": "British Columbia" }, "SubRegion": { "Name": "Metro Vancouver" }, "Locality": "Vancouver", "District": "Gastown", "PostalCode": "V6B" }, "Position": [ -123.10647, 49.28363 ], "Distance": 2633, "MapView": [ -123.11193, 49.28141, -123.10217, 49.28648 ] } ] } ``` ------ #### [ cURL ] ``` curl --request POST \ --url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-text?key=Your_Key' \ --header 'Content-Type: application/json' \ --data '{ "QueryText": "Gas Town", "BiasPosition": [ -123.11336, 49.26038 ] }' ``` ------ #### [ AWS CLI ] ``` aws geo-places search-text --key ${YourKey} --query-text "Gas Town" --bias-position -123.11336 49.26038 ``` ------ ### Search by POI name ------ #### [ Sample request ] ``` { "QueryText": "Stanley Park", "BiasPosition": [ -123.11336, 49.26038 ] } ``` ------ #### [ Sample response ] ``` { "ResultItems": [ { "PlaceId": "", "PlaceType": "PointOfInterest", "Title": "Stanley Park", "Address": { "Label": "Stanley Park, Stanley Park Dr, Vancouver, BC V6G, Canada", "Country": { "Code2": "CA", "Code3": "CAN", "Name": "Canada" }, "Region": { "Code": "BC", "Name": "British Columbia" }, "SubRegion": { "Name": "Metro Vancouver" }, "Locality": "Vancouver", "District": "Stanley Park", "PostalCode": "V6G", "Street": "Stanley Park Dr", "StreetComponents": [ { "BaseName": "Stanley Park", "Type": "Dr", "TypePlacement": "AfterBaseName", "TypeSeparator": " ", "Language": "en" } ] }, "Position": [ -123.13593, 49.29716 ], "Distance": 4405, "Categories": [ { "Id": "park-recreation_area", "Name": "Park-Recreation Area", "LocalizedName": "Park-Recreation Area", "Primary": true }, { "Id": "tourist_attraction", "Name": "Tourist Attraction", "LocalizedName": "Tourist Attraction", "Primary": false } ] } ] } ``` ------ #### [ cURL ] ``` curl --request POST \ --url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-text?key=Your_Key' \ --header 'Content-Type: application/json' \ --data '{ "QueryText": "Stanley Park", "BiasPosition": [ -123.11336, 49.26038 ] }' ``` ------ #### [ AWS CLI ] ``` aws geo-places search-text --key ${YourKey} --query-text "Stanley Park" --bias-position -123.11336 49.26038 ``` ------ ### Search by business name ------ #### [ Sample request ] ``` { "QueryText": "Amazon YVR11", "BiasPosition": [ -123.11336, 49.26038 ] } ``` ------ #### [ Sample response ] ``` { "ResultItems": [ { "PlaceId": "", "PlaceType": "PointOfInterest", "Title": "Amazon YVR11", "Address": { "Label": "Amazon YVR11, 510 W Georgia St, Vancouver, BC V6B 0M3, Canada", "Country": { "Code2": "CA", "Code3": "CAN", "Name": "Canada" }, "Region": { "Code": "BC", "Name": "British Columbia" }, "SubRegion": { "Name": "Metro Vancouver" }, "Locality": "Vancouver", "District": "Downtown Vancouver", "PostalCode": "V6B 0M3", "Street": "W Georgia St", "StreetComponents": [ { "BaseName": "Georgia", "Type": "St", "TypePlacement": "AfterBaseName", "TypeSeparator": " ", "Prefix": "W", "Language": "en" } ], "AddressNumber": "510" }, "Position": [ -123.11694, 49.28126 ], "Distance": 2336, "Categories": [ { "Id": "business_facility", "Name": "Business Facility", "LocalizedName": "Business Facility", "Primary": true } ], "AccessPoints": [ { "Position": [ -123.11656, 49.28151 ] } ] } ] } ``` ------ #### [ cURL ] ``` curl --request POST \ --url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-text?key=Your_Key' \ --header 'Content-Type: application/json' \ --data '{ "QueryText": "Amazon YVR11", "BiasPosition": [ -123.11336, 49.26038 ] }' ``` ------ #### [ AWS CLI ] ``` aws geo-places search-text --key ${YourKey} --query-text "Amazon YVR11" --bias-position -123.11336 49.26038 ``` ------ # How to search for a place using contact information Search for a place using contact information The SearchText API allows users to search for a place using a phone number, supporting both international and local formats. Users can bias results by setting a position based on device location, IP address, or map viewport center, or by specifying a city or place to refine results based on geocoordinates. ## Potential use cases + **Locate a place with a phone number:** Find a POI by using its contact number to retrieve its address. ## Examples ### Search using phone number In this example, the Vancouver Aquarium is searched using its phone number "\$11 778-655-9554" from a bias position in Vancouver, BC. ------ #### [ Sample request ] ``` { "QueryText": "+1 778-655-9554", "BiasPosition": [ -123.11336, 49.26038 ] } ``` ------ #### [ Sample response ] ``` { "ResultItems": [ { "PlaceId": "", "PlaceType": "PointOfInterest", "Title": "Vancouver Aquarium", "Address": { "Label": "Vancouver Aquarium, 834 Avison Way, Vancouver, BC V6G, Canada", "Country": { "Code2": "CA", "Code3": "CAN", "Name": "Canada" }, "Region": { "Code": "BC", "Name": "British Columbia" }, "SubRegion": { "Name": "Metro Vancouver" }, "Locality": "Vancouver", "District": "Stanley Park", "PostalCode": "V6G", "Street": "Avison Way", "StreetComponents": [ { "BaseName": "Avison", "Type": "Way", "TypePlacement": "AfterBaseName", "TypeSeparator": " ", "Language": "en" } ], "AddressNumber": "834" }, "Position": [ -123.13049, 49.30013 ], "Distance": 4591, "Categories": [ { "Id": "aquarium", "Name": "Aquarium", "LocalizedName": "Aquarium", "Primary": true }, { "Id": "tourist_attraction", "Name": "Tourist Attraction", "LocalizedName": "Tourist Attraction", "Primary": false } ] } ] } ``` ------ #### [ cURL ] ``` curl --request POST \ --url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-text?key=Your_Key' \ --header 'Content-Type: application/json' \ --data '{ "QueryText": "+1 778-655-9554", "BiasPosition": [ -123.11336, 49.26038 ] }' ``` ------ #### [ AWS CLI ] ``` aws geo-places search-text --key ${YourKey} --query-text "+1 778-655-9554" --bias-position -123.11336 49.26038 ``` ------ # How to search using category name or food type Search categories or food types The `SearchText` API enables you to search by name of category such as restaurants, schools and more. You can also search by food type. One way to use the SearchText API is to let end users search by name (category and food type) and an application set's bias position. These bias positions can be a device position, IP position, or a map‘s view port center. Additionally, end users can provide the city name or place and the application can bias results based on geo-coordinates. For more information, see [Categories filters](places-filtering.md#place-categories) and [Food Type filters](places-filtering.md#food-type). ## Potential use cases + Search for specific POI or place as a part of exploring a neighborhood. + Search for specific tourist spot for travel planning. + Search for restaurants that serve a specific food. ## Examples ### Search on a category ------ #### [ Sample request ] ``` { "QueryText": "Nursing Home", "BiasPosition": [ -123.11336, 49.26038 ], } ``` ------ #### [ Sample response ] ``` { "ResultItems": [ { "PlaceId": "", "PlaceType": "PointOfInterest", "Title": "Diamond Geriatrics Inc", "Address": { "Label": "Diamond Geriatrics Inc, 288 W 8th Ave, Vancouver, BC V5Y 1N5, Canada", "Country": { "Code2": "CA", "Code3": "CAN", "Name": "Canada" }, "Region": { "Code": "BC", "Name": "British Columbia" }, "SubRegion": { "Name": "Metro Vancouver" }, "Locality": "Vancouver", "District": "Mt Pleasant", "PostalCode": "V5Y 1N5", "Street": "W 8th Ave", "StreetComponents": [ { "BaseName": "8th", "Type": "Ave", "TypePlacement": "AfterBaseName", "TypeSeparator": " ", "Prefix": "W", "Language": "en" } ], "AddressNumber": "288" }, "Position": [ -123.11061, 49.2636 ], "Distance": 410, "Categories": [ { "Id": "nursing_home", "Name": "Nursing Home", "LocalizedName": "Nursing Home", "Primary": true }, { "Id": "social_service", "Name": "Social Service", "LocalizedName": "Social Services", "Primary": false } ] }, { "PlaceId": "", "PlaceType": "PointOfInterest", "Title": "Para Med Home Health Care", "Address": { "Label": "Para Med Home Health Care, 601 W Broadway, Vancouver, BC V5Z 4C2, Canada", "Country": { "Code2": "CA", "Code3": "CAN", "Name": "Canada" }, "Region": { "Code": "BC", "Name": "British Columbia" }, "SubRegion": { "Name": "Metro Vancouver" }, "Locality": "Vancouver", "District": "Fairview", "PostalCode": "V5Z 4C2", "Street": "W Broadway", "StreetComponents": [ { "BaseName": "Broadway", "Prefix": "W", "Language": "en" } ], "AddressNumber": "601" }, "Position": [ -123.11772, 49.26343 ], "Distance": 464, "Categories": [ { "Id": "nursing_home", "Name": "Nursing Home", "LocalizedName": "Nursing Home", "Primary": true }, { "Id": "hospital_or_health_care_facility", "Name": "Hospital or Health Care Facility", "LocalizedName": "Hospital or Health Care Facility", "Primary": false } ] } ... ... ] } ``` ------ #### [ cURL ] ``` curl --request POST \ --url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-text?key=Your_Key' \ --header 'Content-Type: application/json' \ --data '{ "QueryText": "Nursing Home", "BiasPosition": [ -123.11336, 49.26038 ] }' ``` ------ #### [ AWS CLI ] ``` aws geo-places search-text --key ${YourKey} --query-text "Nursing Home" --bias-position -123.11336 49.26038 ``` ------ ### Search on a food type Specify a food type for `QueryText` to select restaurants by food type. Filtering by food type enables restaurants to be indexed, queried, and displayed by food type. ------ #### [ Sample request ] ``` { "QueryText": "Sushi", "BiasPosition": [ -123.11336, 49.26038 ] } ``` ------ #### [ Sample response ] ``` { "ResultItems": [ { "PlaceId": "", "PlaceType": "PointOfInterest", "Title": "Sushi Tomy", "Address": { "Label": "Sushi Tomy, 555 W 12th Ave, Vancouver, BC V5Z 3X7, Canada", "Country": { "Code2": "CA", "Code3": "CAN", "Name": "Canada" }, "Region": { "Code": "BC", "Name": "British Columbia" }, "SubRegion": { "Name": "Metro Vancouver" }, "Locality": "Vancouver", "District": "Fairview", "PostalCode": "V5Z 3X7", "Street": "W 12th Ave", "StreetComponents": [ { "BaseName": "12th", "Type": "Ave", "TypePlacement": "AfterBaseName", "TypeSeparator": " ", "Prefix": "W", "Language": "en" } ], "AddressNumber": "555" }, "Position": [ -123.11629, 49.26086 ], "Distance": 219, "Categories": [ { "Id": "deli", "Name": "Deli", "LocalizedName": "Deli", "Primary": true }, { "Id": "restaurant", "Name": "Restaurant", "LocalizedName": "Restaurant", "Primary": false }, { "Id": "casual_dining", "Name": "Casual Dining", "LocalizedName": "Casual Dining", "Primary": false } ], "FoodTypes": [ { "LocalizedName": "Japanese - Sushi", "Id": "japanese-sushi", "Primary": true }, { "LocalizedName": "Canadian", "Id": "canadian", "Primary": false }, { "LocalizedName": "Japanese", "Id": "japanese", "Primary": false } ] }, { "PlaceId": "" "PlaceType": "PointOfInterest", "Title": "Shiro Japanese Restaurant", "Address": { "Label": "Shiro Japanese Restaurant, 3096 Cambie St, Vancouver, BC V5Z 2V9, Canada", "Country": { "Code2": "CA", "Code3": "CAN", "Name": "Canada" }, "Region": { "Code": "BC", "Name": "British Columbia" }, "SubRegion": { "Name": "Metro Vancouver" }, "Locality": "Vancouver", "District": "Mt Pleasant", "PostalCode": "V5Z 2V9", "Street": "Cambie St", "StreetComponents": [ { "BaseName": "Cambie", "Type": "St", "TypePlacement": "AfterBaseName", "TypeSeparator": " ", "Language": "en" } ], "AddressNumber": "3096" }, "Position": [ -123.11461, 49.25797 ], "Distance": 283, "Categories": [ { "Id": "casual_dining", "Name": "Casual Dining", "LocalizedName": "Casual Dining", "Primary": true }, { "Id": "restaurant", "Name": "Restaurant", "LocalizedName": "Restaurant", "Primary": false } ], "FoodTypes": [ { "LocalizedName": "Japanese - Sushi", "Id": "japanese-sushi", "Primary": true }, { "LocalizedName": "Asian", "Id": "asian", "Primary": false }, { "LocalizedName": "Japanese", "Id": "japanese", "Primary": false } ] }, ... ... ] } ``` ------ #### [ cURL ] ``` curl --request POST \ --url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-text?key=Your_Key' \ --header 'Content-Type: application/json' \ --data '{ "QueryText": "Sushi", "BiasPosition": [ -123.11336, 49.26038 ] }' ``` ------ #### [ AWS CLI ] ``` aws geo-places search-text --key ${YourKey} --query-text "Sushi" --bias-position -123.11336 49.26038 ``` ------ # How to search for an address Search for addresses The `SearchText` API enables you to search for an address. One way to use the SearchText API is to let end users search for an address and an application set's bias position. These bias positions can be a device position, IP position, or a map‘s view port center. Additionally, end users can provide the city name or place and the application can bias results based on geo-coordinates. ## Potential use cases + Search for an address based on a bias position. + Filter results to include or remove specific addresses. ## Examples ### Search for an address ------ #### [ Sample request ] ``` { "QueryText":"1368 E 8 Ave Vancouver", "BiasPosition":[ -123.18544, 49.24643 ], "MaxResults":1 } ``` ------ #### [ Sample response ] ``` { "ResultItems": [ { "PlaceId": "", "PlaceType": "PointAddress", "Title": "1368 E 8th Ave, Vancouver, BC V5N 1T2, Canada", "Address": { "Label": "1368 E 8th Ave, Vancouver, BC V5N 1T2, Canada", "Country": { "Code2": "CA", "Code3": "CAN", "Name": "Canada" }, "Region": { "Code": "BC", "Name": "British Columbia" }, "SubRegion": { "Name": "Metro Vancouver" }, "Locality": "Vancouver", "District": "Grandview-Woodland", "PostalCode": "V5N 1T2", "Street": "E 8th Ave", "StreetComponents": [ { "BaseName": "8th", "Type": "Ave", "TypePlacement": "AfterBaseName", "TypeSeparator": " ", "Prefix": "E", "Language": "en" } ], "AddressNumber": "1368" }, "Position": [ -123.07612, 49.26306 ], "Distance": 8147, "MapView": [ -123.07752, 49.26299, -123.05661, 49.26334 ] } ] } ``` ------ #### [ cURL ] ``` curl --request POST \ --url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-text?key=Your_Key' \ --header 'Content-Type: application/json' \ --data '{ "QueryText": "1368 E 8 Ave Vancouver", "BiasPosition": [ -123.18544, 49.24643 ], "MaxResults": 1 }' ``` ------ #### [ AWS CLI ] ``` aws geo-places search-text --key ${YourKey} --query-text "1368 E 8 Ave Vancouver" --bias-position -123.18544 49.24643 --max-results 1 ``` ------ # How to search for a place within a country Search within a country The `SearchText` API enables you limit search results to within one or more countries. This feature useful for searching in border areas or smaller countries that neighbour each other. One way to use the SearchText API is to let end users do a free-text search and an application set's bias position. These bias positions can be a device position, IP position, or a map‘s view port center. Additionally, end users can provide the city name or place and the application can bias results based on geo-coordinates. ## Potential use cases + Limit the search results to within a country for an area that has a nearby international border. + Filter results to withing multiple countries. ## Examples ### Search within a country In this example, the bias position is near the USA and Canada border. Without specifying `IncludeCountries": ["CAN"]`, the API would return results from both Canada and the USA. ------ #### [ Sample request ] ``` { "QueryText": "Starbucks", "BiasPosition": [ -122.741803, 49.002478 ] } ``` ------ #### [ Sample response ] ``` { "ResultItems": [ { "PlaceId": "", "PlaceType": "PointOfInterest", "Title": "STARBUCKS", "Address": { "Label": "STARBUCKS, 16010 24 Ave, Surrey, BC V3Z 0R5, Canada", "Country": { "Code2": "CA", "Code3": "CAN", "Name": "Canada" }, "Region": { "Code": "BC", "Name": "British Columbia" }, "SubRegion": { "Name": "Metro Vancouver" }, "Locality": "Surrey", "District": "South Surrey", "PostalCode": "V3Z 0R5", "Street": "24 Ave", "StreetComponents": [ { "BaseName": "24", "Type": "Ave", "TypePlacement": "AfterBaseName", "TypeSeparator": " ", "Language": "en" } ], "AddressNumber": "16010" }, "Position": [ -122.77867, 49.04482 ], "Distance": 5422, "Categories": [ { "Id": "coffee_shop", "Name": "Coffee Shop", "LocalizedName": "Coffee Shop", "Primary": true } ] }, { "PlaceId": "", "PlaceType": "PointOfInterest", "Title": "STARBUCKS", "Address": { "Label": "STARBUCKS, 1730 152 St, Surrey, BC V4A 4N4, Canada", "Country": { "Code2": "CA", "Code3": "CAN", "Name": "Canada" }, "Region": { "Code": "BC", "Name": "British Columbia" }, "SubRegion": { "Name": "Metro Vancouver" }, "Locality": "Surrey", "District": "South Surrey", "PostalCode": "V4A 4N4", "Street": "152 St", "StreetComponents": [ { "BaseName": "152", "Type": "St", "TypePlacement": "AfterBaseName", "TypeSeparator": " ", "Language": "en" } ], "AddressNumber": "1730" }, "Position": [ -122.80096, 49.03341 ], "Distance": 5517, "Categories": [ { "Id": "coffee_shop", "Name": "Coffee Shop", "LocalizedName": "Coffee Shop", "Primary": true } ], "BusinessChains": [ { "Name": "Starbucks", "Id": "Starbucks" } ] }, ... ... ] } ``` ------ #### [ cURL ] ``` curl --request POST \ --url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-text?key=Your_Key' \ --header 'Content-Type: application/json' \ --data '{ "QueryText": "Starbucks", "BiasPosition": [ -122.741803, 49.002478 ] }' ``` ------ #### [ AWS CLI ] ``` aws geo-places search-text --key ${YourKey} --query-text "Starbucks" --bias-position -122.741803 49.002478 ``` ------ # How to search for contact and opening hours Search contact and opening hours The `SearchText` API enables you to search for contacts and opening hours of a POI (Point of Interest). One way to use the SearchText API is to get the contact information for a location (phone number, website, email) and opening hours by searching with business name and bias position. These bias positions can be a device position, IP position, map‘s view port center. Another way is to let end users provide the city name or place name and the application can bias results based on the geo-coordinates. For more information, see [Contacts and opening hours](contacts-opening-hours.md). ## Potential use cases You can use the `SearchText` API to filter on contacts and opening hours. ## Examples ### Search by category name ------ #### [ Sample request ] ``` { "QueryText": "Nursing Home", "BiasPosition": [ -123.11336, 49.26038 ], "AdditionalFeatures":["Contact"] } ``` ------ #### [ Sample response ] ``` { "PricingBucket": "Advanced", "ResultItems": [ { "PlaceId": "", "PlaceType": "PointOfInterest", "Title": "Para Med Home Health Care", "Address": { "Label": "Para Med Home Health Care, 601 W Broadway, Vancouver, BC V5Z 4C2, Canada", "Country": { "Code2": "CA", "Code3": "CAN", "Name": "Canada" }, "Region": { "Code": "BC", "Name": "British Columbia" }, "SubRegion": { "Name": "Metro Vancouver" }, "Locality": "Vancouver", "District": "Fairview", "PostalCode": "V5Z 4C2", "Street": "W Broadway", "StreetComponents": [ { "BaseName": "Broadway", "Prefix": "W", "Language": "en" } ], "AddressNumber": "601" }, "Position": [ -123.11771, 49.26341 ], "Distance": 462, "Categories": [ { "Id": "nursing_home", "Name": "Nursing Home", "LocalizedName": "Nursing Home", "Primary": true }, { "Id": "hospital_or_health_care_facility", "Name": "Hospital or Health Care Facility", "LocalizedName": "Hospital or Health Care Facility", "Primary": false } ], "Contacts": { "Phones": [ { "Value": "+16045634663" }, { "Value": "+16047311594", "Categories": [ { "Id": "hospital_or_health_care_facility", "Name": "Hospital or Health Care Facility" } ] } ], "Websites": [ { "Value": "http://www.rightathomecanada.com/vancouver", "Categories": [ { "Id": "nursing_home", "Name": "Nursing Home" } ] }, { "Value": "https://www.facebook.com/507123162974954", "Categories": [ { "Id": "nursing_home", "Name": "Nursing Home" } ] } ] } }, { "PlaceId": "", "PlaceType": "PointOfInterest", "Title": "Yaletown House", "Address": { "Label": "Yaletown House, 1099 Cambie St, Vancouver, BC V6B 5A8, Canada", "Country": { "Code2": "CA", "Code3": "CAN", "Name": "Canada" }, "Region": { "Code": "BC", "Name": "British Columbia" }, "SubRegion": { "Name": "Metro Vancouver" }, "Locality": "Vancouver", "District": "Yaletown", "PostalCode": "V6B 5A8", "Street": "Cambie St", "StreetComponents": [ { "BaseName": "Cambie", "Type": "St", "TypePlacement": "AfterBaseName", "TypeSeparator": " ", "Language": "en" } ], "AddressNumber": "1099" }, "Position": [ -123.11949, 49.27533 ], "Distance": 1721, "Categories": [ { "Id": "nursing_home", "Name": "Nursing Home", "LocalizedName": "Nursing Home", "Primary": true }, { "Id": "restaurant", "Name": "Restaurant", "LocalizedName": "Restaurant", "Primary": false }, { "Id": "clothing_and_accessories", "Name": "Clothing and Accessories", "LocalizedName": "Clothing & Accessories", "Primary": false }, { "Id": "market", "Name": "Market", "LocalizedName": "Market", "Primary": false }, { "Id": "jeweler", "Name": "Jeweler", "LocalizedName": "Jeweler", "Primary": false }, { "Id": "advertising-marketing,_pr_and_market_research", "Name": "Advertising-Marketing, PR and Market Research", "LocalizedName": "Advertising/Marketing, PR & Market Research", "Primary": false }, { "Id": "management_and_consulting_services", "Name": "Management and Consulting Services", "LocalizedName": "Management and Consulting Services", "Primary": false }, { "Id": "organizations_and_societies", "Name": "Organizations and Societies", "LocalizedName": "Organizations and Societies", "Primary": false }, { "Id": "finance_and_insurance", "Name": "Finance and Insurance", "LocalizedName": "Finance and Insurance", "Primary": false }, { "Id": "consumer_services", "Name": "Consumer Services", "LocalizedName": "Consumer Services", "Primary": false }, { "Id": "attorney", "Name": "Attorney", "LocalizedName": "Attorney", "Primary": false }, { "Id": "social_service", "Name": "Social Service", "LocalizedName": "Social Services", "Primary": false } ], "Contacts": { "Phones": [ { "Value": "+16045584546", "Categories": [ { "Id": "management_and_consulting_services", "Name": "Management and Consulting Services" }, { "Id": "consumer_services", "Name": "Consumer Services" } ] }, { "Value": "+16046464065", "Categories": [ { "Id": "finance_and_insurance", "Name": "Finance and Insurance" } ] }, { "Value": "+16046699800", "Categories": [ { "Id": "clothing_and_accessories", "Name": "Clothing and Accessories" }, { "Id": "jeweler", "Name": "Jeweler" } ] }, { "Value": "+16046838109", "Categories": [ { "Id": "attorney", "Name": "Attorney" } ] }, { "Value": "+16046841838", "Categories": [ { "Id": "advertising-marketing,_pr_and_market_research", "Name": "Advertising-Marketing, PR and Market Research" }, { "Id": "management_and_consulting_services", "Name": "Management and Consulting Services" } ] }, { "Value": "+16046848898", "Categories": [ { "Id": "attorney", "Name": "Attorney" } ] }, { "Value": "+16046890022" }, { "Value": "+16046999120", "Categories": [ { "Id": "nursing_home", "Name": "Nursing Home" } ] }, { "Value": "+16046999121", "Categories": [ { "Id": "nursing_home", "Name": "Nursing Home" } ] }, { "Value": "+16048016446", "Categories": [ { "Id": "management_and_consulting_services", "Name": "Management and Consulting Services" } ] } ], "Faxes": [ { "Value": "+16046464068", "Categories": [ { "Id": "finance_and_insurance", "Name": "Finance and Insurance" } ] }, { "Value": "+16046627954", "Categories": [ { "Id": "organizations_and_societies", "Name": "Organizations and Societies" } ] }, { "Value": "+16046841801", "Categories": [ { "Id": "advertising-marketing,_pr_and_market_research", "Name": "Advertising-Marketing, PR and Market Research" } ] }, { "Value": "+16046848608", "Categories": [ { "Id": "attorney", "Name": "Attorney" } ] } ], "Websites": [ { "Value": "http://www.yaletown.org", "Categories": [ { "Id": "organizations_and_societies", "Name": "Organizations and Societies" }, { "Id": "social_service", "Name": "Social Service" }, { "Id": "nursing_home", "Name": "Nursing Home" } ] }, { "Value": "http://www.yaletownhq.com", "Categories": [ { "Id": "advertising-marketing,_pr_and_market_research", "Name": "Advertising-Marketing, PR and Market Research" } ] }, { "Value": "http://www.yaletownlaw.ca", "Categories": [ { "Id": "attorney", "Name": "Attorney" } ] }, { "Value": "https://www.facebook.com/1509112252725564", "Categories": [ { "Id": "nursing_home", "Name": "Nursing Home" } ] } ], "Emails": [ { "Value": "nina@yaletownhq.com", "Categories": [ { "Id": "advertising-marketing,_pr_and_market_research", "Name": "Advertising-Marketing, PR and Market Research" } ] } ] }, "OpeningHours": [ { "Display": [ "Mon-Fri: 08:30 - 16:00" ], "OpenNow": true, "Components": [ { "OpenTime": "T083000", "OpenDuration": "PT07H30M", "Recurrence": "FREQ:DAILY;BYDAY:MO,TU,WE,TH,FR" } ], "Categories": [ { "Id": "organizations_and_societies", "Name": "Organizations and Societies" } ] }, { "Display": [ "Mon-Fri: 09:00 - 17:00" ], "OpenNow": true, "Components": [ { "OpenTime": "T090000", "OpenDuration": "PT08H00M", "Recurrence": "FREQ:DAILY;BYDAY:MO,TU,WE,TH,FR" } ], "Categories": [ { "Id": "attorney", "Name": "Attorney" } ] }, { "Display": [ "Tue: 10:00 - 16:30", "Wed-Sat: 09:30 - 16:30" ], "OpenNow": true, "Components": [ { "OpenTime": "T100000", "OpenDuration": "PT06H30M", "Recurrence": "FREQ:DAILY;BYDAY:TU" }, { "OpenTime": "T093000", "OpenDuration": "PT07H00M", "Recurrence": "FREQ:DAILY;BYDAY:WE,TH,FR,SA" } ], "Categories": [ { "Id": "clothing_and_accessories", "Name": "Clothing and Accessories" }, { "Id": "jeweler", "Name": "Jeweler" } ] } ] }, ] } ``` ------ #### [ cURL ] ``` curl --request POST \ --url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-text?key=Your_Key' \ --header 'Content-Type: application/json' \ --data '{ "QueryText": "Nursing Home", "BiasPosition": [ -123.11336, 49.26038 ], "AdditionalFeatures":["Contact"] }' ``` ------ #### [ AWS CLI ] ``` aws geo-places search-text --key ${YourKey} --query-text "Nursing Home" \ --bias-position -123.11336 49.26038 \ --additional-features "Contact" ``` ------ # How to search places using query ID Search using query ID The `SearchText` API enables you get details of the query result returned by [SuggestHow to use Suggest](suggest.md). ## Potential use cases Get search results for Query ID, which are returned by the `Suggestion` API. ## Examples ### Search by query ID ------ #### [ Sample request ] ``` { "QueryId": "" } ``` ------ #### [ Sample response ] ``` { "ResultItems": [ { "PlaceId": "", "PlaceType": "PointOfInterest", "Title": "Restore", "Address": { "Label": "Restore, 400 Urban Plz, Kirkland, WA 98033, United States", "Country": { "Code2": "US", "Code3": "USA", "Name": "United States" }, "Region": { "Code": "WA", "Name": "Washington" }, "SubRegion": { "Name": "King" }, "Locality": "Kirkland", "District": "Moss Bay", "PostalCode": "98033", "Street": "Urban Plz", "StreetComponents": [ { "BaseName": "Urban", "Type": "Plz", "TypePlacement": "AfterBaseName", "TypeSeparator": " ", "Language": "en" } ], "AddressNumber": "400" }, "Position": [ -122.19958, 47.67822 ], "Distance": 190670, "Categories": [ { "Id": "wellness_center_and_services", "Name": "Wellness Center and Services", "LocalizedName": "Wellness Center & Services", "Primary": true } ], "BusinessChains": [ { "Name": "Restore", "Id": "Restore" } ], "Contacts": { "Phones": [ { "Value": "+14258352271" }, { "Value": "+14254205116" } ], "Websites": [ { "Value": "https://restore.com" }, { "Value": "https://restore.com/locations" }, { "Value": "https://www.facebook.com/rhwkirkland" }, { "Value": "https://www.restore.com/locations/wa-kirkland-wa001?utm_source=extnet&utm_medium=Yext&y_source=1_MzE2Mjk5NTgtNTY2LWxvY2F0aW9uLndlYnNpdGU%3D" }, { "Value": "https://www.restore.com/sitemap.xml" } ], "Emails": [ { "Value": "kirkland@restore.com" } ] }, "OpeningHours": [ { "Display": [ "Mon-Thu: 10:00 - 19:00", "Fri: 10:00 - 17:00", "Sat: 09:00 - 17:00", "Sun: 10:00 - 16:00" ], "OpenNow": false, "Components": [ { "OpenTime": "T100000", "OpenDuration": "PT09H00M", "Recurrence": "FREQ:DAILY;BYDAY:MO,TU,WE,TH" }, { "OpenTime": "T100000", "OpenDuration": "PT07H00M", "Recurrence": "FREQ:DAILY;BYDAY:FR" }, { "OpenTime": "T090000", "OpenDuration": "PT08H00M", "Recurrence": "FREQ:DAILY;BYDAY:SA" }, { "OpenTime": "T100000", "OpenDuration": "PT06H00M", "Recurrence": "FREQ:DAILY;BYDAY:SU" } ] } ], "AccessPoints": [ { "Position": [ -122.19944, 47.67801 ] } ] }, { "PlaceId": "", "PlaceType": "PointOfInterest", "Title": "Restore", "Address": { "Label": "Restore, 1520 Highlands Dr NE, Issaquah, WA 98029, United States", "Country": { "Code2": "US", "Code3": "USA", "Name": "United States" }, "Region": { "Code": "WA", "Name": "Washington" }, "SubRegion": { "Name": "King" }, "Locality": "Issaquah", "District": "Issaquah Highlands", "PostalCode": "98029", "Street": "Highlands Dr NE", "StreetComponents": [ { "BaseName": "Highlands", "Type": "Dr", "TypePlacement": "AfterBaseName", "TypeSeparator": " ", "Suffix": "NE", "Language": "en" } ], "AddressNumber": "1520" }, "Position": [ -122.01868, 47.54262 ], "Distance": 209665, "Categories": [ { "Id": "wellness_center_and_services", "Name": "Wellness Center and Services", "LocalizedName": "Wellness Center & Services", "Primary": true } ], "BusinessChains": [ { "Name": "Restore", "Id": "Restore" } ], "Contacts": { "Phones": [ { "Value": "+14256518137" } ], "Websites": [ { "Value": "https://restore.com", "Categories": [ { "Id": "wellness_center_and_services", "Name": "Wellness Center and Services" } ] }, { "Value": "https://www.facebook.com/rhwissaquah", "Categories": [ { "Id": "wellness_center_and_services", "Name": "Wellness Center and Services" } ] }, { "Value": "https://www.restore.com/locations", "Categories": [ { "Id": "wellness_center_and_services", "Name": "Wellness Center and Services" } ] }, { "Value": "https://www.restore.com/locations/wa-issaquah-wa002?utm_source=extnet&utm_medium=Yext&y_source=1_MzE2Mjk5NTktNTY2LWxvY2F0aW9uLndlYnNpdGU%3D", "Categories": [ { "Id": "wellness_center_and_services", "Name": "Wellness Center and Services" } ] }, { "Value": "https://www.restore.com/sitemap.xml", "Categories": [ { "Id": "wellness_center_and_services", "Name": "Wellness Center and Services" } ] } ], "Emails": [ { "Value": "issaquah@restore.com", "Categories": [ { "Id": "wellness_center_and_services", "Name": "Wellness Center and Services" } ] } ] }, "OpeningHours": [ { "Display": [ "Mon-Thu: 10:00 - 18:00", "Fri: 10:00 - 17:00", "Sat: 09:00 - 17:00" ], "OpenNow": false, "Components": [ { "OpenTime": "T100000", "OpenDuration": "PT08H00M", "Recurrence": "FREQ:DAILY;BYDAY:MO,TU,WE,TH" }, { "OpenTime": "T100000", "OpenDuration": "PT07H00M", "Recurrence": "FREQ:DAILY;BYDAY:FR" }, { "OpenTime": "T090000", "OpenDuration": "PT08H00M", "Recurrence": "FREQ:DAILY;BYDAY:SA" } ], "Categories": [ { "Id": "wellness_center_and_services", "Name": "Wellness Center and Services" } ] } ], "AccessPoints": [ { "Position": [ -122.01894, 47.54262 ] } ] } ] } ``` ------ #### [ cURL ] ``` curl --request POST \ --url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-text?key=Your_Key' \ --header 'Content-Type: application/json' \ --data '{ "QueryId": "" }' ``` ------ #### [ AWS CLI ] ``` aws geo-places search-text --key ${YourKey} --query-id "" ``` ------ # How to search in a specific language Search in a language This feature allows the selection of a preferred response language from BCP47-compliant codes. It detects the query language based on name variants and uses the preferred language for unmatched tokens and ambiguous cases. If there is no requested language, the **Places** API provides results in the official country language, but prioritizes the regional language in regions where it differs. As a fallback strategy, if any address elements are unavailable in the requested language, **Places** APIs return addresses in the default language. ## Potential use cases One potential use case is to localize the query and/or the result. ## Examples ### Get result in a specific language Without the `"Language": "EN"` line in the request, results would be returned in Hebrew. ------ #### [ Sample request ] ``` { "QueryText": "Vegan", "BiasPosition":[ 34.78953, 32.08556 ], "Language": "EN" } ``` ------ #### [ Sample response ] ``` { "ResultItems": [ { "PlaceId": "", "PlaceType": "PointOfInterest", "Title": "Rainbow", "Address": { "Label": "Rainbow, Ibn Gabirol 88, 6404612 Tel Aviv-Yafo, Israel", "Country": { "Code2": "IL", "Code3": "ISR", "Name": "Israel" }, "Region": { "Code": "TA", "Name": "TA" }, "SubRegion": { "Name": "Tel Aviv" }, "Locality": "Tel Aviv-Yafo", "District": "The New North-Southern Area", "PostalCode": "6404612", "Street": "Ibn Gabirol", "StreetComponents": [ { "BaseName": "Ibn Gabirol", "Language": "he-Latn" } ], "AddressNumber": "88" }, "Position": [ 34.78149, 32.08252 ], "Distance": 829, "Categories": [ { "Id": "restaurant", "Name": "Restaurant", "LocalizedName": "Restaurant", "Primary": true }, { "Id": "fast_food", "Name": "Fast Food", "LocalizedName": "Fast Food", "Primary": false } ], "FoodTypes": [ { "LocalizedName": "Vegan", "Id": "vegan", "Primary": true }, { "LocalizedName": "Fast Food", "Id": "fast_food", "Primary": false }, { "LocalizedName": "Burgers", "Id": "burgers", "Primary": false }, { "LocalizedName": "Jewish/Kosher", "Id": "jewish/kosher", "Primary": false } ] }, { "PlaceId": "", "PlaceType": "PointOfInterest", "Title": "Alegria", "Address": { "Label": "Alegria, Ibn Gabirol 165, 6203305 Tel Aviv-Yafo, Israel", "Country": { "Code2": "IL", "Code3": "ISR", "Name": "Israel" }, "Region": { "Code": "TA", "Name": "TA" }, "SubRegion": { "Name": "Tel Aviv" }, "Locality": "Tel Aviv-Yafo", "District": "The Old North-Northern Area", "PostalCode": "6203305", "Street": "Ibn Gabirol", "StreetComponents": [ { "BaseName": "Ibn Gabirol", "Language": "he-Latn" } ], "AddressNumber": "165" }, "Position": [ 34.78295, 32.0923 ], "Distance": 973, "Categories": [ { "Id": "restaurant", "Name": "Restaurant", "LocalizedName": "Restaurant", "Primary": true }, { "Id": "coffee_shop", "Name": "Coffee Shop", "LocalizedName": "Coffee Shop", "Primary": false }, { "Id": "specialty_food_store", "Name": "Specialty Food Store", "LocalizedName": "Specialty Food Store", "Primary": false }, { "Id": "bakery_and_baked_goods_store", "Name": "Bakery and Baked Goods Store", "LocalizedName": "Bakery & Baked Goods Store", "Primary": false } ], "FoodTypes": [ { "LocalizedName": "Vegan", "Id": "vegan", "Primary": true } ] } ] } ``` ------ #### [ cURL ] ``` curl --request POST \ --url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-text?key=Your_Key' \ --header 'Content-Type: application/json' \ --data ' { "QueryText": "Vegan", "BiasPosition":[ 34.78953, 32.08556 ], "Language": "EN" }' ``` ------ #### [ AWS CLI ] ``` aws geo-places search-text --key ${YourKey} --query-text "Vegan" \ --bias-position 34.78953 32.08556 \ --language "EN" ``` ------