Quick start

From an API key to a typed client, in three steps. If you do not have a key yet, Getting Started covers the account side first.

Put your key in the environment

Never paste a key into source. Read it from the environment or a secrets manager.

Make a call

Everything lives under https://api.polestar-production.com. Send the key in the api-key header.

A 200 with a meta block and a data array means you are through. A 401 means the header name or value is wrong; see Authentication.

Generate a client instead of hand-writing one

Every endpoint here comes from an OpenAPI 3.1 contract, and that contract is downloadable from this site. Point your generator at it. Hand-written request and response types drift as the contract moves; generated ones do not.

Start with a read

/vessel-insights/v1/vessel-search and /zone-port-insights/v1/zones are read-only, but remember there is no test environment; use Cloud Mock if you want a safe place to experiment. Leave POST and DELETE until you mean them: a POST to a notifications endpoint creates a real subscription.

Testing & Sandbox covers the mock server.

Build with an assistant

Assistants read this documentation alongside your developers. Three ways to give one access, in rising order of effort.

MCP

llms.txt

OpenAPI

Connect this documentation to Cursor, Claude Code, Cline or any MCP-capable editor. The assistant can then read these endpoints, schemas and examples directly, so it writes against the real contract instead of guessing.

{
  "mcpServers": {
    "polestar-api": {
      "command": "npx",
      "args": ["-y", "apidog-mcp-server@latest", "--site-id=773590"]
    }
  }
}

No credentials needed: it reads the published documentation, not your account.

The contract is the source of truth

Endpoint pages on this site come from the OpenAPI contract running in production. If an endpoint is documented here, it is live. Parameter tables, error bodies and auth requirements are not repeated in prose; each endpoint page renders them straight from the contract.

Then what

Concepts & Terminology

Vessels, voyages, zones and fleets, and how they relate.

Pagination & Filtering

Walking list results, and narrowing them before you do.

Errors & Status Codes

Every code, body and retry rule.

Build with an assistant#

Then what#

Build with an assistant

Then what