maxun README

The project's README from github.com/getmaxun/maxun. As one markdown file: README.md.


Maxun
Turn Any Website Into A Structured API

✨ The unified open-source no-code platform for real-time web scraping, crawling, search and AI data extraction ✨

Go To App • Documentation • Website • Discord • Watch Tutorials

getmaxun%2Fmaxun | Trendshift

Sponsors

Webshare Webshare
Webshare gives you instant access to a proxy pool of 80M+ ethically-sourced IPs across 195+ countries, with rotating residential, static ISP, and datacenter options plus a full API. It includes a 100+ Gbps backbone, country/city/state/ZIP/ASN-level targeting, and requires no credit card to start.
Free tier: 10 proxies + 1GB/month · Discount: MAXUN20 - Get 20% off your first purchase.
Mango Proxy Mango Proxy
MangoProxy offers Residential, ISP, Datacenter, and Mobile Proxies in 200+ countries with HTTP(S)/SOCKS5 support and flexible IP management.
Discount: MAXUN - 8% off Static ISP Proxies.
Nodemaven Nodemaven
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!
Discounts: MAXUN35 — 35% off Mobile & Residential · MAXUN40 — 40% off ISP (Static)
TestMu AI TestMu AI
The native AI-agentic cloud platform for quality engineering. Test intelligently and ship faster.

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.

  7. Document Extraction & Parsing – Extract structured data from documents (PDF, DOCX, XLSX, and CSV) using native parsers and images (Scanned PDF, JPG, and PNG) with OCR, or convert them into clean Markdown, HTML, links, or a summary.

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 five types of robots, each designed for a different job.

1. Extract

Extract emulates real user behavior and captures structured data.

Example: Extract 10 Property Listings from Airbnb

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

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

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

Learn more here.

2. Scrape

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

Learn more here.

3. Crawl

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

Learn more here.

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

Learn more here.

5. Document Extraction & Parsing

Upload a document or image — PDF, DOCX, XLSX, CSV, JPG, or PNG — and Maxun reads the text out of it, using OCR for scanned pages and photos. Convert it into clean Markdown, HTML, a list of links, or a summary, or use AI-powered extraction to pull specific structured fields.

Use cases: digitize scanned receipts and invoices, pull fields from a photo of a paper form, turn a screenshot of a table into structured data, or convert a scanned document into clean Markdown for an AI workflow.

Learn more here.

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

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

This project is licensed under AGPLv3.

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!

maxun (getmaxun/maxun)

Searching Database…

17.9K ·GitHub
这是什么东西?Maxun 是一个开源的无代码网页数据平台,能把任意网站变成结构化、可靠的数据:它支持数据提取、爬取、抓取、搜索,以及基于 AI 的数据提取。
它是需要注册使用的托管服务,还是我自己部署运行的?它是自托管平台:后端是 Node.js,前端是 React 网页界面,附带 docker-compose 部署方案,另外还提供 CLI 和 SDK,方便用代码调用。
我怎么把它跑起来?克隆仓库后用 docker-compose 启动,或者从源码运行:先 npm install,再 npm run build:server 和 npm run start —— 这样会构建 TypeScript 服务端,并把它和 Vite 客户端一起跑起来。
创建提取机器人需要会写代码吗?不需要。在录制模式(Recorder Mode)下,你只要正常浏览网页,Maxun 就会把你的操作变成可复用的机器人;AI 模式则接收一段大白话描述,自动帮你完成由大语言模型驱动的数据提取。
商用放心吗?项目采用 AGPLv3 许可证,可以免费使用,不过作者明确希望商业用户通过给项目贡献代码或赞助开发的方式回馈社区。
它能解析 PDF 之类的文档吗,还是只能处理在线网页?可以。文档提取对 PDF、DOCX、XLSX 和 CSV 使用原生解析器,对扫描版 PDF 以及 JPG、PNG 图片则用 OCR 识别。结果可以输出为干净的 Markdown、HTML、链接或摘要。
开发者能在自己的代码里调用它吗?可以。它的生态包含一个 SDK,覆盖抓取、提取、定时调度和端到端数据自动化;还有 CLI,可以在终端里创建机器人、触发运行并取回提取的数据。
什么情况下用 Scrape 而不是 Extract?Scrape 会把整个网页转成干净的 Markdown 或 HTML,还能截取屏幕截图,适合 AI 工作流、智能体和文档处理;Extract 则针对页面上特定的结构化字段进行提取。
Creator
getmaxun
Size
7.8 MB
Stars
17.9K
Age
2y
Commits · 90 Days