Resources/Docs & API
◆ Developer docs

Build against the hull layer.

Every BoaterOS dealership gets a first-class REST API, webhooks for every event, TypeScript and Python SDKs, and a full sandbox with seeded inventory. Build custom portals, custom integrations, custom everything.

  • OpenAPI 3.1 spec with auto-generated reference
  • TypeScript + Python SDKs (Ruby + Go in Q2)
  • Webhooks for every event · signed · idempotent
  • Sandbox with seeded inventory, no credit card
Explore the API Get a sandbox key
Quickstart

Your first request, in 60 seconds.

terminal · curl
# GET a hull by ID
curl https://api.boater.os/v1/hulls/hull_YDV48219 \
  -H "Authorization: Bearer $BOATEROS_KEY" \
  -H "Accept: application/json"
200 OK · application/json
{
  "id": "hull_YDV48219",
  "hin": "GRT40912B324",
  "make": "Grady-White",
  "model": "Freedom 307",
  "year": 2024,
  "length_ft": 31.17,
  "price_usd": 324900,
  "status": "available",
  "location_id": "loc_ftmyers",
  "photos": [
    "https://cdn.boater.os/h/YDV48219/01.jpg",
    "https://cdn.boater.os/h/YDV48219/02.jpg"
  ],
  "created_at": "2026-03-22T14:12:04Z"
}
Full quickstart TypeScript SDK Python SDK
Docs by section

Pick a lane.

Guides

Common builds, done right.

The builds we see most, written by the engineers who built them.

01 Ingesting from DockMaster
02 Real-time inventory sync to your website
03 Building a custom dealer portal
04 Syndication webhook → Boat Trader
05 AI Companion: embedding on your site
06 TCPA consent capture
07 Stripe Terminal mobile deposits
08 Extending the Service module
All systems operational
v2026.4 · p99 < 180ms · uptime 99.98%
status.boater.os
Talk to us

The developer hotline.

api@boater.os

Questions, bug reports, SDK requests. Reply within one business day.

Discord community

2,400 developers building on BoaterOS. Engineers from our team staff #help daily.

Office hours

Thursdays 2–4pm ET. Drop in with an API question or a design review.