Enrichment API Documentation

This section provides comprehensive details on using the Leadita Enrichment API to enhance your existing lead data.

Overview

The Enrichment API allows you to take a list of domains and retrieve additional, valuable data points such as emails, technologies used, and more. This is ideal for enhancing your existing CRM data or validating lead information.

Key Features:

Batch enrichment of multiple domains in a single request.
Select specific data attributes to retrieve.
Clear status indicators for each domain (success, not_found, error).
Seamless integration with your existing workflows.

Base URL

All API requests should be made to the following base URL:

API Base URL

https://api.leadita.com

Authentication

All requests to the Leadita API must include an X-API-Key header with your valid API key. If the key is missing or invalid, the API will respond with a 401 Unauthorized error.

You can generate and manage your API keys from your dashboard settings.

HTTP Header

X-API-Key: your_api_key_here

Endpoint

The Enrichment API is accessed via a POST request to the following URL:

POST /v1/leads/enrich

Request Body Parameters

The following parameters can be included in the JSON request body for the `/v1/leads/enrich` endpoint.

Parameter	Type	Required/Optional	Description	Example Value(s)
`domains`	array of strings	Required	An array of domain strings to be enriched.	`["domain1.com", "domain2.com"]`
`select`	array of strings	Required	An array of strings specifying the desired data attributes.	`["domain", "emails", "technologies"]`

Responses

A successful request to the Enrichment API will always return a `200 OK` status code. The response body will be an array of objects, where each object corresponds to a domain in the original request, maintaining the same order.

JSON (200 OK)

{
    "results": [
        {
            "status": "success",
            "domain": "leadita.com",
            "data": {
                "domain": "leadita.com",
                "title": "Leadita - B2B Lead Generation Platform",
                "url": "https://www.leadita.com",
                "emails": ["[email protected]", "[email protected]"],
                "phones": ["+1-800-123-4567"],
                "social_accounts": ["https://linkedin.com/company/leadita", "https://twitter.com/leadita_app"],
                "technologies": ["React", "Node.js", "PostgreSQL", "Stripe"],
                "country": "USA",
                "state": "CA",
                "city": "San Francisco",
                "keywords": ["lead generation", "B2B sales", "data enrichment"],
                "updated_at": "2024-07-25T10:00:00Z",
                "crawled_at": "2024-07-24T08:30:00Z",
                "spending": 3000.00
            }
        },
        {
            "status": "success",
            "domain": "stripe.com",
            "data": {
                "domain": "stripe.com",
                "title": "Stripe - Online Payment Processing",
                "url": "https://stripe.com",
                "emails": ["[email protected]"],
                "phones": [],
                "social_accounts": ["linkedin: https://linkedin.com/company/stripe", "twitter: https://twitter.com/stripe"],
                "technologies": ["React", "Ruby on Rails", "AWS"],
                "country": "USA",
                "state": "CA",
                "city": "San Francisco",
                "keywords": ["payments", "fintech", "API"],
                "updated_at": "2024-07-26T11:00:00Z",
                "crawled_at": "2024-07-25T09:00:00Z",
                "spending": 15000.00
            }
        },
        {
            "status": "not_found",
            "domain": "nonexistentdomain.com",
            "message": "No data found for this domain."
        }
    ]
}

Error Responses

The API may return the following error codes:

JSON (401 Unauthorized)

{
    "error": "UNAUTHORIZED",
    "message": "Invalid or expired API Key"
}

JSON (429 Too Many Requests)

{
    "error": "TOO_MANY_REQUESTS",
    "message": "You have exceeded your rate limit."
}

Examples

Basic Enrichment Request

This example demonstrates enriching a list of domains and selecting specific data fields.

Request Body

{
    "domains": ["leadita.com", "stripe.com", "nonexistentdomain.com"],
    "select": ["domain", "emails", "technologies", "social_accounts"]
}

cURL Example

curl -X POST \
  https://api.leadita.com/v1/leads/enrich \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: your_api_key_here' \
  -d '{
    "domains": ["leadita.com", "stripe.com", "nonexistentdomain.com"],
    "select": ["domain", "emails", "technologies", "social_accounts"]
  }'

Selectable Fields

When using the `select` parameter in your request, you can specify which fields you want to receive in the response. If the `select` parameter is omitted, all available fields will be returned.

Field Name	Type	Description
`domain`	string	The primary domain of the website.
`title`	string	The title of the website (from HTML tag).
`description`	string	A short description of the website content.
`emails`	array of strings	Detected email addresses associated with the domain.
`phones`	array of strings	Detected phone numbers associated with the domain.
`language`	string	The detected primary language of the website (e.g., "en", "fr").
`spending`	number	Estimated monthly spending on online advertising.
`country`	string	The detected country of the website's primary audience or business location.
`state`	string	The detected state/province of the website's primary audience or business location.
`city`	string	The detected city of the website's primary audience or business location.
`technologies`	array of strings	List of detected technologies used by the website (e.g., "Shopify", "WordPress").
`pages`	array of strings	Key pages identified on the website (e.g., "/pricing", "/contact").
`score`	number	A relevance score for the website based on the search query.
`social_accounts`	array of strings	Links to social media profiles (e.g., LinkedIn, Twitter).
`crawled_at`	string (RFC3339)	Timestamp of the last time the website was crawled.

Credits & Usage

Your API key is associated with a credit balance. Credits are consumed in two ways for the Enrichment API:

API Call Credit: Each request to the /v1/leads/enrich endpoint costs 1 API credit, regardless of the number of domains in the request.
Enrichment Credit: For each domain that is successfully found in our database and returned with data, 1 Lead Credit is consumed.

Example Usage: If you send a request with 10 domains and we find data for 7 of them, your credit usage will be:

1 API Credit (for the single API call)
7 Lead Credits (for the 7 successful enrichments)

Get Your API Key