/craft/companies/search

POST /api/craft/companies/search

Price: 1 credit

Search Craft (craft.co) companies by name, type, sector, location and headcount

How to use it

Search the Craft (craft.co) company catalogue by name or keywords, company type, sector alias, country or city, and headcount range. Each result carries the alias that the other /craft/companies endpoints take, with headquarters, headcount and revenue in USD.

Call these first: /craft/companies/autocomplete

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of results (min: 1; max: 525)
• query string — Company name or keywords (default: ""; examples: "tesla", "payments")
• company_types array — Company types to include (default: []; one of: "public", "private", "subsidiary", "investor"; examples: ["public"], ["private","subsidiary"])
• sectors array — Sector aliases (default: []; examples: ["technology"], ["commercial-banks","investment-banks"])
• locations array — Countries or cities to include (default: []; examples: ["US"], ["Berlin, DE","GB"])
• hq_only boolean — Match locations against the headquarters only, not every office (default: true)
• employees_min integer nullable — Minimum number of employees (min: 0)
• employees_max integer nullable — Maximum number of employees (min: 0)
• sort string — Result order (default: "relevance"; one of: "relevance", "name_asc", "name_desc", "employees_desc", "employees_asc")

Response

• @type string (default: "CraftSearchCompany")
• 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
• employee_count integer nullable
• employee_growth number nullable
• revenue_usd number nullable
• headquarters object nullable
  • @type string (default: "CraftSearchHeadquarters")
  • city string nullable
  • state string nullable
  • country_code string nullable
• tags array (default: [])
  • @type string (default: "CraftTag")
  • name string required
  • alias 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 — The entity was not found, or a precondition failed 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.