Charter Boats API

Quick Start

Start importing boats in under 5 minutes

This guide walks you through importing a boat listing using the Charter Boats API.

Prerequisites

  • An API key (contact api@charter.boats)
  • Boat details ready (title, location, capacity, etc.)

Import Your First Boat

1. Prepare your request

Create a JSON payload with your boat details:

{
  "title": "Luxury Catamaran - BALI 4.6",
  "description": "Beautiful 46ft catamaran perfect for day trips.",
  "location_city": "Miami",
  "location_state": "Florida",
  "boat_type": "catamaran",
  "capacity": 10,
  "price_per_hour": 350,
  "price_per_day": 2500,
  "owner_email": "captain@example.com",
  "images": [
    "https://example.com/boat-exterior.jpg",
    "https://example.com/boat-interior.jpg"
  ],
  "amenities": ["WiFi", "Air Conditioning", "Snorkeling Equipment"]
}

2. Send the request

curl -X POST https://charter.boats/api/import/boat \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "title": "Luxury Catamaran - BALI 4.6",
    "location_city": "Miami",
    "location_state": "Florida",
    "boat_type": "catamaran",
    "capacity": 10,
    "price_per_day": 2500,
    "owner_email": "captain@example.com"
  }'

3. Check the response

A successful response returns the created boat:

{
  "success": true,
  "boat": {
    "id": "abc123-def456-...",
    "title": "Luxury Catamaran - BALI 4.6",
    "boat_type": "catamaran",
    "is_published": true
  },
  "images_uploaded": 0,
  "amenities_added": 3,
  "view_url": "https://charter.boats/boats/abc123-def456-..."
}

Next Steps

On this page