Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SearchPlaceIndexForPosition

Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.

Request Syntax


POST /places/v0/indexes/IndexName/search/position?key=Key HTTP/1.1
Content-type: application/json

{
   "Language": "string",
   "MaxResults": number,
   "Position": [ number ]
}

URI Request Parameters

The request uses the following URI parameters.

IndexName

The name of the place index resource you want to use for the search.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[-._\w]+$

Required: Yes

Key

The optional API key to authorize the request.

Length Constraints: Minimum length of 0. Maximum length of 1000.

Request Body

The request accepts the following data in JSON format.

Language

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 35.

Required: No

MaxResults

An optional parameter. The maximum number of results returned per request.

Default value: 50

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

Position

Specifies the longitude and latitude of the position to query.

This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents a position with longitude -123.1174 and latitude 49.2847.

Type: Array of doubles

Array Members: Fixed number of 2 items.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Results": [ 
      { 
         "Distance": number,
         "Place": { 
            "AddressNumber": "string",
            "Categories": [ "string" ],
            "Country": "string",
            "Geometry": { 
               "Point": [ number ]
            },
            "Interpolated": boolean,
            "Label": "string",
            "Municipality": "string",
            "Neighborhood": "string",
            "PostalCode": "string",
            "Region": "string",
            "Street": "string",
            "SubMunicipality": "string",
            "SubRegion": "string",
            "SupplementalCategories": [ "string" ],
            "TimeZone": { 
               "Name": "string",
               "Offset": number
            },
            "UnitNumber": "string",
            "UnitType": "string"
         },
         "PlaceId": "string"
      }
   ],
   "Summary": { 
      "DataSource": "string",
      "Language": "string",
      "MaxResults": number,
      "Position": [ number ]
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Results

Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.

Type: Array of SearchForPositionResult objects

Summary

Contains a summary of the request. Echoes the input values for Position, Language, MaxResults, and the DataSource of the place index.

Type: SearchPlaceIndexForPositionSummary object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

HTTP Status Code: 403

InternalServerException

The request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource that you've entered was not found in your AWS account.

HTTP Status Code: 404

ThrottlingException

The request was denied because of request throttling.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

HTTP Status Code: 400