Skip to content

Home

OpenProspect Developer API

Welcome to the OpenProspect Developer API documentation. Access company data programmatically using our REST API with API key authentication.

What Can You Build?

The OpenProspect API allows you to:

  • Retrieve Company Data: Access detailed company profiles including contact information, business details, and match scores
  • Filter and Search: Find companies based on review status, match scores, and text search
  • Paginate Results: Efficiently retrieve large datasets with offset-based pagination
  • Get Job Listings: Access active job postings with hiring activity metrics
  • View Technology Stacks: Discover web technologies used by companies

Quick Example

Bash
curl -H "Authorization: Bearer lnc_live_your_api_key_here" \
  "https://api.openprospect.io/api/v1/companies/?prospect_search_id=<uuid>&limit=10"

Getting Started

Follow these steps to get started:

  1. Get API Key: Contact your OpenProspect account manager to request API access
  2. Read Quick Start: Make your first API call in under 5 minutes
  3. Explore API Reference: Learn about available endpoints and parameters
  4. View Code Examples: See practical examples in your preferred language

Current API Coverage

Available Now:

  • ✅ Companies API - Full access to company data retrieval

Coming Soon:

  • 🔜 Prospects API - Access individual prospect data
  • 🔜 Job Search API - Query job listings across multiple platforms
  • 🔜 Webhooks - Real-time notifications for data updates

Authentication

All API requests require an API key passed via the Authorization header:

HTTP
Authorization: Bearer lnc_live_your_api_key_here

API keys are scoped with specific permissions. The companies:read scope provides read access to company endpoints.

Learn more about authentication →

Rate Limits

Current rate limits per API key:

  • Free Tier: 100 requests per hour
  • Pro Tier: 1,000 requests per hour
  • Enterprise: Custom limits available

Rate limit information is returned in response headers:

HTTP
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Support

Need help or have questions?

  • Documentation Issues: Contact your account manager
  • API Support: Contact your account manager
  • Feature Requests: Contact your account manager

API Status

Check the current API status at: https://status.openprospect.io