Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Amazon Web Services location Places API
description: '"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"'
tags:
- name: Places
paths:
/places/v0/indexes:
POST:
summary: Amazon Web Services Createplaceindex
description: Creates a place index resource in your Amazon Web Services account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation. If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
operationId: amazonWebServicesCreatePlaceIndex
tags:
- Places
/places/v0/indexes/{IndexName}:
PATCH:
summary: Amazon Web Services Updateplaceindex
description: Updates the specified properties of a given place index resource.
operationId: amazonWebServicesUpdatePlaceIndex
tags:
- Places
/places/v0/indexes/{IndexName}/places/{PlaceId}:
GET:
summary: Amazon Web Services Getplace
description: Finds a place by its unique ID. A PlaceId is returned by other search operations. A PlaceId is valid only if all of the following are the same in the original search request and the call to GetPlace. Customer Amazon Web Services account Amazon Web Services Region Data provider specified in the place index resource
operationId: amazonWebServicesGetPlace
tags:
- Places
/places/v0/list-indexes:
POST:
summary: Amazon Web Services Listplaceindexes
description: Lists place index resources in your Amazon Web Services account.
operationId: amazonWebServicesListPlaceIndexes
tags:
- Places
/places/v0/indexes/{IndexName}/search/position:
POST:
summary: Amazon Web Services Searchplaceindexforposition
description: Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
operationId: amazonWebServicesSearchPlaceIndexForPosition
tags:
- Places
/places/v0/indexes/{IndexName}/search/suggestions:
POST:
summary: Amazon Web Services Searchplaceindexforsuggestions
description: Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching. Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe. You can search for suggested place names near a specified position by using BiasPosition, or filter results within a bounding box by using FilterBBox. These parameters are mutually exclusive; using both BiasPosition and FilterBBox in the same command returns an error.
operationId: amazonWebServicesSearchPlaceIndexForSuggestions
tags:
- Places
/places/v0/indexes/{IndexName}/search/text:
POST:
summary: Amazon Web Services Searchplaceindexfortext
description: Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest. Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe. You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error. Search results are returned in order of highest to lowest relevance.
operationId: amazonWebServicesSearchPlaceIndexForText
tags:
- Places