> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.beatapi.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.beatapi.io/_mcp/server.

# Map a website

POST https://api.beatapi.io/v1/web/map
Content-Type: application/json

Synchronously lists the URLs of one website by following its links from a
starting page, optionally only the paths that match `select_paths`. Use it to
find the right pages inside a site, then read them with `POST /v1/web/read`
instead of guessing URLs with search. Billed per URL returned, so a call that
finds none costs nothing. Prices are in the
[billing section](https://docs.beatapi.io/web-search#billing).

Unknown request fields and path expressions that do not compile are rejected
with `400`. The same operation is the `data:web.map` capability of
`POST /v1/capabilities/run` and the `web_map` tool of the BeatAPI MCP endpoint.


Reference: https://docs.beatapi.io/api-reference/core/web-search/map-website

## Authentication

- `Authorization` header (bearer token, required) — Send your API key as `Authorization: Bearer <BEATAPI_API_KEY>`.

## Request

### Headers

- `Idempotency-Key` (string, optional)

### Body (application/json)

This endpoint expects a WebMapRequest.

- `url` (string, required) — The page to start from. It must be a public `http` or `https` URL without a user name or password, and not `localhost` or a private-network IP address.
- `limit` (integer, optional, default: 50) — At most this many URLs are returned. Each URL returned is billed.
- `max_depth` (integer, optional, default: 1) — How many links away from the starting page to follow.
- `include_external` (boolean, optional, default: false) — Also list links that leave the site.
- `select_paths` (list of string, optional) — Regular expressions over the URL path, such as `/docs/.*`. Only matching URLs are listed. An expression that does not compile is rejected with `400`.
- `exclude_paths` (list of string, optional) — Regular expressions over the URL path. Matching URLs are left out.

## Response

### 200

The URLs found from the starting page.

- `object` (enum, required)
  - Allowed values: `web.map`
- `request_id` (string, required) — Quote it in support requests.
- `url` (string, required) — The starting page.
- `urls` (list of string, required) — URLs found from the starting page, without duplicates and at most `limit`.
- `note` (string, optional) — Present only when urls is empty, saying what to try next (an empty map is not charged).
- `usage` (WebCallUsage, optional) — What this call was charged, in US dollars. The same object a social-data call answers with.

## Errors

### 400 Bad Request Error

Malformed JSON or a field, value or combination this endpoint does not accept (`bad_request`; the message names the field), or input refused by moderation (`content_policy_violation`). Not retryable unchanged.

- `error` (ErrorError, required) — Structured BeatAPI error. Use `code` (or `retryable`) for program logic and retain `request_id` for support.

### 401 Unauthorized Error

No API key (`missing_api_key`), or a key that is wrong, expired, disabled or exhausted (`invalid_api_key`; the message says which). Send it as `Authorization: Bearer <key>`; the key works with or without the `sk-` prefix. Not retryable.

- `error` (ErrorError, required) — Structured BeatAPI error. Use `code` (or `retryable`) for program logic and retain `request_id` for support.

### 402 Payment Required Error

Insufficient balance (`insufficient_credits`). The account balance is zero or below the price of this request. Top up, then send it again; not retryable before that.

- `error` (ErrorError, required) — Structured BeatAPI error. Use `code` (or `retryable`) for program logic and retain `request_id` for support.

### 403 Forbidden Error

The key or account is not permitted to make this call (`forbidden`), for example a model that is not available on free credit (a top-up unlocks it), a request from outside the key's IP allowlist, or a model outside the key's group. Not retryable.

- `error` (ErrorError, required) — Structured BeatAPI error. Use `code` (or `retryable`) for program logic and retain `request_id` for support.

### 409 Conflict Error

The `Idempotency-Key` was already used with a different request body, or the first request with it is still being processed (`idempotency_conflict`). Not retryable unchanged.

- `error` (ErrorError, required) — Structured BeatAPI error. Use `code` (or `retryable`) for program logic and retain `request_id` for support.

### 429 Too Many Requests Error

Too many requests (`rate_limit_exceeded`, including the free-model limits) or too many tasks processing at once (`user_concurrency_exceeded`). Retryable after `Retry-After` seconds (also `error.retry_after_seconds`).

- `error` (ErrorError, required) — Structured BeatAPI error. Use `code` (or `retryable`) for program logic and retain `request_id` for support.

### 500 Internal Server Error

Unexpected internal error (`internal_error`). Retryable; keep `request_id` for support if it persists.

- `error` (ErrorError, required) — Structured BeatAPI error. Use `code` (or `retryable`) for program logic and retain `request_id` for support.

### 503 Service Unavailable Error

The request could not be completed (`processing_unavailable`, `processing_timeout`, `processing_failed` or `result_transfer_failed`). Nothing was charged. Retryable with backoff; `Retry-After` is sent when the wait is known. BeatAPI does not answer 502 or 504.

- `error` (ErrorError, required) — Structured BeatAPI error. Use `code` (or `retryable`) for program logic and retain `request_id` for support.

## Types

### WebCallUsage

What this call was charged, in US dollars. The same object a social-data call answers with.

- `billing_unit` (enum, required) — request for search and research; page for read (pages read) and map (URLs returned).
  - Allowed values: `request`, `page`
- `quantity` (integer, required) — How many units the reply shows were billed.
- `price_usd` (string, required) — The settled charge for this call
- `price_version` (string, required) — Fingerprint of the price this call was charged at.

### ErrorError

Structured BeatAPI error. Use `code` (or `retryable`) for program logic and retain `request_id` for support.

- `code` (enum, required) — Stable machine-readable error code. `unauthorized` is the deprecated name for a 401; since 2026-09-29 a 401 is `missing_api_key` or `invalid_api_key`. Treat a legacy `unauthorized` like `invalid_api_key`.
  - Allowed values: `bad_request`, `missing_api_key`, `invalid_api_key`, `unauthorized`, `forbidden`, `not_found`, `insufficient_credits`, `idempotency_conflict`, `user_concurrency_exceeded`, `rate_limit_exceeded`, `content_policy_violation`, `processing_unavailable`, `processing_failed`, `processing_timeout`, `result_transfer_failed`, `invalid_signature`, `realtime_disabled`, `realtime_capacity_unavailable`, `realtime_session_expired`, `origin_not_allowed`, `invalid_client_secret`, `transport_not_allowed`, `internal_error`
- `message` (string, required) — English sentence that states the cause; for `bad_request` it names the field. Written for people and logs, not for parsing.
- `retryable` (boolean, required) — Whether making the same call again could succeed. Present on every error; branch on it instead of the status code. True for 429, 500 and 503 (rate_limit_exceeded, user_concurrency_exceeded, internal_error, processing_unavailable, processing_timeout, processing_failed, result_transfer_failed, realtime_capacity_unavailable). False for a request, key or balance that must change first (bad_request, content_policy_violation, missing_api_key, invalid_api_key, insufficient_credits, forbidden, not_found, idempotency_conflict, realtime_disabled and the other realtime credential codes).
- `request_id` (string, required) — Correlation ID to retain for BeatAPI support.
- `retry_after_seconds` (integer, optional) — Seconds to wait before retrying. Present on every 429, and on a 503 when the wait is known; the same value is sent in the `Retry-After` header.
- `docs` (string, optional) — The public Skill page that says what to do about an error. Present on errors answered by the capability endpoints (`/v1/capabilities/search`, `/v1/capabilities/inspect`, `/v1/capabilities/run`); absent on every other endpoint.

## Examples

**Request**

```json
{
  "url": "https://spec.openapis.org",
  "limit": 20,
  "select_paths": [
    "/oas/.*"
  ]
}
```

**Response**

```json
{
  "object": "web.map",
  "request_id": "task_xxx",
  "url": "https://spec.openapis.org",
  "urls": [
    "https://spec.openapis.org/oas/v3.1.0",
    "https://spec.openapis.org/oas/v3.0.3"
  ]
}
```

**SDK Code**

```python Web Search_mapWebsite_example
import requests

url = "https://api.beatapi.io/v1/web/map"

payload = {
    "url": "https://spec.openapis.org",
    "limit": 20,
    "select_paths": ["/oas/.*"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Web Search_mapWebsite_example
const url = 'https://api.beatapi.io/v1/web/map';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"url":"https://spec.openapis.org","limit":20,"select_paths":["/oas/.*"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Web Search_mapWebsite_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.beatapi.io/v1/web/map"

	payload := strings.NewReader("{\n  \"url\": \"https://spec.openapis.org\",\n  \"limit\": 20,\n  \"select_paths\": [\n    \"/oas/.*\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Web Search_mapWebsite_example
require 'uri'
require 'net/http'

url = URI("https://api.beatapi.io/v1/web/map")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://spec.openapis.org\",\n  \"limit\": 20,\n  \"select_paths\": [\n    \"/oas/.*\"\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java Web Search_mapWebsite_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.beatapi.io/v1/web/map")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://spec.openapis.org\",\n  \"limit\": 20,\n  \"select_paths\": [\n    \"/oas/.*\"\n  ]\n}")
  .asString();
```

```php Web Search_mapWebsite_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.beatapi.io/v1/web/map', [
  'body' => '{
  "url": "https://spec.openapis.org",
  "limit": 20,
  "select_paths": [
    "/oas/.*"
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Web Search_mapWebsite_example
using RestSharp;

var client = new RestClient("https://api.beatapi.io/v1/web/map");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"url\": \"https://spec.openapis.org\",\n  \"limit\": 20,\n  \"select_paths\": [\n    \"/oas/.*\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Web Search_mapWebsite_example
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "url": "https://spec.openapis.org",
  "limit": 20,
  "select_paths": ["/oas/.*"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.beatapi.io/v1/web/map")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```