Skip to main content
POST
List Generation

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json
query
string

Natural language search query (e.g. 'SaaS companies in the US with Series A funding'). Cannot be used with filters.

filters
object

Structured filter conditions. Use the Filter Builder API to generate valid filters. Cannot be used with query. See filter options at /api-reference/listgen-api.

sections
string[]

Data enrichment sections to include. Values: firmographic, business_model, company_assessment, trust_signal, company_hierarchy, digital_presence, financial_estimate, location, management_profile, product_offering, strategic_signal, customer_profile, industry, technology, funding_detail (Subscription, Enterprise), mna_and_investment (Subscription, Enterprise)

sort_by
enum<string>

Field to sort results by. Default: relevance

可用选项:
relevance,
revenue_estimate,
valuation_estimate,
employee_range,
total_funding,
founded_year
sort_order
enum<string>

Sort direction. Default: desc

可用选项:
asc,
desc
limit
integer

Maximum companies to return. Default: 50, Max: 500

offset
integer

Number of results to skip for pagination. Default: 0

响应

成功响应

data
object[]
count
integer

Number of companies returned.

total_count
integer

Total matching companies. Capped at 500.

credits_consumed
number<float>

Credits consumed. Returns 0 when no enrichment sections requested.