toolzerhub API Docs

Search stays

Search Airbnb stays for a destination, with optional dates and guest counts. Check location.resolved before treating results as a destination match.

1 credit / requestBilled only on success
GET
/v1/airbnb/stays/search

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Query Parameters

destination*string

City, region, neighbourhood, or address to search. Check location.resolved; an unrecognized destination can return unrelated stays.

Length1 <= length <= 200
count?integer

Maximum stays to return. Check has_more to see whether more results are available.

Range1 <= value <= 270
Default18
checkin?string

Check-in date, ISO YYYY-MM-DD. Must be given together with checkout. When both are set, prices come back for that stay length rather than Airbnb's default window.

Match^\d{4}-\d{2}-\d{2}$
checkout?string

Check-out date, ISO YYYY-MM-DD. Must be after checkin.

Match^\d{4}-\d{2}-\d{2}$
adults?integer

Number of adult guests (1-16).

Range1 <= value <= 16
children?|

Number of children (0-15).

Range0 <= value <= 15
infants?|

Number of infants (0-5).

Range0 <= value <= 5
curl -X GET "https://example.com/v1/airbnb/stays/search?destination=San+Francisco%2C+CA" \  -H "x-api-key: YOUR_API_KEY"
{  "data": {    "stays": [      {        "id": "string",        "url": "string",        "name": "string",        "title": "string",        "subtitle": "string",        "coordinate": {          "latitude": 0,          "longitude": 0        },        "price": {          "label": "string",          "amount": "string",          "original_amount": "string",          "qualifier": "string"        },        "rating": {          "score": 0,          "reviews": 0,          "label": "string"        },        "pictures": [          "string"        ]      }    ],    "count": 0,    "has_more": true,    "location": {      "resolved": true,      "place_id": "string",      "canonical_location": "string"    }  }}