---
title: "Search for regions"
method: POST
path: "/{country}/{version}/{level}/withinproximity"
tags: ["Regions"]
---

# Search for regions

`POST /{country}/{version}/{level}/withinproximity`

Search for all regions within a radius.

## Path parameters

- `country` string, required
- `version` string, required
- `level` string, required

## Request body

- object
  - `radius` number, required
  - `radiusUnit` 'miles' | 'meters' | 'degrees'
  - `centroid` object, required
    - `lat` number, required
    - `lon` number, required
  - `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 `200`

OK

- object — A list of codes.
  - `codes` union[], required
    - union
      - string
      - integer

## Other responses

- `400` — bad request
- `404` — requested resource not found

---

[API](https://skmtc.net/lightcast/apis/alumni-pathways-2-0.md) · [All operations](https://skmtc.net/lightcast/apis/alumni-pathways-2-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightcast/alumni-pathways-2-0/revisions/fc66b9877391/schema)