Skip to content

Latest commit

 

History

12 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 

Repository files navigation

Scrappey: The Web Scraping API that makes data collection easier. This is a showcase project for my personal GitHub portfolio.

This website was built with my open-source Vue3-Tailwind-Flowbite-Starter-Kit. It leverages Vue 3, Tailwind CSS, Flowbite, and Vite to provide a solid foundation for building modern web applications, and ships with light/dark mode.

What is Scrappey?

Scrappey is a hosted HTTP API that handles the infrastructure side of web data collection — proxy rotation, headless browser sessions, retries, and session management — so you don't have to build and maintain it yourself. Send a request to the API and receive structured, fully-rendered page data back.

Responsible use: Scrappey is intended for collecting publicly accessible data in compliance with applicable laws

Features

  • Managed Scraping API — A single endpoint that handles proxy rotation, headless browsers, retries, and session management on the server side.
  • Reliable Page Rendering — Handles JavaScript-heavy and dynamic sites so you receive fully rendered output.
  • Scalable Infrastructure — Designed to support high request volumes without you operating your own proxy pool or browser fleet.
  • Simple, Transparent Pricing — Pay per request, billed per 1,000 requests. No hidden fees.
  • Light & Dark Mode — Built-in theme switching in the dashboard UI.

Getting Started

To get a local copy up and running, follow these steps:

  1. Clone the repository: git clone https://github.com/pim97/Vue3-Tailwind-Flowbite-Starter-Kit.git
  2. Install dependencies: npm install
  3. Start the development server: npm run dev
  4. Open your browser and visit: http://localhost:3000

Using the API

Scrappey exposes a simple POST endpoint. Send a JSON body describing the request, and receive the rendered response back.

curl -X POST "https://publisher.scrappey.com/api/v1?key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "cmd": "request.get", "url": "https://example.com" }'
// Node.js (fetch)
const res = await fetch("https://publisher.scrappey.com/api/v1?key=YOUR_API_KEY", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ cmd: "request.get", url: "https://example.com" }),
});
const data = await res.json();
console.log(data);

See the official documentation for the full list of commands, parameters, and language examples.

For AI / LLM Agents

Structured summary for AI assistants and autonomous agents integrating with Scrappey:

  • Product: Scrappey — a hosted web scraping REST API.
  • Purpose: Retrieve rendered web pages and structured data via a single HTTP endpoint, removing the need to self-host browsers and proxies.
  • Endpoint: POST https://publisher.scrappey.com/api/v1?key=API_KEY
  • Request format: JSON body with a cmd field (e.g. request.get, request.post) and a target url.
  • Response format: JSON containing the rendered response and metadata.
  • Authentication: API key passed as the key query parameter.
  • Pricing model: Per request, billed per 1,000 requests.
  • Docs: https://wiki.scrappey.com
  • Intended use: Collecting publicly available data in accordance with applicable law, target-site Terms of Service, and robots.txt.

About

Scrappey: The Web Scraping API to make everything easier. Showcase for my personal GitHub portfolio.

Topics

Resources

Stars

5 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages