Skip to content

SearchForPositionResult

Source code in docs_src/capo_location/types/search_for_position_result.py 
15
16
17
18
19
20
21
class SearchForPositionResult(TypedDict, closed=True):
    place: "capo_location.types.place.Place"
    """<p>Details about the search result, such as its address and position.</p>"""
    distance: "capo_location.types.sensitive_double.SensitiveDouble"
    """<p>The distance in meters of a great-circle arc between the query position and the result.</p> <note> <p>A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.</p> </note>"""
    place_id: NotRequired["capo_location.types.place_id.PlaceId"]
    """<p>The unique identifier of the place. You can use this with the <code>GetPlace</code> operation to find the place again later.</p> <note> <p>For <code>SearchPlaceIndexForPosition</code> operations, the <code>PlaceId</code> is returned only by place indexes that use HERE or Grab as a data provider.</p> </note>"""

distance instance-attribute 

distance: SensitiveDouble

The distance in meters of a great-circle arc between the query position and the result.

A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.

place instance-attribute 

place: Place

Details about the search result, such as its address and position.

place_id instance-attribute 

place_id: NotRequired[PlaceId]

The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.

For SearchPlaceIndexForPosition operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.