Boat Listing API Documentation
Query Parameters
The following parameters can be used to filter and paginate the listings.
per_page
Type: int
Optional: Yes
Description: Number of listings per page
Allowed values: 1-100
page
Type: int
Optional: Yes
Description: Page number to retrieve
Allowed values: 1, 2, 3, ...
schema
Type: bool
Optional: Yes
Description: If true, returns example output with field descriptions
Allowed values: true/false
Response Schema
The following schema describes the structure of the response data.
meta
Type: object
Optional: No
Description: Metadata about the response
schema_version
Type: string
Optional: No
Description: Version of the schema
page
Type: int
Optional: No
Description: Current page number
per_page
Type: int
Optional: No
Description: Number of items per page
total
Type: int
Optional: No
Description: Total number of items
total_pages
Type: int
Optional: No
Description: Total number of pages
listings
Type: array
Optional: No
Description: Array of listings
id
Type: string
Optional: No
Description: Stable Boatshed listing ID
provenance
Type: string
Optional: No
Description: Type of provenance
Default: boatshed_verified
title
Type: string
Optional: No
Description: Listing title
make
Type: string
Optional: No
Description: Boat make
model
Type: string
Optional: No
Description: Boat model
year
Type: int
Optional: No
Description: Year of build
price
Type: float as string
Optional: No
Description: Current asking price (numeric only)
original_price
Type: float as string
Optional: No
Description: Original asking price (numeric only)
currency
Type: string
Optional: No
Description: ISO 4217 currency code (e.g., GBP, USD, EUR)
price_updated_at
Type: string
Optional: Yes
Description: Last price change (ISO 8601 UTC)
price_history
Type: array
Optional: Yes
Description: History of price changes
price_updated_at
Type: string
Optional: No
Description: Price change time (ISO 8601 UTC)
old_price
Type: float as string
Optional: No
Description: Old price (numeric only)
naw_price
Type: float as string
Optional: No
Description: Now price (numeric only)
location_city
Type: string
Optional: No
Description: City of the listing
location_country
Type: string
Optional: No
Description: Country (ISO 3166-1 alpha-2 preferred)
length_m
Type: float as string
Optional: No
Description: Length in metres (numeric only)
beam_m
Type: float as string
Optional: Yes
Description: Beam in metres (numeric only)
draft_m
Type: float as string
Optional: Yes
Description: Draft in metres
status
Type: string
Optional: No
Description: Listing status
Enum values: active, sold, withdrawn
listing_type
Type: string
Optional: No
Description: Listing type
Enum values: used, used, new
boat_name
Type: string
Optional: Yes
Description: Boat name
fuel_type
Type: string
Optional: No
Description: Fuel type
Enum values: diesel, petrol, petrol, petrol, electric, hybrid, other, other
hull_material
Type: string
Optional: No
Description: Hull material
Enum values: GRP, steel, aluminium, wood, composite, other, other, composite, steel, other, other, other, other, steel, other
underwater_profile
Type: string
Optional: No
Description: Underwater profile
Enum values: planing, multihull, semi-displacement, full-displacement
keel_type
Type: string
Optional: Yes
Description: Keel type (omit for motorboats)
Enum values: fin, bilge, lifting, wing, shallow, tandem, fin_bulb, canting_fin_bulb, shallow_bilge
engines
Type: array
Optional: Yes
Description: List of engines
make_model
Type: string
Optional: No
Description: Engine make & model
power_hp
Type: float
Optional: No
Description: Engine power in HP
fuel_type
Type: string
Optional: No
Description: Engine fuel type
Enum values: diesel, petrol, electric, hybrid, other
hours
Type: int
Optional: Yes
Description: Hours of operation
updated_at
Type: string
Optional: No
Description: Last modified time (ISO 8601 UTC)
url
Type: string
Optional: No
Description: Canonical Boatshed URL
photos
Type: array
Optional: No
Description: List of photos (at least one)
url
Type: string
Optional: No
Description: Public image URL
thumbnail_url
Type: string
Optional: No
Description: Public thumbnail URL
caption
Type: string
Optional: Yes
Description: Caption
primary
Type: bool
Optional: Yes
Description: Defines if this is the primary photo
broker
Type: object
Optional: No
Description: Broker details
name
Type: string
Optional: No
Description: Broker name
Type: string
Optional: No
Description: Broker public email
phone
Type: string
Optional: No
Description: Broker public phone