LocationServicePlacesV2 / Client / geocode

geocode

LocationServicePlacesV2.Client.geocode(**kwargs)

The Geocode action allows you to obtain coordinates, addresses, and other information about places.

See also: AWS API Documentation

Request Syntax

response = client.geocode(
    QueryText='string',
    QueryComponents={
        'Country': 'string',
        'Region': 'string',
        'SubRegion': 'string',
        'Locality': 'string',
        'District': 'string',
        'Street': 'string',
        'AddressNumber': 'string',
        'PostalCode': 'string'
    },
    MaxResults=123,
    BiasPosition=[
        123.0,
    ],
    Filter={
        'IncludeCountries': [
            'string',
        ],
        'IncludePlaceTypes': [
            'Locality'|'PostalCode'|'Intersection'|'Street'|'PointAddress'|'InterpolatedAddress',
        ]
    },
    AdditionalFeatures=[
        'TimeZone'|'Access',
    ],
    Language='string',
    PoliticalView='string',
    IntendedUse='SingleUse'|'Storage',
    Key='string'
)

Parameters:

• QueryText (string) – The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.

• QueryComponents (dict) –

  A structured free text query allows you to search for places by the name or text representation of specific properties of the place.

  • Country (string) –

    The alpha-2 or alpha-3 character code for the country that the results will be present in.

  • Region (string) –

    The region or state results should be to be present in.

    Example: North Rhine-Westphalia.

  • SubRegion (string) –

    The sub-region or county for which results should be present in.

  • Locality (string) –

    City or locality results should be present in.

    Example: Vancouver.

  • District (string) –

    The district or division of a city the results should be present in.

  • Street (string) –

    The name of the street results should be present in.

  • AddressNumber (string) –

    The house number or address results should have.

  • PostalCode (string) –

    An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should posses.

• MaxResults (integer) – An optional limit for the number of results returned in a single call.

• BiasPosition (list) –

  The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WSG84 format.

  Note

  The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

  • (float) –

• Filter (dict) –

  A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

  • IncludeCountries (list) –

    A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.

    • (string) –

  • IncludePlaceTypes (list) –

    The included place types.

    • (string) –

• AdditionalFeatures (list) –

  A list of optional additional parameters, such as time zone, that can be requested for each result.

  • (string) –

• Language (string) – A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

• PoliticalView (string) – The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

• IntendedUse (string) – Indicates if the results will be stored. Defaults to SingleUse, if left empty.

• Key (string) – Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

Return type:

dict

Returns:

Response Syntax

{
    'PricingBucket': 'string',
    'ResultItems': [
        {
            'PlaceId': 'string',
            'PlaceType': 'Country'|'Region'|'SubRegion'|'Locality'|'District'|'SubDistrict'|'PostalCode'|'Block'|'SubBlock'|'Intersection'|'Street'|'PointOfInterest'|'PointAddress'|'InterpolatedAddress',
            'Title': 'string',
            'Address': {
                'Label': 'string',
                'Country': {
                    'Code2': 'string',
                    'Code3': 'string',
                    'Name': 'string'
                },
                'Region': {
                    'Code': 'string',
                    'Name': 'string'
                },
                'SubRegion': {
                    'Code': 'string',
                    'Name': 'string'
                },
                'Locality': 'string',
                'District': 'string',
                'SubDistrict': 'string',
                'PostalCode': 'string',
                'Block': 'string',
                'SubBlock': 'string',
                'Intersection': [
                    'string',
                ],
                'Street': 'string',
                'StreetComponents': [
                    {
                        'BaseName': 'string',
                        'Type': 'string',
                        'TypePlacement': 'BeforeBaseName'|'AfterBaseName',
                        'TypeSeparator': 'string',
                        'Prefix': 'string',
                        'Suffix': 'string',
                        'Direction': 'string',
                        'Language': 'string'
                    },
                ],
                'AddressNumber': 'string',
                'Building': 'string'
            },
            'AddressNumberCorrected': True|False,
            'PostalCodeDetails': [
                {
                    'PostalCode': 'string',
                    'PostalAuthority': 'Usps',
                    'PostalCodeType': 'UspsZip'|'UspsZipPlus4',
                    'UspsZip': {
                        'ZipClassificationCode': 'Military'|'PostOfficeBoxes'|'Unique'
                    },
                    'UspsZipPlus4': {
                        'RecordTypeCode': 'Firm'|'General'|'HighRise'|'PostOfficeBox'|'Rural'|'Street'
                    }
                },
            ],
            'Position': [
                123.0,
            ],
            'Distance': 123,
            'MapView': [
                123.0,
            ],
            'Categories': [
                {
                    'Id': 'string',
                    'Name': 'string',
                    'LocalizedName': 'string',
                    'Primary': True|False
                },
            ],
            'FoodTypes': [
                {
                    'LocalizedName': 'string',
                    'Id': 'string',
                    'Primary': True|False
                },
            ],
            'AccessPoints': [
                {
                    'Position': [
                        123.0,
                    ]
                },
            ],
            'TimeZone': {
                'Name': 'string',
                'Offset': 'string',
                'OffsetSeconds': 123
            },
            'PoliticalView': 'string',
            'MatchScores': {
                'Overall': 123.0,
                'Components': {
                    'Title': 123.0,
                    'Address': {
                        'Country': 123.0,
                        'Region': 123.0,
                        'SubRegion': 123.0,
                        'Locality': 123.0,
                        'District': 123.0,
                        'SubDistrict': 123.0,
                        'PostalCode': 123.0,
                        'Block': 123.0,
                        'SubBlock': 123.0,
                        'Intersection': [
                            123.0,
                        ],
                        'AddressNumber': 123.0,
                        'Building': 123.0
                    }
                }
            }
        },
    ]
}

Response Structure

• (dict) –

  • PricingBucket (string) –

    The pricing bucket for which the query is charged at.

    For more inforamtion on pricing, please visit Amazon Location Service Pricing.

  • ResultItems (list) –

    List of places or results returned for a query.

    • (dict) –

      The Geocoded result.

      • PlaceId (string) –

        The PlaceId of the place you wish to receive the information for.

      • PlaceType (string) –

        A PlaceType is a category that the result place must belong to.

      • Title (string) –

        The localized display name of this result item based on request parameter language.

      • Address (dict) –

        The place’s address.

        • Label (string) –

          Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.

        • Country (dict) –

          The country component of the address.

          • Code2 (string) –

            Country, represented by its alpha 2-character code.

          • Code3 (string) –

            Country, represented by its alpha t-character code.

          • Name (string) –

            Name of the country.

        • Region (dict) –

          The region or state results should be present in.

          Example: North Rhine-Westphalia.

          • Code (string) –

            Abbreviated code for a the state, province or region of the country.

            Example: BC.

          • Name (string) –

            Name for a the state, province, or region of the country.

            Example: British Columbia.

        • SubRegion (dict) –

          The sub-region or county for which results should be present in.

          • Code (string) –

            Abbreviated code for the county or sub-region.

          • Name (string) –

            Name for the county or sub-region.

        • Locality (string) –

          The locality or city of the address.

          Example: Vancouver.

        • District (string) –

          The district or division of a locality associated with this address.

        • SubDistrict (string) –

          A subdivision of a district.

          Example: Minden-Lübbecke.

        • PostalCode (string) –

          An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should posses.

        • Block (string) –

          Name of the block.

          Example: Sunny Mansion 203 block: 2 Chome

        • SubBlock (string) –

          Name of sub-block.

          Example: Sunny Mansion 203 sub-block: 4

        • Intersection (list) –

          Name of the streets in the intersection.

          Example: ["Friedrichstraße","Unter den Linden"]

          • (string) –

        • Street (string) –

          The name of the street results should be present in.

        • StreetComponents (list) –

          Components of the street.

          Example: Younge from the “Younge street”.

          • (dict) –

            Components of a street.

            • BaseName (string) –

              Base name part of the street name.

              Example: Younge from the “Younge street”.

            • Type (string) –

              Street type part of the street name.

              Example: “avenue".

            • TypePlacement (string) –

              Defines if the street type is before or after the base name.

            • TypeSeparator (string) –

              What character(s) separates the string from its type.

            • Prefix (string) –

              A prefix is a directional identifier that precedes, but is not included in, the base name of a road.

              Example: E for East.

            • Suffix (string) –

              A suffix is a directional identifier that follows, but is not included in, the base name of a road.

              Example W for West.

            • Direction (string) –

              Indicates the official directional identifiers assigned to highways.

            • Language (string) –

              A BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

        • AddressNumber (string) –

          The number that identifies an address within a street.

        • Building (string) –

          The name of the building at the address.

      • AddressNumberCorrected (boolean) –

        Boolean indicating if the address provided has been corrected.

      • PostalCodeDetails (list) –

        Contains details about the postal code of the place/result.

        • (dict) –

          Contains details about the postal code of the place or result.

          • PostalCode (string) –

            An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should posses.

          • PostalAuthority (string) –

            The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.

          • PostalCodeType (string) –

            The postal code type.

          • UspsZip (dict) –

            The ZIP Classification Code, or in other words what type of postal code is it.

            • ZipClassificationCode (string) –

              The ZIP Classification Code, or in other words what type of postal code is it.

          • UspsZipPlus4 (dict) –

            The USPS ZIP+4 Record Type Code.

            • RecordTypeCode (string) –

              The USPS ZIP+4 Record Type Code.

      • Position (list) –

        The position in longitude and latitude.

        • (float) –

      • Distance (integer) –

        The distance in meters from the QueryPosition.

      • MapView (list) –

        The bounding box enclosing the geometric shape (area or line) that an individual result covers.

        The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

        • (float) –

      • Categories (list) –

        Categories of results that results must belong to.

        • (dict) –

          Category of the Place returned.

          • Id (string) –

            The category ID.

          • Name (string) –

            The category name.

          • LocalizedName (string) –

            Localized name of the category type.

          • Primary (boolean) –

            Boolean which indicates if this category is the primary offered by the place.

      • FoodTypes (list) –

        List of food types offered by this result.

        • (dict) –

          List of Food types offered by this result.

          • LocalizedName (string) –

            Localized name of the food type.

          • Id (string) –

            The Food Type Id.

          • Primary (boolean) –

            Boolean which indicates if this food type is the primary offered by the place. For example, if a location serves fast food, but also dessert, he primary would likely be fast food.

      • AccessPoints (list) –

        Position of the access point represent by longitude and latitude.

        • (dict) –

          Position of the access point represented by longitude and latitude for a vehicle.

          • Position (list) –

            The position, in longitude and latitude.

            • (float) –

      • TimeZone (dict) –

        The time zone in which the place is located.

        • Name (string) –

          The time zone name.

        • Offset (string) –

          Time zone offset of the timezone from UTC.

        • OffsetSeconds (integer) –

          The offset of the time zone from UTC, in seconds.

      • PoliticalView (string) –

        The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

      • MatchScores (dict) –

        Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.

        • Overall (float) –

          Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.

        • Components (dict) –

          Indicates how well the component input matches the returned. It is equal to 1 if all input tokens are recognized and matched.

          • Title (float) –

            Indicates the starting and ending index of the title in the text query that match the found title.

          • Address (dict) –

            The place’s address.

            • Country (float) –

              The alpha-2 or alpha-3 character code for the country that the results will be present in.

            • Region (float) –

              The region or state results should be to be present in.

              Example: North Rhine-Westphalia.

            • SubRegion (float) –

              The sub-region or county for which results should be present in.

            • Locality (float) –

              The city or locality results should be present in.

              Example: Vancouver.

            • District (float) –

              The district or division of a city the results should be present in.

            • SubDistrict (float) –

              A subdivision of a district.

              Example: Minden-Lübbecke

            • PostalCode (float) –

              An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should posses.

            • Block (float) –

              Name of the block.

              Example: Sunny Mansion 203 block: 2 Chome

            • SubBlock (float) –

              Name of sub-block.

              Example: Sunny Mansion 203 sub-block: 4

            • Intersection (list) –

              Name of the streets in the intersection.

              Example: ["Friedrichstraße","Unter den Linden"]

              • (float) –

            • AddressNumber (float) –

              The house number or address results should have.

            • Building (float) –

              The name of the building at the address.

Exceptions

• LocationServicePlacesV2.Client.exceptions.InternalServerException

• LocationServicePlacesV2.Client.exceptions.AccessDeniedException

• LocationServicePlacesV2.Client.exceptions.ValidationException

• LocationServicePlacesV2.Client.exceptions.ThrottlingException