Quickstart

First extraction in 5 minutes

2 min read

1. Get your API key

Try instantly — visit the Playground for 10 free discoveries with zero setup. No API key required.

For programmatic access — sign in to the dashboard, create an organization, and copy your API key from Settings → API Keys. API access requires a Developer plan or above.

2. Install the SDK

Python

pip install kloakd-sdk

TypeScript / Node.js

npm install kloakd-sdk

Go

go get github.com/kloakd/kloakd-go

Java (Maven)

<dependency>
  <groupId>dev.kloakd</groupId>
  <artifactId>kloakd-sdk</artifactId>
  <version>0.1.0</version>
</dependency>

3. Run the 3-step quickstart (Python)

import os
from kloakd import Kloakd

client = Kloakd(
    api_key=os.environ["KLOAKD_API_KEY"],
    organization_id=os.environ["KLOAKD_ORG_ID"],
)

# Step 1  -  Anti-bot fetch
page = client.evadr.fetch("https://example.com/products")
print(f"Bypassed: {page.anti_bot_bypassed}, tier: {page.tier_used}")

# Step 2  -  Crawl the site (reuse fetch artifact)
crawl = client.webgrph.crawl("https://example.com", artifact_id=page.artifact_id)
print(f"Pages found: {crawl.total_pages}")

# Step 3  -  Extract structured data
data = client.kolektr.page(
    "https://example.com/products",
    artifact_id=page.artifact_id,
)
for record in data.records:
    print(record)

TypeScript equivalent

import { Kloakd } from 'kloakd-sdk';

const client = new Kloakd({
  apiKey: process.env.KLOAKD_API_KEY!,
  organizationId: process.env.KLOAKD_ORG_ID!,
});

const page = await client.evadr.fetch('https://example.com/products');
const crawl = await client.webgrph.crawl('https://example.com', { artifactId: page.artifactId });
const data = await client.kolektr.page('https://example.com/products', { artifactId: page.artifactId });
data.records.forEach(r => console.log(r));

What just happened?

1. Evadr detected and bypassed the anti-bot protection, returning HTML and an artifact_id
2. Webgrph used the artifact to crawl the full site without re-fetching
3. Kolektr used the same artifact to extract structured data - zero redundant requests

This artifact chaining pattern is the core of KLOAKD's efficiency.

Next steps

• Authentication - learn about API keys and org context
• Concepts - understand how modules compose
• Evadr - deeper anti-bot configuration
• Kolektr - extraction schemas and pagination