(Waterfall) Contact Enrichment - TradeWind AI API 2.0 Documentation

Real-time contact detail search in waterfall mode, integrating global data sources such as Apollo, Hunter, Snovio, and RocketReach. Performs waterfall-style retrieval and offers two response modes: First Match (single-source priority matching) and Aggregate (multi-source data aggregation), leveraging the strengths of multiple providers.

Request

Header Params

Body Params application/json

Example

{
  "identity": {
    "first_name": "Jan",
    "last_name": "Shumate",
    "domain": "eastman.com"
  },
  "waterfall": {
    "mode": "first_match",
    "source_order": [
      "hunter",
      "snov",
      "apollo",
      "rocketreach"
    ],
    "byok": {
      "apollo_api_key": "<YOUR_APOLLO_KEY>",
      "hunter_api_key": "<YOUR_HUNTER_KEY>",
      "rocketreach_api_key": "<YOUR_ROCKETREACH_KEY>",
      "snov_client_id": "<YOUR_SNOV_CLIENT_ID>",
      "snov_client_secret": "<YOUR_SNOV_CLIENT_SECRET>"
    }
  }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200成功

application/json

Bodyapplication/json

Example

{
  "success": true,
  "status": "completed",
  "request_id": "req_xxx",
  "person": {
    "first_name": "Jane",
    "last_name": "Doe",
    "current_title": "Engineer",
    "company_name": "Example Inc",
    "company_domain": "example.com",
    "company_website": "https://www.example.com",
    "company_linkedin_url": null,
    "location": {
      "city": "San Francisco",
      "country": "United States",
      "country_code": "US"
    },
    "emails": [
      {
        "email": "jane.doe@example.com",
        "type": "work",
        "status": "valid",
        "sources": [
          "apollo"
        ],
        "confidence": null
      }
    ],
    "phones": [
      {
        "number": "+1 415 555 0100",
        "type": "work"
      }
    ],
    "social_links": {
      "linkedin_url": "https://www.linkedin.com/in/janedoe"
    },
    "employment_history": [
      {
        "company_name": "Example Inc",
        "title": "Engineer",
        "start_date": "2020-01",
        "end_date": null,
        "is_current": true,
        "company_linkedin_url": null,
        "department": null,
        "description": null,
        "company_city": "San Francisco",
        "company_country_code": "US"
      }
    ],
    "education": [
      {
        "school": "Stanford University",
        "degree": "BS",
        "major": "Computer Science",
        "start": 2012,
        "end": 2016
      }
    ]
  },
  "meta": {
    "field_sources": {
      "first_name": "request",
      "last_name": "request",
      "company_domain": "request",
      "company_name": "request",
      "social_links": "request",
      "emails": "apollo",
      "phones": "rocketreach",
      "employment_history": "apollo",
      "education": "rocketreach",
      "location": "rocketreach"
    },
    "billing": {
      "total_credits_charged": 4,
      "platform_credits_charged": 4,
      "byok_used": false,
      "breakdown": [
        {
          "source": "apollo",
          "credits": 2
        },
        {
          "source": "rocketreach",
          "credits": 2
        }
      ]
    },
    "waterfall": {
      "mode": "first_match",
      "all_fields_filled": true,
      "total_latency_ms": 920,
      "async_pending": false,
      "sources_attempted": [
        "apollo",
        "rocketreach"
      ],
      "sources_skipped": []
    }
  }
}

🟠400请求有误

🟠401未认证

🟠402需要付款

🟠403权限不足

🟠409冲突

🟠429请求过多