Skip to content

GeocodeQueryComponents

Used by
Source code in docs_src/capo_geo_places/types/geocode_query_components.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class GeocodeQueryComponents(TypedDict, closed=True):
    country: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>The alpha-2 or alpha-3 character code for the country that the results will be present in.</p>"""
    region: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>The region or state results should be to be present in. </p> <p>Example: <code>North Rhine-Westphalia</code>.</p>"""
    sub_region: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>The sub-region or county for which results should be present in. </p>"""
    locality: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>The city or locality results should be present in. </p> <p>Example: <code>Vancouver</code>.</p>"""
    district: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>The district or division of a city the results should be present in.</p>"""
    street: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>The name of the street results should be present in.</p>"""
    address_number: NotRequired[
        "capo_geo_places.types.sensitive_string.SensitiveString"
    ]
    """<p>The house number or address results should have. </p>"""
    postal_code: NotRequired["capo_geo_places.types.sensitive_string.SensitiveString"]
    """<p>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 possess. </p>"""

address_number instance-attribute 

address_number: NotRequired[SensitiveString]

The house number or address results should have.

country instance-attribute 

country: NotRequired[SensitiveString]

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

district instance-attribute 

district: NotRequired[SensitiveString]

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

locality instance-attribute 

locality: NotRequired[SensitiveString]

The city or locality results should be present in.

Example: Vancouver.

postal_code instance-attribute 

postal_code: NotRequired[SensitiveString]

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 possess.

region instance-attribute 

region: NotRequired[SensitiveString]

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

Example: North Rhine-Westphalia.

street instance-attribute 

street: NotRequired[SensitiveString]

The name of the street results should be present in.

sub_region instance-attribute 

sub_region: NotRequired[SensitiveString]

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