Skip to main content
Cost: 25 credits
POST
/
companies
/
similar
/
deep
Similar companies API (deep)
curl --request POST \
  --url https://api.workfloo.ws/v0/companies/similar/deep \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://workfloows.com",
  "language": "en"
}
'
{
  "response": {
    "success": true,
    "job": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "limits": {
        "current": 1,
        "remaining": 9,
        "max": 10
      }
    }
  }
}
This is async API. Use the /jobs/{jobId} endpoint to check job status and retrieve results.
Asynchronous version of Similar companies API which offers more detailed analysis, additional language parameter support and results list of max 25 similar companies.
On average, it takes 2-5 minutes to complete the job. You can run max 10 concurrent jobs per account.
Creates an asynchronous job to find similar companies based on a given company URL and optional language parameter. Returns a job ID that can be used to check the status and retrieve results when the analysis is complete.
If you want to research companies based on a specific language, use optional language parameter.
Each item of the complete analysis results list includes company:
  • name,
  • URL,
  • description,
  • similarity score (from 0 to 1, where 1 is the most similar).
This API endpoint automatically manages proxy and CAPTCHA solving.
Job results are available for 24 hours after the job is completed.

​
Optional

You can use optional language parameter to research companies based on a specific language. If provided, the analysis will run research focusing on keywords in the specified language. Helps to narrow the search results to a specific language/region. Supported languages: en, es, de, fr, pt, it, nl, pl, tr.
CodeLanguage
enEnglish
esSpanish
deGerman
frFrench
ptPortuguese
itItalian
nlDutch
plPolish
trTurkish

​
Example workflow

1

Create job

Make a POST /companies/similar/deep request including url parameter (and optional language parameter if needed).
2

Check status

Make a GET /jobs/{jobId} request to check job status. It usually takes 2-5 minutes to complete the job. Until the job is completed, the response will include status: "pending" or status: "processing".
3

Retrieve results

When the job is completed (status: "completed"), you will receive results in the response to your request for check status (GET /jobs/{jobId}). Job results are available for 24 hours.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
url
string<uri>
required

Target URL to find similar companies for (including protocol)

Example:

"https://workfloows.com"

​
language
enum<string>

Target language for analysis (optional)

Available options:
en,
es,
de,
fr,
pt,
it,
nl,
pl,
tr
Example:

"en"

Response

Job created successfully

​
response
object