Mr. Scraper

https://docs.mrscraper.com/
Admin
Mr. Scraper is a powerful AI-powered and manual scraping platform designed to automate and simplify...
Tokens:139,726
Snippets:958
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Quick Start Example

Source: https://docs.mrscraper.com/docs/integrations/node

Demonstrates fetching raw HTML and creating an AI scraper using the SDK.

```javascript
import {
  fetchHtml,
  createAiScraper,
  MrScraperError,
} from "@mrscraper/sdk";

try {
  // 1. Fetch raw HTML from a URL
  const html = await fetchHtml({
    url: "https://example.com",
  });
  console.log(html);

  // 2. Create an AI scraper (listing agent)
  const scraper = await createAiScraper({
    url: "https://example.com/products",
    message: "Extract all product names and prices",
    agent: "listing",
  });
  console.log(scraper);
  
} catch (err) {
  if (err instanceof MrScraperError) {
    console.error(`[${err.status ?? "network"}] ${err.message}`);
  } else {
    throw err;
  }
}
```

--------------------------------

### Install Dependencies

Source: https://docs.mrscraper.com/docs/residential-proxy/examples/nodejs

Required packages for the provided Node.js proxy examples.

```bash
npm install axios cheerio puppeteer
```

--------------------------------

### Install and Verify CLI

Source: https://docs.mrscraper.com/docs/getting-started/cli

Install the CLI globally via npm and verify the installation.

```bash
npm install -g @mrscraper/cli
mrscraper --help
```

--------------------------------

### Install Prerequisites

Source: https://docs.mrscraper.com/docs/integrations/langchain

Install the necessary LangGraph and LangChain OpenAI packages.

```bash
pip install langgraph langchain-openai
```

--------------------------------

### Install HTTParty Gem

Source: https://docs.mrscraper.com/docs/residential-proxy/examples/ruby

Required dependency for the HTTParty examples.

```bash
gem install httparty
```

--------------------------------

### Custom Session Duration Example

Source: https://docs.mrscraper.com/docs/residential-proxy/configuration/authentication

Example of a 30-minute session configuration.

```text
# Session lasts 30 minutes
user123-country-jp-sessid-x9-sesstime-30:pass456@proxy.mrscraper.com:10000
```

--------------------------------

### Install MrScraper SDK

Source: https://docs.mrscraper.com/docs/integrations/python

Use pip to install the package from PyPI.

```bash
pip install mrscraper-sdk
```

--------------------------------

### 404 Not Found Error Example

Source: https://docs.mrscraper.com/docs/api/error-handling

Example response when a requested entity does not exist.

```json
{
  "message": "Resource not found",
  "error": "Not Found"
}
```

--------------------------------

### Session-Based Static Proxy Example

Source: https://docs.mrscraper.com/docs/residential-proxy/configuration/authentication

Example of a static session ID configuration.

```text
# Session ID: alpha1
user123-country-us-sessid-alpha1:pass456@proxy.mrscraper.com:10000
```

--------------------------------

### Install CLI from Source

Source: https://docs.mrscraper.com/docs/getting-started/cli

Clone the repository and run the CLI directly from the source code.

```bash
git clone https://github.com/mrscraper-com/cli.git
cd cli
npm install
node bin/mrscraper.js --help
```

--------------------------------

### Initialize MrScraper

Source: https://docs.mrscraper.com/docs/getting-started/cli

Perform first-time setup with a welcome message.

```bash
mrscraper init
```

--------------------------------

### Install Dependencies

Source: https://docs.mrscraper.com/docs/residential-proxy/examples/python

Required packages for using the proxy with requests and BeautifulSoup.

```bash
pip install requests beautifulsoup4
```

--------------------------------

### Install SDK

Source: https://docs.mrscraper.com/docs/integrations/node

Use npm to install the official MrScraper SDK package.

```bash
npm install @mrscraper/sdk
```

--------------------------------

### Example Proxy Authentication String

Source: https://docs.mrscraper.com/docs/residential-proxy/configuration/country-codes

A concrete example of a proxy username configured for the United States.

```text
user123-country-us:pass456@proxy.mrscraper.com:10000
```

--------------------------------

### Install langchain-mrscraper

Source: https://docs.mrscraper.com/docs/integrations/langchain

Install the package and its dependencies using pip.

```bash
pip install -U langchain-mrscraper
```

--------------------------------

### Static Proxy Implementation

Source: https://docs.mrscraper.com/docs/residential-proxy/configuration/proxy-types

Example of using a static proxy with a 30-minute session duration in Python.

```python
import requests

# Static proxy with 30-minute session
proxy = {
    'http': 'http://user-country-us-sessid-stable1-sesstime-30:pass@proxy.mrscraper.com:10000',
    'https': 'http://user-country-us-sessid-stable1-sesstime-30:pass@proxy.mrscraper.com:10000'
}

# All requests use the same IP
for i in range(10):
    response = requests.get('https://api.ipify.org', proxies=proxy)
    print(f"Request {i+1}: {response.text}")  # Same IP every time
```

--------------------------------

### API Response Examples

Source: https://docs.mrscraper.com/docs/api/v3/analytic/proxy

Examples of successful and error response bodies returned by the bandwidth endpoint.

```json
[
  {
    "username": "john",
    "total_bandwidth_usage": 99.384
  },
  {
    "username": "jane",
    "total_bandwidth_usage": 31.022
  }
]
```

```json
{
  "message": "startDate is required and must be in `yyyy-MM-dd HH:mm:ss` format",
  "error": "Bad Request",
  "statusCode": 400
}
```

```json
{
  "message": "Unauthorized access",
  "error": "Unauthorized"
}
```

--------------------------------

### Listing Agent JSON Output Example

Source: https://docs.mrscraper.com/docs/features/ai-scraper/listing

Example of the structured JSON output generated by the Listing Agent, showing data extracted across multiple pages.

```json
{
    "response": [
        {
        "page_num": 0,
        "data": {
            "mode": "direct",
            "data": [
            {
                "id": "74301965",
                "address": "80 Emerald Street, Manchester, NH 03103",
                "agent_company": "Listing provided by PrimeMLS",
                "price": "$364,900",
                "bedrooms": "3",
                "bathrooms": "2",
                "sqft": "1",
                "status": "Active",
                "url": "https://www.zillow.com/homedetails/80-Emerald-St-Manchester-NH-03103/74301965_zpid/",
                "highlight": "14 hours ago"
            },
            {
                "id": "121734329",
                "address": "21 School Street, New Portland, ME 04961",
                "agent_company": "KELLER WILLIAMS REALTY",
                "price": "$449,000",
                "bedrooms": "2",
                "bathrooms": "1",
                "sqft": "1",
                "status": "Active",
                "url": "https://www.zillow.com/homedetails/21-School-St-New-Portland-ME-04961/121734329_zpid/",
                "highlight": "18 hours ago"
            },
            ...
            ]
        }
        },
        {
        "page_num": 1,
        "data": {
            "mode": "direct",
            "data": [
            {
                "id": "458007902",
                "address": "Lot 59&60 Starks Road, New Sharon, ME 04955",
                "agent_company": "COLDWELL BANKER SANDY RIVER REALTY",
                "price": "$420,000",
                "bedrooms": null,
                "bathrooms": null,
                "sqft": "92 acres lot",
                "status": "Active",
                "url": "https://www.zillow.com/homedetails/LOT-5960-Starks-Rd-New-Sharon-ME-04955/458007902_zpid/",
                "highlight": "Open fields"
            },
            {
                "id": "91905999",
                "address": "3 Long Cove Road, York, ME 03909",
                "agent_company": "LEGACY PROPERTIES SOTHEBY'S INTERNATIONAL REALTY",
                "price": "$1,795,000",
                "bedrooms": "3",
                "bathrooms": "2",
                "sqft": "2",
                "status": "Active",
                "url": "https://www.zillow.com/homedetails/3-Long-Cove-Rd-York-ME-03909/91905999_zpid/",
                "highlight": "Modern comforts"
            }
            ...
            ],
            "link": "https://www.zillow.com/me/?searchQueryState=%7B%22isMapVisible%22%3Atrue..."
        }
        }
    ]
}
```

--------------------------------

### Bulk scraping response examples

Source: https://docs.mrscraper.com/docs/guides/programmatically

Example JSON responses for running and finished bulk scraping tasks.

```json
{
  "message": "Successful operation!",
  "data": {
    "id": "YOUR_BULK_RESULT_ID",
    "status": "Running",
    "data": null
  }
}
```

```json
{
  "message": "Successful operation!",
  "data": {
    "createdAt": "2026-01-18T08:38:23.993Z",
    "id": "YOUR_BULK_RESULT_ID",
    "userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "scraperId": "YOUR_DETAIL_SCRAPER_ID",
    "type": "Bulk-AI",
    "status": "Finished",
    "tokenUsage": 12,
    "data": {
      "mergedData": [
        {
          "title": "A Light in the Attic",
          "price": "£51.77",
          "availability": "In stock (22 available)",
          "description": "It's hard to imagine a world without A Light in the Attic...",
          "product_type": "Books",
          "upc": "a897fe39b1053632",
          "price_excl_tax": "£51.77",
          "price_incl_tax": "£51.77",
          "tax": "£0.00",
          "number_of_reviews": "0"
        },
        {
          "title": "Tipping the Velvet",
          "price": "£53.74",
          "availability": "In stock (20 available)",
          "description": "Erotic and absorbing...Written with starling power...",
          "product_type": "Books",
          "upc": "90fa61229261140a",
          "price_excl_tax": "£53.74",
          "price_incl_tax": "£53.74",
          "tax": "£0.00",
          "number_of_reviews": "0"
        },
        {
          "title": "Soumission",
          "price": "£50.10",
          "availability": "In stock (20 available)",
          "description": "Dans une France assez proche de la nôtre...",
          "product_type": "Books",
          "upc": "6957f44c3847a760",
          "price_excl_tax": "£50.10",
          "price_incl_tax": "£50.10",
          "tax": "£0.00",
          "number_of_reviews": "0"
        }
      ],
      "urlDetails": [
        {
          "url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html",
          "status": "Finished",
          "error": ""
        },
        {
          "url": "https://books.toscrape.com/catalogue/tipping-the-velvet_999/index.html",
          "status": "Finished",
          "error": ""
        },
        {
          "url": "https://books.toscrape.com/catalogue/soumission_998/index.html",
          "status": "Finished",
          "error": ""
        }
      ],
      "summary": {
        "totalUrls": 3,
        "successfulUrls": 3,
        "failedUrls": 0,
        "totalTokenUsage": 12
      }
    }
  }
}
```

--------------------------------

### 403 Forbidden Error Example

Source: https://docs.mrscraper.com/docs/api/error-handling

Example response when the token lacks permission for the requested resource.

```json
{
  "message": "You do not have permission to access this resource",
  "error": "Forbidden"
}
```

--------------------------------

### Install and use MrScraper CLI

Source: https://docs.mrscraper.com/docs/getting-started/cli

Global installation and basic usage for scraping a webpage with AI prompts.

```bash
# 1. Install globally
npm install -g @mrscraper/cli

# 2. Login
mrscraper login

# 3. Scrape a webpage
mrscraper scrape "https://www.ebay.com/itm/266727555514" \
  --prompt "get name, price, features/description, images, seller, and shipping"
```

--------------------------------

### Default Proxy cURL Example

Source: https://docs.mrscraper.com/docs/residential-proxy/configuration/authentication

A basic cURL command demonstrating the default proxy authentication.

```bash
curl -x "user123:pass456@proxy.mrscraper.com:10000" https://api.ipify.org
```

--------------------------------

### View Manual Scraper Output with Cookies

Source: https://docs.mrscraper.com/docs/features/manual-scraper

Example JSON structure showing the inclusion of a cookies field when the Get Cookies option is enabled.

```json
{
  "books_data": [
    {
      "title": "A Light in the Attic",
      "rating": "Three"
    }
  ],
  "cookies": []
}
```

--------------------------------

### Initialize Individual Tools

Source: https://docs.mrscraper.com/docs/integrations/langchain

Directly instantiate specific tools using their respective constructor classes.

```python
from langchain_mrscraper.tools import MrScraperFetchHtmlTool

fetch_html = MrScraperFetchHtmlTool(token="MRSCRAPER_API_TOKEN")
```

--------------------------------

### Complete Programmatic Workflow

Source: https://docs.mrscraper.com/docs/guides/programmatically

An end-to-end example demonstrating the full scraping lifecycle from URL collection to result retrieval.

```javascript
(async () => {
  console.log("🚀 Starting N2N Programmatic Workflow\n");
  console.log("=".repeat(60));
  
  // Step 1: Verify token
  if (!await step1VerifyToken()) {
    process.exit(1);
  }
  
  // Step 2: Collect URLs
  const url = "https://books.toscrape.com";
  const { urls: initialUrls, scraperId: urlScraperId } = await step2CollectUrls(
    url,
    "Return array of urls that follow patterns https://books.toscrape.com/catalogue but exclude that has patterns https://books.toscrape.com/catalogue/category"
  );
  
  // Step 3: Rerun URL collection scraper
  let urls = [];
  if (urlScraperId) {
    urls = await step3RerunCollectUrls(url, urlScraperId);
  }
  
  if (!urls.length) {
    process.exit(1);
  }
  
  // Use first 3 URLs for demo
  urls = urls.slice(0, 3);
  console.log(`  Using ${urls.length} URLs for demo`);
  
  // Step 4: Create detail scraper
  const detailScraperId = await step4CreateDetailScraper(
    urls[0],
    "Extract all data detail"
  );
  
  if (!detailScraperId) {
    process.exit(1);
  }
  
  // Step 5: Bulk scrape
  let bulkResultId = await step5BulkScrape(detailScraperId, urls);
  
  // Optional: Uncomment to use a specific bulk result ID
  // bulkResultId = "a438e4c2-8489-4473-b405-6b4b5e18ed3f";
  
  // Step 6: Get results
  const results = await step6GetResults(bulkResultId);
  
  if (results) {
    console.log("\n" + "=".repeat(60));
    console.log("📊 RESULTS SUMMARY");
    console.log("=".repeat(60));
    console.log(`✓ Total items: ${results.mergedData.length}`);
    console.log(`✓ Successful: ${results.summary.successfulUrls}`);
    console.log(`✓ Failed: ${results.summary.failedUrls}`);
    console.log(`✓ Tokens used: ${results.summary.totalTokenUsage}`);
    
    console.log("\n📦 EXTRACTED DATA:");
    console.log(JSON.stringify(results.mergedData, null, 2));
  }
})();
```

--------------------------------

### Initialize MrScraperToolkit

Source: https://docs.mrscraper.com/docs/integrations/langchain

Load all available tools using the toolkit class, either via environment variables or an explicit API token.

```python
from langchain_mrscraper import MrScraperToolkit

# Using environment variable
tools = MrScraperToolkit().get_tools()

# Or with explicit token
tools = MrScraperToolkit(token="MRSCRAPER_API_TOKEN").get_tools()
```

--------------------------------

### Create a detail scraper via API

Source: https://docs.mrscraper.com/docs/guides/programmatically

Use these examples to initiate a detail extraction task. Ensure you replace the placeholder token with your actual API token.

```bash
curl --location 'https://api.app.mrscraper.com/api/v1/scrapers-ai' \
--header 'accept: application/json' \
--header 'x-api-token: <MRSCRAPER_API_TOKEN>' \
--header 'content-type: application/json' \
--data '{
    "url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html",
    "agent": "general",
    "message": "Extract data : Title, Product Description, Price (Float), Availability, and Number of reviews",
    "proxyCountry": ""
}'
```

```javascript
const token = "MRSCRAPER_API_TOKEN";

fetch("https://api.app.mrscraper.com/api/v1/scrapers-ai", {
  method: "POST",
  headers: {
    "accept": "application/json",
    "x-api-token": token,
    "content-type": "application/json"
  },
  body: JSON.stringify({
    url: "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html",
    agent: "general",
    message: "Extract data : Title, Product Description, Price (Float), Availability, and Number of reviews",
    proxyCountry: ""
  })
})
.then(res => res.json())
.then(data => console.log(data))
.catch(err => console.error(err));
```

```python
import requests

token = "MRSCRAPER_API_TOKEN"

url = "https://api.app.mrscraper.com/api/v1/scrapers-ai"
headers = {
    "accept": "application/json",
    "x-api-token": token,
    "content-type": "application/json"
}
payload = {
    "url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html",
    "agent": "general",
    "message": "Extract data : Title, Product Description, Price (Float), Availability, and Number of reviews",
    "proxyCountry": ""
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())
```

--------------------------------

### Mobile Proxy Example

Source: https://docs.mrscraper.com/docs/residential-proxy/configuration/authentication

Example of targeting US mobile carrier IPs.

```text
# US mobile carrier IPs
user123-mobile-country-us:pass456@proxy.mrscraper.com:10000
```

--------------------------------

### 429 Too Many Requests Error Example

Source: https://docs.mrscraper.com/docs/api/error-handling

Example response when rate limits are exceeded.

```json
{
  "message": "Too many requests. Please try again later."
}
```

--------------------------------

### 422 Unprocessable Entity Error Example

Source: https://docs.mrscraper.com/docs/api/error-handling

Example response when a request fails validation.

```json
{
  "message": "Validation failed",
  "error": "Unprocessable Entity"
}
```

--------------------------------

### Country-Specific Proxy Example

Source: https://docs.mrscraper.com/docs/residential-proxy/configuration/authentication

Example of targeting US proxies using the country-specific format.

```text
# Target US proxies
user123-country-us:pass456@proxy.mrscraper.com:10000
```

--------------------------------

### Analytic Statuses Response Examples

Source: https://docs.mrscraper.com/docs/api/v3/analytic/status

Examples of successful and unauthorized response bodies returned by the API.

```json
{
  "message": "Successful operation!",
  "data": {
    "countAll": 35,
    "successRate": 100,
    "reqPerMinute": 0.00023597785853464491,
    "avgLatency": 0,
    "data": [
      {
        "key": "PENDING",
        "value": 0
      },
      {
        "key": "RUNNING",
        "value": 0
      },
      {
        "key": "PROCESSING",
        "value": 0
      },
      {
        "key": "COMPLETED",
        "value": "35"
      },
      {
        "key": "FAILED",
        "value": 0
      },
      {
        "key": "CANCELLED",
        "value": 0
      }
    ]
  }
}
```

```json
{
  "message": "Unauthorized access",
  "error": "Unauthorized"
}
```

--------------------------------

### Create AI Scraper

Source: https://docs.mrscraper.com/docs/integrations/python

Initialize an AI-powered scraper with natural language instructions.

```python
result = await client.create_scraper(
    url="https://example.com/products",
    message="Extract all product names, prices, and ratings",
    agent="listing",  # "general" | "listing" | "map"
    proxy_country="US",
)
scraper_id = result["data"]["data"]["id"]
print("Scraper ID:", scraper_id)
```

--------------------------------

### Proxy Configuration Examples

Source: https://docs.mrscraper.com/docs/residential-proxy/examples/overview

Standard proxy connection strings for different routing requirements including random country, static, and session-based configurations.

```text
# Random country, rotating IP
user:password@proxy.mrscraper.com:10000
```

--------------------------------

### Node.js Custom Session Duration Example

Source: https://docs.mrscraper.com/docs/residential-proxy/configuration/authentication

Demonstrates using axios with a 20-minute session proxy configuration.

```javascript
const axios = require('axios');

// 20-minute session proxy
const proxy = {
  host: 'proxy.mrscraper.com',
  port: 10000,
  auth: {
    username: 'user123-country-us-sessid-node_session-sesstime-20',
    password: 'pass456'
  }
};

async function testProxy() {
  for (let i = 0; i < 10; i++) {
    const response = await axios.get('https://api.ipify.org', { proxy });
    console.log(`Request ${i+1}: ${response.data}`);
    
    // Wait 2 minutes between requests
    await new Promise(resolve => setTimeout(resolve, 120000));
  }
}

testProxy();
```

--------------------------------

### Basic HTTP Request with Net::HTTP

Source: https://docs.mrscraper.com/docs/residential-proxy/examples/ruby

Fundamental setup using Ruby's built-in Net::HTTP library with a static proxy session.

```ruby
require 'net/http'
require 'uri'

# Static proxy configuration
proxy_uri = URI.parse('http://user-country-us-sessid-ruby1:pass123@proxy.mrscraper.com:10000')

uri = URI.parse('https://api.ipify.org')

http = Net::HTTP.new(uri.host, uri.port, 
                     proxy_uri.host, proxy_uri.port, 
                     proxy_uri.user, proxy_uri.password)
http.use_ssl = true

request = Net::HTTP::Get.new(uri.request_uri)
response = http.request(request)

puts "Your IP: #{response.body}"
```

--------------------------------

### 400 Bad Request Error Example

Source: https://docs.mrscraper.com/docs/api/error-handling

Example response when a request body is malformed or missing required parameters.

```json
{
  "message": "startDate is required and must be in `yyyy-MM-dd HH:mm:ss` format",
  "error": "Bad Request"
}
```

--------------------------------

### Run CLI Without Installation

Source: https://docs.mrscraper.com/docs/getting-started/cli

Execute CLI commands directly using npx without a permanent global installation.

```bash
npx @mrscraper/cli --help
npx @mrscraper/cli scrape "https://example.com/"
```

--------------------------------

### Initialize MrScraper Client

Source: https://docs.mrscraper.com/docs/integrations/python

Configure the client with your API token. Environment variables are recommended for security.

```python
from mrscraper import MrScraper

client = MrScraper(token="MRSCRAPER_API_TOKEN")
```

```python
import os
from mrscraper import MrScraper

client = MrScraper(token=os.getenv("MRSCRAPER_API_TOKEN"))
```

--------------------------------

### AI Assistant Prompt Example

Source: https://docs.mrscraper.com/docs/features/manual-scraper

A sample prompt used to instruct the AI Assistant to extract specific data points from a target URL.

```text
Extract the book title and rating from the page.
```

--------------------------------

### Extract Detailed Data with General Agent

Source: https://docs.mrscraper.com/docs/features/ai-scraper/multi-agent-flow/list

Input configuration and sample output for extracting comprehensive product specifications from a specific URL.

```json
// Input (for each URL)
{
  "url": "https://www.walmart.com/ip/123456789",
  "agent": "general",
  "prompt": "Extract laptop specifications including processor, RAM, storage, display, graphics, ports, battery life, weight, and full description"
}

// Output (sample)
{
  "data": {
    "id": "1",
    "name": "HP 15.6\" Laptop, Intel Core i5-1235U, 8GB RAM, 256GB SSD",
    "price": "$499.00",
    "rating": "4.3",
    "reviews_count": "1,247",
    "specifications": {
      "processor": "Intel Core i5-1235U (12th Gen)",
      "ram": "8GB DDR4",
      "storage": "256GB PCIe NVMe SSD",
      "display": "15.6\" FHD (1920 x 1080) Anti-Glare",
      "graphics": "Intel Iris Xe Graphics",
      "battery": "Up to 8 hours",
      "weight": "3.75 lbs",
      "operating_system": "Windows 11 Home"
    },
    "description": "Stay productive and entertained with this HP laptop...",
    "features": [
      "Fast processor for multitasking",
      "Full HD display",
      "Long battery life"
    ]
  }
}
```

--------------------------------

### Scrape Listing Page with Listing Agent

Source: https://docs.mrscraper.com/docs/features/ai-scraper/multi-agent-flow/list

Input configuration and sample output for extracting product lists and URLs from a category page.

```json
// Input
{
  "url": "https://www.walmart.com/browse/electronics/laptops/3944_3951_132960",
  "agent": "listing",
  "prompt": "Extract all laptop names, prices, ratings, and detail page URLs"
}

// Output (sample)
{
  "response": [
    {
      "page_num": 0,
      "data": {
        "mode": "direct",
        "data": [
          {
            "id": "1",
            "name": "HP 15.6\" Laptop, Intel Core i5",
            "price": "$499.00",
            "rating": "4.3",
            "url": "https://www.walmart.com/ip/123456789"
          },
          {
            "id": "2",
            "name": "Dell Inspiron 15 3000",
            "price": "$379.99",
            "rating": "4.1",
            "url": "https://www.walmart.com/ip/987654321"
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### Scrape Result

Source: https://docs.mrscraper.com/docs/guides/complex-website/lecho

Example JSON output structure returned by the scraper.

```json
{
  "data": {
    "canonicalUrl": "https://www.lecho.be/economie-politique/belgique/federal/le-plan-de-l-arizona-pour-remettre-100-000-malades-de-longue-duree-a-l-emploi/10637620.html",
    "title": "Le plan de l'Arizona pour remettre 100.000 malades de longue durée à l'emploi",
```

--------------------------------

### GET /api/v1/results

Source: https://docs.mrscraper.com/docs/api/pagination

Retrieves a paginated list of results from the MrScraper API.

```APIDOC
## GET /api/v1/results

### Description
Retrieves a paginated list of scraper results. Supports sorting, searching, and date range filtering.

### Method
GET

### Endpoint
/api/v1/results

### Parameters
#### Query Parameters
- **page** (number) - Required - The page number to retrieve (1-indexed)
- **pageSize** (number) - Required - Number of items per page
- **sortField** (string) - Required - Field name to sort by
- **sortOrder** (string) - Required - Sort direction (ASC or DESC)
- **search** (string) - Optional - Search across all entity columns
- **dateRangeColumn** (string) - Optional - Column name for date filtering
- **startAt** (string) - Optional - Start date for filtering (ISO 8601)
- **endAt** (string) - Optional - End date for filtering (ISO 8601)

### Request Example
curl -X GET "https://api.app.mrscraper.com/api/v1/results?page=1&pageSize=10&sortField=updatedAt&sortOrder=DESC" -H "x-api-token: MRSCRAPER_API_TOKEN" -H "accept: application/json"

### Response
#### Success Response (200)
- **message** (string) - Status message
- **data** (array) - List of result objects
- **meta** (object) - Pagination metadata containing page, pageSize, total, and totalPage
```

--------------------------------

### GET /results

Source: https://docs.mrscraper.com/docs/guides/programmatically

Retrieves a paginated list of historical results for a specific scraper.

```APIDOC
## GET /results

### Description
Use this endpoint to retrieve all historical results for a specific scraper with pagination and sorting options.

### Method
GET

### Endpoint
https://api.app.mrscraper.com/api/v1/results

### Parameters
#### Query Parameters
- **filters[scraperId]** (string) - Required - Filter results by scraper ID
- **page** (integer) - Optional - Page number (default: 1)
- **pageSize** (integer) - Optional - Results per page (default: 10)
- **sort** (string) - Optional - Field to sort by (e.g., createdAt)
- **sortOrder** (string) - Optional - Sort direction: ASC or DESC

### Response
#### Success Response (200)
- **message** (string) - Successful fetch
- **data** (array) - List of result objects
- **meta** (object) - Pagination metadata including page, pageSize, total, and totalPage

### Response Example
{
  "message": "Successful fetch",
  "data": [
    {
      "createdAt": "2026-01-18T07:28:44.725Z",
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxx...",
      "scraperId": "YOUR_SCRAPER_ID",
      "status": "Finished"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 10,
    "total": 2,
    "totalPage": 1
  }
}
```

--------------------------------

### Get Result by ID

Source: https://docs.mrscraper.com/docs/integrations/node

Fetches a single scraping result by its unique identifier.

```javascript
import { getResultById } from "@mrscraper/sdk";

const result = await getResultById({
  resultId: "your-result-id",
  // token: "optional_override_token"
});
```
Tokens:
Raw