/cro/companies/quick-search

POST /api/cro/companies/quick-search

Price: 5 credits

Quick relevance-ranked lookup of Irish companies by name words or company number

How to use it

Relevance-ranked lookup of Irish companies by whole words of the name (RYAN does not find RYANAIR), or an exact company number; at most 10000 rows. Use cro/companies/search for prefix or substring matching and for more rows.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Words of the company name, or a company number (examples: "RYANAIR"; minLength: 1; maxLength: 150)
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "CroQuickSearchResult")
• reg_number string nullable
• name string nullable
• type string nullable
• type_id integer nullable
• status string nullable
• status_id integer nullable
• status_effective_date integer nullable
• reg_date integer nullable
• annual_return_due_date integer nullable
• dissolved_date integer nullable
• last_annual_return_date integer nullable
• last_accounts_date integer nullable
• name_effective_date integer nullable
• type_effective_date integer nullable
• nace_code string nullable
• principal_object_code string nullable
• address object nullable
  • @type string (default: "CroCompanyAddress")
  • address1 string nullable
  • address2 string nullable
  • address3 string nullable
  • address4 string nullable
  • postcode string nullable
  • full 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.