/owler/companies/competitors

POST /api/owler/companies/competitors

Price: 5 credits

Get the competitor graph for an Owler (owler.com) company by alias or profile URL

How to use it

Get the competitor graph for an Owler (owler.com) company by alias or profile URL. Returns each competitor with its name, alias, CEO and approval rating, headquarters, founding year, company type, annual revenue, employee count and total funding.

Call these first: /owler/companies/search

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Company alias (the URL segment, e.g. 'uber') or a full company profile URL (examples: "uber", "https://www.owler.com/company/uber"; minLength: 1; pattern: ^(?:https?://[^\s]+|[A-Za-z0-9][A-Za-z0-9._-]*)$)
• count integer required — Max number of competitors to return (min: 1)

Response

• @type string (default: "OwlerCompetitor")
• id integer nullable
• name string required
• alias string nullable
• url string nullable
• website string nullable
• image string nullable
• ceo object nullable
  • @type string (default: "OwlerCeo")
  • name string required
  • rating integer nullable
  • image string nullable
  • linkedin_url string nullable
  • twitter_url string nullable
• headquarters object nullable
  • @type string (default: "OwlerHeadquarters")
  • city string nullable
  • state string nullable
  • country string nullable
• founded integer nullable
• company_type string nullable
• revenue number nullable
• revenue_range string nullable
• formatted_revenue string nullable
• employee_count integer nullable
• employee_range string nullable
• formatted_employee_count string nullable
• total_funding number nullable
• formatted_funding string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Company not found. Use /owler/companies/search to find the correct alias. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.