# firecrawl.web.map

URLs, titles and descriptions on a website, from its URL

> Map multiple URLs based on options

Page: https://telipot.com/catalog/tasks/firecrawl.web.map · Markdown: https://telipot.com/catalog/tasks/firecrawl.web.map/md · JSON: https://telipot.com/catalog/tasks/firecrawl.web.map/json

| Field | Value |
| --- | --- |
| provider | [Firecrawl](https://telipot.com/catalog/providers/firecrawl) `firecrawl` |
| capability | [`web.map`](https://telipot.com/catalog/capabilities/web.map) |
| kind | data |
| tier | core |
| price | $0.0038 / call (1 credit · docs) |
| price note | 1 credit per call, however many URLs come back; a limit of 100000 still costs 1 credit. |
| identity | Your plan |
| auth | `bearer · Authorization: Bearer` |
| scope | any_account |
| principal | organization |
| required_scopes | none |
| retention | standard |
| route | `POST https://api.firecrawl.dev/v2/map` |
| verification | Not verified yet. Not checked yet. We test with a real request before we mark it. |
| status | live |
| docs | https://docs.firecrawl.dev/api-reference/endpoint/map |

## Preview the price · nothing runs

```bash
telipot run firecrawl.web.map \
  --input-json '{"url":"https://example.com","limit":1}' \
  --quote
```

## Run it

```bash
telipot run firecrawl.web.map \
  --input-json '{"url":"https://example.com","limit":1}'
```

```bash
curl https://api.telipot.com/v1/tasks/firecrawl.web.map/run \
  -H "Authorization: Bearer $TELIPOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","limit":1}'
```

## Input

| Field | In | Type | Required | Constraints | Note |
| --- | --- | --- | --- | --- | --- |
| `url` | body | string | yes |  | The base URL to start from |
| `search` | body | string | no |  | Orders the results by relevance to this query, such as blog for URLs that contain blog |
| `limit` | body | integer | no | at most 100000; default 5000 | Maximum number of links to return |
| `sitemap` | body | string | no | one of "skip", "include", "only"; default "include" | include uses the sitemap together with other methods; only returns just URLs in the sitemap; skip ignores it |
| `includeSubdomains` | body | boolean | no | default true | Include subdomains of the website |

## Input schema

```json
{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "The base URL to start from",
      "examples": [
        "https://example.com"
      ]
    },
    "search": {
      "type": "string",
      "description": "Orders the results by relevance to this query, such as blog for URLs that contain blog",
      "examples": [
        "blog"
      ]
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of links to return",
      "default": 5000,
      "maximum": 100000
    },
    "sitemap": {
      "type": "string",
      "description": "include uses the sitemap together with other methods; only returns just URLs in the sitemap; skip ignores it",
      "enum": [
        "skip",
        "include",
        "only"
      ],
      "default": "include"
    },
    "includeSubdomains": {
      "type": "boolean",
      "description": "Include subdomains of the website",
      "default": true
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}
```

## Output schema

```json
{
  "type": "object",
  "required": [
    "success",
    "links"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "url"
        ],
        "properties": {
          "url": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        }
      }
    }
  }
}
```