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 — опенсорсная no-code платформа для сбора веб-данных, которая превращает любой сайт в структурированные и надёжные данные: она умеет извлекать информацию, обходить сайты (краулинг), делать скрейпинг, поиск и извлечение данных с помощью ИИ.
Это облачный сервис, куда нужно регистрироваться, или я запускаю его сам?Это платформа для самостоятельного размещения (self-hosted): бэкенд на Node.js с веб-интерфейсом на React, который поставляется вместе с настройкой docker-compose, плюс CLI и SDK для программной работы.
Как его запустить?Склонируйте репозиторий и запустите через docker-compose, либо соберите из исходников: npm install, затем npm run build:server и npm run start — это соберёт сервер на TypeScript и запустит его вместе с клиентом на Vite.
Нужно ли уметь программировать, чтобы создать робота для извлечения данных?Нет. В режиме Recorder вы просто ходите по сайту, а Maxun превращает ваши действия в многоразового робота. В режиме AI достаточно простым языком описать, что вам нужно, и он сам выполнит извлечение данных с помощью LLM.
Можно ли спокойно использовать в коммерческих целях?Проект распространяется по лицензии AGPLv3 и бесплатен, но авторы открыто просят коммерческих пользователей внести свой вклад — участвовать в разработке проекта или поддержать его спонсорством.
Может ли он разбирать документы вроде PDF или только живые веб-страницы?Да, может. Для извлечения из документов используются встроенные парсеры PDF, DOCX, XLSX и CSV, а для отсканированных PDF и изображений JPG и PNG — OCR. Результат можно получить в виде чистого Markdown, HTML, списка ссылок или краткого содержания.
Могут ли разработчики управлять им из собственного кода?Да. В экосистему входит SDK, который покрывает скрейпинг, извлечение данных, планировщик задач и сквозную автоматизацию работы с данными, а также CLI для создания роботов, запуска их и получения извлечённых данных прямо из терминала.
Зачем использовать Scrape вместо Extract?Scrape превращает всю страницу целиком в чистый Markdown или HTML и умеет делать скриншоты — это подходит для ИИ-сценариев, агентов и обработки документов. Extract же нацелен на конкретные структурированные поля на странице.
Creator
getmaxun
Size
7.8 MB
Stars
17.9K
Age
2y
Commits · 90 Days