Documentation

Quick Start

Get up and running with SuiteScrape in under 60 seconds.

1

Open the app

https://suitescrape.com/app
2

Queue a URL

POST /api/queue
{ "url": "https://example.com" }
3

Scrape it

POST /api/scrape
{ "id": "your-url-id" }
4

Get formatted output

GET /api/formats/:id?format=markdown

API Reference

GET
/api/data

Returns all queued URLs and scraped content

POST
/api/queue

Add a URL to the scraping queue. Body: { url }

POST
/api/scrape

Scrape a queued URL. Body: { id }

GET
/api/formats/:id

Get formatted output. Query: ?format=raw|summary|markdown|json

DELETE
/api/urls/:id

Remove a URL and its scraped content

Self-host SuiteScrape

# Clone and install
git clone https://github.com/passiveprintlabs/suitescrape
cd suitescrape

# Install all dependencies
npm run install:all

# Start development
npm start

# Frontend: http://localhost:3000
# Backend:  http://localhost:3001