Skip to main content

Documentation Index

Fetch the complete documentation index at: https://terminal49-codex-docs-audit-diataxis-skill.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The Terminal49 TypeScript SDK lets you track containers, retrieve shipment data, and receive status updates from your Node.js applications.

Requirements

Install

npm install @terminal49/sdk
Package links:

Support policy

  • Runtime support: Node.js 18 or later.
  • Browser, Deno, and Bun runtimes are not currently documented as supported targets.
  • Versioning follows npm package versions. Pin a specific version in production and review the changelog before upgrading.
  • License terms are governed by Terminal49’s API terms. The npm package metadata does not currently declare an open-source license.

Setup

Store your API key as an environment variable:
export T49_API_TOKEN=your_api_key
Then initialize the client:
import { Terminal49Client } from '@terminal49/sdk';

const client = new Terminal49Client({
  apiToken: process.env.T49_API_TOKEN!,
});

What you can do

  • Track containers — Create tracking requests by container number, booking number, or bill of lading
  • List shipments and containers — Query with filters by status, port, carrier, or date
  • Get transport events — Pull milestones, timestamps, and location updates
  • Fetch routing details — See the full journey including vessels and ports
For real-time updates, set up webhooks to receive status changes as they happen.

Next steps

Quickstart

Track your first container in 5 minutes

Methods Reference

See all available SDK methods

TypeScript API Reference

Browse SDK classes, interfaces, and types