REST API v1

Build powerful integrations with the ScrapeLi API

Programmatically scrape your competitors' followers, ICP search results and much more, and receive real-time notifications — all through a simple REST API.

Get Your API Key View Full Docs
Python JavaScript cURL PHP Ruby
quickstart.py
# Get your API key from the dashboard import requests API_KEY = "sk_live_your_key_here" BASE = "https://app.scrapeli.com/api/v1" headers = {"Authorization": f"Bearer {API_KEY}"} # Check your account r = requests.get(f"{BASE}/account/", headers=headers) print(r.json()) # Enrich companies r = requests.post(f"{BASE}/enrichment/", headers=headers, json={"company_urls": ["https://example.com/company/acme"]}) print(r.json()["data"]["id"])

Everything you need to integrate

A complete API platform for data enrichment, lead generation, and competitor intelligence.

API Key Authentication

Simple Bearer token auth. Separate live and test keys with full sandbox mode — 50K virtual credits to test your integration risk-free.

Company Enrichment

Enrich company profiles with firmographic data: industry, size, HQ location, specialties, and more — at scale.

Lead Generation

Generate targeted lead lists from competitor audiences. Basic or Advanced packages with configurable record counts.

ICP Filtering

Submit custom ideal customer profile filters. Receive a quote from our team, then accept to generate a targeted dataset.

Webhooks

Real-time event notifications with HMAC-SHA256 signatures. 13 event types, automated retries, and delivery logs.

Interactive Docs

Full OpenAPI 3.0 spec with Swagger UI and ReDoc. Try endpoints directly from the browser after logging in.

Sandbox Mode

Test your full integration risk-free. Each test key gets 50,000 virtual credits, realistic mock data, simulated order lifecycles, and webhook delivery — all without touching real credits.

Get started in minutes

Three steps to your first API call.

1
Create an account & get your API key

Sign up, go to API Settings, and generate a key. Start with a Test key to explore the API with 50,000 virtual credits, then switch to a Live key for production.

2
Make your first request

Hit GET /api/v1/account/ with your Bearer token to verify everything works.

3
Start enriching & generating leads

Use the Orders, Enrichment, or ICP endpoints. Register a webhook to get notified when results are ready.

34 API endpoints

Full REST coverage for orders, enrichment, ICP requests, webhooks, and account management.

Account & Credits
GET/api/v1/account/
GET/api/v1/credits/balance/
GET/api/v1/credits/transactions/
Orders
POST/api/v1/orders/Create order
GET/api/v1/orders/list/List orders
GET/api/v1/orders/{id}/Detail
POST/api/v1/orders/{id}/cancel/Cancel
GET/api/v1/orders/{id}/results/JSON results
GET/api/v1/orders/{id}/results/download/CSV/XLSX
Competitor Followers
GET/api/v1/icp/company-info/Lookup company name + follower count
POST/api/v1/orders/Place order — all or custom count (min 100)
POST/api/v1/icp/Submit ICP filtered request
GET/api/v1/icp/list/List
GET/api/v1/icp/{id}/Detail + quote
POST/api/v1/icp/{id}/accept/Accept
POST/api/v1/icp/{id}/decline/Decline
GET/api/v1/icp/{id}/results/Results
Company Enrichment
POST/api/v1/enrichment/Submit
GET/api/v1/enrichment/list/List
GET/api/v1/enrichment/{id}/Detail
GET/api/v1/enrichment/{id}/progress/Progress
GET/api/v1/enrichment/{id}/results/Results
GET/api/v1/enrichment/{id}/results/download/Download
GET/api/v1/enrichment/{id}/failed/Failed
POST/api/v1/enrichment/{id}/cancel/Cancel
POST/api/v1/enrichment/{id}/retry-failed/Retry
Webhooks
POST/api/v1/webhooks/Register
GET/api/v1/webhooks/list/List
GET/api/v1/webhooks/{id}/Detail
PATCH/api/v1/webhooks/{id}/Update
DEL/api/v1/webhooks/{id}/delete/Delete
POST/api/v1/webhooks/{id}/test/Test
GET/api/v1/webhooks/{id}/deliveries/Log
Schema & Docs
GET/api/v1/schema/OpenAPI spec
GET/api/v1/docs/Swagger UI
GET/api/v1/redoc/ReDoc

Works with your favourite tools

Standard REST + JSON + Webhooks — integrates with any HTTP-capable platform.

Clay Zapier Make n8n Custom Code

Ready to integrate?

Create a free account, get your API key, and start making requests in minutes.

Sign Up Free Log In