/importgenius/companies/search

POST /api/importgenius/companies/search

Price: 20 credits

Search one country's customs bill-of-lading records for businesses whose name matches a keyword. Each result carries the business id, the side it files under, its filed address, how many shipments it received and sent, the date of its latest shipment, the ports it uses, a year-by-year shipment history and its largest trading partners.

How to use it

Start here when you have a business name and need an ImportGenius id, because every other endpoint takes the qualified id this returns. The keyword only matches a substring of the filed business name — an HS code or a bill-of-lading number is not searched as such, though a numeric one can still coincidentally hit a business name that happens to contain the same digits. One real firm is usually split across several filer records, so pick by address and shipment_count rather than taking the first hit as the parent.

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: "walmart", "reliance", "trading"; minLength: 1)
• count integer required — Max number of results (min: 1; max: 500)
• market string — Customs dataset to search; each market holds its own businesses and its own ids (default: "us"; one of: "us", "argentina", "chile", "colombia", "costarica", "ecuador", "india", "panama", "paraguay", "peru", "ukraine", "uruguay", "venezuela", "vietnam")

Response

• @type string (default: "ImportgeniusProfile")
• id string required
• alias string required
• url string required
• country string required
• role string required
• name string required
• address string nullable
• shipment_count integer nullable
• inbound_shipment_count integer nullable
• outbound_shipment_count integer nullable
• last_shipment_date string nullable
• origin_ports array (default: [])
  • @type string (default: "ImportgeniusPort")
  • name string required
  • name_english string nullable
  • shipment_count integer nullable
• destination_ports array (default: [])
  • @type string (default: "ImportgeniusPort")
  • name string required
  • name_english string nullable
  • shipment_count integer nullable
• yearly_shipments array (default: [])
  • @type string (default: "ImportgeniusYearlyShipments")
  • start_date string required
  • end_date string nullable
  • trader_role string nullable
  • shipment_count integer nullable
• top_partners array (default: [])
  • @type string (default: "ImportgeniusTradePartner")
  • record_key string required
  • company string required
  • name string nullable
  • is_name_withheld boolean nullable
  • id string nullable
  • alias string nullable
  • url string nullable
  • partner_role string required
  • country string nullable
  • country_code string nullable
  • address string nullable
  • address_english string nullable
  • full_address string nullable
  • shipment_count integer nullable
  • overall_shipment_count integer nullable
  • container_count integer nullable
  • gross_weight_kg number nullable
  • gross_weight_lb number nullable
  • net_weight_lb number nullable
  • last_shipment_date 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.