Skip to content

Commit ef3523b

Browse files
VinciGit00claude
andauthored
docs(readme): add Open Source vs Managed API comparison (#1091)
Add a comparison table and guidance clarifying the difference between the open-source library and the managed cloud API (Python/JS SDKs), so users can pick the right option. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 037a42e commit ef3523b

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,33 @@ You can find more informations at the following [link](https://scrapegraphai.com
5050
- **Low-code Frameworks**: [Pipedream](https://pipedream.com/apps/scrapegraphai), [Bubble](https://bubble.io/plugin/scrapegraphai-1745408893195x213542371433906180), [Zapier](https://zapier.com/apps/scrapegraphai/integrations), [n8n](http://localhost:5001/dashboard), [Dify](https://dify.ai), [Toolhouse](https://app.toolhouse.ai/mcp-servers/scrapegraph_smartscraper)
5151
- **MCP server**: [Link](https://smithery.ai/server/@ScrapeGraphAI/scrapegraph-mcp)
5252

53+
## 🆚 Open Source vs Managed API
54+
55+
ScrapeGraphAI comes in two flavours: **this open-source library**, which you run yourself, and the **managed cloud API** (used via the [Python](https://github.com/ScrapeGraphAI/scrapegraph-py) and [JS/TS](https://github.com/ScrapeGraphAI/scrapegraph-js) SDKs). This table explains the difference so you can pick the right one.
56+
57+
| | Open Source (`scrapegraphai`) | Managed API (`scrapegraph-py` / `scrapegraph-js`) |
58+
|---|---|---|
59+
| **What it is** | A Python library you run yourself | A hosted cloud service you call via SDK |
60+
| **Where it runs** | Your own infrastructure (self-hosted) | ScrapeGraphAI cloud |
61+
| **LLM** | Bring your own (OpenAI, Groq, Gemini, Azure, local via Ollama) | Managed for you |
62+
| **Browser / JS rendering** | You configure it (Playwright) | Managed (stealth, `auto`/`fast`/`js` modes) |
63+
| **Proxies & anti-bot** | Your responsibility | Included |
64+
| **Scaling & maintenance** | Your responsibility | Fully managed |
65+
| **Cost model** | LLM tokens + your own infra | Pay-as-you-go credits |
66+
| **Auth** | Your own LLM keys | `SGAI_API_KEY` |
67+
| **Capabilities** | Graph pipelines (SmartScraper, Search, Speech, ScriptCreator…) | Scrape, Extract, Search, Crawl, Monitor, History |
68+
| **Setup effort** | More configuration | Minimal — API key + one call |
69+
| **License** | MIT | SDK is MIT; the API service is paid |
70+
71+
**Choose the open-source library** if you want full control, on-prem/self-hosted data, local LLMs (Ollama), or fine-grained cost tuning — and you're happy to manage browsers, proxies and scaling yourself.
72+
73+
**Choose the managed API** if you want zero infrastructure, managed JS rendering & anti-bot, built-in **Crawl** and scheduled **Monitor** jobs, and the fastest path to production — billed per credit.
74+
75+
- Open-source library: https://github.com/ScrapeGraphAI/Scrapegraph-ai
76+
- Python SDK: https://github.com/ScrapeGraphAI/scrapegraph-py
77+
- JS/TS SDK: https://github.com/ScrapeGraphAI/scrapegraph-js
78+
- API docs: https://docs.scrapegraphai.com/introduction
79+
5380
## 🚀 Quick install
5481

5582
The reference page for Scrapegraph-ai is available on the official page of PyPI: [pypi](https://pypi.org/project/scrapegraphai/).

0 commit comments

Comments
 (0)