# maxun

**Repository Path**: mirrors/maxun

## Basic Information

- **Project Name**: maxun
- **Description**: Maxun 是一个无需代码的 Web 数据抓取平台
- **Primary Language**: TypeScript
- **License**: AGPL-3.0
- **Default Branch**: develop
- **Homepage**: https://www.oschina.net/p/maxun
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 2
- **Created**: 2025-04-09
- **Last Updated**: 2026-02-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h2 align="center">
    <div>
        <a href="https://www.maxun.dev/?ref=ghread">
            <img src="/src/assets/maxunlogo.png" width="70" />
            <br>
            Maxun
        </a>
    </div>
    Turn Any Website Into A Structured API
<br>
</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>
    <br />
    <br />
<a href="https://trendshift.io/repositories/12113" target="_blank"><img src="https://trendshift.io/api/badge/repositories/12113" alt="getmaxun%2Fmaxun | Trendshift" style="width: 250px; height: 55px; margin-top: 10px;" width="250" height="55"/></a>
</p>

## 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](https://docs.maxun.dev/category/extract)** – Emulate real user behavior and collect structured data from any website.
   * **[Recorder Mode](https://docs.maxun.dev/robot/extract/robot-actions)** - Record your actions as you browse; Maxun turns them into a reusable extraction robot.
   * **[AI Mode](https://docs.maxun.dev/robot/extract/llm-extraction)** - Describe what you want in natural language and let LLM-powered extraction do the rest.

2. **[Scrape](https://docs.maxun.dev/robot/scrape/scrape-robots)** – Convert full webpages into clean Markdown or HTML and capture screenshots.
3. **[Crawl](https://docs.maxun.dev/robot/crawl/crawl-introduction)** - Crawl entire websites and extract content from every relevant page, with full control over scope and discovery.
4. **[Search](https://docs.maxun.dev/robot/search/search-introduction)** - Run automated web searches to discover or scrape results, with support for time-based filters.
5. **[SDK](https://docs.maxun.dev/sdk/sdk-overview)** – A complete developer toolkit for scraping, extraction, scheduling, and end-to-end data automation.

## 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](https://github.com/user-attachments/assets/c6baa75f-b950-482c-8d26-8a8b6c5382c3)
- <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>.

### 4. Search
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. You can self-host if you prefer!

### Installation
Maxun can run locally with or without Docker
1. [Setup with Docker Compose](https://docs.maxun.dev/installation/docker)
2. [Setup without Docker](https://docs.maxun.dev/installation/local)
3. [Environment Variables](https://docs.maxun.dev/installation/environment_variables)
4. [SDK](https://github.com/getmaxun/node-sdk)

### Upgrading & Self Hosting
1. [Self Host Maxun With Docker & Portainer](https://docs.maxun.dev/self-host)
2. [Upgrade Maxun With Docker Compose Setup](https://docs.maxun.dev/installation/upgrade#upgrading-with-docker-compose)
3. [Upgrade Maxun Without Docker Compose Setup](https://docs.maxun.dev/installation/upgrade#upgrading-with-local-setup)

## Sponsors
<table>
  <tr>
  <td width="229">
      <br/>
      <a href="https://www.testmu.ai/?utm_source=maxun&utm_medium=sponsor" target="_blank">
        <img src="https://github.com/user-attachments/assets/6c96005b-85df-43e0-9b63-96aaca676c11" /><br/><br/>
        <b>TestMu AI</b>
      </a>
      <br/>
      <sub>The Native AI-Agentic Cloud Platform to Supercharge Quality Engineering. Test Intelligently and Ship Faster.
      </sub>
    </td>
  </tr>
</table>

## 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

## Note
This project is in early stages of development. Your feedback is very important for us - we're actively working on improvements. </a>

## 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](https://github.com/sponsors/amhsirak). 

## Contributors
Thank you to the combined efforts of everyone who contributes!

<a href="https://github.com/getmaxun/maxun/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=getmaxun/maxun" />
</a>