The main endpoint for retrieving businesses is /companies/. When called without any parameters, this will return all available businesses in the database.
In order to perform searches, various filters are added to the companies. These can all be combined together; for example, to retrieve all manufacturing (SIC section D) companies near the centre of Oldham the query would be:
https://api2.redflagalert.net/v4/companies/?sic_section=D&postcode=OL11HD&distance=3miles
Various search filters are available and we expect these to be steadily added to as the API develops. If you require a search which is not currently available, please contact us to suggest it.
Search Parameter | Description | Examples | Notes |
| Search within a specified radius of a UK postcode. |
Returns businesses with postcode SW1A 2AA | Where we have multiple addresses for a business, if any of them match the postcode filter then the business will be included in the search results. |
| Search within a specified radius of a UK postcode. |
Returns businesses within a 3 mile radius of SW1A 2AA | Where we have multiple addresses for a business, if any of them match the postcode filter then the business will be included in the search results. |
| Filter companies based on available contact information. |
Returns companies which have a contact phone number or a contact email address.
Returns companies which have a contact email address.
Returns companies with no contact email address but with a contact phone number. | All of these filters take a boolean value; e.g. 'true' or 'false'. |
| Filter out non-trading companies (rated 'Discontinued', 'Dissolved', 'Not-trading' or 'Strike Off'). |
| The filter does not return only non trading companies if set to 'false'. |
| Filter companies with accounting data i.e. who have filed accounts. |
| Returns companies which have at least one set of figures for balance sheet, profit and loss, cashflow, or ratio analysis. Setting it to false will only return companies who have none of these data. |
| Filter search results to include/exclude registered/limited companies. |
Only returns companies which are registered/limited. | This filter takes a boolean value; e.g. 'true' or 'false'. |
| A simple closest text match on the name of the business. |
Will return Red Flag A!ert first, followed by other similar matches. | ​ |
| Also a text match, but focuses on the beginning of the company name. |
Returns all businesses whose name starts with ‘red flag’. | Most commonly used for autocomplete-style search. |
| Range search on the reported number of employees for the business. |
Returns all companies with between 5 and 50 employees. | Can specify min or max parameters. To search within a range, specify both. |
| Retrieve companies registered in a particular date range. |
Return companies established on or after the 9th of February 1987.
Return companies established between 1977 and 1987. | Supply valid dates in ISO-8601 standard YYYY-MM-DD format. Can specify min or max parameters. To search within a range, specify both. |
| Search on the last available total assets figure. |
Returns companies with most recently reported assets of between £50k and £100k. | Can specify min or max parameters. To search within a range, specify both. |
| Search on the last available turnover figure for a business. |
Returns businesses with last reported turnovers of between £50k and £100k. | Can specify min or max parameters. To search within a range, specify both. |
| Filters companies that have at least one directorship record. |
| ​ |
| Filter by the top-level SIC Section to which the company belongs. |
Returns all construction businesses in the database. Multiple section can be searched, in which case results will containe businesses that have any of the supplied codes:
In order to only get results that match all of the supplied sectors, supply the 'sic_section_search_type' parameter:
| SIC section headings and letter codes given in Appendix 2. Companies may have several SIC sections if they are active in several areas; in this case, if any of the sections match then the company will be returned. |
| Filter on the exact SIC codes a company has. |
Returns companies with the SIC code 51519.
Returns companies with the SIC code 51519 or 51511.
Returns companies with at least the SIC codes 51519 and 51511 assigned.
Returns companies whose primary SIC code is 51519.
Returns companies whose primary SIC code is 51519 or 51511. | You can supply multiple search parameters, comma separated in list. By default, a search on a sic_code will return companies that have any of the listed SIC codes. If you would like to see only companies that have all of the supplied SIC codes, supply the ' SIC codes for companies are returned in order of priority, the primary SIC code being the first entry in the list. The primary SIC code itself is a searchable field. Multiple values can be supplied that will match a company that has any one of them as the primary SIC code. Only one value can be present for the 'primary_sic_code' therefore you cannot perform an 'and' search on this field as with 'sic code'. |
| The Red Flag Alert credit rating currently assigned to this company. | Returns companies with the specified Red Flag rating e.g:
Returns companies with a 'Bronze' Red Flag rating. | See Appendix 3 for a complete list of Red Flag Alert ratings and descriptions. |
| Minimum and maximum date filters allowing you to narrow your query down to records updated within a specified time period. | ​ | ​ |
| Whether or not the company is registered for the Telephone Preference Service. | ​ | ​ |
filter_name | ​ | ​ | ​ |
company_type | ​ | ​ | ​ |
postcode_area | ​ | ​ | ​ |
county | ​ | ​ | ​ |
town | ​ | ​ | ​ |
country | ​ | ​ | ​ |
telephone_number | ​ | ​ | ​ |
mortgage_type | ​ | ​ | ​ |
mortgage_holder | ​ | ​ | ​ |
min_last_updated | isoformat date | ​ | ​ |
max_last_updated | isoformat date | ​ | ​ |
min_latest_action_date | isoformat date | ​ | ​ |
max_latest_action_data | isoformat date | ​ | ​ |
address_type | "trading" or "registered" | ​ | ​ |