Subway

Browse Subway's global store-URL index

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.

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

Query parameters

shardinteger

Sitemap shard index (default 0). shard_count in the response says how many exist.

pageinteger

1-based page within the shard (default 1)

page_sizeinteger

Entries per page, 1-500 (default 100)

Headers

x-api-keystring required

API key required

Response

OK

codeinteger

Code is the HTTP status code or a custom code used to indicate the result of the request @example 200

msgunknown

Example response

{
  "data": {
    "count": 100,
    "entries": [
      {
        "depth": 4,
        "path": "united-states/ny/new-york/1-penn-plaza"
      }
    ],
    "page": 1,
    "shard_count": 1,
    "total_in_shard": 22706,
    "total_pages": 228
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.