Maxun SDK

The official Node.js SDK for Maxun - turn any website into an API.

Works with both Maxun Cloud and Maxun Open Source - automatically handles the differences for you.

https://github.com/user-attachments/assets/71a6f10b-5b2a-45dd-9ef7-53d0bcf2b76d

What can you do with Maxun SDK?

• Extract structured data from any website
• Scrape entire pages as Markdown or HTML
• Crawl multiple pages automatically to discover and scrape content
• Perform web searches and extract results as metadata or full content
• Use AI to extract data with natural language prompts
• Capture screenshots (visible area or full page)
• Automate workflows with clicks, form fills, and navigation
• Schedule recurring jobs to keep your data fresh
• Get webhooks when extractions complete
• Handle pagination automatically (scroll, click, load more)

Quick Start

Follow the quick-start guide here: https://docs.maxun.dev/category/node-sdk

Table of Contents

1. Extract

   • LLM Extraction (Beta)
   • Non-LLM Extraction
   • Auto Pagination
   • Auto List Capture

2. Scrape

3. Crawl

4. Search

5. Robot Management

   • Scheduling
   • Webhooks
   • Runs
   • Error Handling
   • Execution History

Examples

Check out the examples directory for complete working examples:

Example	What it does
basic-extraction.ts	Extract fields from a single page
list-pagination.ts	Scrape lists with different pagination strategies
form-fill-screenshot.ts	Fill forms and capture screenshots
chained-extract.ts	Execute multiple capture actions with one robot
simple-scrape.ts	Convert pages to Markdown/HTML/Screenshots
basic-crawl.ts	Crawl multiple pages automatically
llm-extraction.ts	AI-powered extraction with natural language
scheduling.ts	Set up robot schedules to execute runs
webhooks.ts	Configure webhook notifications
robot-management.ts	CRUD operations for robots
complete-workflow.ts	Create a robot combining multiple features