> ## 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.

# Quick start

## Get your API KEY

Copy your API key from the [dashboard](https://dashboard.decodo.com/). Send it in the `Authorization` header as `Bearer YOUR_API_KEY`.

## Start a crawl

Send a `POST` request with the URL you want to crawl. The response returns a `crawl_id`.

<CodeGroup>
  ```shellscript cURL theme={null}
  #replace the TOKEN value with your API KEY
  curl --request 'POST' \
        --url 'https://data.decodo.com/v1/crawl' \
        --header 'Accept: application/json' \
        --header 'Authorization: Bearer TOKEN VALUE' \
        --header 'Content-Type: application/json' \
        --data '
      {
      "url": "https://decodo.com",
      "limit": 2,
      "max_depth": 1,
      "sitemap": "skip"
      }
  '
  ```
</CodeGroup>

You will get a response that contains crawl\_id and crawl status.<br />First response

```shellscript theme={null}
{
    "target": "crawl",
    "url": "https://decodo.com/",
    "created_at": "2026-10-01 04:48:26",
    "crawl_id": "{crawl_id}",
    "status": "pending",
    "crawl_status": "https://data.decodo.com/v1/crawl/{crawl_id}/status",
    "results_tasks": "https://data.decodo.com/v1/crawl/{crawl_id}",
    "results_content": "https://data.decodo.com/v1/crawl/{crawl_id}?type=content"
}
```

## Check the Crawl status

Use the `crawl_status` link from the response to see how far the crawl has progressed.

<CodeGroup>
  ```shellscript cURL theme={null}
  curl --request 'GET' \
        --url 'https://data.decodo.com/v1/crawl/{crawl_id}/status' \
        --header 'Accept: application/json' \
        --header 'Authorization: Bearer YOUR_API_KEY'
  ```

  ```text file name theme={null}
  ```
</CodeGroup>

## Get the results

Use `results_content` to get the scraped page content inline in the response, or `results_tasks` for a list of every crawled URL and its status.

<CodeGroup>
  ```shellscript cURL theme={null}
  curl --request 'GET' \
        --url 'https://data.decodo.com/v1/crawl/{crawl_id}?type=content' \
        --header 'Accept: application/json' \
        --header 'Authorization: Bearer TOKEN VALUE'
  ```

  ```text file name theme={null}
  ```
</CodeGroup>


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