> ## Documentation Index
> Fetch the complete documentation index at: https://docs.supadata.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Map

> Scan a whole website and get URLs on it. Can be used to create a sitemap or run a crawler to fetch content of all pages of a destination.

## Request

<CodeGroup>
  ```js Node theme={null}
  import {
    Supadata,
    SiteMap
  } from '@supadata/js';

  // Initialize the client
  const supadata = new Supadata({
    apiKey: 'YOUR_API_KEY',
  });

  const siteMap: SiteMap = await supadata.web.map('https://supadata.ai');

  ```

  ```python Python theme={null}
  from supadata import Supadata, SupadataError

  # Initialize the client
  supadata = Supadata(api_key="YOUR_API_KEY")

  site_map = supadata.web.map("https://supadata.ai")
  print(f"Found {len(site_map.urls)} URLs")
  ```

  ```bash cURL theme={null}
  curl 'https://api.supadata.ai/v1/web/map?url=https://example.com' \
  -H 'x-api-key: YOUR_API_KEY'
  ```
</CodeGroup>

## Parameters

| Parameter | Type | Required | Description |
| - | - | - | - |
| url | string | Yes | URL of the website to map |

## Response Format

```json theme={null}
{
  "urls": [
    "string" // List of URLs found on the webpage
  ]
}
```

## Pricing

* 1 map request = 1 credit


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.