EG Radius APIs endpoint explanation
Endpoints and structure can be viewed here
| API | Description | Parameters |
| Radius PUT APIs (4 endpoints) * Letting Deals * Occupational Sales * Investment Sales * Availabilities | Used by Radius contributors to upload transaction and availability data (including “red” and private), preferably via integration with their core systems so that records flow automatically to Radius. | The company ID is provided in the API url Details of the contributed record are provided in the request payload. |
| Radius GET APIs (4 endpoints) * Letting Deals * Occupational Sales * Investment Sales * Availabilities | Used by a contributor to retrieve their records only in a structured form. The response will include any “red” and private data originally contributed. | The company ID is provided in the API url Date range is provided as a query string parameter The response is paginated and the page size and page number can be provided as query string parameters |
| Radius Search APIs (4 endpoints) * Letting Deals * Occupational Sales * Investment Sales * Availabilities | Used by any subscriber with access to retrieve the whole UK’s contributed and researched data. Does not include “red” and private data. | Parameters for the query are provided in the request as a json object. They include date ranges for accepted and transaction dates, geography in the form of major post code or a polygon and finally sectors. |
| Radius Places API (2 endpoints) * match * autocomplete | The main use case is returning structured address data (inc. child and parent UPRN) given a free text address. The match endpoint is optimised for address lookup (the vast majority of cases). The autocomplete endpoint is optimised for providing suggestions for a UI’s auto-complete feature and is only currently used in CUI | Parameters can be set to return parent buildings only or the parent and its children. The API can also be used to find addresses given a list of UPRNs Finally it has a radial search feature that will return all addresses within x metres of a lat/long |