---
title: "Browse Subway's global store-URL index"
method: GET
path: "/subway/sitemap"
tags: ["Subway"]
---

# Browse Subway's global store-URL index

`GET /subway/sitemap`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/subway/sitemap`
- Auth: API key in header `x-api-key`

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.

## Query parameters

- `shard` integer
- `page` integer
- `page_size` integer

## Headers

- `x-api-key` string, required

## Response `200`

OK

- SubwaySitemapResponseDoc
  - `code` integer: Code is the HTTP status code or a custom code used to indicate the result of the request @example 200
  - `data` SubwaySitemapResponse
    - `count` integer
    - `entries` SubwaySitemapEntry[]
      - `depth` integer: 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.
      - `path` string: Path is the locator path, the value /subway/store takes.
      - `url` string
    - `fetched_at` string
    - `page` integer
    - `shard` integer
    - `shard_count` integer
    - `source_url` string
    - `total_in_shard` integer
    - `total_pages` integer
  - `msg` unknown

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `429`: Too Many Requests
- `503`: Service Unavailable

---

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