@import url('https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@300..700&display=swap');
body {
  font-family: 'Space Grotesk', sans-serif;
}

.dark p {
  color: white;
}

.ring-transparent {
  transition: 0.5s ease-in-out;
}

.ring-transparent:hover {
  box-shadow: 1px 1px 21px -1px rgba(49, 57, 219, 0.64);
  -webkit-box-shadow: 1px 1px 21px -1px rgba(49, 57, 219, 0.64);
  -moz-box-shadow: 1px 1px 21px -1px rgba(49, 57, 219, 0.64);
}

:is(.dark .dark\:bg-codeblock\/50) {
  filter: brightness();
}

:is(.dark .dark\:bg-codeblock\/50) svg {
  filter: brightness(10);
}

:is(.dark .dark\:bg-codeblock\/50):hover {
  filter: brightness(10);
}

:is(.dark .dark\:text-primary-light) {
  color: #1bd0ef;
}

.text-primary {
  color: #1bd0ef;
}

.dark\:bg-primary-light\/10:is(.dark *) {
  background-color: #13353a;
}

.border-primary-light\/30 {
  border-color: #1bd0ef;
}

.bg-primary-dark {
  background-color: #1bd0ef;
}

.bg-primary {
  background-color: #1bd0ef;
}

.dark\:bg-primary-light:is(.dark *) {
  background-color: #1bd0ef;
}

.prose:is(.dark *) {
  color: white;
}

.prose {
  color: black;
}

:not(pre) > code:is(.dark *) {
  background: transparent;
  border-width: 0;
}

:not(pre) > code {
  background: transparent;
  border-width: 0;
}


Quickstart

Welcome to the MrScraper Documentation!

Explore the powerful scrapers for various platforms.

Introduction

Starter Kit

Step-by-step guide to generate an API token for accessing the MrScraper API.

How to Get Your API Token

Step-by-step guide to integrate our Scrapers to another external API using webhooks

How to Setup Webhooks

Step-by-step guide to using the MrScraper Chrome extension for easier CSS Selector selection.

How to Use Selector Helper Extension

Example section for showcasing API endpoints

Manual Scraper

AI Chat

Example of using AI Scraper to extract data from an e-commerce website.

E-commerce

Example of using AI Scraper to extract data from a real estate website.

Real Estate

Example of using AI Scraper to extract data from a social media website.

Social Media

Example of using Job Board API to extract a job serch platform data.

Job Search Platform

Gathering leads information from the world's fastest-moving social network, X (formerly Twitter).

Gather Leads

Extract search results for leads information from Google.

Automate marketplace data collection to keep track of listings from Facebook.

Scrape Facebook Marketplace

Extract PDF documents from the Internet with AI Vision.

Run PDF Scraper

Scrape property listings from Realestate.com.au website easily and quickly.

Run Realestate.com.au Scraper

Scrape product from shopee website easily and quickly.

Run Shopee Scraper Syncronously

This endpoint allows you to get basic information from your account such as token usage and other stats.

Account summary

This endpoint allows you to get a scraping result.

Get a result

This endpoint allows you to get a scraping HTML result.

Get a HTML result

This endpoint allows you to delete a scraping result.

Delete a result

This endpoint returns the information about the latest result for a scraper.

You can use the optional `status` body parameter to filter the result for a particular scraping status.

Get a scraper's latest result

This endpoint allows you to get a list of all your scraping results.

List all results

This endpoint allows you to get a list of all your scrapers.

List all scrapers

This endpoint allows you to get a single scraper's information.

Get a scraper

This endpoint allows you to tell a scraper to start a scraping.

Run a scraper

This endpoint allows you to delete a scraping run and its results.

Delete a scraping run

This endpoint returns the information about the latest scraping run for a scraper.

You can use the optional `status` body parameter to filter the result for a particular scraping run status.

Get a scraper's latest scraping run

This endpoint allows you to get a scraping run details. If the status is succeeded, the scraped data will be appeared in the API response.

Get a scraping run details

This endpoint allows you to get a scraping run details HTML. If the status is succeeded, the scraped HTML will be appeared in the API response.

Get a scraping run details HTML

This endpoint allows you to list all scraping runs.

List all scraping runs

This endpoint allows you to run a new ai scraper.

Run a AI scraper

This endpoint allows you to create and run a leads generator scraper for X (Twitter) based on keywords and sentiment type.

Create and run a leads generator scraper for X (Twitter) platform

This endpoint allows you to create and run a leads generator scraper for Google based on URL / keywords.

Create and run a leads generator scraper for Google platform

This endpoint allows you to run a job board scraper. You can give 1 or more URLs and it will return some data you specify in the request body from those URLs.

Run the job board scraper

This endpoint allows you to create and run a Facebook Marketplace scraper to scrape the listings available in Facebook Marketplace.

Create and run a Facebook Marketplace scraper

This endpoint allows you to create and run a PDF scraper.

Create and run a PDF scraper

This endpoint allows you to create and run a Realestate.com.au scraper.

Create and run a Realestate.com.au scraper

This endpoint allows you to scrape a shopee scraper.

Documentation

Quickstart

Introduction

Welcome to the MrScraper Documentation!

Quickstart

Manual Scraper

AI Scraper

Google Scraper

X Scraper

Job Board Scraper

PDF Scraper

Realestate.com.au Scraper

Documentation

Quickstart

​Welcome to the MrScraper Documentation!

​Quickstart

Manual Scraper

AI Scraper

Google Scraper

X Scraper

Job Board Scraper

PDF Scraper

Realestate.com.au Scraper

Welcome to the MrScraper Documentation!

Quickstart