/importgenius/companies

POST /api/importgenius/companies

Price: 5 credits

Get one business profile built from customs bill-of-lading filings: name, filed address, total shipments and the split between shipments received and sent, the ports it loads and unloads at, a year-by-year shipment history, one full sample bill of lading with its commodity codes, declared values, transport, customs and container detail, and the businesses that trade the same lanes with their own top partners, ports and countries.

How to use it

Pass the qualified id from /importgenius/companies/search, never a bare alias, which is rejected, and keep the role segment that search returned: in United States records importers/<alias> and suppliers/<alias> are two different businesses, and outside it a business is often published under both spellings but only the one the customs authority filed it under resolves here. What the sample bill of lading declares is a property of the market: United States filings carry vessel and container detail and no declared value at all, India and Ukraine a unit or invoice price instead of FOB and CIF, Vietnam only the agreed incoterm, Costa Rica CIF without FOB, and the remaining markets FOB usually together with CIF.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — ImportGenius business id as returned by search: importers/<alias> or suppliers/<alias> for United States customs records, <country>/<role>/<alias> for the other markets. A full importgenius.com profile URL also works (examples: "importers/walmart", "india/suppliers/dkh-retail-ltd", "ukraine/buyers/zevidon-trading-limited"; minLength: 1)

Response

• @type string (default: "ImportgeniusCompany")
• id string required
• alias string required
• url string required
• country string required
• role string required
• name string required
• address string nullable
• description string nullable
• shipment_count integer nullable
• inbound_shipment_count integer nullable
• outbound_shipment_count integer 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
• sample_shipment object nullable
  • @type string (default: "ImportgeniusSampleShipment")
  • shipment_id string nullable
  • bol string nullable
  • master_bol string nullable
  • arrival_date string nullable
  • added_date string nullable
  • consignee object nullable
    • @type string (default: "ImportgeniusShipmentConsignee")
    • name string nullable
    • id string nullable
    • url string nullable
    • filer_id string nullable
    • normalized_name string nullable
    • address string nullable
    • address_lines array (default: [])
    • address_parts object nullable
      • @type string (default: "ImportgeniusAddressParts")
      • street_number string nullable
      • street_name string nullable
      • street_pre_type string nullable
      • street_pre_directional string nullable
      • street_post_type string nullable
      • place_name string nullable
      • state_name string nullable
      • zip_code string nullable
      • country_name string nullable
    • street string nullable
    • street_number string nullable
    • city string nullable
    • state string nullable
    • zip_code string nullable
    • country string nullable
    • destination string nullable
    • contact string nullable
    • contacts array (default: [])
    • phone string nullable
    • fax string nullable
    • emails array (default: [])
  • shipper object nullable
    • @type string (default: "ImportgeniusShipmentShipper")
    • name string nullable
    • id string nullable
    • url string nullable
    • filer_id string nullable
    • normalized_name string nullable
    • address string nullable
    • address_lines array (default: [])
    • city string nullable
    • country string nullable
    • contact string nullable
  • origin_country string nullable
  • origin_country_english string nullable
  • departure_country string nullable
  • product_description string nullable
  • extra_descriptions array (default: [])
  • hs_code string nullable
  • hs_code_description string nullable
  • chapter_code string nullable
  • chapter_description string nullable
  • cn_code string nullable
  • cn_description string nullable
  • brand string nullable
  • brand_id string nullable
  • brand_fob number nullable
  • brand_quantity number nullable
  • variety string nullable
  • item string nullable
  • attributes string nullable
  • product_id string nullable
  • product_status string nullable
  • merchandise_state string nullable
  • quantity number nullable
  • quantity_unit string nullable
  • physical_quantity number nullable
  • physical_unit string nullable
  • previous_year_quantity number nullable
  • previous_year_unit string nullable
  • gross_weight number nullable
  • gross_weight_kg number nullable
  • gross_weight_lb number nullable
  • total_gross_weight number nullable
  • net_weight number nullable
  • net_weight_kg number nullable
  • net_weight_lb number nullable
  • total_net_weight number nullable
  • measurement number nullable
  • measurement_unit string nullable
  • package_count integer nullable
  • package_type string nullable
  • transport object nullable
    • @type string (default: "ImportgeniusShipmentTransport")
    • transportation_type string nullable
    • transport_type string nullable
    • company string nullable
    • agency string nullable
    • vessel string nullable
    • vessel_name string nullable
    • vessel_country string nullable
    • voyage_number string nullable
    • carrier_code string nullable
    • carrier_name string nullable
    • carrier_address string nullable
    • carrier_city string nullable
    • carrier_state string nullable
    • carrier_zip string nullable
    • place_of_receipt string nullable
    • embarkation string nullable
    • foreign_port string nullable
    • port string nullable
    • destination_port string nullable
    • destination_port_english string nullable
    • distribution_port string nullable
    • landing string nullable
    • load_type string nullable
    • bill_type_code string nullable
    • manifest_number string nullable
    • in_bond_entry_type string nullable
    • notify_party string nullable
    • notify_party_address string nullable
    • container_count integer nullable
    • container_types array (default: [])
    • marks_and_numbers array (default: [])
  • value object nullable
    • @type string (default: "ImportgeniusShipmentValue")
    • fob number nullable
    • total_fob number nullable
    • venezuela_fob number nullable
    • cif number nullable
    • total_cif number nullable
    • venezuela_cif number nullable
    • freight number nullable
    • total_freight number nullable
    • origin_freight number nullable
    • insurance number nullable
    • total_insurance number nullable
    • origin_insurance number nullable
    • tax number nullable
    • total_taxable number nullable
    • ad_valorem number nullable
    • total_invoice number nullable
    • invoice_price number nullable
    • price_usd number nullable
    • unit_price_usd number nullable
    • unit_price_eur number nullable
    • unit_price_inr number nullable
    • currency_ratio number nullable
    • amount number nullable
    • incoterms string nullable
    • payment_type string nullable
    • pay_type string nullable
  • customs object nullable
    • @type string (default: "ImportgeniusShipmentCustoms")
    • customs string nullable
    • custom string nullable
    • custom_code string nullable
    • custom_agent string nullable
    • declaration string nullable
    • declaration_number string nullable
    • declarant_name string nullable
    • declarant_address string nullable
    • control_id string nullable
    • operation_type string nullable
    • importer_id string nullable
    • acquisition string nullable
    • verifier string nullable
    • reviewer string nullable
    • review_type string nullable
    • payee_name string nullable
    • payee_address string nullable
    • bank string nullable
    • bank_number string nullable
    • remarks string nullable
    • trading_country string nullable
    • is_commercial string nullable
    • is_private string nullable
    • estate string nullable
    • extra_field string nullable
  • containers array (default: [])
    • @type string (default: "ImportgeniusShipmentContainer")
    • container_number string nullable
    • container_type string nullable
    • type_code string nullable
    • equipment_description string nullable
    • service_type string nullable
    • load_status string nullable
    • container_load string nullable
    • length number nullable
    • width number nullable
    • height number nullable
    • teu number nullable
    • raw_teu number nullable
    • seal_numbers array (default: [])
    • marks array (default: [])
    • hs_chapters array (default: [])
    • hazardous_materials array (default: [])
    • is_containerized boolean nullable
    • is_hazardous boolean nullable
    • is_refrigerated boolean nullable
    • is_heated boolean nullable
    • is_liquid boolean nullable
    • is_gas boolean nullable
    • is_livestock boolean nullable
    • is_automobile_carrier boolean nullable
    • cargoes array (default: [])
• related_companies array (default: [])
  • @type string (default: "ImportgeniusRelatedCompany")
  • name string required
  • id string nullable
  • url string nullable
  • country string nullable
  • country_english string nullable
  • country_code string nullable
  • shipment_count integer nullable
  • top_partners object nullable
    • @type string (default: "ImportgeniusPartnerBreakdown")
    • total_count integer nullable
    • other_count integer nullable
    • max_count integer nullable
    • entries array (default: [])
  • top_ports object nullable
    • @type string (default: "ImportgeniusPlaceBreakdown")
    • total_count integer nullable
    • other_count integer nullable
    • max_count integer nullable
    • entries array (default: [])
  • top_countries object nullable
    • @type string (default: "ImportgeniusPlaceBreakdown")
    • total_count integer nullable
    • other_count integer nullable
    • max_count integer nullable
    • entries array (default: [])

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 — No ImportGenius profile under that id 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.