API Overview
Comprehensive documentation for MrScraper's API endpoints, including authentication, pagination, error handling, and scraper management.
Introduction
The MrScraper API provides a powerful and flexible way to programmatically scrape web pages and retrieve structured data. Built on REST principles, our API offers predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.
API Playground
The API Playground is your interactive testing environment for experimenting with MrScraper's API without writing any code. Build requests, test parameters, preview responses, and generate code snippets in multiple programming languages—all from your browser. The API Playground provides a visual interface to:
- Test API requests in real-time with instant feedback
- Experiment with parameters without coding
- Generate code snippets in 8 programming languages
- Preview API responses before implementation
- Learn API functionality through hands-on experimentation
Quick Access
Access the Playground directly from your MrScraper dashboard.
Base URL
All API requests should be made to:
Residential Proxyhttps://api.app.mrscraper.comAPI Features
JSON Format
All requests with a payload require Content-Type: application/json header. All responses are returned in JSON format.
Authentication
All API endpoints require authentication using an API key passed in the x-api-token header. See the Authentication page for details.
Pagination
List endpoints support pagination to handle large datasets efficiently. See the Pagination page for details.
Error Handling
The API uses standard HTTP status codes and returns detailed error messages. See the Error Handling page for details.