maxun/README.md

<h3 align="center">
    <div>
        <a href="https://www.maxun.dev/?ref=ghread">
            <img src="https://github.com/user-attachments/assets/82cfc163-7772-41d7-b090-6dbf4d6dd5a1" width="100" />
            <br>
            Maxun
        </a>
    </div>
    Turn Any Website Into A Structured API
</h3>

<p align="center">
The open-source web data platform for real-time web scraping, crawling, search, monitoring 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: 200px; height: 40px; margin-top: 5px;" width="200" height="40"/></a>
</p>

### Sponsors

<table>
<tr>
<td width="20%" align="center" valign="middle">
<a href="https://www.webshare.io/?referral_code=wwhk524ynls2">
  <img src="https://github.com/user-attachments/assets/c3a60969-a8f8-4d2c-acef-22bee80c2484" alt="Webshare" width="240" height="130">
</a>
</td>
<td width="80%" valign="middle">
<a href="https://www.webshare.io/?referral_code=wwhk524ynls2"><strong>Webshare</strong></a> 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. <strong>Free tier:</strong> 10 proxies + 1GB/month · <strong>Discount:</strong> <code>MAXUN20</code> - 20% off your first purchase.
</td>
</tr>

<tr>
<td width="20%" align="center" valign="middle">
<a href="https://byteful.com/?utm_source=github&utm_medium=github-sponsor&utm_campaign=maxun_github_sponsorship">
  <img src="https://github.com/user-attachments/assets/f3f7ea4a-a965-4ff9-aab6-8d257da3b18c" alt="Byteful" width="280" height="130">
</a>
</td>
<td width="80%" valign="middle">
<a href="https://byteful.com/?utm_source=github&utm_medium=github-sponsor&utm_campaign=maxun_github_sponsorship"><strong>Byteful</strong></a> is a UK-based web data infrastructure platform providing ethically sourced residential, mobile, static residential (ISP) and datacenter proxies alongside API-first tools for web scraping, data collection, and AI-driven automation, processing tens of billions of requests per month.<strong>Discount:</strong> <code>MAXUN10</code> - Get 10% off Byteful Residential Proxies.
</td>
</tr>

<tr>
<td width="20%" align="center" valign="middle">
<a href="https://www.thordata.com/?ls=github&lk=getmaxun">
  <img src="https://github.com/user-attachments/assets/74ba8f9e-a8a8-4c6a-b06c-cd048a118117" alt="Thordata" width="250" height="130">
</a>
</td>
<td width="80%" valign="middle">
<a href="https://www.thordata.com/?ls=github&lk=getmaxun"><strong>Thordata – Reliable Proxies for Web Scraping & AI Data Collection </strong></a> offers Residential, Mobile, ISP & Datacenter Proxies · 190+ countries with city-level targeting · Sticky and rotating sessions for flexible workflows · Fast, stable proxy infrastructure for developers. <strong>Discount:</strong> <code>MAXUN10</code> - Get 10% off.
</td>
</tr>

<tr>
<td width="20%" align="center" valign="middle">
<a href="https://mangoproxy.com/?utm_source=github&utm_medium=partner&utm_campaign=getmaxun">
  <img src="https://github.com/user-attachments/assets/326b5b8f-6a2c-4aa2-94c8-6a29ae23f2ac" alt="Mango Proxy" width="250" height="130">
</a>
</td>
<td width="80%" valign="middle">
<a href="https://mangoproxy.com/?utm_source=github&utm_medium=partner&utm_campaign=getmaxun"><strong>Mango Proxy</strong></a> offers Residential, ISP, Datacenter, and Mobile Proxies in 200+ countries with HTTP(S)/SOCKS5 support and flexible IP management. <strong>Discount:</strong> <code>MAXUN</code> - 8% off Static ISP Proxies.
</td>
</tr>


<tr>
<td width="20%" align="center" valign="middle">
<a href="https://go.nodemaven.com/maxunGHsept">
  <img src="https://github.com/user-attachments/assets/7269ea9b-83fb-4b70-9a41-0eb2beaabf2a" alt="Nodemaven" width="420" height="130">
</a>
</td>
<td width="80%" valign="middle">
<a href="https://go.nodemaven.com/maxunGHsept"><strong>Nodemaven</strong></a> offers the most efficient proxy provider for Web Scraping and Automation with the Highest Quality IP on the market. Why <a href="https://go.nodemaven.com/maxunGHsept">Nodemaven</a>? · 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! <strong>Discounts:</strong> <code>MAXUN35</code> — 35% off Mobile & Residential · <code>MAXUN40</code> - 40% off ISP (Static)
</td>
</tr>

<tr>
<td width="20%" align="center" valign="middle">
<a href="https://www.testmuai.com/?utm_medium=sponsor&utm_source=maxun">
  <img src="https://github.com/user-attachments/assets/6c96005b-85df-43e0-9b63-96aaca676c11" alt="TestMu AI" width="250" height="130">
</a>
</td>
<td width="80%" valign="middle">
<a href="https://www.testmuai.com/?utm_medium=sponsor&utm_source=maxun"><strong>TestMu AI</strong></a> is the native AI-agentic cloud platform for quality engineering. Test intelligently and ship faster.
</td>
</tr>
</table>

## What Maxun Does

- **[Extract](https://docs.maxun.dev/category/extract)** – Extract structured data from any website by emulating real user behavior.
   * **[Recorder Mode](https://docs.maxun.dev/robot/extract/robot-actions)** – Record browser actions and turn them into reusable extraction robots.
   * **[AI Mode](https://docs.maxun.dev/robot/extract/llm-extraction)** – Describe what you need in natural language and extract it with AI.
- **[Scrape](https://docs.maxun.dev/robot/scrape/scrape-robots)** – Convert full webpages into Markdown, HTML and capture screenshots.
- **[Crawl](https://docs.maxun.dev/robot/crawl/crawl-introduction)** – Crawl entire websites and extract content across pages.
- **[Search](https://docs.maxun.dev/robot/search/search-introduction)** – Search the web and extract results with time-based filters.
- **[Monitoring](https://docs.maxun.dev/robot/monitoring)** – Track websites over time, detect changes, and get notified when they occur.
- **[Document Extraction & Parsing](https://docs.maxun.dev/robot/document)** – Extract and parse structured data from documents.

## How To Use Maxun

- **[Dashboard](https://app.maxun.dev/login)** – Build, run, and manage robots through Maxun's visual interface.
- **[API](https://docs.maxun.dev/category/api-reference)** – Integrate Maxun's scraping and extraction capabilities into your applications.
- **[SDK](https://docs.maxun.dev/category/sdk)** – Use Maxun programmatically for scraping, extraction, automation and more.
- **[CLI](https://docs.maxun.dev/category/cli)** – Create robots, trigger runs, and retrieve data from your terminal.
- **[MCP](https://docs.maxun.dev/category/mcp)** – Connect Maxun to AI agents through the Model Context Protocol.


## 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](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](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)

## 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 to the codebase, 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>