Flowprise Leads API Reference
Welcome to the developer documentation for Flowprise Leads. Programmatically extract verified B2B decision makers, Google Maps businesses, live organic SERP opportunities, social channels, and automated high-converting cold outreach pitches directly from any external script, n8n node, or custom application.
Authentication
All lead extraction, website intelligence, and outreach endpoints require authentication. You can generate and copy your secret API key directly from your dashboard with 1 click.
fp_live_... Secret Key.
Pass your secret key in your HTTP request headers using either format:
// Method 1: Dedicated Header (Recommended)
X-API-Key: fp_live_YOUR_SECRET_KEY
// Method 2: Standard Bearer Token
Authorization: Bearer fp_live_YOUR_SECRET_KEY
Base URL
All endpoints documented below are hosted on your live production instance:
https://lead.flowprise.tech
Rate Limits
To guarantee server stability and prevent bot spam, endpoints use rolling sliding-window limits per IP address:
- Lead Scrapers (Maps, SERP, Socials, SEO):
15 requests / minute - Email Deliverability Verifier:
30 requests / minute - Cold Outreach Send:
20 requests / minute
If exceeded, the server returns HTTP 429 Too Many Requests with a standard Retry-After: <seconds> header.
Universal Dispatcher
Execute any scraper engine through a single unified endpoint by passing the source parameter in your JSON payload.
maps, serp, instagram, facebook, linkedin, website, and seo.
| Parameter | Type | Description |
|---|---|---|
| source required | string | Target engine: "maps", "serp", "instagram", "facebook", "linkedin", "website", "seo" |
| query / keyword | string | Search keyword or niche query (e.g., "Dentist in Austin") |
| location optional | string | Target city, state, or region |
| limit optional | integer | Max results to return (Default: 15, Max: 50) |
curl -X POST https://lead.flowprise.tech/api/leads/extract \
-H "X-API-Key: fp_live_YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{
"source": "maps",
"query": "Chiropractor",
"location": "Dallas, TX",
"limit": 10
}'
Google Maps Business Scraper
Extract local business listings, addresses, direct telephone numbers, reviews, website URLs, and underlying technology stacks directly from Google Maps.
| Parameter | Type | Description |
|---|---|---|
| query required | string | Business niche or category (e.g. "Italian Restaurant") |
| location optional | string | Target city, state, or postal code (e.g. "Miami, FL") |
| limit optional | integer | Max leads to extract (Default: 15, Max: 50) |
| enrich optional | boolean | Audit prospect websites for emails and Meta Pixels (Default: true) |
curl -X POST https://lead.flowprise.tech/api/leads/maps \
-H "X-API-Key: fp_live_YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "Dentist in Austin",
"location": "Austin, TX",
"limit": 15,
"enrich": true
}'
Google SERP & 1-Click SEO Pitch Scraper
Scrapes organic Google rankings for any keyword, diagnoses technical SEO bottlenecks, and automatically generates high-converting cold outreach email pitches praising their rank.
| Parameter | Type | Description |
|---|---|---|
| query required | string | Target Google search query (e.g. "rooftop solar delhi") |
| country optional | string | Country code for regional SERP (Default: "us", "in", "uk") |
| limit optional | integer | Max organic results to extract (Default: 15, Max: 50) |
import requests
res = requests.post(
"https://lead.flowprise.tech/api/leads/serp",
headers={"X-API-Key": "fp_live_YOUR_SECRET_KEY"},
json={"query": "rooftop solar delhi", "country": "in", "limit": 5}
)
data = res.json()
for lead in data.get("leads", []):
print(f"Rank #{lead['position']} • {lead['domain']}")
print(f"Subject: {lead['emailSubject']}\n")
Website Tech & Contact Auditor
Crawls homepage and contact pages to uncover corporate emails, direct phone numbers, WhatsApp links, social profiles (LinkedIn, IG, FB, Twitter), CMS engine, and advertising tracking pixels.
| Parameter | Type | Description |
|---|---|---|
| url required | string | Target domain or URL (e.g. "https://flowprise.tech") |
curl -X POST https://lead.flowprise.tech/api/leads/website \
-H "X-API-Key: fp_live_YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com"}'
LinkedIn Decision Maker X-Ray
Extracts indexed professional profiles, executive titles, companies, locations, and predicted email patterns without needing a premium LinkedIn account.
| Parameter | Type | Description |
|---|---|---|
| role optional | string | Target executive title (e.g. "Head of Marketing", "Founder") |
| industry optional | string | Industry niche (e.g. "SaaS", "Real Estate") |
| location optional | string | Target country or city (e.g. "United States", "London") |
curl -X POST https://lead.flowprise.tech/api/leads/linkedin \
-H "X-API-Key: fp_live_YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{
"role": "Chief Marketing Officer",
"industry": "FinTech",
"location": "New York",
"limit": 15
}'
Export Leads (CSV & JSON)
Instantly download current or filtered prospects into standard spreadsheets for CRM ingestion or offline analysis.
text/csv; charset=utf-8 with headers: name, phone, whatsapp, email, website, address, rating, reviews, cms, tech_stack, has_meta_pixel, audit_badge, source.
API Health & Monitoring
Query platform health status for uptime monitors (UptimeRobot, Render, Datadog).
{"status": "online"}. Authenticated requests return full database connectivity metrics.