Skip to main content
POST
/
crawl
Start an asynchronous crawl
curl --request POST \
  --url https://api.beecrawl.dev/crawl \
  --header 'Content-Type: application/json' \
  --header 'X-Web-Extract-Api-Key: <api-key>' \
  --data '
{
  "url": "<string>",
  "limit": 100,
  "maxDepth": 2,
  "includeSubdomains": false,
  "ignoreQueryParameters": true,
  "timeout_seconds": 30,
  "waitFor": 0,
  "useBrowser": "auto",
  "maxRetries": 2
}
'
import requests

url = "https://api.beecrawl.dev/crawl"

payload = {
"url": "<string>",
"limit": 100,
"maxDepth": 2,
"includeSubdomains": False,
"ignoreQueryParameters": True,
"timeout_seconds": 30,
"waitFor": 0,
"useBrowser": "auto",
"maxRetries": 2
}
headers = {
"X-Web-Extract-Api-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-Web-Extract-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
limit: 100,
maxDepth: 2,
includeSubdomains: false,
ignoreQueryParameters: true,
timeout_seconds: 30,
waitFor: 0,
useBrowser: 'auto',
maxRetries: 2
})
};

fetch('https://api.beecrawl.dev/crawl', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.beecrawl.dev/crawl",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'limit' => 100,
'maxDepth' => 2,
'includeSubdomains' => false,
'ignoreQueryParameters' => true,
'timeout_seconds' => 30,
'waitFor' => 0,
'useBrowser' => 'auto',
'maxRetries' => 2
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Web-Extract-Api-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.beecrawl.dev/crawl"

payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"limit\": 100,\n \"maxDepth\": 2,\n \"includeSubdomains\": false,\n \"ignoreQueryParameters\": true,\n \"timeout_seconds\": 30,\n \"waitFor\": 0,\n \"useBrowser\": \"auto\",\n \"maxRetries\": 2\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-Web-Extract-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.beecrawl.dev/crawl")
.header("X-Web-Extract-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"limit\": 100,\n \"maxDepth\": 2,\n \"includeSubdomains\": false,\n \"ignoreQueryParameters\": true,\n \"timeout_seconds\": 30,\n \"waitFor\": 0,\n \"useBrowser\": \"auto\",\n \"maxRetries\": 2\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.beecrawl.dev/crawl")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Web-Extract-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"limit\": 100,\n \"maxDepth\": 2,\n \"includeSubdomains\": false,\n \"ignoreQueryParameters\": true,\n \"timeout_seconds\": 30,\n \"waitFor\": 0,\n \"useBrowser\": \"auto\",\n \"maxRetries\": 2\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "url": "<string>",
  "status": "<string>"
}
{}

Authorizations

X-Web-Extract-Api-Key
string
header
required

API key. X-Api-Key and Bearer authentication are also accepted.

Body

application/json
url
string<uri>
required
limit
integer
default:100
maxDepth
integer
default:2
includeSubdomains
boolean
default:false
ignoreQueryParameters
boolean
default:true
timeout_seconds
integer
default:30
waitFor
integer
default:0
useBrowser
enum<string>
default:auto
Available options:
never,
auto,
always
maxRetries
integer
default:2

Response

Crawl job created.

id
string
url
string<uri>
status
string