Skip to content

README.md

Latest commit

 

History

History
68 lines (48 loc) · 22.5 KB

README.md

File metadata and controls

68 lines (48 loc) · 22.5 KB

EnrichedAddress

Overview

Available Operations

  • get - Fetch enriched address suggestions. Requires a partial address.

To access this endpoint using an access token you'll need to specify the /profile-enrichment.read scope.

get

Fetch enriched address suggestions. Requires a partial address.

To access this endpoint using an access token you'll need to specify the /profile-enrichment.read scope.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.enriched_address.get(search="<value>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
search str ✔️ Partial or complete address to search.
max_results Optional[int] ➖ Maximum number of results to return.
include_cities Optional[str] ➖ Limits results to a list of given cities.
include_states Optional[str] ➖ Limits results to a list of given states.
include_zipcodes Optional[str] ➖ Limits results to a list of given zipcodes.
exclude_states Optional[str] ➖ Exclude list of states from results. No include pararmeters may be used with this parameter.
prefer_cities Optional[str] ➖ Display results with the listed cities at the top.
prefer_states Optional[str] ➖ Display results with the listed states at the top.
prefer_zipcodes Optional[str] ➖ Display results with the listed zipcodes at the top.
prefer_ratio Optional[int] ➖ Specifies the percentage of address suggestions that should be preferred and will appear at the top of the results.
prefer_geolocation Optional[str] ➖ If omitted or set to city, it uses the sender's IP address to determine location, then automatically adds the city and state
to the preferCities value. This parameter takes precedence over other include or exclude parameters meaning that if it is
not set to none, you may see addresses from areas you do not wish to see.
selected Optional[str] ➖ Useful for narrowing results with addressLine2 suggestions such as Apt (denotes an apartment building with multiple residences).
source Optional[str] ➖ Include results from alternate data sources. Allowed values are all (non-postal addresses), or postal (postal addresses only).
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetEnrichmentAddressResponse

Errors

Error Type Status Code Content Type
errors.APIError 4XX, 5XX */*