Address Verify and Geocode

FREE
By loqate
Updated 25 days ago
Data
8.6/10
Popularity Score
908ms
Latency
100%
Success Rate

Address Verify and Geocode API Documentation

Our RESTful web service allows developers to access all of the transactional functionality that exists within the core engine provided by Loqate. This includes processing for address validation (one in, one out), geocoding and address suggestion (or look-up). To use any everythinglocation.com resource you must first sign up for an everythinglocation.com account and obtain an API key. Please visit everythinglocation.com to get started now.

View API Details
Address Verify and Geocode
GETProcess Address
GETProcess Address

This service accepts one address record per call and returns an Address Verihttps://www.mashape.com/loqate/address-verify-and-geocodefication Code (see Readme) along with both the standardized and verified address fields/values. To use this resource you must first sign up for an everythinglocation.com account and obtain an API key. Please visit everythinglocation.com to get started now.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
pSTRING
REQUIREDUsed to specify the desired processes to run on the input record. Available values include: v = Verify, s = Search/Suggest, v+g = Verify & Geocode, s+g = Search & Geocode
lqtkeySTRING
REQUIREDUsed to specify the supplied user key for authenticating the web service call. API keys can be created on your everythinglocation.com cloud account and used with an active credit plan.
Optional Parameters
tfreSTRING
OPTIONALInput Thoroughfare such as Kings Road, Main Street or Mystic Avenue (Level 3 validation)
lctySTRING
OPTIONALInput Locality such as Town, City or Village (Level 2 validation)
add3STRING
OPTIONALUsed to specify Address Line 3. May be used with all other fields except addr (above)
add4STRING
OPTIONALUsed to specify Address Line 4. May be used with all other fields except addr (above)
add2STRING
OPTIONALUsed to specify Address Line 2. May be used with all other fields except addr (above)
add5STRING
OPTIONALUsed to specify Address Line 5. May be used with all other fields except addr (above)
addrSTRING
OPTIONALSingle address field to provide either some or all parts on an address (incl. a Country). The field is best used either by itself or with component fields.
add1STRING
OPTIONALUsed to specify Address Line 1. May be used with all other fields except addr (above)
add6STRING
OPTIONALUsed to specify Address Line 6. May be used with all other fields except addr (above)
premSTRING
OPTIONALInput Premise Number or Building Name (Level 4 validation)
admnSTRING
OPTIONALInput Administrative Area such as State, County or Region (Level 1 validation)
orgnSTRING
OPTIONALInput Organization. This value will be identified (parsed) only. The service currently does not support Organization verification.
fsSTRING
OPTIONALUsing this parameter and setting it to "yes" will return a field status code with each output field. The code reports on what happened to the field during the validation process. Please see everythinglocation.com for more information about what each field status code means. Default = no
outputfieldsSTRING
OPTIONALSpecify which output fields to return after processing. Only functions with Search (p=s) and Query (p=q) requests. Separate values with a comma (no spaces). Please see everythinglocation.com for a full list of component and composite address fields.
optsSTRING
OPTIONALUsed for advanced server-side settings that allow further customization to the web service call. Syntax must follow opts=option_name=value, option_name=value, etc. Please see everythinglocation.com for a full list of server settings.
maxresultsNUMBER
OPTIONALSet the maximum number for returned address results. Used primarily with Search (p=s) call types which are designed to return a list of suggestions.
pcdeSTRING
OPTIONALInput Postal Code (e.g. Postcode, Zip, PIN)
ctrySTRING
OPTIONALInput Country, supplied as a name or ISO classification (ISO-3 or ISO-2). Please note that a country is required for all processes. This field can be specified in other field types (such as addr) or be set using advanced server options (e.g. DefaultCountry or ForceCountry).
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication