API Reference

Welcome to the Scrappy API documentation. Use our REST API to manage projects, sources, jobs, and leads programmatically.

Getting Started

Base URL

All API requests should be made to:

https://api.scrappy.gg

Authentication

Most endpoints require authentication. Include your API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.scrappy.gg/api/users

Response Format

All responses are returned in JSON format with a consistent structure:

{
  "success": true,
  "data": {
    // Response data here
  }
}

// Error response
{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human readable error message"
  }
}

Rate Limiting

API requests are rate limited to ensure fair usage. When you exceed the rate limit, you'll receive a 429 status code. Rate limits vary by endpoint and are documented in each section.

API Sections

Explore the API by section. Click on any section to view detailed endpoint documentation.

User authentication and session management

User profile and account management

Consent Management

GDPR consent preferences and history

GDPR subject access requests - export your data

Account Deletion

GDPR right to erasure - delete your account

Organize sources and leads into projects

Manage data sources for lead scraping

Scraping job management and monitoring

Lead management and email validation

Email Verification

Email bounce tracking and spam trap detection

Credit balance and purchasing

Markdown Exports

Export websites to markdown format

Admin-only endpoints for platform management

Webhook endpoints for external integrations

Health checks and monitoring endpoints

SDKs & Libraries

We provide code examples in cURL, JavaScript, and Python for every endpoint. Official SDKs are coming soon.

cURLJavaScriptPython