ContextQMD
Back to Maxun

README

README.md

0.0.4610.3 KB
Original Source
<h2 align="center"> <div> <a href="https://www.maxun.dev/?ref=ghread"> 
        Maxun
    </a>
</div>
Turn Any Website Into A Structured API
</h2> <p align="center"> ✨ The unified open-source no-code platform for real-time web scraping, crawling, search and AI data extraction ✨ <p align="center"> <a href="https://app.maxun.dev/?ref=ghread"><b>Go To App</b></a> • <a href="https://docs.maxun.dev/?ref=ghread"><b>Documentation</b></a> • <a href="https://www.maxun.dev/?ref=ghread"><b>Website</b></a> • <a href="https://discord.gg/5GbPjBUkws"><b>Discord</b></a> • <a href="https://www.youtube.com/@MaxunOSS?ref=ghread"><b>Watch Tutorials</b></a>

<a href="https://trendshift.io/repositories/12113" target="_blank"></a>

</p>

Sponsors

<table> <tr> <td width="30%" height="100"> <a href="https://www.ipcook.com/?ref=githubmaxun&utm_source=github&utm_medium=referral&utm_campaign=maxun"> </a> </td> <td width="70%">

<a href="https://www.ipcook.com/?ref=githubmaxun&utm_source=github&utm_medium=referral&utm_campaign=maxun">IPcook</a>

IPcook provides 55M+ real residential IPs across 185+ countries and regions, delivering fast and reliable proxy solutions for web scraping, automation, and data collection. 99.99% uptime, average response times under 0.5s, and 100,000 concurrency at max. Start with a FREE 100MB Trial to experience IPcook’s proxy service.

<b>Discount Code: WELCOME20 - Get 20% off your first purchase.</b>

</td> </tr> <tr> <td width="35%" height="100"> <a href="https://go.nodemaven.com/maxunGHaugust"> </a> </td> <td width="70%">

<a href="https://go.nodemaven.com/maxunGHaugust">Nodemaven</a>

The most efficient proxy provider for Web Scraping and Automation with the Highest Quality IP on the market. Why Nodemaven?

  • ZIP targeting
  • 99.9% uptime
  • IP filtering: all proxies have fraud score <97%
  • No KYC required
  • Unique free tools: Proxy Bandwidth Checker, Meta Tag Checker, IP Lookup and others!

<b>Discount Code: MAXUN35 - 35% off to Mobile and Residential Proxies. MAXUN40 - 40% off to ISP (Static) Proxies.</b>

</td> </tr> <tr> <td width="30%" height="100"> <a href="https://www.novada.com/?github-maxun"> </a> </td> <td width="70%">

<a href="https://www.novada.com/?github-maxun">Novada</a>

Novada provides high-quality residential proxies and a powerful Scraper API for reliable web data collection at scale. Access real residential IPs worldwide, reduce blocks, and collect the data your scraping workflows need.

<b>Discount Code: GitNOVADA - Get 20% off Rotating Residential Proxies and Scraping solutions.</b>

</td> </tr> <tr> <td width="20%" height="100"> <a href="https://www.coreclaw.com/?utm_source=github&utm_medium=cpc&utm_campaign=max&utm_term=&utm_id=max"> </a> </td> <td width="80%">

<a href="https://www.coreclaw.com/?utm_source=github&utm_medium=cpc&utm_campaign=max&utm_term=&utm_id=max">CoreClaw</a>

CoreClaw — Production-ready Web Data APIs for AI agents and developers. Extract structured data from the web and build powerful automation workflows.

</td> </tr> <tr> <td width="30%" height="100"> <a href="https://www.testmuai.com/?utm_medium=sponsor&utm_source=maxun"> </a> </td> <td width="70%">

<a href="https://www.testmuai.com/?utm_medium=sponsor&utm_source=maxun">TestMu AI</a>

TestMu AI is the Native AI-Agentic Cloud Platform to Supercharge Quality Engineering. Test Intelligently and Ship Faster.

</td> </tr> </table>

What is Maxun?

Maxun is an open-source no-code web data platform for turning the web into structured, reliable data. It supports extraction, crawling, scraping, and search — designed to scale from simple use cases to complex, automated workflows.

Ecosystem

  1. Extract – Emulate real user behavior and collect structured data from any website.

    • Recorder Mode – Record your actions as you browse; Maxun turns them into a reusable extraction robot.
    • AI Mode – Describe what you want in natural language and let LLM-powered extraction do the rest.

  2. Scrape – Convert full webpages into clean Markdown or HTML and capture screenshots.

  3. Crawl – Crawl entire websites and extract content from every relevant page, with full control over scope and discovery.

  4. Search – Run automated web searches to discover or scrape results, with support for time-based filters.

  5. SDK – A complete developer toolkit for scraping, extraction, scheduling, and end-to-end data automation.

  6. CLI – Create robots, trigger runs, and retrieve extracted data from your terminal.

How Does It Work?

Maxun robots are automated tools that help you collect data from websites without writing any code. Think of them as your personal web assistants that can navigate websites, extract information, and organize data just like you would manually - but faster and more efficiently.

There are four types of robots, each designed for a different job.

1. Extract

Extract emulates real user behavior and captures structured data.

  • <a href="/robot/extract/robot-actions">Recorder Mode</a> - Record your actions as you browse; Maxun turns them into a reusable extraction robot.

Example: Extract 10 Property Listings from Airbnb

https://github.com/user-attachments/assets/recorder-mode-demo-video

  • <a href="/robot/extract/llm-extraction">AI Mode</a> - Describe what you want in natural language and let LLM-powered extraction do the rest.

Example: Extract Names, Rating & Duration of Top 50 Movies from IMDb

https://github.com/user-attachments/assets/f714e860-58d6-44ed-bbcd-c9374b629384

Learn more <a href="/category/extract">here</a>.

2. Scrape

Scrape converts full webpages into clean Markdown, HTML and can capture screenshots. Ideal for AI workflows, agents, and document processing.

Learn more <a href="https://docs.maxun.dev/robot/scrape/scrape-robots">here</a>.

3. Crawl

Crawl entire websites and extract content from every relevant page, with full control over scope and discovery.

Learn more <a href="https://docs.maxun.dev/robot/crawl/crawl-introduction">here</a>.

Run automated web searches to discover or scrape results, with support for time-based filters.

Learn more <a href="https://docs.maxun.dev/robot/search/search-introduction">here</a>.

Quick Start

Getting Started

The simplest & fastest way to get started is to use the hosted version: https://app.maxun.dev.

Installation

Maxun can run locally with or without Docker

  1. Setup with Docker Compose
  2. Setup without Docker
  3. Environment Variables
  4. SDK

Upgrading & Self Hosting

  1. Self Host Maxun With Docker
  2. Upgrade Maxun With Docker Compose Setup
  3. Upgrade Maxun Without Docker Compose Setup

Features

  • ✨ Extract Data With No-Code – Point and click interface
  • ✨ LLM-Powered Extraction – Describe what you want; use LLMs to scrape structured data
  • ✨ Developer SDK – Programmatic extraction, scheduling, and robot management
  • ✨ Handle Pagination & Scrolling – Automatic navigation
  • ✨ Run Robots On Schedules – Set it and forget it
  • ✨ Turn Websites to APIs – RESTful endpoints from any site
  • ✨ Turn Websites to Spreadsheets – Direct data export to Google Sheets & Airtable
  • ✨ Adapt To Website Layout Changes – Auto-recovery from site updates
  • ✨ Extract Behind Login – Handle authentication seamlessly
  • ✨ Integrations – Connect with your favorite tools
  • ✨ MCP Support – Model Context Protocol integration
  • ✨ LLM-Ready Data – Clean Markdown for AI applications
  • ✨ Self-Hostable – Full control over your infrastructure
  • ✨ Open Source – Transparent and community-driven

Demos

Maxun can be used for various use-cases, including lead generation, market research, content aggregation and more. View demos here: https://www.maxun.dev/usecases

License

<p> This project is licensed under <a href="./LICENSE">AGPLv3</a>. </p>

Project Values

We believe in fair and responsible use of open source. If you rely on this project commercially, please consider contributing back or supporting its development.

Support Us

Star the repository, contribute if you love what we’re building, or sponsor us.

Contributors

Thank you to the combined efforts of everyone who contributes!

<a href="https://github.com/getmaxun/maxun/graphs/contributors"> </a>