# List nearby listings

> Takes a point (lat/lng) and returns a flat, distance-ordered list — no address resolution and no grouping, unlike /around, which takes an address and returns grouped, ranked results.

Source: https://api.tailend.dev/docs/api/list-nearby

```http
GET https://api.tailend.dev/v1/{metro}/nearby
X-API-Key: $TAILEND_API_KEY
```

Takes a **point** (`lat`/`lng`) and returns a flat, distance-ordered
list — no address resolution and no grouping, unlike `/around`, which
takes an **address** and returns grouped, ranked results. Use this
when the caller already has coordinates; use `/around` when the
caller has an address.

Returns published, active rows with coordinates within `radius_m` of
`lat`/`lng`, nearest first, with the distance in metres on every row.
Only rows with something still ahead of them: places always, events
that have not started, and classes and camps whose term has not
ended.

Paged by `cursor` only (there is no `page`); `meta.next_cursor` is
`"<distance_m>:<listing_id>"`, the key of the last row returned, so
the page cannot drift as rows are written.

Results are confined to `{metro}`; a point outside it returns an
empty page rather than the neighboring metro's rows. `lat`/`lng`
choose where in the metro to look, never which metro to look in.

Use `types` to narrow; each type requested must be in the key's
`scopes.types`. Returns 503 when this endpoint is unavailable.

Authorization: send your key in the `X-API-Key` header. Available on every plan.

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `metro` | string | yes | Metro slug from /v1/metros (e.g. philadelphia). |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `lat` | number | yes | Latitude of the point to search around. |
| `lng` | number | yes | Longitude of the point to search around. |
| `radius_m` | integer | no | Radius in metres. |
| `types` | array of string | no | Restrict to these listing types. |
| `cursor` | string | no | meta.next_cursor from the previous page: "<distance_m>:<listing_id>". |
| `limit` | integer | no |  |

## Example request

```bash
curl -sS \
  -H "X-API-Key: $TAILEND_API_KEY" \
  "https://api.tailend.dev/v1/philadelphia/nearby"
```

## Responses

### 200

A page of nearby items, nearest first.

```json
{
  "data": [
    {
      "listing_id": "00000000-0000-4000-8000-000000000001",
      "type": "event",
      "name": "example",
      "distance_m": 1
    }
  ],
  "meta": {
    "limit": 1,
    "count": 1,
    "has_more": false
  }
}
```

### 400

Malformed or contradictory parameters (lat without lng, to before from, unknown category), or a cursor this API did not issue for this exact request — replayed from another endpoint, resource, metro or filter set, hand-crafted, or altered.

```json
{
  "error": {
    "code": "bad_request",
    "message": "radius_m: must be at least 100",
    "details": {
      "param": "radius_m"
    },
    "request_id": "req_dfbc3295a8382b05"
  }
}
```

### 401

Missing, unknown or revoked X-API-Key.

```json
{
  "error": {
    "code": "unauthorized",
    "message": "missing X-API-Key header",
    "request_id": "req_90e63908273f6bff"
  }
}
```

### 403

Two different reasons share this status.

```json
{
  "error": {
    "code": "forbidden",
    "message": "key is not scoped to metro 'boston'",
    "details": {
      "metros": [
        "philadelphia"
      ]
    },
    "request_id": "req_9e7a750acef48ab2"
  }
}
```

### 404

No published, active resource with that id (or unknown metro).

```json
{
  "error": {
    "code": "not_found",
    "message": "unknown metro 'boston'",
    "request_id": "req_7431b51e10ec2b77"
  }
}
```

### 405

The path exists; the method does not.

```json
{
  "error": {
    "code": "method_not_allowed",
    "message": "POST is not allowed on this path; this API is read-only",
    "details": {
      "allow": [
        "GET",
        "HEAD",
        "OPTIONS"
      ]
    },
    "request_id": "req_01J9Z3"
  }
}
```

### 429

A limit was reached.

```json
{
  "error": {
    "code": "rate_limited",
    "message": "3 requests per minute exceeded",
    "request_id": "req_06bfd3c2d5e8aa9f"
  }
}
```

### 500

A bug on our side.

```json
{
  "error": {
    "code": "internal",
    "message": "internal error",
    "request_id": "req_01J9Z3"
  }
}
```

### 501

This endpoint or feature is not available and will not become available without a configuration change — for ?address=, this means no geocoder is configured.

```json
{
  "error": {
    "code": "not_implemented",
    "message": "this endpoint is not enabled on this deployment; it is not a fault and retrying will not help",
    "request_id": "req_01J9Z3"
  }
}
```

### 503

A transient outage: a dependency could not be reached or did not answer in time.

```json
{
  "error": {
    "code": "unavailable",
    "message": "the service is temporarily unable to serve this request; retry after the interval in Retry-After",
    "request_id": "req_01J9Z3"
  }
}
```