Charter Boats API

API Reference

Complete reference for the Charter Boats API

Base URL

All API endpoints are relative to:

https://charter.boats/api

Authentication

Most endpoints require an API key passed in the X-API-Key header. See Authentication for details.

Response Format

All responses are JSON. Successful responses typically include:

{
  "success": true,
  "data": { ... }
}

Error responses include:

{
  "statusCode": 400,
  "message": "Error description"
}

Available Endpoints

Boats

MethodEndpointDescription
GET/boatsList all boats
GET/boats/:idGet boat details
POST/import/boatImport a new boat

Bookings

MethodEndpointDescription
GET/bookingsList user's bookings
POST/bookingsCreate a booking
GET/bookings/:idGet booking details

Calendar

MethodEndpointDescription
GET/calendar/:boatId/export.icsExport boat calendar

HTTP Status Codes

CodeDescription
200Success
201Created
400Bad Request - Invalid parameters
401Unauthorized - Missing or invalid API key
404Not Found
429Rate Limited
500Server Error

On this page