OpenProspect External Developer API¶
Access qualified prospect data and company information programmatically via API keys.
Getting Started¶
- Get your API key from your OpenProspect dashboard
- Validate your credentials using the
/api/v1/auth/validateendpoint - Fetch data from companies, prospects, and prospect searches
Quick Example¶
import httpx
API_KEY = "lnc_live_your_api_key_here"
BASE_URL = "https://api.openprospect.io"
headers = {"Authorization": f"Bearer {API_KEY}"}
# Validate credentials
response = httpx.get(f"{BASE_URL}/api/v1/auth/validate", headers=headers)
print(response.json())
# List prospect searches
response = httpx.get(f"{BASE_URL}/api/v1/prospect-searches/", headers=headers)
searches = response.json()
# Get companies from a search
if searches:
search_id = searches[0]["id"]
response = httpx.get(
f"{BASE_URL}/api/v1/companies/",
params={"prospect_search_id": search_id},
headers=headers
)
print(response.json())
Available Endpoints¶
| Endpoint | Description |
|---|---|
GET /api/v1/auth/validate |
Validate API credentials |
GET /api/v1/prospect-searches/ |
List available prospect searches |
GET /api/v1/companies/ |
List companies for a prospect search |
GET /api/v1/companies/{id} |
Get company details |
GET /api/v1/prospects/ |
List prospects |
GET /api/v1/prospects/{id} |
Get prospect details |
GET /api/v1/deliveries/{id}/companies |
Get delivered companies for CRM sync |
Documentation¶
- Authentication - API key setup and usage
- API Quickstart - First API call walkthrough
- Interactive API Reference - Full endpoint documentation
- Python Examples - Working code examples
- Error Handling - Error codes and troubleshooting
Support¶
Email: support@openprospect.io