跳转到主要内容
POST
公司信息
按行业、员工规模、总部或类型搜索目标公司,按名称查找候选公司,或通过域名研究公司资料、技术栈、流量、相似企业、融资、新闻、在招职位和 Google 广告。search 需要提示词或结构化筛选,lookup 需要公司名称 query,其他操作需要 domain。 所有操作返回规范化 output,以及最后一个 Run 的 id、provider 和生命周期 status。search 和 lookup 返回 total_matches 及公司列表 output.items[];匹配总数不可用时为 null,不使用当前页长度替代。enrich 和 traffic 提供固定顶层字段;tech_stack、competitors、news、jobs 提供每行字段固定的 output.items[];funding 提供 total_funding_usd 和 items[];ads 提供 total_ads 和 items[]。原生输出不在 output 中重复,保留在 Run 中,可通过 GET /v1/runs/:id 读取。所选数据提供商未报告的值为 null;金额统一为美元。 分别检查 result_status 和 status:前者为 success、no_result、error 或 pending。charge_usd 为本响应 runs 的总费用,所有 Run 结算前为 null;runs[] 包含各自费用。provider=auto 选择第一家符合条件的数据提供商,仅在 PROVIDER_ERROR、TIMED_OUT 或受理时 503 后尝试下一家;指定数据提供商时不切换。对于 QUEUED/RUNNING,即 HTTP 202,目前仅 Apify traffic 路径,在 API 服务地址上使用认证轮询 result_url。有意重试时复用相同 Idempotency-Key 和执行参数。

各操作输出

各操作的规范化字段。原生输出保留在 Run 中,可通过 GET /v1/runs/:id 读取。未报告的值为 null;有效空结果保留操作结构,各字段为 null 或 items 为 [],result_status 为 no_result。金额为美元。员工数和营收为响应方自身估算,*_range_min / *_range_max 为其区间边界。自有模型分数带数据提供商名称,如 exa_similarity_score,其他家为 null。industry、categories、round、category 保留响应方词汇。
  • search: total_matches, items[]: domain 及公司资料字段;未报告的字段为 null
  • lookup: total_matches, items[]: domain 及公司资料字段;名称有歧义时返回候选
  • enrich: name, website, description, industry, employees, employee_range_min, employee_range_max, founded_year, city, region, country, country_code, linkedin_url, phone, total_funding_usd, revenue_usd, revenue_range_min_usd, revenue_range_max_usd, ownership, ticker, latest_funding_date
  • tech_stack: items[]: name, categories[], detection_source, predictleads_confidence, first_detected_date, last_detected_date
  • traffic: monthly_visits, organic_traffic, paid_traffic, organic_keywords, paid_keywords, organic_traffic_value_usd, similarweb_global_rank, bounce_rate, pages_per_visit, avg_visit_duration_seconds
  • competitors: items[]: domain, name, page_title, position, predictleads_similarity_score, exa_similarity_score, reason
  • funding: total_funding_usd, items[]: round_date, round, amount_usd, investors[], source_url
  • news: items[]: title, url, source, published_at, event_date, date_text, category, snippet
  • jobs: items[]: title, url, location, seniority, categories[], contract_types[], salary_min_usd, salary_max_usd, salary_period, posted_at, first_seen_at, last_seen_at
  • ads: total_ads, items[]: creative_id, advertiser_id, advertiser_name, format, ad_url, image_url, first_shown_at, last_shown_at

请求头

idempotency-key
string
必填

为每次预期执行生成唯一值,推荐使用 UUID。使用同一个键和执行参数重试,可读取原 Run,避免再次扣费。使用同一个键但修改执行参数会返回 409;修改 task_id 或 metadata 不会更新原 Run。

Minimum string length: 1

请求体

application/json
action
enum<string> | null

默认为 enrich。search 需要 query 或结构化筛选;lookup 需要 query,即公司名称;其他操作均需要 domain。

  • search:按行业、员工区间、国家或公司类型发现公司,使用 offset 分页。结构化筛选使用 Hunter 词汇;query 只表达这些筛选能表示的条件。其他 ICP 条件需另行检查。
  • lookup:按名称查找候选公司,使用 page 分页;名称有歧义时不要猜测。
  • enrich:公司资料和企业属性。
  • tech_stack、traffic、funding、news:对应公司数据。
  • jobs:公司自有招聘页面上的在招职位;limit 限制行数,默认及最大均为 25,因此返回行数不是公司职位总数。
  • ads:域名背后广告主在 Google Ads Transparency Center 中的广告素材;country 限定地区,省略则包含所有地区。
  • competitors:相似企业。查询 Google 结果中的竞争域名时,使用 SEO 研究的 organic_competitors。
可用选项:
search,
lookup,
enrich,
tech_stack,
traffic,
competitors,
funding,
news,
jobs,
ads
provider
enum<string> | null

默认为 auto,按 Glasser 偏好顺序选择第一家符合条件的数据提供商。指定的数据提供商必须支持请求且获得当前 API Key 的允许,不会切换到其他家。可用值见下方。

可用选项:
auto,
apollo,
pdl,
hunter,
prospeo,
predictleads,
leadmagic,
builtwith,
dataforseo,
ahrefs,
apify,
exa,
serper,
scrapecreators
domain
string | null

网站域名,例如 stripe.com。也接受完整 URL,并提取主机名。

Required string length: 3 - 253
industries
string[] | null
Required array length: 1 - 20 elements
Minimum string length: 1
headcounts
enum<string>[] | null
Required array length: 1 - 8 elements
可用选项:
1-10,
11-50,
51-200,
201-500,
501-1000,
1001-5000,
5001-10000,
10001+
company_types
enum<string>[] | null
Required array length: 1 - 10 elements
可用选项:
educational,
educational institution,
government agency,
non profit,
partnership,
privately held,
public company,
self employed,
self owned,
sole proprietorship
offset
integer | null
必填范围: 0 <= x <= 10000
page
integer | null
必填范围: 1 <= x <= 500
country
string | null

国家,使用两位 ISO 代码或名称,例如 us、gb、de、Germany。默认为 us。支持代码:us、gb、ca、au、nz、ie、in、sg、de、at、ch、fr、be、es、mx、ar、it、nl、pt、br、jp、kr、cn、hk、tw、ru、pl、se、no、dk、fi、tr、id、th、vn、ph、my、za、ae、il、sa、eg、ng、ua、cz、gr、hu、ro、co、cl、pe、lu。可用范围还取决于操作和数据提供商。不支持的国家会在创建 Run 前被拒绝。不要为了绕过错误而更换国家,这会改变请求的数据。

Required string length: 2 - 60
query
string | null

search:发现公司的提示词。lookup:公司名称。通过 Serper 查询 news 时:使用公司名称,不使用域名。

Required string length: 1 - 200
limit
integer | null

返回条数。请从较少条数开始:路由到的接口可能据此计费。各能力还会进一步限制上限。

必填范围: 1 <= x <= 100
task_id
string | null

将相关 Run,包括自动切换产生的 Run,归入同一个 Task。复用稳定字符串,并通过 Task 筛选 Run 列表。

metadata

可选追踪字段,随 Run 返回,也可用于筛选。不会发送给数据提供商,也不影响路由、价格或幂等。

  • 最多 20 个键:小写字母、数字和下划线,以字母开头,最长 40 个字符。
  • 值:长度为 1–500 的字符串。
  • user_id:终端用户的不透明 ID,不得使用邮箱或姓名。

无效条目整体丢弃,不截断。请求继续执行,Run 返回实际保存的字段。

响应

成功

id
string
必填
run_url
string
必填

在控制台打开 Run,需要工作空间成员权限。

provider
string
必填
Pattern: ^[a-z0-9][a-z0-9-]*$
endpoint
string
必填
Pattern: ^\/.+$
endpoint_version
integer
必填
status
enum<string>
必填

QUEUED 或 RUNNING 表示仍在执行。COMPLETED 表示已有数据提供商响应,包括非 2xx 响应。FAILED 请读取 failure。STOPPED 表示分派前停止。charge_usd 与状态分别检查。

可用选项:
QUEUED,
RUNNING,
COMPLETED,
FAILED,
STOPPED
failure
object | null
必填

Run 失败原因,仅在 status 为 FAILED 时非 null。

input
object
必填
output
object
必填

各操作的规范化字段。原生输出保留在 Run 中,可通过 GET /v1/runs/:id 读取。未报告的值为 null;有效空结果保留操作结构,各字段为 null 或 items 为 [],result_status 为 no_result。金额为美元。员工数和营收为响应方自身估算,*_range_min / *_range_max 为其区间边界。自有模型分数带数据提供商名称,如 exa_similarity_score,其他家为 null。industry、categories、round、category 保留响应方词汇。

  • search: total_matches, items[]: domain 及公司资料字段;未报告的字段为 null
  • lookup: total_matches, items[]: domain 及公司资料字段;名称有歧义时返回候选
  • enrich: name, website, description, industry, employees, employee_range_min, employee_range_max, founded_year, city, region, country, country_code, linkedin_url, phone, total_funding_usd, revenue_usd, revenue_range_min_usd, revenue_range_max_usd, ownership, ticker, latest_funding_date
  • tech_stack: items[]: name, categories[], detection_source, predictleads_confidence, first_detected_date, last_detected_date
  • traffic: monthly_visits, organic_traffic, paid_traffic, organic_keywords, paid_keywords, organic_traffic_value_usd, similarweb_global_rank, bounce_rate, pages_per_visit, avg_visit_duration_seconds
  • competitors: items[]: domain, name, page_title, position, predictleads_similarity_score, exa_similarity_score, reason
  • funding: total_funding_usd, items[]: round_date, round, amount_usd, investors[], source_url
  • news: items[]: title, url, source, published_at, event_date, date_text, category, snippet
  • jobs: items[]: title, url, location, seniority, categories[], contract_types[], salary_min_usd, salary_max_usd, salary_period, posted_at, first_seen_at, last_seen_at
  • ads: total_ads, items[]: creative_id, advertiser_id, advertiser_name, format, ad_url, image_url, first_shown_at, last_shown_at
provider_response
object | null
必填

仅在 status 为 COMPLETED 时非 null。

  • 2xx 响应:output 为任意结构的数据提供商原生 JSON;正文为空时为 null。
  • 非 2xx 响应:error 包含数据提供商错误正文,output 为 null。

两种正文均会移除敏感字段。

charge_usd
string | null
必填

此 Solution 响应所含 runs 的总费用,全部 Run 结算前为 null。每个 Run 保留各自费用;失败也可能收费。

Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$
charge_basis
object | null
必填

单个 Run 的计费依据;多个 Run 汇总时为 null。各项费用请查看 runs[].charge_basis。

stoppable
boolean
必填

当前是否可接受停止请求。不保证能在分派前停止 Run。

stop_requested_at
string<date-time> | null
必填

请求停止的时间。如果已开始分派,Run 仍可能继续。

created_at
string<date-time>
必填

ISO 8601 UTC 时间戳。

started_at
string<date-time> | null
必填

ISO 8601 UTC 时间戳。

completed_at
string<date-time> | null
必填

ISO 8601 UTC 时间戳。

task_id
string | null
必填
metadata
object
必填

已保存的追踪字段,可用于筛选 Run,不发送给数据提供商,不影响路由、价格或幂等。

  • 最多 20 个键:小写字母、数字和下划线,以字母开头,最长 40 个字符。
  • 值:长度为 1–500 的字符串。
  • user_id:终端用户的不透明 ID,不得使用邮箱或姓名。
action
enum<string>
必填
可用选项:
search,
lookup,
enrich,
tech_stack,
traffic,
competitors,
funding,
news,
jobs,
ads
result_status
enum<string>
必填

业务交付状态,与 status 中的最终 Run 生命周期独立。no_result 为有效空结果;error 表示数据提供商输出无法交付。

可用选项:
success,
no_result,
error,
pending
error
object | null
必填
runs
object[]
必填
result_url
string
必填

通过认证读取规范化结果和总费用的只读 URL 路径,配合 API 服务地址使用。不创建 Run,也不恢复切换。GET /v1/runs/:id 仍返回原生单个 Run。