Skip to main content
POST

Authorizations

Authorization
string
header
required

Use a Terminal49 API key in the Authorization header with the Token prefix.

Authorization: Token YOUR_API_KEY

Body

application/json

Give name, imports, or both. With neither, lists the largest importers matching the filters.

name
string | null

Company name; partial or misspelled is fine (fuzzy match). Results are ranked by match quality, not size, so a close but small match can outrank a large importer.

Maximum string length: 200
Example:

"home depot"

imports
string | null

What the company imports, in plain words (semantic match).

Maximum string length: 200
Example:

"frozen shrimp"

state
string | null

US state code of the importer.

Maximum string length: 2
Example:

"FL"

port_of_discharge
string | null

Substring of a US port name.

Maximum string length: 200
Example:

"Long Beach"

origin_country
string | null

Substring of an origin country.

Maximum string length: 200
Example:

"Vietnam"

min_containers
integer | null

Minimum containers in the index window.

Required range: x >= 1
limit
integer
default:10

Maximum results to return.

Required range: 1 <= x <= 50

Response

OK

index
object
required

Index window, freshness, and counts. Also returned as index by companies/search.

results
object[]
required

Matches ordered by score.