Skip to main content
PARTNER DEVELOPERS

Build with DirectStay's catalog

The Catalog API gives partners read-only access to the stays, destinations, hosts and verified local providers on DirectStay, the same facts our own pages show.

What you can read

  • Stays

    Published listings with search, details, availability, price estimates and side-by-side compare.

  • Destinations

    Cities, regions and national parks with live stays, each with its areas, attractions and stays.

  • Hosts and providers

    Public host reviews and rating summaries, and verified provider profiles.

  • Reference data

    Property types, amenities, features, bed types, cancellation policies and badges.

How it works

  • Your key

    DirectStay issues each partner a key. Send it in the x-api-key header. Keys are read-only and carry scopes; catalog.read covers every route below.

  • Rate limits

    100 requests a minute per key unless agreed otherwise, and some keys also have a daily quota. Over a limit you get 429 with a Retry-After header, in seconds. A key can be locked to your servers' IP addresses; other addresses get 403.

  • Versions

    Routes are served under /api/v1/catalog, and every response carries X-API-Version: 1.

  • Responses

    A success is { success: true, data, meta }. A list is data.data with its paging in data.pagination. Errors carry error.code.

  • From the browser

    Callable from any origin (Access-Control-Allow-Origin: *), without credentials.

Endpoints

All are GET, under /api/v1. Parameters and response shapes are in the full API reference.

Stays

  • /catalog/propertiesSearch published listings
  • /catalog/properties/{slug}One listing by slug or id
  • /catalog/properties/{slug}/availabilityBlocked and unavailable dates
  • /catalog/properties/{slug}/pricing-estimateA nightly price estimate for a stay
  • /catalog/properties/compareCompare up to 5 listings
  • /catalog/properties/locationsCities and states with stays within a radius

Destinations and listings

  • /catalog/destinationsDestinations with live stays
  • /catalog/destinations/{type}/{slug}/expandedA destination with the first page of its references
  • /catalog/destinations/{type}/{slug}/{relation}A page of one kind of reference
  • /catalog/listingsDestinations, properties, providers or blog posts

Hosts and providers

  • /catalog/hosts/{hostId}/reviewsA host's public reviews and rating
  • /catalog/providers/{idOrSlug}A provider profile

Reference data

  • /catalog/reference/typesProperty types and subtypes
  • /catalog/reference/amenitiesAmenities (also /tree)
  • /catalog/reference/featuresProperty features (also /tree)
  • /catalog/reference/bed-typesBed types with sleep capacity
  • /catalog/reference/cancellation-policiesCancellation policies
  • /catalog/reference/badge-definitionsProperty badges
  • /catalog/taxonomy/property-typesActive property types (and their subtypes)

Request access

Tell us who you are and what you'll build. We review every request; once it's approved, we email you a one-time link to your key, with the limits we set for it.

What do you need?