Skip to main content
GET
/
Capture
/
Interactive
/
Retrieve
/
v1.30
/
json6.ws
cURL
curl --request GET \
  --url https://api.addressy.com/Capture/Interactive/Retrieve/v1.30/json6.ws
{
  "Items": [
    {
      "Id": "",
      "DomesticId": "",
      "Language": "",
      "LanguageAlternatives": "",
      "Department": "",
      "Company": "",
      "SubBuilding": "",
      "BuildingNumber": "",
      "BuildingName": "",
      "SecondaryStreet": "",
      "Street": "",
      "Block": "",
      "Neighbourhood": "",
      "District": "",
      "City": "",
      "Line1": "",
      "Line2": "",
      "Line3": "",
      "Line4": "",
      "Line5": "",
      "AdminAreaName": "",
      "AdminAreaCode": "",
      "Province": "",
      "ProvinceName": "",
      "ProvinceCode": "",
      "PostalCode": "",
      "CountryName": "",
      "CountryIso2": "",
      "CountryIso3": "",
      "CountryIsoNumber": "",
      "SortingNumber1": "",
      "SortingNumber2": "",
      "Barcode": "",
      "POBoxNumber": "",
      "Label": "",
      "Type": "",
      "DataLevel": "",
      "Field1": "",
      "Field2": "",
      "Field3": "",
      "Field4": "",
      "Field5": "",
      "Field6": "",
      "Field7": "",
      "Field8": "",
      "Field9": "",
      "Field10": "",
      "Field11": "",
      "Field12": "",
      "Field13": "",
      "Field14": "",
      "Field15": "",
      "Field16": "",
      "Field17": "",
      "Field18": "",
      "Field19": "",
      "Field20": ""
    }
  ]
}
This method will consume credit.
We don’t support API connections using HTTP - all calls should use HTTPS.

Query Parameters

​
Key
string
required

The key to use to authenticate with the service. For example: "AA11-AA11-AA11-AA11".

​
Id
string
required

The unique Id generated from a Find method, which you want to retrieve the details for. For example: "GB|RM|B|55605138|ENG".

​
Type
string

This setting is only applicable if you have OS AddressBase Premium dataset enabled. Allows to fetch a record based on data supplier specific record id. For use, check out search type for more details.

​
Field1Format
string

The FieldxFormat fields can be used to return extra data fields into the corresponding Fieldx response. This needs to be supplied in the format of {FieldName} (for example: "{Latitude}"). You can include multiple data fields within each Fieldx field, with commas to separate them - for example, you could call "&Field1Format={Latitude}, {Longitude}" to include both lat/long coordinates in a single field. You can call up to 50 Fieldx fields - if you need more than the default 20, include the &Fields parameter to set how many you need. For example: &Fields=35. Which fields can be called is determined by the available dataset(s) in the country being searched - speak to your account manager or contact Loqate support for more information.

​
Field2Format
string
​
Field3Format
string
​
Field4Format
string
​
Field5Format
string
​
Field6Format
string
​
Field7Format
string
​
Field8Format
string
​
Field9Format
string
​
Field10Format
string
​
Field11Format
string
​
Field12Format
string
​
Field13Format
string
​
Field14Format
string
​
Field15Format
string
​
Field16Format
string
​
Field17Format
string
​
Field18Format
string
​
Field19Format
string
​
Field20Format
string

Response

Success

​
Items
object[]
⌘I