Postcodes

Radius search: every company within a distance, nearest first

Companies registered at every Great Britain postcode within radius km (at most 25) of a postcode or a point, nearest first, each with its distance (to the centre of its registered office postcode). Page with next_cursor until it is null; a page can hold fewer than limit companies in a sparse area. The first page also gives postcodes_in_radius and total (capped at 10,000). Companies at mass-registration addresses (50 or more companies at one address) and at the Companies House default address are left out unless asked for. Give postcode, or lat and lng. Each page is read within a few seconds: a postcode whose companies cannot be read in that time (some formation agents' postcodes hold tens of thousands) is listed in postcodes_skipped and paging carries on after it.

get/postcodes/nearby

Request

  • Base URL: https://api.companystack.co.uk
  • URL: https://api.companystack.co.uk/postcodes/nearby
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Query parameters

postcodestring

The centre: a full Great Britain postcode

latnumber

The centre's latitude (with lng, instead of postcode)

lngnumber

The centre's longitude

radiusnumber

Kilometres, up to 25 (1 mile = 1.609 km)

limitinteger
cursorstring

next_cursor from the previous page, unchanged

status'active' | 'all'

active: active companies only

sicstring

SIC code or its start (2 to 5 digits), matched against any of the company's four

include_mass_registration'true' | 'false'

Include companies at mass-registration addresses (formation agents, accountants, virtual offices)

include_registrar_default'true' | 'false'

Include companies at the Companies House default address (their registered office was removed)

Response

A page of companies, nearest first

radius_kmnumber required
radius_milesnumber
order'distance'
postcodes_searchedinteger

Postcodes whose companies were all read for this page

postcodes_in_radiusinteger nullable

First page only: every Great Britain postcode within the radius (null when it could not be counted in time)

totalinteger nullable

First page only: companies matching, up to 10,000 (null when it could not be counted in time)

total_cappedboolean

First page only: more than 10,000 companies match

limitinteger
filtersobject
noticestring
attributionstring
has_moreboolean required
next_cursorstring nullable required

Pass as cursor for the next page; null on the last page. A page can hold fewer than limit companies in a sparse area: keep going until next_cursor is null.

Changes

No recorded changes to this operation across all 1 revision of this API.