Address

class ab.api.endpoints.address.AddressEndpoint(client)[source]

Address validation (ACPortal API).

Parameters:: client (HttpClient)

validate(*, line1, city, state, zip)[source]

GET /address/isvalid

Docs: https://ab-sdk.readthedocs.io/en/latest/api/address/validate.html Query params: AddressValidateParams Response model: AddressIsValidResult

Parameters:

line1 (str)
city (str)
state (str)
zip (str)

Return type:

AddressIsValidResult

get_property_type(*, address1, address2=None, city, state, zip_code)[source]

GET /address/propertytype

Docs: https://ab-sdk.readthedocs.io/en/latest/api/address/get_property_type.html Query params: AddressPropertyTypeParams

Parameters:

address1 (str)
address2 (str | None)
city (str)
state (str)
zip_code (str)

Return type:

int | None

Per-endpoint reference

Each route-backed method has its own page rendering the HTTP route, the Python and CLI call signatures, and the request/response model field tables. This is the page help(api.address.<method>) links to via its Docs: footer. These pages are generated by scripts/generate_endpoint_docs.py and kept current by a CI freshness gate.

Methods

validate

GET /address/isvalid — Validate an address.

Returns: AddressIsValidResult

from ab import ABConnectAPI

api = ABConnectAPI(env="staging")
result = api.address.validate(
    street="5738 Westbourne Ave",
    city="Columbus",
    state="OH",
    zip_code="43213",
    country="US",
)
if result and result.is_valid:
    print("Address is valid")

get_property_type

GET /address/propertytype — Get property type for an address.

Returns: PropertyType

prop = api.address.get_property_type(street="5738 Westbourne Ave", zip_code="43213")