Houfy Open API › Get started

Get started with the Houfy API

Make your first API call and connect your inventory to the direct-booking marketplace — listings, rates, availability, reservations and guest messaging over plain JSON REST.

Authentication

Every request carries two headers. Unauthorized calls receive 401.

Authtoken — self-serve: in your Houfy account open Settings & Privacy → API access token and generate one.
Authkey — identifies your integration and is issued privately by Houfy. Email info@houfy.com; request it before your build starts.
Rate limit — 60 requests per minute per API key. Spread bulk syncs (e.g. rate pushes across a large portfolio) over time, and use the booking webhooks instead of polling reservations.

The base URL is https://api.houfy.com. Send and expect Content-Type: application/json on every call.

Quickstart

Set your credentials

Export both values as environment variables. The commands below read them from $HOUFY_AUTHTOKEN and $HOUFY_AUTHKEY.

Shell

export HOUFY_AUTHTOKEN="your-token-here"
export HOUFY_AUTHKEY="your-key-here"

Make your first API call

List the (100% complete) listings on your account:

cURL

curl https://api.houfy.com/users/listings \
  -H "Authtoken: $HOUFY_AUTHTOKEN" \
  -H "Authkey: $HOUFY_AUTHKEY" \
  -H "Content-Type: application/json"

Read the response

Each listing arrives with its verification and completion state. Note that numeric ids are serialized as strings on this endpoint.

Response · 200

{
  "listings": [
    {
      "id": "77555",
      "listingName": "Premium Villa with panoramic view",
      "user_id": "51637",
      "listing_photo": "https://www.assets.houfy.com/assets/images/properties/…",
      "active": "Y",
      "verified": "Y",
      "percentage": "100",
      "co_host": "N"
    }
  ]
}

Downloads

Everything you need to explore the API in your own tools.

Postman collection

All 21 requests with auth headers, example bodies and per-field documentation.

Postman environment

base_url, authtoken, authkey, listing_id and rescode variables, ready to fill in.

OpenAPI 3.0 spec

The machine-readable source of truth behind this documentation, in YAML.

Using AI tools

Building the integration with a coding assistant? The complete reference is published machine-readable — point your agent at llms.txt, or hand it the single-file markdown reference: every endpoint with field types, required flags and example bodies in one fetch.

Webhooks

Register a callback URL in your account settings (or via POST /users/updateuser) and Houfy notifies it with an HTTP GET carrying notification_id, listing_id, log_object and a unix timestamp. Reservation events (req.acc, req.dec, req.can, req.mark, req.changed) are instant; other changes batch every 10 minutes. Delivery is at-least-once within 24 hours — make your receiver idempotent and never treat it as the only source of booking state. Full object types are documented in the Notifications section of the reference.