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
company_name
string
required

Exact company_name from companies/search.

Required string length: 1 - 200
Example:

"CATERPILLAR"

company_state
string | null

Restrict to one state; omit for all states.

Maximum string length: 2
Example:

"IL"

months
integer
default:12

Full calendar months ending last month. Use 24 or more for a year-over-year view.

Required range: 1 <= x <= 60

Response

OK

Import profile for one company. When found is true the totals, monthly series, breakdowns, and notes are returned.

company_name
string
required

The requested company name.

Example:

"CATERPILLAR"

company_state
string | null
required

The requested state, or null for all states.

since
string
required

First month of the period (inclusive).

Example:

"2025-10"

until
string
required

Last month of the period (inclusive).

Example:

"2026-09"

found
boolean
required

false when the exact name has no volume in the period. The name must match companies/search exactly; a company can also be split across several names.

totals
object
monthly
object[]

Volume per month, oldest first.

ports_of_discharge
object[]

US ports of discharge.

origin_countries
object[]

Origin countries.

carriers
object[]

Ocean carriers as spelled on manifests. Merge spelling variants before computing shares.

destination_states
object[]

Destination US states.

commodities_hs4
object[]

HS4 headings with estimated value.

notes
string[]

Counting caveats that apply to this response, for example that volume is physical containers or that the window includes a partial month. Surface these to end users.