Official SDKs for Node and Python.

// Section 01 · Node.js

crawlux-sdk on npm.

The Node SDK targets Node 18+ and ships as ESM with CommonJS fallback. TypeScript types are bundled. The package is crawlux-sdk on npm.

npm install crawlux-sdk
# or
yarn add crawlux-sdk
pnpm add crawlux-sdk

Trigger an audit and wait for completion.

import { Crawlux } from "crawlux-sdk";

const crawlux = new Crawlux({ apiKey: process.env.CRAWLUX_API_KEY });

// Trigger an audit and wait for completion (max 10 minutes)
const audit = await crawlux.audits.run({
  domain: "example-protocol.io",
  tier: "team",
  waitForCompletion: true
});

console.log(audit.score.overall);  // 67
console.log(audit.findings.length); // 23

Trigger and poll separately.

const { audit_id } = await crawlux.audits.trigger({
  domain: "example-protocol.io"
});

let audit = await crawlux.audits.get(audit_id);
while (audit.status === "running") {
  await new Promise(r => setTimeout(r, 5000));
  audit = await crawlux.audits.get(audit_id);
}

Verify webhook signatures.

import { verifyWebhookSignature } from "crawlux-sdk";

app.post("/webhooks/crawlux", (req, res) => {
  const valid = verifyWebhookSignature({
    rawBody: req.rawBody,
    signature: req.headers["x-crawlux-signature"],
    secret: process.env.CRAWLUX_WEBHOOK_SECRET
  });
  if (!valid) return res.status(401).send("invalid signature");
  queue.add("process", req.body);
  res.status(200).send("ok");
});

// Section 02 · Python

crawlux on PyPI.

The Python SDK targets Python 3.10+ and ships with full type hints (compatible with mypy and pyright). Async variant available via crawlux.aio. Package name: crawlux on PyPI.

pip install crawlux
# or
poetry add crawlux
uv add crawlux

Trigger an audit and wait for completion.

import os
from crawlux import Crawlux

client = Crawlux(api_key=os.environ["CRAWLUX_API_KEY"])

# Trigger an audit and wait for completion
audit = client.audits.run(
    domain="example-protocol.io",
    tier="team",
    wait_for_completion=True
)

print(audit.score.overall)  # 67
print(len(audit.findings))  # 23

Async variant.

import asyncio
from crawlux.aio import Crawlux

async def main():
    client = Crawlux(api_key=os.environ["CRAWLUX_API_KEY"])
    domains = ["a.io", "b.io", "c.io"]
    audits = await asyncio.gather(*[
        client.audits.run(domain=d, wait_for_completion=True)
        for d in domains
    ])
    return audits

asyncio.run(main())

// Section 03 · Common patterns shipped with both SDKs

Helpers beyond the raw REST surface.

• Polling helpers. waitForCompletion / wait_for_completion abstracts the poll-until-done pattern with built-in exponential backoff and timeout.
• Webhook signature verification. verifyWebhookSignature / verify_webhook_signature handles the HMAC-SHA256 check with constant-time comparison to prevent timing attacks.
• Batch triggers. audits.runBatch / audits.run_batch triggers up to 50 audits in parallel with built-in rate-limit-aware throttling.
• Typed findings. The SDKs expose typed enums for analyzer codes, severity levels, group IDs and site categories. IDE autocomplete works for finding.analyzer == AnalyzerCode.B01 rather than string magic.
• Automatic retries. 5xx responses are retried up to 3 times with exponential backoff. 429 responses respect the X-RateLimit-Reset header.

// Section 04 · Community SDKs

Other languages.

Community SDKs in other languages (Go, Rust, Ruby, PHP, Java, C#) are welcome and will be linked from this page once they reach stable release. Crawlux does not officially maintain community SDKs but provides API stability commitments documented in the REST API reference that make third-party SDK development tractable.

If you build a community SDK, email [email protected] with the repository URL and we will list it here.

// Related docs

Where to go from here.

• REST API reference — the underlying endpoint surface
• Authentication — Bearer token format
• Webhooks reference — signature verification context
• Error reference — error response shapes