.png?fit=max&auto=format&n=tMpg-r-6yeOIk-hz&q=85&s=e0cafcb914826d8adc60e5092187e1ca)
.png?fit=max&auto=format&n=tMpg-r-6yeOIk-hz&q=85&s=f214ebe0a940d8aa0f19a709a6bfd7fa)
Overview
The Filter Builder API converts a free-text description of your target companies into the structuredfilters object accepted by the List Generation API. Use it when you want the precision and reproducibility of structured filters, but would rather describe your target companies in plain English than look up enum values, industry codes, and filter keys yourself.
The endpoint does not return any companies itself — it only returns the equivalent filters object. Pass that object straight into the filters parameter of a subsequent /v1/company/list/generate call to fetch the actual matching companies.
Endpoint Details
- Method: POST
- Endpoint:
/v1/company/list/translate-query
Authentication requirements
- Include a valid API key in the
x-api-keyrequest header.
Request
Request Parameters
Header Parameters
string
required
Your API key.
Body Parameters
string
required
Natural language description of your target companies (e.g. “series a companies in mumbai working in climate tech”).The API interprets location, funding stage, industry, and other filterable attributes mentioned in the query and resolves them to the corresponding structured filter keys and values used by the List Generation API.
Response
Successful Response Fields
object
Container for the translated result. Contains
filters key that includes all the translated filters.object
The structured filters object equivalent to the input query, using the same dotted-path filter keys as the List Generation API (e.g.
location.hq.city, funding_detail.funding_overview.funding_stage, industry.industry).Only the filter groups relevant to the query are included. Pass this object directly into the filters parameter of a List Generation API request.