Docs / API Reference
Getting Started
The LocalLeads REST API lets you search for local business leads, enrich contact data, and manage your account — all programmatically. Every endpoint that powers the dashboard is available via API key.
Base URL
https://leadsapi.postorbit.ioProductionAll requests must use HTTPS. HTTP requests will be rejected.
API Key Auth
Long-lived tokens, no OAuth required. Generate in Settings → Security.
REST + JSON
Standard HTTP verbs. All responses are JSON with a consistent shape.
Same permissions
API keys carry your full account access — same as the dashboard.
Rate limited
100 req/min per IP. Use exponential back-off for heavy automation.
Quick Start
1. Generate an API key in Settings → Security → API Keys.
2. Pass it as a Bearer token on every request:
curl https://leadsapi.postorbit.io/api/v1/credits/balance \
-H "Authorization: Bearer ll_your_api_key_here"3. You get back a JSON object with success: true and a data payload:
{
"success": true,
"data": {
"monthlyCredits": 100,
"bonusCredits": 0,
"usedCredits": 12,
"availableCredits": 88,
"resetDay": 1,
"lastResetAt": "2026-05-01T00:00:00.000Z"
}
}Response Format
Every response shares the same envelope:
// Success
{ "success": true, "data": { ... } }
// Paginated success
{ "success": true, "data": [...], "meta": { "total": 100, "page": 1, "limit": 20 } }
// Error
{ "success": false, "error": "Human-readable message" }