LiveAddress - Extract addresses from text
By smartystreets
Updated 3 months ago

LiveAddress - Extract addresses from text API Documentation

Find and validate addresses in arbitrary text such as emails, web pages, documents, posts, tweets, articles, or whatever else you've got.

Learn more about this API
GETExtract addresses from text
GETExtract addresses from text


Header Parameters
Required Parameters
REQUIREDThe text from which to extract addresses. This is only required if using a GET request. If using a POST request, submit the data in the raw body of the POST request (don't use an "input" field name). For input strings longer than a sentence or two, use a POST request (not GET). The maximum input length is currently 64 KB.
REQUIREDUse only with Secret Key Pairs from your account. This should be the "Auth ID" value associated with your auth-token.
REQUIREDAn "Auth Token" value from your account, obtained from the Key Management page. If using a secret key pair, this must be associated with the ID in the auth-id field, or this is the HTML Key for your host.
Optional Parameters
OPTIONALSet to true if you want the extractor to be more aggressive in finding addresses. This can use more lookups, but can sometimes find more addresses. For example, aggressive mode can find addresses in popular cities without a state and ZIP code. If too many false positives are appearing, turn off aggressive mode.
OPTIONALHTML in your input is auto-detected, but you can override auto-detection by setting this parameter to true or false if needed. For example, if you have addresses inside HTML tags, you should set this to false and submit only as much HTML code as necessary. Do not submit your input text in this field.
OPTIONALThis parameter specifies whether addresses in your input text will ever have line breaks. Typically, you'll only set this to false if you're processing a bunch of single-line addresses (like those in a spreadsheet) and can guarantee that every address in your input will be on the same line, and never have a line break.
OPTIONALDefault 0 (no limit). Limits the extractor to getting a certain number of addresses per line. Generally, you will leave this unchanged to find as many addresses per line as necessary. If you set this to 1, for instance, the extractor will find an address starting on a certain line, and then skip any other addresses that start on that line. This option is typically set to 1 along with setting addr_line_breaks to false if you're extracting from spreadsheet data.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication