API Documentation

Prospct API

Welcome to Prospct API documentation. Our REST API enables you to query our comprehensive dataset of business profiles and contacts, providing enriched data to help you streamline your lead generation and data management. The primary API calls are:

Company API: Retrieve company details using the domain or company name.
Person API: Get detailed contact information for business profiles.

Our APIs follow REST principles and all requests must be made over SSL. Responses are encoded in JSON format.

Please note that Prospct operates as a data aggregator and search platform. We source data from trusted partners and the web, not directly creating it ourselves. For more information about our data collection practices, please refer to our [Privacy Policy].

Important: One credit is deducted for each successful match. A successful match means the API returned results based on your query.

Prospct API Endpoint

https://api.prospct.com/

Authentication

API requests are authenticated with an API key. Each request must include the API key in the Authorization header. Example:

curl "https://api.prospct.com/person?firstName=John&lastName=Doe&company=example" -H "api_key:YOUR_API_KEY"

Note: Your API key is unique to your organization. Do not share it outside your team to maintain security.

Error Codes

Prospct uses standard HTTP response codes to indicate the status of the API request. Here are common responses:

200 OK: Request was successful.
400 Bad Request: The request was not formatted correctly.
401 Unauthorized: Invalid API key.
403 Forbidden: Account is inactive, contact support.
404 Not Found: Endpoint not found.
429 Too Many Requests: Rate limit reached.
499 Request Timeout: The request took too long to process.

Rate Limiting

The Prospct API allows up to 100 requests per second. Check your request headers for rate limit details:

RateLimit-Limit: Maximum allowed requests per second.
RateLimit-Remaining: Remaining requests in the current window.
RateLimit-Reset: Time until rate limit resets (in seconds).

Example of a rate limit response:

HTTP/1.1 429 Too Many Requests RateLimit-Limit: 100 RateLimit-Remaining: 0 RateLimit-Reset: 60

Credit Usage API

You can check your account’s credit usage to track how many credits have been used and how many remain. The credit usage API has a rate limit of 5 requests per minute.

Endpoint URL: GET https://api.prospct.com/account/usage -H "api_key:YOUR_API_KEY"

Credit Usage Response:

{
  "usage": {
    "bulkCredits": {
      "total": 5000,
      "used": 3000,
      "remaining": 2000
    }
  }
}

Person APIs

The Person API allows you to look up detailed contact data using email, LinkedIn profile, full name, and company details. The Person API V2 supports advanced features such as metadata on contact information, improving the accuracy and freshness of data.

Endpoint URL:
GET https://api.prospct.com/v2/person?firstName=:firstName&lastName=:lastName&companyName=:companyName -H "api_key:YOUR_API_KEY"