Sign in

v1

latestOpenAPI 3.1.02026-07-242892032.8 MB
Regions

Search for regions

Search for all regions within a radius.

post/{country}/{version}/{level}/withinproximity

Path parameters

countrystring required

Country abbreviation.

versionstring required

The skills taxonomy version.

levelstring required

A country's region level.

Request body

radiusnumber required
radiusUnit'miles' | 'meters' | 'degrees'
intersectionMethod'contained' | 'centroid' | 'touching'

  • touching - Any region that is touching (intersects) the requested area.

  • centroid - Any region's who's centroid lies inside of the requested area.

  • contained - Any region that lies entirely inside of the requested area.

calculationType'planar' | 'geodetic'

  • planar - Calculate distance as if on a flat plane (faster)

  • geodetic - Calculate distance on the surface of the earth (more accurate).

Response

OK