REST API
A key is required to access the REST API. Please contact Loqate to obtain your key.
The REST API can be accessed from the following URLs:
http://saas.loqate.com/rest/
https://saas.loqate.com/rest/
Implementation Note
The REST API provides the same functionality as the JSON API. With more options of input format and output format.
It supports passing parameter through either URL/GET(HTTP), JSON, or XML. And supports the output in either XML or JSON format.
For JSON and XML input, it requires HTTP POST Method, with the setting of Content-Type header to be either XML or JSON.
To choose the output format, it can be done by setting the Accept Header to either XML or JSON, with JSON as default.
Parameters
The following query string parameters are supported:
lqtkey [Required]
Used to specify the supplied user key
callback [Optional]
Used to specify a JSONP callback function
opts [Optional]
Used to specify the desired server options
p [Optional]
Used to specify the desired processes to run, from the following values. To combine processes use the plus ‘+’ symbol, e.g. p=v+g. Default value is v (Verify)
- v – Verify
- s – Search
- g – Geocode
- r – Report
- q – Query
- f – Format
- m – Match
- p – Parse
Please note that the plus ‘+’ symbol may need to be escaped when used directly within a browser (escape code %2B).
callback [Optional]
Used to specify the JSONP callback function
addr [Optional]
Used to specify the input address block
add1 [Optional]
Used to specify the first line of the input address block (equivalent to addr)
add2 [Optional]
Used to specify the second line of the input address block
add3 [Optional]
Used to specify the third line of the input address block
add4 [Optional]
Used to specify the fourth line of the input address block
add5 [Optional]
Used to specify the fifth line of the input address block
add6 [Optional]
Used to specify the sixth line of the input address block
add7 [Optional]
Used to specify the seventh line of the input address block
add8 [Optional]
Used to specify the eighth line of the input address block
orgn [Optional]
Used to specify the input Organization
prem [Optional]
Used to specify the input Premise Number
tfre [Optional]
Used to specify the input Thoroughfare
lcty [Optional]
Used to specify the input Locality
admn [Optional]
Used to specify the input AdminstrativeArea
pcde [Optional]
Used to specify the input PostalCode
ctry [Optional]
Used to specify the input Country
table [Optional]
Used to specify the query tool country table
maxresults [Optional]
Used to specify the number of set of output results from query tool and search tool, default 10
outputfields [Optional]
Used to specify the output fields for each set of result from query tool and search tool, default ALL
queryclause [Optional]
Used to specify the clause of the query (ALL, DISTINCT, UNIQUE) for query tool and search tool
rangefieldpreference [Optional]
Used to specify the Rangefield Preference (RANGE, FULL, MATCH) for query tool and search tool
aliaspreference[Optional]
Used to specify the Alias Preference (FIRST, EXHAUSTIVE, UNPROCESSED) for query tool and search tool
querystring [Optional]
Used to specify the query string for query tool
Example
Verify example
https://saas.loqate.com/json?lqtkey=12341234&addr=300%20berry%20san%20francisco&ctry=usa
Search tool example
http://saas.loqate.com/json?lqtkey=12341234&p=s&address=ba3%203hf&country=uk
Query tool example