---
title: "List a site's urls"
method: POST
path: "/web/v1/map"
tags: ["Web Tools"]
---

# List a site's urls

`POST /web/v1/map`

## Request

- Base URL: `https://api.oassis.dev`
- URL: `https://api.oassis.dev/web/v1/map`
- Auth: one of:
  - HTTP bearer
  - none

Every url of a site: its sitemap, plus the links on the page itself. HTTP supports the same Bearer API key and shared credits as MCP, or an independent x402 wallet payment.

## Request body

- object
  - `url` string, uri, required: Page to process.
  - `limit` integer: Urls to return. Up to 5000.
  - `includePage` boolean: Render the page too, to catch urls the sitemap does not list. `false` uses no browser at all, so it costs less: $0.002 against $0.003.
  - `search` string: Keep only urls containing this text.
  - `includeSubdomains` boolean: Treat subdomains of the same site as part of it.
  - `includePaths` string[]: Keep only urls whose path contains one of these. Up to twenty.
  - `excludePaths` string[]: Discard urls whose path contains one of these. Up to twenty. It wins over `includePaths`.

## Response `200`

The result.

## Other responses

- `400`: Invalid request; nothing is executed.
- `401`: Invalid or revoked API key.
- `402`: Insufficient account credits, or x402 payment required. The wallet challenge travels in PAYMENT-REQUIRED; a 402 is not a payment or an execution.
- `503`: Operation temporarily unavailable.

---

[API](https://skmtc.dev/oassis/apis/oassis-web-scraping-crawling-and-browser-control-for-ai-agen.md) · [All operations](https://skmtc.dev/oassis/apis/oassis-web-scraping-crawling-and-browser-control-for-ai-agen/llms.txt) · [OpenAPI document](https://skmtc.dev/oassis/apis/oassis-web-scraping-crawling-and-browser-control-for-ai-agen/revisions/dedc2b717b91?raw)