Docs

Getting started

Launch the NTHMAP map, create an API key, and make your first request in under five minutes.

NTHMAP is a physical-world intelligence platform. It layers live vessels, infrastructure, world events, commodity prices, and AI insights on a single interactive map. The same data is available through a REST API, a command-line tool, and an MCP server for AI agents.

This page gets you from zero to a working request in five minutes.

1. Create an account

Visit the app and click Sign in. Create an account with an email and password. You'll start on the free tier — enough to explore the vessels and infrastructure layers.

Upgrade to Pro ($149/mo) to unlock events, chokepoints, draw tools, AI flow analysis, saved prompts, full API + CLI + MCP access, and 10 alert regions.

2. Explore the map

The app is divided into four zones:

  • Left sidebar — layer toggles, per-layer filters, draw tools, saved views, saved prompts
  • Map — Leaflet canvas with vessel markers, infrastructure icons, event pulses, and chokepoint zones
  • Right panel — appears when you click any vessel, asset, or event
  • Bottom ticker — 12 commodity prices scrolling live

Try clicking a vessel marker. The right panel shows position, speed, estimated cargo, load percentage, destination, and (on Pro) an AI trading context summary.

3. Create your first API key

On Pro, you can generate API keys for automated access:

  1. Launch the map at /app
  2. Click your avatar in the top-right
  3. Click Account settings (coming soon — use the CLI login command for now to generate a key)

Or via the API directly while logged in:

curl https://nthmap.com/api/keys/ \
  -X POST \
  -H "content-type: application/json" \
  -b cookies.txt \
  -d '{"name":"My laptop","scopes":["read"]}'

The response includes a token field starting with ntm_live_copy it now, it's only shown once.

4. Make your first API request

With your API key, you can hit any read endpoint:

curl "https://nthmap.com/api/vessels?bbox=54,25,58,28&types=Crude+Tanker" \
  -H "Authorization: Bearer ntm_live_..."

You'll get a JSON array of crude tankers in the Persian Gulf. That same query from the CLI:

$ nthmap vessels list --bbox 54,25,58,28 --types "Crude Tanker"

Or via an AI agent using the MCP server:

"How many crude tankers are currently in the Strait of Hormuz?"

5. Where to next

  • Concepts — how NTHMAP models the physical world
  • API reference — every endpoint, every parameter
  • CLI — command-line tool installation and usage
  • MCP server — give your AI agents physical-world context
  • Use cases — 16 vertical market playbooks

Status & support

NTHMAP is under active development. File issues, request features, or ask questions by emailing hello@nthmap.com.