Skip to main content

Introduction

PortPulse provides API-first metrics for port congestion, dwell, snapshots, trends, and alerts (HS imports in beta).
Outputs: JSON & CSV with strong ETag/304, a unified error model, and header auth via X-API-Key.

SLO/SLA at a glance

  • Endpoint latency: p95 < 300 ms (with edge caching)
  • Freshness: p95 ≤ 2 hours (per last_updated)
  • Availability: 99.9% SLA (for Pro and above)
    See details in SLA & Status.

Start here​

Tools & Integration​

One‑minute sanity check​

Use the demo key to make your first request:

BASE="https://api.useportpulse.com"
KEY="dev_demo_123"

curl -s "$BASE/v1/ports/USLAX/trend?days=30" -H "X-API-Key: $KEY" | head -n 3

Want CSV with strong ETag?

curl -sD - "$BASE/v1/ports/USLAX/trend?days=30&amp;format=csv" -H "X-API-Key: $KEY" \
  | awk 'BEGINIGNORECASE=1(/^etag:/){gsub(/["\r]/,"",$2);print $2}'

Continue in Quickstarts for Python/Node examples.

Operations​

Field dictionary​

See field-by-field definitions and units in Field Dictionary.

Open the full API Reference from the top navigation.

OpenAPI (Download)​

Use the button below to download the exact OpenAPI spec that this docs build uses.

👉 Download OpenAPI (JSON)