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

Profile Types & Profiles

Custom entity schemas for structured data extraction, plus management of extracted profiles

Matching Engine

Rules-based and AI-powered filtering and scoring of profiles — FILTER, SCORED, and AI match types

Aggregated company/account view derived from lead data

AI-powered deal flow management — discover sources, rank accounts, and generate matching rules

Conversational AI assistant (Claude) that can query and manage leads, sources, and jobs via natural language

Email Verification

Email bounce tracking and spam trap detection

LinkedIn Integration

LinkedIn scraping, lead enrichment, profile validation, and commonalities analysis

Email domain warming system — 5-week progressive warmup for improved deliverability

AngelSend Integration

Cold email outreach platform integration — export leads, send emails, AI personalization, and domain warmup

Credit balance and purchasing

Markdown Exports

Export websites to markdown format

Pipeline overview, source performance, capacity planning, and credit burn rate metrics

Admin-only endpoints for platform management

Manage outbound webhooks for event notifications and receive inbound webhooks from external services

Organizations, API keys, source templates, proxy profiles, suppression lists, and data destinations

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