/panjiva/companies

POST /api/panjiva/companies

Price: 5 credits

Company profile of a party that appears on US customs import records: identity and address, how its shipments split across partner countries and customs data sources, its top traded products and HS chapters, its most recent customs records, and one sample bill of lading.

How to use it

Use it to profile one importer or exporter once you already hold its Panjiva id — take the id from the shipper block of /panjiva/shipments/search, since Panjiva publishes no company search to guess one from a name. A field flagged is_masked is withheld by the source rather than empty, so treat it as unknown, and expect no goods description on the customs records listed here. The sample bill of lading is a single record whose labels follow whichever customs authority reported it, so read the names it returns instead of assuming a fixed schema.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Panjiva company id, its slug/id path, or the full company profile URL (examples: "27775255", "https://panjiva.com/Shanghai-Textile-Decoration-Corp-Group/27775255", "Mens-Fashion-Ltd/28825669"; minLength: 1)

Response

• @type string (default: "PanjivaCompany")
• id string required
• url string required
• alias string nullable
• name string required
• role string nullable (one of: "supplier", "buyer")
• address string nullable
• country string nullable
• website string nullable
• customs_record_count integer nullable
• trading_partner_count integer nullable
• country_shipments array (default: [])
  • @type string (default: "PanjivaCompanyCountry")
  • country_code string required
  • name string nullable
  • shipment_count integer nullable
• data_source_shipments array (default: [])
  • @type string (default: "PanjivaCompanyDataSource")
  • data_source string required
  • shipment_count integer nullable
• top_products array (default: [])
• top_hs_codes array (default: [])
  • @type string (default: "PanjivaHsCode")
  • code string required
  • description string nullable
• customs_records array (default: [])
  • @type string (default: "PanjivaCustomsRecord")
  • data_source string nullable
  • shipment_date string nullable
  • shipper string nullable
  • consignee string nullable
  • weight_kg number nullable
  • container_count integer nullable
• sample_bill_of_lading_fields array (default: [])
  • @type string (default: "PanjivaBillOfLadingField")
  • name string required
  • value string nullable
  • is_masked boolean (default: false)
• similar_companies array (default: [])
  • @type string (default: "PanjivaCompanyRef")
  • id string required
  • url string required
  • name string nullable
• research_articles array (default: [])
  • @type string (default: "PanjivaResearchArticle")
  • url string required
  • article_title string nullable
  • author string nullable
  • published_date string nullable
  • excerpt string nullable
  • image 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 — Panjiva serves no public profile page for this id, which also happens for a minority of the shipper ids its own shipment records link to. 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.