/craft/companies/compare

POST /api/craft/companies/compare

Price: 10 credits

Compare up to 12 Craft (craft.co) companies side by side

How to use it

Compare up to 12 companies from Craft (craft.co) by alias or URL: headquarters, headcount and growth, valuation, funding, latest annual revenue and profit, and operating metrics, one result per company. Aliases Craft does not know are left out of the result.

Call these first: /craft/companies/search

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• companies array required — Craft company aliases or craft.co company URLs to compare (examples: ["apple","microsoft"], ["spacex","https://craft.co/blue-origin"]; minItems: 1; maxItems: 12)
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "CraftCompanyCard")
• id string required
• alias string nullable
• name string nullable
• url string nullable
• image string nullable
• description string nullable
• company_type string nullable
• founded_year integer nullable
• headquarters string nullable
• other_locations array (default: [])
• has_more_locations boolean nullable
• employee_count integer nullable
• employee_growth_percent number nullable
• valuation number nullable
• total_funding number nullable
• latest_funding_amount number nullable
• funding_currency string nullable
• tags array (default: [])
  • @type string (default: "CraftCardTag")
  • name string required
  • alias string nullable
  • is_primary boolean nullable
• financials object nullable
  • @type string (default: "CraftCardFinancials")
  • period_label string nullable
  • currency string nullable
  • revenue number nullable
  • cost_of_goods_sold number nullable
  • gross_profit number nullable
  • net_income number nullable
• operating_metrics array (default: [])
  • @type string (default: "CraftCardMetric")
  • name string required
  • group string nullable
  • value number nullable
  • currency string nullable
  • period_label 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 — None of the given aliases is a Craft company. 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.