GET/v1/{metro}/neighborhoodsall plans

List neighborhoods

Returns the metro's neighborhoods with live listing counts by type, including zero-count rows. slug is the value neighborhood= takes on the collection endpoints. Ordered by name then id; the default page size is limit=200.

Returns 501 when this endpoint is unavailable.

Try this requestRun it with sample data, no key needed. Paste a key to run it live.

Example request

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

Example response · 200

{
  "data": [
    {
      "id": "9a9a9a9a-0000-4000-8000-000000000001",
      "name": "University City",
      "slug": "university-city",
      "aliases": [
        "UCity"
      ],
      "lat": 39.95,
      "lng": -75.2,
      "metro": "philadelphia",
      "live": {
        "listings": 40,
        "events": 30,
        "classes": 5,
        "camps": 2,
        "places": 3
      }
    }
  ],
  "meta": {
    "metro": "example",
    "limit": 1,
    "count": 1,
    "has_more": false
  }
}

API key Remember for this tab

Try any request with sample data, no key needed. Available on every plan.

metrostringrequiredpath

Metro slug from /v1/metros (e.g. philadelphia).

Optional parameters (4)

qstringoptionalquery

Find a business by what a person would type: its name, its website address or a pasted URL.

cursorstringoptionalquery

Opaque cursor from meta.next_cursor.

pageintegeroptionalquery

1-based page number (browse mode).

limitintegeroptionalquery

Response

A 200 returns application/json with these fields.

dataarray of Neighborhoodalways present
- idstring (uuid)always present
- namestringalways present
- slugstring · nullable
  What neighborhood= on the collections takes.
- aliasesarray of stringalways present
- latnumber · nullable
- lngnumber · nullable
- metrostringalways present
- liveLiveCountsalways present
  Published, active listings, by type. listings is the total including ongoing.
  - listingsintegeralways present
  - eventsintegeralways present
  - classesintegeralways present
  - campsintegeralways present
  - placesintegeralways present
metaDirectoryMetaalways present
- metrostringalways present
- pageinteger · nullable
- limitintegeralways present
- countintegeralways present
- has_morebooleanalways present
- next_cursorstring · nullable
  Opaque, bound to the request, as on the collections.
- hintstring
  Present only when q had nothing to search by (empty, or only words like the and and and endings like llc). Says what to search by instead.
- generated_atstring (date-time)

Status codes

200
OK
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.
401
Missing, unknown or revoked X-API-Key. Also returned when the key record itself does not validate — the server fails closed and logs why rather than assuming anything about a row it cannot vouch for, and when the value is not shaped like a key (tl_ + 8 hex + _ + 48 hex). The message is invalid API key; the reason is not disclosed. The one exception is a credential shaped like a different kind of token, whose 401 explains it is the wrong credential for /v1 rather than repeating the generic message.
403
Two different reasons share this status. Read error.code.
Show more
forbidden — the key is valid but its scopes exclude this metro or resource type, or the client is inactive. Returned when the caller named the metro or type it was refused — in the path, or in ?metro=. Where the caller supplied only an identifier, an out-of-scope resource is a 404 instead; see NotFound.

include_not_permitted (endpoints that take include= only) — the key is valid and in scope, but is not entitled to a requested include= add-on (details.include names it). Add include_mode=lenient to get a 200 without the block instead of this. See Shaping responses.
404
No published, active resource with that id (or unknown metro).
Show more
Also returned when the resource exists but sits in a metro outside the key's scopes.metros, on the routes that take an identifier rather than a metro: /v1/{type}/{id}, /v1/{type}/slug/{slug} and /v1/organizations/{id}. The metro there is discovered from the row, not named by the caller, so a 403 would confirm that a guessed id or slug is real and say which metro it is in. The two cases are deliberately indistinguishable — same code, same message, same absent details.

Naming the metro is a different question and still gets the explicit 403 with the key's own scopes: /v1/boston/events, or ?metro=boston on a slug lookup.
405
The path exists; the method does not. Every route on this API is a read, so Allow is always GET, HEAD, OPTIONS. A method on a path that does not exist is a 404 instead — 405 is only ever sent where there is a target resource to refuse.
429
A limit was reached. Branch on error.code, not on the status — two different limits share this status:
Show more
- rate_limited — the per-minute rate. Retry-After is seconds, and retrying after it succeeds.
- rate_limited can also mean address lookups are temporarily unavailable. The response explains the condition and provides Retry-After; callers that already have coordinates can send lat/lng instead.
- quota_exceeded — the monthly allowance, or a client's hard cap. Retry-After points at the start of the next UTC month and can therefore be very large; details carries plan, monthly_limit, used and resets_at. Backing off will not help before the reset — the plan has to change. This is a 429; 402 is reserved.
500
A bug on our side. The message is always the constant internal error; details are never included in the body. Retry once with backoff, then contact support with the request_id.
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.
Show more
Nothing is failing, so do not retry and do not back off: there is no Retry-After, and the answer will not change inside any timeout you set. Treat the feature as switched off, disable it in your UI, and use the alternative the message names where there is one (lat/lng instead of address).

The message is a constant per endpoint family and names no internal object. Include the request_id when contacting support.
503
A transient outage: a dependency could not be reached or did not answer in time. This is the 5xx worth retrying — Retry-After says how long, and the same request is expected to succeed afterwards.

Like every other error here, the message names no internal detail.

Every error uses the same envelope; branch on error.code. See Errors.

Ctrl Enter to send

Request

GEThttps://api.tailend.dev/v1/philadelphia/neighborhoods

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

const res = await fetch("https://api.tailend.dev/v1/philadelphia/neighborhoods", {
  headers: { 'X-API-Key': '$TAILEND_API_KEY' },
});
const body = await res.json();
console.log(res.status, body);

import os
import requests

response = requests.get(
    "https://api.tailend.dev/v1/philadelphia/neighborhoods",
    headers={'X-API-Key': os.environ['TAILEND_API_KEY']},
)
response.raise_for_status()
print(response.json())

ResponseSample

Showing sample data. Paste a key to run it live. Get a key

{
  "data": [
    {
      "id": "9a9a9a9a-0000-4000-8000-000000000001",
      "name": "University City",
      "slug": "university-city",
      "aliases": [
        "UCity"
      ],
      "lat": 39.95,
      "lng": -75.2,
      "metro": "philadelphia",
      "live": {
        "listings": 40,
        "events": 30,
        "classes": 5,
        "camps": 2,
        "places": 3
      }
    }
  ],
  "meta": {
    "metro": "example",
    "limit": 1,
    "count": 1,
    "has_more": false
  }
}

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.

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

Missing, unknown or revoked X-API-Key.

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

Two different reasons share this status.

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

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

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

The path exists; the method does not.

{
  "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"
  }
}

A limit was reached.

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

A bug on our side.

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

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

{
  "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"
  }
}

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

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