Developer docs

API Documentation

Base URL: https://api.straitsignal.com

Locations

GET/api/locations

List all tracked chokepoints and ports with current risk summary.

GET/api/locations/{id}/current

Get full live metrics for a specific location.

  • id — Location identifier (e.g. suez, panama, singapore)
GET/api/locations/{id}/history

Get historical daily metrics for a location.

  • id — Location identifier
  • window — Time window: 7d, 30d, 90d, 365d (default: 30d)
  • start — Start date (YYYY-MM-DD)
  • end — End date (YYYY-MM-DD)

Route Risk

GET/api/routes/risk

Score route risk between two ports by the chokepoints it transits.

  • origin — UN/LOCODE (e.g. SGSIN)
  • destination — UN/LOCODE (e.g. NLRTM)

Alerts

GET/api/alerts

List active disruption alerts.

  • location_id — Filter by location (optional)
  • severity — Filter: info, warning, critical (optional)

Webhooks

POST/api/webhooks/test

Send a test webhook to verify your endpoint.

  • body: { "url": "https://your-server.com/hook" }

Authentication

Include your API key in the Authorization header:

Authorization: Bearer ss_live_your_api_key_here