POST
/
web
/
crawl
import { Supadata } from '@supadata/js';

const supadata = new Supadata({
apiKey: 'YOUR_API_KEY',
});

// Start a crawl job
const crawl = await supadata.web.crawl({
url: 'https://example.com',
limit: 10,
});

// Get crawl job results
// This automatically handles pagination and returns all pages
const crawlResults = await supadata.web.getCrawlResults(crawl.jobId);
console.log(crawlResults);
{
  "jobId": "123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

x-api-key
string
header
required

Body

application/json
url
string<uri>
required

URL of the website to crawl

Example:

"https://supadata.ai"

limit
number
default:100

Maximum number of pages to crawl

Required range: 1 <= x <= 5000
Example:

100

Response

Successfully started crawl job

jobId
string
required

The ID of the job

Example:

"123e4567-e89b-12d3-a456-426614174000"