POST/crawl/start

Start Recursive Crawl

Start a multi-page crawl job with sitemap discovery and configurable depth/page limits. Returns job_id. 1 credit per page.

Bytemine·Dynamic pricing

Dynamic pricing

0.03 * (get(body, 'max_pages', 0) > 0 ? get(body, 'max_pages', 0) : 50)

Example code

// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";

const orthogonal = new Orthogonal({
  apiKey: process.env.ORTHOGONAL_API_KEY,
});

const output = await orthogonal.run({
  api: "bytemine",
  path: "/crawl/start",
  body: {
    "url": "example"
  }
});

console.log(output);

Body parameters

urlrequired

string

Website URL to crawl

max_depth

integer

Maximum crawl depth (default 3)

max_pages

integer

Maximum pages to crawl (default 50)

Response

job_id

string

status

string

success

boolean

pages_found

number

pages_crawled

number