/ares/companies/search

POST /api/ares/companies/search

Price: 5 credits

Search Czech companies in the ARES registry by name, address, ICO and other criteria

How to use it

Search Czech companies by name, registered-office address, municipality code, ICO, legal form, financial authority or economic activity code.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• name string nullable — Company name to search for (examples: "Seznam")
• ico array nullable — One or more identification numbers (ICO)
• text_address string nullable — Registered-office address text to match (examples: "Brno")
• municipality_code integer nullable — Registered-office municipality code (RUIAN kodObce) (examples: 582786)
• cz_nace array nullable — CZ-NACE economic activity codes (examples: ["62"])
• legal_form array nullable — Legal form codes (examples: ["112"])
• legal_form_ros array nullable — Legal form codes in the register of persons (examples: ["112"])
• financial_authority array nullable — Financial authority codes (examples: ["004"])
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "AresCompany")
• ico string required
• name string required
• dic string nullable
• legal_form string nullable
• legal_form_ros string nullable
• financial_authority string nullable
• created_at string nullable
• dissolved_at string nullable
• updated_at string nullable
• primary_source string nullable
• cz_nace array
• address object nullable
  • @type string (default: "AresAddress")
  • text string nullable
  • street string nullable
  • house_number integer nullable
  • orientation_number integer nullable
  • orientation_number_letter string nullable
  • city string nullable
  • city_part string nullable
  • district string nullable
  • region string nullable
  • postal_code integer nullable
  • country string nullable
  • country_code string nullable
• mailing_address object nullable
  • @type string (default: "AresMailingAddress")
  • line1 string nullable
  • line2 string nullable
  • line3 string nullable
• registrations object nullable
  • @type string (default: "AresRegistrations")
  • public_register string nullable
  • trade_register string nullable
  • statistical_register string nullable
  • register_of_persons string nullable
  • vat 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.