/lookup

Retrieve address suggestions based on partial input.

• key (query, required) — Embedded API key used for authentication.
• search (query, required) — The part of the address that has already been typed (max 32 characters).
• max_results (query, limit) — Maximum number of address suggestions to return; range [1,10].
• include_only_cities (query) — Limit results to only the listed cities (and the state after the list).
• include_only_states (query) — Limit results to only the listed states (or keywords CONTIGUOUS / ALLSTATES).
• include_only_zip_codes (query) — Limit results to only the listed ZIP Codes (cannot be combined with other city/state filters).
• exclude_states (query) — Exclude the listed states from results (cannot be combined with include_* filters).
• prefer_cities (query) — Boost suggestions from the listed cities to the top of the list.
• prefer_states (query) — Boost suggestions from the listed states to the top of the list.
• prefer_zip_codes (query) — Boost suggestions from the listed ZIP Codes to the top of the list (cannot be combined with other city/state filters).
• prefer_ratio (query) — Percentage of suggestions that should be preferred (0‑100).
• prefer_geolocation (query) — Determines whether to use the requester's IP to add city/state to preferences; values: empty/string (city), none, city.
• selected (query) — Used to request a list of secondary numbers for a selected address (up to 100).
• source (query) — Include results from alternate data sources; values: all, postal.
• Referer (header, required) — URL of the site making the request; required when using an embedded key.