Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get the current credential"
description: "Identify the API key or signed-in user behind a request, the Terminal49 account it is scoped to, and which gated features that credential can use on that account."
description: "Identify the API key or signed-in user behind a request, the Terminal49 account it is scoped to, and which gated features that credential can use."
og:title: Current Credential | Terminal49 API Documentation
og:description: Call GET /me to learn which account and credential a Terminal49 API request uses and which features are available to it.
openapi: get /me
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Cancel a tracking request"
description: "Cancel a pending or awaiting_manifest tracking request in the Terminal49 API so Terminal49 stops trying to find the shipment."
description: "Cancel a pending or awaiting_manifest tracking request in the Terminal49 API so Terminal49 stops searching carriers for the container or shipment."
og:title: Cancel a Tracking Request | Terminal49 API
og:description: Cancel a tracking request that is still pending or awaiting_manifest. The request moves to status cancelled with failed_reason Cancelled by user.
openapi: patch /tracking_requests/{id}/cancel
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get an importer profile"
description: "Get one importer's monthly container history, ports of discharge, origin countries, carriers, destination states, and HS4 commodities from US import bill-of-lading records."
description: "Get an importer's monthly container history, ports of discharge, origin countries, carriers, and HS4 commodities from US import bill-of-lading records."
og:title: Importer Profile | Terminal49 API Documentation
og:description: Pull an importer's monthly ocean import history and trade lanes with Terminal49's trade intelligence API.
openapi: post /trade_intel/companies/profile
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get import trends"
description: "Get monthly, quarterly, or yearly series of containers, TEUs, or estimated value, split by up to two dimensions and filtered by company, commodity, lane, or carrier."
description: "Get monthly, quarterly, or yearly series of containers, TEUs, or estimated value, split by dimension and filtered by company, commodity, lane, or carrier."
og:title: Import Trends | Terminal49 API Documentation
og:description: Chart US ocean import trends by commodity, origin, port, carrier, or company with Terminal49's trade intelligence API.
openapi: post /trade_intel/trends
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Rank importers"
description: "Rank US importers by physical containers for an HS4 heading, port of discharge, or origin country over full calendar months."
description: "Rank US importers by physical container count for an HS4 commodity heading, port of discharge, or origin country over full calendar months of data."
og:title: Top US Importers | Terminal49 API Documentation
og:description: Rank the largest US importers of a commodity, through a port, or from a country with Terminal49's trade intelligence API.
openapi: post /trade_intel/importers/top
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get a vessel by ID"
description: "Retrieve a vessel on one of your actively tracked shipments by its Terminal49 vessel ID, including name, IMO number, and current position. Requires Routing Data."
description: "Retrieve a vessel on your actively tracked shipments by its Terminal49 vessel ID, including name, IMO number, and current position. Requires Routing Data."
og:title: Get a Vessel by ID | Terminal49 API
og:description: Retrieve vessel details by Terminal49 resource ID. Returns the vessel name, IMO number, current position, flag, and linked shipment information.
openapi: get /vessels/{id}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get a vessel by IMO"
description: "Retrieve a vessel on one of your actively tracked shipments by its IMO number, including name, Terminal49 vessel ID, and current position. Requires Routing Data."
description: "Retrieve a vessel on your actively tracked shipments by its IMO number, including name, Terminal49 vessel ID, and current position. Requires Routing Data."
og:title: Get a Vessel by IMO Number | Terminal49 API
og:description: Look up vessel details by IMO number using the Terminal49 API. Returns the vessel name, current position, flag, and associated shipment data.
openapi: get /vessels/{imo}
Expand Down
2 changes: 1 addition & 1 deletion docs/coverage/inland-rail-terminals.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Inland rail terminals"
description: "Search the complete Terminal49 inland rail terminal location catalog by name, location, UN/LOCODE, FIRMS code, or SPLC."
description: "Search the complete Terminal49 inland rail terminal catalog by name, city, UN/LOCODE, FIRMS code, or SPLC to find supported rail ramps and intermodal yards."
mode: "wide"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/data/coverage/rail-carriers.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Rail carrier coverage reference"
description: "Complete feature coverage with explicit statuses and public integration identifiers."
description: "Rail carrier coverage reference listing each railroad's SCAC and support status for rail milestones, availability, and rail last free day (LFD) data."
---

Last updated 2026-10-13.
Expand Down
2 changes: 1 addition & 1 deletion docs/data/coverage/shipping-lines.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Shipping line coverage reference"
description: "Complete feature coverage with explicit statuses and public integration identifiers."
description: "Shipping line coverage reference listing each ocean carrier's SCAC and support status for bill of lading, booking, container tracking, and milestone data."
---

Last updated 2026-10-13.
Expand Down
2 changes: 1 addition & 1 deletion docs/data/coverage/terminals.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Terminal coverage reference"
description: "Complete feature coverage with explicit statuses and public integration identifiers."
description: "Terminal coverage reference listing each container terminal's UN/LOCODE, SMDG, and FIRMS codes plus support status for availability, holds, and LFD data."
---

Last updated 2026-10-13.
Expand Down
2 changes: 1 addition & 1 deletion docs/mcp/setup/antigravity.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Connect Antigravity to Terminal49"
sidebarTitle: "Antigravity"
description: "Add the Terminal49 MCP server to Google Antigravity and sign in with your Terminal49 account."
description: "Add the Terminal49 MCP server to Google Antigravity with mcp_config.json and sign in with OAuth so its Gemini agent can answer container tracking questions."
keywords:
- "Terminal49 MCP server"
- "Google Antigravity"
Expand Down
2 changes: 1 addition & 1 deletion docs/mcp/setup/gemini.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Connect Gemini to Terminal49"
sidebarTitle: "Gemini"
description: "Add the Terminal49 MCP server as a custom app in the Gemini app and sign in with your Terminal49 account."
description: "Add the Terminal49 MCP server as a custom app in the Gemini app, sign in with OAuth, and ask Gemini about live container and shipment tracking data."
keywords:
- "Terminal49 MCP server"
- "Gemini"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: CustomFieldDefinitionListFilters"
description: "CustomFieldDefinitionListFilters interface in the Terminal49 TypeScript SDK, filtering custom field definitions by data type, display name, or entity type."
---

# Interface: CustomFieldDefinitionListFilters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: CustomFieldDefinitionListOptions"
description: "CustomFieldDefinitionListOptions interface in the Terminal49 TypeScript SDK, the filters and call options accepted by customFieldDefinitions.list."
---

# Interface: CustomFieldDefinitionListOptions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: CustomFieldListFilters"
description: "CustomFieldListFilters interface in the Terminal49 SDK, filtering custom field values by definition ID, entity ID, or entity type in customFields.list."
---

# Interface: CustomFieldListFilters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: TriggerWebhookParams"
description: "TriggerWebhookParams interface in the Terminal49 SDK, setting the webhook event name and document type used by triggerWebhook to send test payloads."
---

# Interface: TriggerWebhookParams
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: VesselFuturePositionsParams"
description: "VesselFuturePositionsParams interface in the Terminal49 SDK, setting the destination port ID used by getVesselFuturePositions to estimate a route."
---

# Interface: VesselFuturePositionsParams
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: VesselFuturePositionsWithCoordsParams"
description: "VesselFuturePositionsWithCoordsParams interface in the Terminal49 SDK, adding a latitude and longitude start point for vessel future position estimates."
---

# Interface: VesselFuturePositionsWithCoordsParams
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: WebhookNotificationGetOptions"
description: "WebhookNotificationGetOptions interface in the Terminal49 SDK, setting response format and includes when fetching one webhook notification by ID."
---

# Interface: WebhookNotificationGetOptions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: WebhookNotificationListOptions"
description: "WebhookNotificationListOptions interface in the Terminal49 TypeScript SDK, setting pagination, response format, and includes for listWebhookNotifications."
---

# Interface: WebhookNotificationListOptions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: DocumentManager"
description: "DocumentManager class in the Terminal49 SDK, used to upload, list, update, rotate, reclassify, re-extract, relink, and download shipping documents."
---

# Class: DocumentManager
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: DocumentSchemaManager"
description: "DocumentSchemaManager class in the Terminal49 SDK, used to fetch the extraction schema that defines the fields Terminal49 reads from a document type."
---

# Class: DocumentSchemaManager
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: EmailSubmissionManager"
description: "EmailSubmissionManager class in the Terminal49 TypeScript SDK, used to list email submissions and fetch a single forwarded email submission by its ID."
---

# Class: EmailSubmissionManager
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Class: TradeIntelManager"
description: "TradeIntelManager class in the Terminal49 SDK for US import bill-of-lading data: search importers and commodities, rank importers, and chart trends."
---

# Class: TradeIntelManager
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: ContainerAddPartyRoleParams"
description: "ContainerAddPartyRoleParams interface in the Terminal49 TypeScript SDK, the party ID and pickup_dray_carrier role used to assign a party to a container."
---

# Interface: ContainerAddPartyRoleParams
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: CreateDocumentParams"
description: "CreateDocumentParams interface in the Terminal49 SDK, the signed blob ID, display name, and attributes accepted by DocumentManager.create uploads."
---

# Interface: CreateDocumentParams
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: DocumentListFilters"
description: "DocumentListFilters interface in the Terminal49 SDK, filtering DocumentManager.list results by document type, filename full-text match, and more."
---

# Interface: DocumentListFilters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: ShipmentAddPartyRoleParams"
description: "ShipmentAddPartyRoleParams interface in the Terminal49 SDK, assigning a party to a shipment as customer, shipper, consignee, broker, or forwarder."
---

# Interface: ShipmentAddPartyRoleParams
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: TradeIntelBillOfLadingLookupOptions"
description: "TradeIntelBillOfLadingLookupOptions interface in the Terminal49 TypeScript SDK, setting how many months back lookupBillOfLading searches US import records."
---

# Interface: TradeIntelBillOfLadingLookupOptions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Interface: UpdateDocumentParams"
description: "UpdateDocumentParams interface in the Terminal49 SDK, the document type, classification notes, and other attributes accepted by DocumentManager.update."
---

# Interface: UpdateDocumentParams
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: ContainerUpdateAttributes"
description: "ContainerUpdateAttributes type alias in the Terminal49 TypeScript SDK, the writable container attributes sent in a PATCH /containers/{id} update request."
---

# Type Alias: ContainerUpdateAttributes
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: DocumentRotation"
description: "DocumentRotation type alias in the Terminal49 TypeScript SDK, the 90, 180, or 270 degree values accepted when rotating an uploaded document with rotate."
---

# Type Alias: DocumentRotation
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: ShipmentUpdateAttributes"
description: "ShipmentUpdateAttributes type alias in the Terminal49 SDK, the writable shipment attributes for PATCH /shipments/{id}. Each list replaces the old one."
---

# Type Alias: ShipmentUpdateAttributes
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TrackingRequestUpdateAttributes"
description: "TrackingRequestUpdateAttributes type alias in the Terminal49 SDK, the writable tracking request attributes. Passing ref_numbers replaces the list."
---

# Type Alias: TrackingRequestUpdateAttributes
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelBillOfLadingLookup"
description: "TradeIntelBillOfLadingLookup type alias in the Terminal49 SDK, the response of POST /trade_intel/bills_of_lading/lookup for US import B/L records."
---

# Type Alias: TradeIntelBillOfLadingLookup
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelBreakdown"
description: "TradeIntelBreakdown type alias in the Terminal49 SDK, the response of POST /trade_intel/breakdown splitting US import volume by chosen dimensions."
---

# Type Alias: TradeIntelBreakdown
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelBreakdownRequest"
description: "TradeIntelBreakdownRequest type alias in the Terminal49 SDK, the request body for POST /trade_intel/breakdown with dimensions, measures, and filters."
---

# Type Alias: TradeIntelBreakdownRequest
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelCommoditySearchRequest"
description: "TradeIntelCommoditySearchRequest type alias in the Terminal49 SDK, the request body for POST /trade_intel/commodities/search to find HS4 commodities."
---

# Type Alias: TradeIntelCommoditySearchRequest
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelCommoditySearchResponse"
description: "TradeIntelCommoditySearchResponse type alias in the Terminal49 SDK, the matching HS commodities returned by POST /trade_intel/commodities/search."
---

# Type Alias: TradeIntelCommoditySearchResponse
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelCompanyProfile"
description: "TradeIntelCompanyProfile type alias in the Terminal49 SDK, the importer profile returned by POST /trade_intel/companies/profile from US import data."
---

# Type Alias: TradeIntelCompanyProfile
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelCompanyProfileRequest"
description: "TradeIntelCompanyProfileRequest type alias in the Terminal49 SDK, the request body for POST /trade_intel/companies/profile to load an importer profile."
---

# Type Alias: TradeIntelCompanyProfileRequest
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelCompanySearchRequest"
description: "TradeIntelCompanySearchRequest type alias in the Terminal49 SDK, the request body for POST /trade_intel/companies/search to find US importers by name."
---

# Type Alias: TradeIntelCompanySearchRequest
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelCompanySearchResponse"
description: "TradeIntelCompanySearchResponse type alias in the Terminal49 SDK, the list of matching US importers returned by POST /trade_intel/companies/search."
---

# Type Alias: TradeIntelCompanySearchResponse
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelCompanySearchResult"
description: "TradeIntelCompanySearchResult type alias in the Terminal49 SDK, a single matching US importer returned in the searchCompanies trade intelligence results."
---

# Type Alias: TradeIntelCompanySearchResult
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelContainerLookup"
description: "TradeIntelContainerLookup type alias in the Terminal49 SDK, the response of POST /trade_intel/containers/lookup for a container's US import records."
---

# Type Alias: TradeIntelContainerLookup
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelDimension"
description: "TradeIntelDimension type alias in the Terminal49 SDK, a dimension accepted by group_by in trade intelligence trends and by dims in breakdown requests."
---

# Type Alias: TradeIntelDimension
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelFilters"
description: "TradeIntelFilters type alias in the Terminal49 SDK, the company, commodity, lane, and carrier filters accepted by trade intelligence trends and breakdown."
---

# Type Alias: TradeIntelFilters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelMeasure"
description: "TradeIntelMeasure type alias in the Terminal49 SDK, a measure such as containers, TEUs, or estimated value accepted by trade intel trends and breakdown."
---

# Type Alias: TradeIntelMeasure
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelMeta"
description: "TradeIntelMeta type alias in the Terminal49 SDK, the index window, data freshness, and record counts returned by GET /trade_intel/meta for US imports."
---

# Type Alias: TradeIntelMeta
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelTopImporters"
description: "TradeIntelTopImporters type alias in the Terminal49 SDK, the ranked list of US importers by container count returned by POST /trade_intel/importers/top."
---

# Type Alias: TradeIntelTopImporters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelTopImportersRequest"
description: "TradeIntelTopImportersRequest type alias in the Terminal49 SDK, the request body for POST /trade_intel/importers/top to rank importers by HS4 or lane."
---

# Type Alias: TradeIntelTopImportersRequest
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelTrends"
description: "TradeIntelTrends type alias in the Terminal49 TypeScript SDK, the monthly, quarterly, or yearly US import time series returned by POST /trade_intel/trends."
---

# Type Alias: TradeIntelTrends
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: TradeIntelTrendsRequest"
description: "TradeIntelTrendsRequest type alias in the Terminal49 SDK, the request body for POST /trade_intel/trends with interval, measure, group_by, and filters."
---

# Type Alias: TradeIntelTrendsRequest
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Type Alias: PartyAttributes"
description: "PartyAttributes type alias in the Terminal49 SDK, the party attributes such as company name and contact details accepted by parties.create and update."
---

# Type Alias: PartyAttributes
Expand Down
Loading
Loading