/importyeti/companies/search

POST /api/importyeti/companies/search

Price: 1 credit

Search US ocean-import trade records for businesses whose name matches a keyword. Returns US importers and their foreign counterparties with role, address, country, total recorded shipments, the date of the latest recorded shipment, and how many alternative names and addresses the same business ships under. Results can be narrowed by side of the trade, by shipment recency and by a minimum shipment count.

How to use it

Start here when you have a business name and need its ImportYeti id: every result carries the qualified id /importyeti/companies takes. Matching is on the business name only, not on products or HS codes. One real-world firm is usually split across several records, one per filer name and address, so expect near-duplicates and pick by address and total_shipments rather than assuming the first hit is the parent. A broad keyword matches far more businesses than can be served, so narrow the keyword or apply the filters instead of treating the result as the complete set of matches.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Business name to match, for example a brand, a legal name or a name fragment (examples: "nike", "kiefel", "shenzhen electronics"; minLength: 1)
• count integer required — Max number of results (min: 1; max: 140)
• profile_type string — Restrict to US importers (company), to their foreign counterparties (supplier), or return both sides (default: "both"; one of: "both", "company", "supplier")
• most_recent_shipment string — Keep only businesses whose latest recorded shipment falls inside this window (default: "any"; one of: "any", "6mo", "12mo")
• min_shipments integer nullable — Keep only businesses with strictly more recorded shipments than this (min: 0)
• include_related boolean — Also match businesses linked to the keyword through a trademark rather than by name (default: false)

Response

• @type string (default: "ImportyetiProfile")
• id string required
• alias string required
• role string required
• url string required
• name string nullable
• country_code string nullable
• address string nullable
• total_shipments integer nullable
• last_shipment_date string nullable
• other_addresses_count integer nullable
• other_names_count integer 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.