Skip to main content

Get Started

Maxun Cloud

That’s it! Most users create their first robot in about a minute.

Maxun SDK

The Maxun SDK lets you create robots programmatically for scraping websites and extracting structured data.

Installation

npm install maxun-sdk

Requirements

Environment Variables

MAXUN_API_KEY=your-api-key

# For LLM Extraction (optional)
ANTHROPIC_API_KEY=your-anthropic-key
OPENAI_API_KEY=your-openai-key

Initialization

import { Extract, Scrape, Crawl, Search } from 'maxun-sdk';

// For Extract
const extractor = new Extract({
apiKey: process.env.MAXUN_API_KEY
});

// For Scrape
const scraper = new Scrape({
apiKey: process.env.MAXUN_API_KEY
});

// For Crawl
const crawler = new Crawl({
apiKey: process.env.MAXUN_API_KEY
});

// For Search
const searcher = new Search({
apiKey: process.env.MAXUN_API_KEY
});

Running Robots

const result = await robot.run();
console.log(result.data);

Learn how to use the SDK in detail here.