---
title: "Find Nearby Couriers"
method: GET
path: "/v1/routes/nearby-couriers"
tags: ["Route"]
---

# Find Nearby Couriers

`GET /v1/routes/nearby-couriers`

## Request

- Base URL: `https://api.sandbox.usenash.com`
- URL: `https://api.sandbox.usenash.com/v1/routes/nearby-couriers`
- Auth: none declared

Nearest couriers on active routes (assigned, started, in progress) to a point, ranked by straight-line distance from each courier's latest GPS ping. Couriers with no recorded ping are omitted. Scope to one depot with store_location_id, and leave out the route being rescued with exclude_route_ids.

## Query parameters

- `lat` number, required: Latitude to measure from, e.g. the stranded driver.
- `lng` number, required: Longitude to measure from.
- `limit` integer: Maximum couriers to return.
- `store_location_id` string, nullable: Only routes carrying an order picked up at this store location.
- `exclude_route_ids` string, nullable: Comma-separated route ids to leave out, along with their couriers, e.g. the route that needs rescuing.
- `max_location_age_minutes` integer: Ignore couriers whose latest ping is older than this.

## Response `200`

OK

- NearbyCouriersResponse
  - `couriers` NearbyCourier[], required: Nearest first.
    - `courier_id` string, required
    - `courier_name` string, nullable, required
    - `route_id` string, required
    - `route_name` string, nullable, required
    - `route_status` 'created' | 'assigned' | 'started' | 'in_progress' | 'completed' | 'failed' | 'canceled', required: Status enum for Routes.
    - `lat` number, required
    - `lng` number, required
    - `captured_at` string, date-time, required
    - `distance_meters` integer, required: Straight-line distance from the query point.

## Other responses

- `422`: Unprocessable Content

---

[API](https://skmtc.dev/nash/apis/nash-api.md) - [All operations](https://skmtc.dev/nash/apis/nash-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nash/apis/nash-api/revisions/e3713837c5c9?raw)