Scraperr---API

Scraperr---API

Docker app from grtgbln's Repository

Overview

A self-hosted web application that allows users to scrape data from web pages by specifying elements via XPath. Users can submit URLs and the corresponding elements to be scraped, and the results will be displayed in a table.
Scraperr Logo

A powerful self-hosted web scraping solution

MongoDB FastAPI Next JS TailwindCSS

πŸ“‹ Overview

Scrape websites without writing a single line of code.

πŸ“š Check out the docs for a comprehensive quickstart guide and detailed information.

Scraperr Main Interface

✨ Key Features

  • XPath-Based Extraction: Precisely target page elements
  • Queue Management: Submit and manage multiple scraping jobs
  • Domain Spidering: Option to scrape all pages within the same domain
  • Custom Headers: Add JSON headers to your scraping requests
  • Media Downloads: Automatically download images, videos, and other media
  • Results Visualization: View scraped data in a structured table format
  • Data Export: Export your results in markdown and csv formats
  • Notifcation Channels: Send completion notifcations, through various channels

πŸš€ Getting Started

Docker

make up

Helm

Refer to the docs for helm deployment: https://scraperr-docs.pages.dev/guides/helm-deployment

βš–οΈ Legal and Ethical Guidelines

When using Scraperr, please remember to:

  1. Respect robots.txt: Always check a website's robots.txt file to verify which pages permit scraping
  2. Terms of Service: Adhere to each website's Terms of Service regarding data extraction
  3. Rate Limiting: Implement reasonable delays between requests to avoid overloading servers

Disclaimer: Scraperr is intended for use only on websites that explicitly permit scraping. The creator accepts no responsibility for misuse of this tool.

πŸ’¬ Join the Community

Get support, report bugs, and chat with other users and contributors.

πŸ‘‰ Join the Scraperr Discord

πŸ“„ License

This project is licensed under the MIT License. See the LICENSE file for details.

πŸ‘ Contributions

Development made easier with the webapp template.

To get started, simply run make build up-dev.

Media gallery

1 / 6

Install Scraperr---API on Unraid in a few clicks.

Find Scraperr---API in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for Scraperr---API Review the template variables and paths Click Install

Download Statistics

40,975
Total Downloads
752
This Month
1,384
Avg / Month

Total Downloads Over Time

Loading chart...

Related apps

Details

Repository
jpyles0524/scraperr_api:latest
Last Updated2025-10-12
First Seen2025-01-21

Runtime arguments

Network
bridge
Privileged
true

Template configuration

API PortPorttcp

Container Port: 8000

Target
8000
Default
8000
Value
8000
Secret KeyVariable

Used to encode authentication tokens, can be a random string

Target
SECRET_KEY
OpenAI API KeyVariable

API key for OpenAI, used for chat functionality

Target
OPENAI_KEY
Media PathPath

Path to store media files

Target
/project/app/media
Value
/mnt/user/appdata/scraperr/media
App DataPath

Path to store application data

Target
/project/app/data
Default
/mnt/user/appdata/scraperr/api_data
Value
/mnt/user/appdata/scraperr/api_data
Log LevelVariable

Log level for the application

Target
LOG_LEVEL
Default
INFO|DEBUG|ERROR
Auth Token AlgorithmVariable

Algorithm used to encode authentication tokens

Target
ALGORITHM
Default
HS256
Value
HS256
Access Token Expiry TimeVariable

Time in minutes before access tokens expire

Target
ACCESS_TOKEN_EXPIRE_MINUTES
Default
600
Value
600
Docker socketPathro

Path to the Docker socket

Target
/var/run/docker.sock
Default
/var/run/docker.sock
Value
/var/run/docker.sock