API reference

Hotels

Resolve a destination, search, read the rates of one hotel, book. Searching is billable; a booking is charged to your account.

Operations

OperationWhat it doesScope
GET/v1/hotels/destinationsResolve a place name to something searchablehotels:search
POST/v1/hotels/searchesStart a search — billablehotels:search
GET/v1/hotels/searches/{id}Current state of a search — freehotels:search
PATCH/v1/hotels/searches/{id}Refine a search — billable only if it reaches the supplierhotels:search
POST/v1/hotels/searches/{id}/load-moreFetch more results — billablehotels:search
GET/v1/hotels/{hotelId}/ratesThe bookable rates of one hotel — billablehotels:search
GET/v1/hotels/bookingsYour hotel bookings, newest firsthotels:book
POST/v1/hotels/bookingsBook a rate — charged to your accounthotels:book
GET/v1/hotels/bookings/{id}One bookinghotels:book
POST/v1/hotels/bookings/{id}/cancelCancel a bookinghotels:book

A key that lacks one of these scopes is refused with 403 insufficient_scope, and error.missingScope names the one it was missing. Scopes are fixed when the key is issued.

Shared across these operations

The error envelope and the full list of error types are the same for every operation in the API, as are the object schemas the responses are built from. Neither is repeated per page.