Getting Started

All requests to the Panjiva API are based on HTTP and require the use of Bearer Tokens to authenticate. The endpoints are structured using a REST methodology with common HTTP methods such as get, post, and common HTTP response codes such as 200, 404, and 500.

What are the endpoints?

Each available endpoint and its respective parameters are detailed in the associated API Reference.

Building a Search

All searches against the Panjiva API are constructed in two parts, the selection criteria and the operation.

Selection Criteria

The selection criteria specifies the set of shipment records to perform the subsequent operation against, and is generally the same format across all endpoints with the specific data-source, free-text search, and strict filters.

Selection Examples

Examples such as targeting a shipment's destination or the contents of a shipment are available within the examples section.

Operations

Once a set of records are selected, the records may either be retrieved or analyzed further using different aggregation methods. The exact operation to perform is dictated by the specific endpoint used.

Entity Schemas

The structure for Shipment Records and Company Entities are briefly described in the Entity Schema section.