AddressesByStreetKey
Finds details of an address within a street.
To connect to this service you'll need to use one of these endpoints:
Description
Finds details of an address within a street. The street to search within is identified by the streetKey
parameter, which should be a street key returned from the StreetsByLocalityKey
or StreetsByName
methods.
The building to find the address for is specified by the building
parameter. This should be set to the name of the building or organisation you wish to find. If null
is supplied for this parameter, all buildings on the street will be returned.
Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
licence | licence As the Royal Mail PAF database can be licensed in multiple ways, this parameter indicates under which license you are accessing the data. This must match the variant you have a license or credits for - if you are unsure which option to choose, please contact your account manager |
streetKey | streetKey The identifier of a street as returned from the |
building | building The name of the building or organisation to find within the street |
Results
This method returns an object containing the following fields:
Status |
Status Success field is true , the other results described below can be used to get the results of the method.
If Success is false , some error occurred in calling the method, such as the authentication failed or the
account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored
|
---|---|
Results | Results Contains an array of addresses that match the query. Each address is returned with a |