Jump to

• Request
• Response

Address Search: Find Addresses in Indirect Mode

get

/api/v2/address/find

Address Find

Note: We recommend you use the equivalent function in the latest version, v3/.

This endpoint implements text-based searches in Indirect Mode. (For faster searches, use Direct Mode with /preparefind.) Address Find provides type-ahead searches for address records or specific address components, like house numbers, cities, or zip codes.

Cost: This action is generally without cost or increase of usage count.

The next step is to narrow down results to a desired record, and then use the /v3/address/retrieve endpoint to obtain it in full.

As input, define at least one query parameter called Text, with whatever value the user has entered so far. This is the only mandatory input parameter.
Additional parameters to refine a search:
Container: The string value must be a previously retrieved Id from an object.
Origin: The string value bases find search results off the location (default is your public IP address).
Limit Maximum: Number of results to return (default is 7).
Language: The preferred language for this result.

The output is a JSON list of JSON objects. Each object represents a potential search result with the following attributes

Attribute Name	Description
Id	String value to identify this search result. The value can be used to retrieve this object via the /v3/address/retrieve endpoint
Type	This attribute helps identify which sort of entity this search result represents. Values are: Address, Street, City, and so on. A drill down is possible. For example, suppose you?re looking for an address, and you get a street with 50 possible matches. To drill down in the street, re-issue the same find request, but adding the Id provided as a new query parameter Container.
Text	This is a one line String value describing this potential result to the user.
Highlight	This is a notation of a substring(s) inside the Text value. They are used to highlight where matches to the original Text input occurred
Description	String value which contains additional information pertinent to this potential result.

The next step is to narrow down results. For more information, see here.

Example Response [ {"Id":"US|US|B|Z222725132|941","Type":"Address","Text":"941 Terra California Dr","Highlight":"0-3","Description":"Walnut Creek CA 94595"}, {"Id":"US|US|ENG|94595-CA-WALNUT_CREEK--DR-TERRA_CALIFORNIA--941","Type":"BuildingNumber","Text":"941 Terra California Dr Apt","Highlight":"0-3","Description":"Walnut Creek CA 94595 - 3 Addresses"}, {"Id": "US|US|ENG|94579-CA-SAN_LEANDRO--BLVD-LEWELLING--941","Type":"BuildingNumber","Text":"941 Lewelling Blvd Apt","Highlight":"0-3","Description":"San Leandro CA 94579 - 36 Addresses"}, {"Id":"US|US|B|Z209400723|941","Type":"Address","Text":"941 Lewelling Blvd","Highlight":"0-3","Description":"San Leandro CA 94579"}, {"Id":"US|US|B|Z222676602|941","Type":"Address","Text":"941 Garcia Ave","Highlight":"0-3","Description":"Pittsburg CA 94565"}, {"Id":"US|US|B|Z222676603|941","Type":"Address","Text":"941 Garcia Ave Ste","Highlight":"0-3","Description":"Pittsburg CA 94565"}, {"Id":"US|US|B|Z222923677|941","Type":"Address","Text":"941 Clyde Ave","Highlight":"0-3","Description":"Santa Clara CA 95054"}, {"Id":"US|US|B|Z222923696|941","Type":"Address","Text":"941 Laurelwood Rd","Highlight":"0-3","Description":"Santa Clara CA 95054"}, {"Id":"US|US|ENG|94501-CA-ALAMEDA--CT-SHOREPOINT--941","Type":"BuildingNumber","Text":"941 Shorepoint Ct Apt","Highlight":"0-3","Description":"Alameda CA 94501 - 146 Addresses"}, {"Id":"US|US|B|Z213529633|941","Type":"Address","Text":"941 Shorepoint Ct","Highlight":"0-3","Description":"Alameda CA 94501"}] ]

Request

Query Parameters

• Text(required): string

Header Parameters

• True-Client-IP(required):

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : array

Type: array

Title: array

array of key and values

Show Source

• Array of: object items

{
    "description":"array of key and values",
    "items":{
        "type":"object"
    },
    "title":"array",
    "type":"array"
}

Nested Schema : items

Type: object

401 Response

Unauthorized

403 Response

Forbidden

500 Response

An unexpected error occurred during the request.

Back to Top