Generate a ranked list of companies similar to a given seed company.
1. Overview
The Competitor List API generates a ranked list of companies similar to a given seed company, enriched with firmographic, funding and financial data. Given a company permalink and optional refinements, the AI pipeline evaluates each candidate against the seed company’s product, customers and business model.Unlike Market Map, which starts from a market topic, Competitor List starts from a specific company.This is an asynchronous API. Starting the workflow returns a report_id, which you use to track completion and export the results. See How Async APIs work.Each peer includes firmographics, product profile, funding and headcount, financials (for public companies), M&A history, an Overall Score (1 to 10) measuring similarity to the seed company, and a Commentary explaining the overlap.Common use cases:
Competitive intelligence: build a vendor landscape around a specific company
Peer benchmarking: identify comparables for valuation or KPI analysis
Roll-up sourcing: find players similar to a platform company for bolt-on consolidation
The response contains a report_id.Step 2: Track completionUse /api/assets/get_notebook_status/ with the report_id to check whether the report has completed.Step 3: Export resultsOnce the report is complete, use /api/assets/download_report/ with the report_id to export the results.
3. Authentication
Include a Bearer token in the Authorization header of every request.
Authorization: Bearer <YOUR_API_TOKEN>
Obtain a token from the /auth/token/ endpoint using the client id and client secret under Account Details → API Credentials in the Wokelo dashboard. Contact support@wokelo.ai if you do not yet have API access.
Never expose your token in client-side code or public repositories.
4. Request Reference
Endpoint
POST https://api.wokelo.ai/api/workflow_manager/start/
The request body is JSON. Include advanced_settings in every request and send empty values ("", []) for filters you do not want to apply.
Parameter
Type
Required
Description
workflow
string
Required
Must be "company_peers".
workbook_name
string
Required
Name of the workbook that holds the generated report.
permalink
string
Required
Permalink or full URL of the seed company whose peers you want to find (e.g. "harvey-128b").
advanced_settings
object
Optional
Filter parameters. All filters below live inside this object.
advanced_settings.detailed_query
string
Optional
A descriptive query that refines what “similar” means for this run.
advanced_settings.companies
string[]
Optional
Permalinks or full URLs of additional representative companies to anchor the peer set.
advanced_settings.geography
string[]
Optional
["Worldwide"] for no restriction, or ISO country codes (e.g. ["USA", "GBR"]).
advanced_settings.company_type
string
Optional
"private", "public" or "all".
advanced_settings.employee_count
string[]
Optional
Headcount bands. Empty array includes all. Values: 1-10, 11-50, 51-100, 101-250, 251-500, 501-1000, 1001-5000, 5001-10000, 10000+.
advanced_settings.founded_year
object
Optional
Object with from and/or to (integer years, inclusive).
advanced_settings.funding_stage
string[]
Optional
Empty array includes all. Values: Non-Equity Assistance, Angel round, Pre-seed, Seed, Series A to Series J, Corporate-Funded, Debt-Funded, Private equity round, Others.
advanced_settings.total_funding
object
Optional
Object with from and/or to, in USD.
advanced_settings.total_funding_include_blanks
boolean
Optional
When true, companies with no reported total funding are included.