Skip to content

SearchNearbyResultItem

Source code in docs_src/capo_geo_places/types/search_nearby_result_item.py
class SearchNearbyResultItem(TypedDict, closed=True):
    place_id: "capo_geo_places.types.sensitive_string.SensitiveString"
    """<p>The <code>PlaceId</code> of the place you wish to receive the information for.</p>"""
    place_type: "capo_geo_places.types.place_type.PlaceType"
    """<p>A <code>PlaceType</code> is a category that the result place must belong to.</p>"""
    title: "capo_geo_places.types.sensitive_string.SensitiveString"
    """<p>The item's title.</p>"""
    address: NotRequired["capo_geo_places.types.address.Address"]
    """<p>The place's address.</p>"""
    address_number_corrected: NotRequired[
        "capo_geo_places.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p>Boolean indicating if the address provided has been corrected.</p>"""
    position: NotRequired["capo_geo_places.types.position.Position"]
    """<p>The position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>"""
    distance: "capo_geo_places.types.distance_meters.DistanceMeters"
    """<p>The distance in meters from the QueryPosition.</p>"""
    map_view: NotRequired["capo_geo_places.types.bounding_box.BoundingBox"]
    """<p>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</p> <p>The bounding box formed is defined as a set 4 coordinates: <code>[{westward lng}, {southern lat}, {eastward lng}, {northern lat}]</code> </p>"""
    categories: NotRequired["capo_geo_places.types.category_list.CategoryList"]
    """<p>Categories of results that results must belong to.</p>"""
    food_types: NotRequired["capo_geo_places.types.food_type_list.FoodTypeList"]
    """<p>List of food types offered by this result.</p>"""
    business_chains: NotRequired[
        "capo_geo_places.types.business_chain_list.BusinessChainList"
    ]
    """<p>The Business Chains associated with the place.</p>"""
    contacts: NotRequired["capo_geo_places.types.contacts.Contacts"]
    """<p>List of potential contact methods for the result/place.</p>"""
    opening_hours: NotRequired[
        "capo_geo_places.types.opening_hours_list.OpeningHoursList"
    ]
    """<p>List of opening hours objects.</p>"""
    access_points: NotRequired[
        "capo_geo_places.types.access_point_list.AccessPointList"
    ]
    """<p>Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].</p>"""
    access_restrictions: NotRequired[
        "capo_geo_places.types.access_restriction_list.AccessRestrictionList"
    ]
    """<p>Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.</p>"""
    time_zone: NotRequired["capo_geo_places.types.time_zone.TimeZone"]
    """<p>The time zone in which the place is located.</p>"""
    political_view: NotRequired["capo_geo_places.types.country_code3.CountryCode3"]
    """<p>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.</p>"""
    phonemes: NotRequired["capo_geo_places.types.phoneme_details.PhonemeDetails"]
    """<p>How the various components of the result's address are pronounced in various languages.</p>"""
    place_attributes: NotRequired[
        "capo_geo_places.types.place_attribute_list.PlaceAttributeList"
    ]
    """<p>A list of place attributes for the result, such as whether the business offers drive-through service.</p>"""
    cross_references: NotRequired[
        "capo_geo_places.types.cross_reference_list.CrossReferenceList"
    ]
    """<p>The list of supplier references available for this place. Requires the <code>CrossReferences</code> additional feature to be enabled.</p>"""

access_points instance-attribute

access_points: NotRequired[AccessPointList]

Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].

access_restrictions instance-attribute

access_restrictions: NotRequired[AccessRestrictionList]

Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.

address instance-attribute

address: NotRequired[Address]

The place's address.

address_number_corrected instance-attribute

address_number_corrected: NotRequired[SensitiveBoolean]

Boolean indicating if the address provided has been corrected.

business_chains instance-attribute

business_chains: NotRequired[BusinessChainList]

The Business Chains associated with the place.

categories instance-attribute

categories: NotRequired[CategoryList]

Categories of results that results must belong to.

contacts instance-attribute

contacts: NotRequired[Contacts]

List of potential contact methods for the result/place.

cross_references instance-attribute

cross_references: NotRequired[CrossReferenceList]

The list of supplier references available for this place. Requires the CrossReferences additional feature to be enabled.

distance instance-attribute

distance: DistanceMeters

The distance in meters from the QueryPosition.

food_types instance-attribute

food_types: NotRequired[FoodTypeList]

List of food types offered by this result.

map_view instance-attribute

map_view: NotRequired[BoundingBox]

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}]

opening_hours instance-attribute

opening_hours: NotRequired[OpeningHoursList]

List of opening hours objects.

phonemes instance-attribute

phonemes: NotRequired[PhonemeDetails]

How the various components of the result's address are pronounced in various languages.

place_attributes instance-attribute

place_attributes: NotRequired[PlaceAttributeList]

A list of place attributes for the result, such as whether the business offers drive-through service.

place_id instance-attribute

place_id: SensitiveString

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

place_type instance-attribute

place_type: PlaceType

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

political_view instance-attribute

political_view: NotRequired[CountryCode3]

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.

position instance-attribute

position: NotRequired[Position]

The position in World Geodetic System (WGS 84) format: [longitude, latitude].

time_zone instance-attribute

time_zone: NotRequired[TimeZone]

The time zone in which the place is located.

title instance-attribute

The item's title.