API Documentation

The Ship Talkers API serves the same numbers the website shows: global stats, live boards, per-user and per-channel stats, and search. Everything is JSON.

Base URL

  • https://shiptalkers.kirze.de/api/v1

All endpoints are versioned under /api/v1.

Authentication

Keys are issued on demand from your account page while signed in, stored hashed, and can be revoked at any time. Send one as Authorization: Bearer <key>.

curl -H "Authorization: Bearer shiptalkers_..." \
     https://shiptalkers.kirze.de/api/v1/me

Only GET /api/v1/me, the key management endpoints, and the grants endpoints require a key or session. All other endpoints work without one. Reading someone else's data requires their key, or a grant they issue to your key (see Grants).

Errors

Errors use the following shape:

{
  "error": "human-readable message"
}