---
title: "Map a website's URLs"
method: POST
path: "/v1/data/web/map"
tags: ["Web: Map"]
---

# Map a website's URLs

`POST /v1/data/web/map`

## Request

- Base URL: `https://api.superagnt.com`
- URL: `https://api.superagnt.com/v1/data/web/map`
- Auth: API key in header `Authorization`

Returns a list of URLs found on a website, quickly. Useful for discovering the structure of a site before scraping specific pages. Optionally order results by relevance to a `search` term.

## Request body

- object
  - `url` string, uri, required: The base URL of the site to map.
  - `search` string: Order returned URLs by relevance to this query.
  - `sitemap` 'skip' | 'include' | 'only': How to use the site's sitemap. Default 'include'.
  - `includeSubdomains` boolean: Include URLs on subdomains.
  - `ignoreQueryParameters` boolean: Treat URLs that differ only by query string as the same URL.
  - `limit` integer: Maximum number of URLs to return. Default 5000, max 100000.
  - `timeout` integer: Request timeout in milliseconds.
  - `location` object: Geographic proxy location and language settings.
    - `country` string: ISO 3166-1 alpha-2 country code.
    - `languages` string[]

## Response `200`

The list of URLs discovered on the site.

- object

## Other responses

- `400`: Bad request — missing `url` or invalid parameter.
- `401`: Unauthorized.
- `402`: Insufficient balance.
- `429`: Too many requests.
- `5XX`: Upstream error.

---

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