> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Booking.com booking.com Search API
> Scrape Booking.com search results with prices. Call the Booking.com booking.com Search API for JSON. 1 credit per call. Every call returns the same flat shape.
Scrape Booking.com search results with prices.
## Request
`query` is required.
```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null}
import { Stophy } from "stophy";
const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.booking.search({ query: "Lisbon", checkIn: "2026-11-23" });
console.log(result.data.results);
```
```python Python icon="python" theme={null}
from stophy import Stophy
stophy = Stophy() # reads STOPHY_API_KEY
result = stophy.booking.search(query="Lisbon", check_in="2026-11-23")
print(result["data"]["results"])
```
```bash cURL icon="terminal" theme={null}
curl -X POST https://api.stophy.dev/v1/booking/search \
-H "Authorization: Bearer $STOPHY_API_KEY" \
-H "content-type: application/json" \
-d '{"query":"Lisbon","checkIn":"2026-11-23"}'
```
```bash CLI icon="square-terminal" theme={null}
stophy booking search Lisbon --checkIn 2026-11-23
```
## Response
If successful, the response body contains the standard envelope. `data.results[]` contains the hotels, each with its price, taxes, review score and address.
The following example is a real response, truncated: each list shows one item and long strings are cut.
```json theme={null}
{
"success": true,
"data": {
"place": "Lisbon",
"checkIn": "2026-11-23",
"checkOut": "2026-11-24",
"total": 1886,
"results": [
{
"position": 1,
"hotelId": "16673871",
"hotelUrl": "https://www.booking.com/hotel/pt/varandas-da-bica-room.html",
"name": "Varandas da Bica room",
"reviewScore": 7.7,
"reviews": 40,
"price": 51.39,
"taxesAndFees": 8.96,
"originalPrice": 85.65,
"priceCurrency": "USD",
"address": "Travessa da Laranjeira 29",
"city": "Lisboa",
"countryCode": "pt",
"area": "Misericordia, Lisbon",
"distanceText": "0.5 miles from downtown",
"latitude": 38.7100533,
"longitude": -9.1465548,
"imageUrl": "https://cf.bstatic.com/xdata/images/hotel/square600/886948570.jpg?k=86334b99abc0f00afa920678a67992ab39820df3198e0419842…",
"hasFreeCancellation": false
}
],
"cursor": "-VNPCx2jeyJvZmZzZXQiOjI1LCJzZWVuIjpbMTY2NzM4NzEsMzk3MTksNDc4MzgsMTIwNjM1MDksNTA4MjUyMywzMTU0NDIsMTI2MzQ3OSwyMDIxMjMxLDE…"
},
"creditsUsed": 1,
"requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}
```
| Field | Type | Description |
| - | - | - |
| `cursor` | string | The pagination token. Pass it as `cursor` to retrieve the next page. Omitted on the last page. |
| `total` | integer | The total number of matching results, across all pages. |
| `position` | integer | The 1-based position of the result in the list. |
| `reviews` | integer | The number of reviews the rating is based on. |
For every field, see the response schema on this page.
## Optional parameters
| Parameter | Type | Description |
| - | - | - |
| `checkIn` | string (date) | The check-in date. Defaults to tomorrow. Format: `YYYY-MM-DD`. |
| `checkOut` | string (date) | The check-out date. Defaults to one night after `checkIn`. Format: `YYYY-MM-DD`. |
| `adults` | integer | Adults across all rooms. Prices are for the whole group. Must be between 1 and 30. If unset, defaults to `2`. |
| `rooms` | integer | Rooms to book, at most one per adult. Prices are for all rooms together. Must be between 1 and 30. If unset, defaults to `1`. |
| `currency` | string | Three-letter currency code, such as `USD`. If unset, defaults to `USD`. |
| `sort` | string | Booking.com's own Sort by: relevance (Our top picks) or distance (closest to the center of the place first). Acceptable values are `relevance` and `distance`. If unset, defaults to `relevance`. |
| `cursor` | string | The pagination token from the previous response. |
## Billing
Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.
## Pagination
Results are paginated. To retrieve the next page, pass the value of `data.cursor` as `cursor` in a subsequent request. A response that omits `cursor` is the last page.
## Related methods
* [Booking.com booking.com Hotel](/api-reference/endpoint/booking-hotel): Accepts `hotelUrl`. Scrape a Booking.com hotel page.
* [Booking.com booking.com Hotel Reviews](/api-reference/endpoint/booking-hotel-reviews): Accepts `hotelUrl`. Scrape a Booking.com hotel's guest reviews.
## OpenAPI
````yaml api-reference/openapi.json POST /v1/booking/search
openapi: 3.1.0
info:
title: Stophy API
version: '1'
description: >-
Every endpoint is a POST that takes its input as a JSON object body. Unknown
fields are rejected with 400.
Responses leave out empty values: null, empty strings, empty objects and
empty nested lists are not sent.
Text comes back whole. To get shorter responses, add
?maxTextLength= to the URL. Every text value longer than that is
cut and ends with …. A screenshot is never cut, and a page whose text was
cut has isTruncated set to true.
x-credits is what one call costs. Every call costs the same, whatever it
returns, unless an operation's description says it costs per 10 results, or
per second of audio. Then x-credits is the lowest price and x-credits-max
the most one call can cost. Where an operation takes limit, send it to
return fewer results and pay for fewer.
When a response has a cursor, send it back unchanged with the same input to
get the next page. When it has a page, send the next page number.
servers:
- url: https://api.stophy.dev
security:
- apiKey: []
paths:
/v1/booking/search:
post:
summary: Scrape Booking.com search results with prices
description: Costs 1 credit per call. Pages with cursor.
operationId: bookingSearch
parameters:
- $ref: '#/components/parameters/MaxTextLength'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
query:
type: string
minLength: 2
maxLength: 200
description: 'Where to stay: a city, region or landmark, like Lisbon.'
checkIn:
description: Defaults to tomorrow.
type: string
format: date
pattern: >-
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
checkOut:
description: Defaults to one night after checkIn.
type: string
format: date
pattern: >-
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
adults:
default: 2
description: Adults across all rooms. Prices are for the whole group.
type: integer
minimum: 1
maximum: 30
rooms:
default: 1
description: >-
Rooms to book, at most one per adult. Prices are for all
rooms together.
type: integer
minimum: 1
maximum: 30
currency:
default: USD
type: string
pattern: ^[A-Z]{3}$
description: ISO 4217 currency code, e.g. USD.
sort:
default: relevance
description: >-
Booking.com's own Sort by: relevance (Our top picks) or
distance (closest to the center of the place first).
type: string
enum:
- relevance
- distance
cursor:
type: string
minLength: 1
description: The cursor from the previous response. Send it as is.
required:
- query
additionalProperties: false
example:
query: Lisbon
checkIn: '2026-11-23'
responses:
'200':
description: The data, and the credits this call used.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
x-credits-used:
$ref: '#/components/headers/CreditsUsed'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
x-cache:
$ref: '#/components/headers/Cache'
x-cache-age:
$ref: '#/components/headers/CacheAge'
content:
application/json:
schema:
type: object
required:
- success
- data
- creditsUsed
- requestId
properties:
success:
const: true
data:
type: object
additionalProperties: false
properties:
place:
type: string
checkIn:
type: string
format: date
pattern: >-
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
checkOut:
type: string
format: date
pattern: >-
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
total:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
results:
type: array
items:
type: object
additionalProperties: false
properties:
position:
type: integer
minimum: 1
maximum: 9007199254740991
hotelId:
type: string
hotelUrl:
type: string
format: uri
name:
type: string
reviewScore:
type: number
minimum: 0
maximum: 10
reviews:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
price:
description: >-
Price of the whole stay for all rooms. Null when
the hotel has no room for these dates and
guests, which Booking.com's own page shows as
not found.
type: number
minimum: 0
taxesAndFees:
type: number
minimum: 0
originalPrice:
type: number
minimum: 0
priceCurrency:
type: string
stars:
type: integer
minimum: 1
maximum: 5
address:
type: string
city:
type: string
countryCode:
type: string
area:
type: string
distanceText:
type: string
latitude:
type: number
minimum: -90
maximum: 90
longitude:
type: number
minimum: -180
maximum: 180
imageUrl:
type: string
format: uri
hasFreeCancellation:
type: boolean
required:
- position
- hotelUrl
- hasFreeCancellation
cursor:
type: string
required:
- checkIn
- checkOut
- results
creditsUsed:
type: integer
requestId:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
components:
parameters:
MaxTextLength:
name: maxTextLength
in: query
required: false
description: >-
Cut every text value in the response to this many characters. A value
that was cut ends with …, and a page whose text was cut has isTruncated
set to true. A screenshot is never cut. Leave it out to get the full
text.
schema:
type: integer
minimum: 1
headers:
RequestId:
description: The request id. Quote it when you report a problem.
schema:
type: string
CreditsUsed:
description: Credits this call used.
schema:
type: integer
RateLimitLimit:
description: Requests allowed in the current window.
schema:
type: integer
RateLimitRemaining:
description: Requests left in the current window.
schema:
type: integer
RateLimitReset:
description: Unix time in seconds when the current window resets.
schema:
type: integer
Cache:
description: hit if this result came from the cache, miss if it was fetched live.
schema:
type: string
CacheAge:
description: Seconds since the returned result was written to the cache.
schema:
type: integer
RetryAfter:
description: Seconds to wait before retrying.
schema:
type: integer
responses:
Error:
description: The request failed. retryable says whether trying again can help.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
Retry-After:
$ref: '#/components/headers/RetryAfter'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
required:
- success
- error
properties:
success:
const: false
error:
type: object
required:
- code
- message
- retryable
- requestId
properties:
code:
type: string
enum:
- cliSessionCompleted
- cliSessionExists
- cliSessionNotFound
- forbidden
- insufficientCredits
- internalError
- inviteClaimed
- inviteDisabled
- inviteExpired
- inviteUsedUp
- invalidCliSession
- invalidCliVerifier
- invalidRequest
- notFound
- rateLimited
- sourceChanged
- sourceRefused
- sourceTimeout
- sourceUnavailable
- tooManyInFlight
- unauthorized
- unsupportedMediaType
message:
type: string
retryable:
type: boolean
retryAfterSeconds:
type: integer
requestId:
type: string
requiredCredits:
type: number
availableCredits:
type: number
billingUrl:
type: string
const: https://stophy.dev/billing
securitySchemes:
apiKey:
type: http
scheme: bearer
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.