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

# Parameters

Request parameters for Crawl API: limits, path filters, sitemap, domain scope, output formats, geo and webhook delivery

## POST endpoint

`https://data.decodo.com/v1/crawl`

## Input parameters

<table>
  <colgroup>
    <col width="163" />

    <col width="100" />

    <col width="485" />
  </colgroup>

  <thead>
    <tr>
      <th>Parameter</th>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>`url`</td>
      <td>string</td>
      <td>The URL to start crawling from.</td>
    </tr>

    <tr>
      <td>`limit`</td>
      <td>integer</td>
      <td>Maximum number of pages to scrape. Maximum value is `10000`.</td>
    </tr>

    <tr>
      <td>`max_depth`</td>
      <td>integer</td>
      <td>Maximum number of link hops from the starting URL. Pages at this depth are scraped, but their links aren't followed.</td>
    </tr>

    <tr>
      <td>`JS_retry`</td>
      <td>boolean</td>
      <td>when set to `true`, pages that failed to successfully scrape are retried with JavaScript rendering</td>
    </tr>

    <tr>
      <td>`sitemap`</td>
      <td>string</td>
      <td>Possible values:`include, only, skip.` <ul><li>`include` - collect URLs from both the sitemap and page links.</li><li>`only` - crawl only URLs listed in the sitemap.</li><li>`skip` - ignore the sitemap and follow page links only.</li></ul> Default value is `include`</td>
    </tr>

    <tr>
      <td>`select_paths`</td>
      <td>array</td>
      <td>Only URLs whose path matches at least one pattern are crawled. Example: `blog`</td>
    </tr>

    <tr>
      <td>`exclude_paths`</td>
      <td>array</td>
      <td>URLs whose path matches any pattern are skipped.  Example: `case-studies`</td>
    </tr>

    <tr>
      <td>`domain_filter`</td>

      <td />

      <td />
    </tr>

    <tr>
      <td>`geo`</td>
      <td>string</td>
      <td>Set the country to use when submitting the query. Example: `United States`</td>
    </tr>

    <tr>
      <td>`locale`</td>
      <td>string</td>
      <td>This will change the search page web interface language (not the results). <br />Example: – en-US – en-GB</td>
    </tr>

    <tr>
      <td>webhook</td>

      <td />

      <td />
    </tr>
  </tbody>
</table>

## Output

Starting a crawl returns its `crawl_id` immediately, along with links to its status and results. Use it to check status, fetch results, or cancel.


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