Subway API endpoint
Returns one page of Subway's sitemap-declared store index -- 22,700+ URLs across 2 shards at time of writing, covering a country/region/city/street tree worldwide. This is the cheapest way to enumerate Subway locations. Each entry carries its URL, the locator path GET /subway/store takes, and a depth: the deepest entries are store pages, shallower ones are country, region and city directory pages listed in the same sitemap. A page past the end returns an empty list rather than an error, so a caller can walk to exhaustion.
/subway/sitemapQuery parameters:
shard (optional, default 0) — sitemap shard index. shard_count in the response says how many exist.page (optional, default 1) — 1-based page within the shard.page_size (optional, default 100, max 500) — entries per page.Response includes shard, shard_count, entries[], count, total_in_shard, page, total_pages, source_url, and fetched_at. Each entry has url, path (the value /api/v1/subway/store takes), and depth.
| Field | Filled in, of 40 checked | Values in the sample |
|---|---|---|
| url | 40 | restaurants.subway.com |
| path | 40 | “austria” and 39 other values |
| depth | 40 | 1 to 5, median 3 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| shard | integer | No | Sitemap shard index (default 0). shard_count in the response says how many exist. | 0 | |
| page | integer | No | 1-based page within the shard (default 1) | 1 | |
| page_size | integer | No | Entries per page, 1-500 (default 100) | 100 | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/subway/sitemap?page=1" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"shard": 0,
"shard_count": 2,
"entries": [
{
"url": "https://restaurants.subway.com/austria/bu/eisenstadt",
"path": "austria/bu/eisenstadt",
"depth": 3
}
],
"count": 1,
"total_in_shard": 22705,
"page": 1,
"total_pages": 227,
"source_url": "https://restaurants.subway.com/sitemap.xml.0",
"fetched_at": "2026-08-31T17:30:00Z"
}
}Request schema
No body schema
Response schema
#/definitions/subway.sitemapResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | Code is the HTTP status code or a custom code used to indicate the result of the request @example 200 | |||
| data | subway.SitemapResponse | No | ||||
| data.count | integer | No | 100 | |||
| data.entries | array | No | ||||
| data.entries[].depth | integer | No | 4 | Depth is how many path segments the entry has. A store page is the deepest level; shallower entries are country/region/city directory pages that are also listed in the same sitemap. | ||
| data.entries[].path | string | No | united-states/ny/new-york/1-penn-plaza | Path is the locator path, the value /subway/store takes. | ||
| data.entries[].url | string | No | ||||
| data.fetched_at | string | No | ||||
| data.page | integer | No | 1 | |||
| data.shard | integer | No | 0 | |||
| data.shard_count | integer | No | 1 | |||
| data.source_url | string | No | ||||
| data.total_in_shard | integer | No | 22706 | |||
| data.total_pages | integer | No | 228 | |||
| msg | unknown | No | Msg is the message that describes the result of the request @example "Request successful" |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 404 | Not Found | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/subway/sitemap?page=1" \
-H "x-api-key: $CRAWLORA_API_KEY"