Subway API endpoint
Use Crawlora's Subway Sitemap API to extract supported public Subway data as structured JSON. This page includes request parameters, cURL examples, response schema, error behavior, credit cost, and a Playground link for testing before integration.
/subway/sitemapReturns 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, and it is the entry point Subway's own robots.txt declares. 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. Developers commonly use this endpoint for data enrichment, monitoring, research dashboards, internal automation, and agent-native workflows that need repeatable structured public web data. Authentication uses the documented Crawlora headers, and usage is metered with the credit cost shown on this page.
Request parameters are generated from the active endpoint catalog. Required values must be sent before Crawlora can call the upstream public web data source.
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| shard | integer | No | Sitemap shard index (default 0). shard_count in the response says how many exist. | ||
| page | integer | No | 1-based page within the shard (default 1) | ||
| page_size | integer | No | Entries per page, 1-500 (default 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"
Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
This endpoint is executed through Crawlora's managed scraping infrastructure.
Crawlora does not silently return bad data when the upstream page cannot be used.
| Status | Common failure case |
|---|---|
| 400 | Invalid input or missing required parameter |
| 429 | Plan or endpoint rate limit exceeded |
| 500 | Internal execution error |
| 502 | Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved |
When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.
| 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 |
{
"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" |
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"Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.
Read Crawlora terms