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

# Firecrawl Map: Inputs, Cost & CLI Example

> Discovering URLs on a website without scraping content. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=firecrawl_map:{"url":"{{url}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                            | Type                            | Required | Default | Description                                    |
| ------------------------------- | ------------------------------- | -------- | ------- | ---------------------------------------------- |
| `payload.url`                   | `string`                        | Yes      |         | URL to map                                     |
| `payload.search`                | `string`                        | No       |         | Search term to filter URLs                     |
| `payload.sitemap`               | `"skip" \| "include" \| "only"` | No       |         | Sitemap handling (default "include")           |
| `payload.includeSubdomains`     | `boolean`                       | No       |         | Include subdomain URLs                         |
| `payload.limit`                 | `integer`                       | No       |         | Max URLs to return (default 5000, max 100000)  |
| `payload.ignoreQueryParameters` | `boolean`                       | No       |         | Ignore query parameters in URLs (default true) |
| `payload.ignoreCache`           | `boolean`                       | No       |         | Ignore cached results (default false)          |
| `payload.timeout`               | `integer`                       | No       |         | Request timeout in ms                          |
| `payload.location`              | `object`                        | No       |         | Geographic location settings                   |

### Allowed values

| Field             | Allowed values            |
| ----------------- | ------------------------- |
| `payload.sitemap` | `skip`, `include`, `only` |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Discover URLs on a website without scraping content.",
    "properties": {
      "url": {
        "type": "string",
        "description": "URL to map"
      },
      "search": {
        "type": "string",
        "description": "Search term to filter URLs"
      },
      "sitemap": {
        "type": "string",
        "description": "Sitemap handling (default \"include\")",
        "enum": [
          "skip",
          "include",
          "only"
        ]
      },
      "includeSubdomains": {
        "type": "boolean",
        "description": "Include subdomain URLs"
      },
      "limit": {
        "type": "integer",
        "description": "Max URLs to return (default 5000, max 100000)"
      },
      "ignoreQueryParameters": {
        "type": "boolean",
        "description": "Ignore query parameters in URLs (default true)"
      },
      "ignoreCache": {
        "type": "boolean",
        "description": "Ignore cached results (default false)"
      },
      "timeout": {
        "type": "integer",
        "description": "Request timeout in ms"
      },
      "location": {
        "type": "object",
        "description": "Geographic location settings",
        "properties": {
          "country": {
            "type": "string",
            "description": "Country code (e.g. \"US\")"
          },
          "languages": {
            "type": "array",
            "description": "Language codes",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      }
    },
    "required": [
      "url"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `result.meta` | `record` | No       |         | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Discovered URLs on the site.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "links": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "url": {
                  "type": "string"
                },
                "title": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                }
              },
              "required": [
                "url"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "links"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute firecrawl_map --payload '{
  "url": "string"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Provider API Context

<details>
  <summary>Show provider reference (optional)</summary>

  ````md theme={null}
  ```
  ```
  ````
</details>

## Cost

* Pricing model: `per_result` (per result).
* Estimated Deepline credits: `0.02` per pricing unit.
* Billing mode: `post_deduct`.