nqach · Insly

Description

Get address list from AddressCloud by postcode

Example request




API token

output

Postcode

Request parameters

Parameter	Type	Reqd	Description	Options
postcode	string	•	Postcode

Response parameters

Parameter	Type	Description
status	integer	Status
response	array	list of addresses
response.match_status	string	TODO
response.found	integer	Results found
response.max_score	float	Max score
response.results	array	Address list
response.results.location_type	string	TODO
response.results.id	string	Address Id
response.results.description	string	Full address
response.results.score	float	TODO
apirequest_oid	integer	Address request id from Insly

Json response example

{
 "status": 1,
 "response": {
  "match_status": "MULTIMATCH",
  "found": 5,
  "max_score": 1,
  "results": {
   "0": {
    "location_type": "address",
    "id": "GfXPwlf8EziOw1Q-xBMVtw",
    "description": "Bromley & Lewisham Mind, 20B Hayne Road, Beckenham BR3 4HY",
    "score": 1
   },
   "1": {
    "location_type": "address",
    "id": "2-xy0Y2BxPjf6hDjkD7zdA",
    "description": "Riverside School, 2 Hayne Road, Beckenham BR3 4HY",
    "score": 1
   },
   "2": {
    "location_type": "address",
    "id": "SOfsrT38sHMYYG1KvjXJkQ",
    "description": "Flat 1, Fontaine Court, 1 Hayne Road, Beckenham BR3 4HY",
    "score": 1
   },
   "3": {
    "location_type": "address",
    "id": "qFiczdB6x6vvRadnjfK2fA",
    "description": "Flat 2, Fontaine Court, 1 Hayne Road, Beckenham BR3 4HY",
    "score": 1
   },
   "4": {
    "location_type": "address",
    "id": "zOeMk_bDa2lVWTo1ZIHgnQ",
    "description": "Flat 3, Fontaine Court, 1 Hayne Road, Beckenham BR3 4HY",
    "score": 1
   },
   "5": {
    "location_type": "address",
    "id": "rm6lhj1---AD6_9gDAe6qw",
    "description": "Flat 4, Fontaine Court, 1 Hayne Road, Beckenham BR3 4HY",
    "score": 1
   }
  }
 },
 "apirequest_oid": 10001012
}

return