> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** <https://www.socialfetch.dev/docs/api/v1/airbnb/search/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/airbnb/search/get.mdx>

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** <https://www.socialfetch.dev/openapi.json>

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 1112 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).
- Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`).

---
# Search Airbnb stays (https://www.socialfetch.dev/docs/api/v1/airbnb/search/get)

## Summary

Search Airbnb stays in a place for your dates and guests, with prices, ratings and photos.

**Tags:** `Airbnb`

## HTTP

- **Method:** GET
- **Path:** `/v1/airbnb/search`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.airbnb.searchStays({ location: "London", adults: 2, currency: "USD" })`
- **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore`
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`

## Credits

- 1 credit
- Failed requests are free
- Found, empty and not-found answers are all charged

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `location` (query)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 100
- **Description:** Where to stay: a city, region, neighbourhood or address, as you would type it on the site, e.g. `London` or `Hay-on-Wye`. Add the country to tell places apart, e.g. `Paris, France`.

### `checkIn` (query)

- **Required:** no
- **Constraints:** type `string`
- **Description:** Check-in date, `YYYY-MM-DD`. Pass it with `checkOut`. Default: no dates, so each listing is priced for the next dates it is free (its own `checkIn` and `checkOut` say which).

### `checkOut` (query)

- **Required:** no
- **Constraints:** type `string`
- **Description:** Check-out date, `YYYY-MM-DD`, after `checkIn`.

### `adults` (query)

- **Required:** no
- **Constraints:** type `integer`; default: `1`; minimum: 1; maximum: 16
- **Description:** Adults, 1 to 16. Default 1.

### `children` (query)

- **Required:** no
- **Constraints:** type `integer`; default: `0`; minimum: 0; maximum: 15
- **Description:** Children aged 2 to 12, 0 to 15. Default 0.

### `infants` (query)

- **Required:** no
- **Constraints:** type `integer`; default: `0`; minimum: 0; maximum: 5
- **Description:** Infants under 2, 0 to 5. Default 0.

### `pets` (query)

- **Required:** no
- **Constraints:** type `integer`; default: `0`; minimum: 0; maximum: 5
- **Description:** Pets, 0 to 5. Default 0.

### `currency` (query)

- **Required:** no
- **Constraints:** type `string`; default: `USD`
- **Description:** Currency for prices, a three-letter code such as `USD`, `EUR` or `GBP`. Default `USD`.

### `cursor` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1; maxLength: 4096; pattern: `^[A-Za-z0-9_.-]+$`
- **Description:** Pass `page.nextCursor` from the previous response to get the next page. It only works with the same parameters. Omit it for the first page.

## Pagination

This endpoint uses **cursor-based pagination** via the `cursor` query parameter.

- Read **hasMore** from `data.page.hasMore`.
- When that value is `true`, read **nextCursor** from `data.page.nextCursor` and pass it as the `cursor` query parameter on the **next** request (URL-encode when building a query string).
- Omit `cursor` on the **first** request.
- Stop when **hasMore** is `false` or **nextCursor** is null (end of list).

## Responses (status codes)

- **200**: Airbnb stays for a place and dates.
- **400**: Invalid request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed.
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Airbnb stays for a place and dates.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. `found` when the site placed the location, with an empty list when nothing is free; `not_found` when it could not place it.
  - **location** (required) — type `string`. The `location` searched.
  - **resolvedLocation** (required) — type `string`; nullable. The place the site matched it to, e.g. `London, United Kingdom`. Check it: a vague location can match somewhere else. Null when `lookupStatus` is `not_found`.
  - **checkIn** (required) — type `string`; nullable. Check-in date searched, if any.
  - **checkOut** (required) — type `string`; nullable. Check-out date searched, if any.
  - **adults** (required) — type `integer`. Adults searched.
  - **children** (required) — type `integer`. Children searched.
  - **infants** (required) — type `integer`. Infants searched.
  - **pets** (required) — type `integer`. Pets searched.
  - **currency** (required) — type `string`. Currency of every price.
  - **totalResults** (required) — type `integer`; nullable. Matching stays the site reports, when it gives a number; null when it says only `Over 1,000`.
  - **totalResultsText** (required) — type `string`; nullable. The site's own count line, e.g. `Over 1,000 homes in London`.
  - **listings** (required) — type `array`. A page of up to 18 listings in the site's own order. The site re-ranks between requests, so a listing an earlier page returned is left out of later pages, and a page can hold fewer rows.
    - _items:_
      - **listingId** (required) — type `string`. Listing id. Pass it as `listingId` to the listing, reviews and availability endpoints.
      - **url** (required) — type `string`. Listing URL on airbnb.com.
      - **name** (required) — type `string`; nullable. Listing name the host gave it.
      - **title** (required) — type `string`; nullable. Card heading, e.g. `Apartment in Shoreditch` or a hotel's name.
      - **subtitle** (required) — type `string`; nullable. Card line under the heading, e.g. `Hotel in City of London`.
      - **area** (required) — type `string`; nullable. Neighbourhood or town the card names, e.g. `Camden`.
      - **coordinates** (required) — type `object`; nullable. Map position as the site shows it: for most homes an approximate point near the listing, never the exact address.
      - **rating** (required) — type `number`; nullable. Average guest rating out of 5; null for a new listing.
      - **reviewCount** (required) — type `integer`; nullable. Reviews behind the rating; null for a new listing.
      - **isNew** (required) — type `boolean`. True when the card shows `New` instead of a rating.
      - **isGuestFavorite** (required) — type `boolean`. Whether the card carries the `Guest favorite` badge.
      - **isSuperhost** (required) — type `boolean`. Whether the card carries the `Superhost` badge.
      - **badges** (required) — type `array`. Badges as shown, e.g. `Guest favorite`.
        - _items:_
          - type `string`
      - **highlights** (required) — type `array`. Details the card lists, e.g. `2 king beds`, `1 bath`.
        - _items:_
          - type `string`
      - **offers** (required) — type `array`. Booking messages the card shows, e.g. `Free cancellation`.
        - _items:_
          - type `string`
      - **photos** (required) — type `array`. Photo URLs the card shows. Links only; not hosted by Social Fetch.
        - _items:_
          - type `string`
      - **propertyId** (required) — type `string`; nullable. Hotel or property id, for a room in a hotel; null for a home.
      - **checkIn** (required) — type `string`; nullable. Check-in date the price is for, `YYYY-MM-DD`: your `checkIn`, or the listing's next free dates when you passed none.
      - **checkOut** (required) — type `string`; nullable. Check-out date the price is for, `YYYY-MM-DD`.
      - **price** (required) — type `object`; nullable. Price for the stay; null when the card shows none.
  - **page** (required) — type `object`
    - **page** (required) — type `integer`. Page number of this response, from 1.
    - **hasMore** (required) — type `boolean`. Whether another page is available.
    - **nextCursor** (required) — type `string`; nullable. Pass as `cursor` to get the next page; null on the last page.
    - **lastPage** (required) — type `integer`; nullable. Last page the site offers for this search, at most 15.
    - **truncated** (required) — type `boolean`. True when more stays match than the site's 15 pages reach: the list ends early. Narrow the search (dates, a smaller place) to reach the rest.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.
  - **stale** (optional) — type `boolean`; enum: true. Present, and `true`, only when the source couldn't be reached and this is the last good answer for the same request instead, up to 24 hours old. Absent on every live answer.
  - **fetchedAt** (optional) — type `string`. When a stale answer (`stale: true`) was originally fetched (ISO 8601, UTC). Absent on every live answer.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "location": "London",
    "resolvedLocation": "London, United Kingdom",
    "checkIn": "2027-01-16",
    "checkOut": "2027-01-19",
    "adults": 2,
    "children": 1,
    "infants": 0,
    "pets": 0,
    "currency": "EUR",
    "totalResults": null,
    "totalResultsText": "Over 1,000 homes in London",
    "listings": [
      {
        "listingId": "1500167927972092778",
        "url": "https://www.airbnb.com/rooms/1500167927972092778",
        "name": "Cozy Courtyard Flat Opposite British Museum",
        "title": "Condo in Holborn",
        "subtitle": "Private courtyard, balcony, and kitchen",
        "area": "Holborn",
        "coordinates": {
          "latitude": 51.5179,
          "longitude": -0.1262
        },
        "rating": 4.94,
        "reviewCount": 96,
        "isNew": false,
        "isGuestFavorite": true,
        "isSuperhost": false,
        "badges": [
          "Guest favorite"
        ],
        "highlights": [
          "1 bedroom"
        ],
        "offers": [
          "Pay €0 today"
        ],
        "photos": [
          "https://a0.muscache.com/im/pictures/hosting/Hosting-1500167927972092778/original/c9c440e0-405f-431d-bf61-5b060b10ca75.jpeg"
        ],
        "propertyId": null,
        "checkIn": "2027-01-16",
        "checkOut": "2027-01-19",
        "price": {
          "total": 755,
          "totalText": "€755",
          "originalTotal": null,
          "originalTotalText": null,
          "currency": "EUR",
          "nights": 3,
          "perNight": 262.54,
          "feesIncluded": true,
          "taxesIncluded": false,
          "breakdown": [
            {
              "label": "3 nights x €262.54",
              "amount": 787.61,
              "amountText": "€787.61"
            }
          ]
        }
      }
    ],
    "page": {
      "page": 1,
      "hasMore": true,
      "nextCursor": "eyJ2IjoxLCJrIjoic2VhcmNoIiwiZiI6InFqNzZrdiIsIm8iOjE4fQ.i35kUFWGvu0u7i6KPIPv4tEDoWXImmFHKMauRMaqSCqHSJS1-Wce7HCwk2L5tTyYmECliIi9w6ABywPxA2cpvSqVTi-kf0iZ",
      "lastPage": 15,
      "truncated": true
    }
  },
  "meta": {
    "requestId": "req_01example_airbnb_search",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.airbnb.searchStays({
  location: "London",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/airbnb/search?location=London",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/airbnb/search?location=London" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/airbnb/search?location=London",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```

### Example: next page (pagination)

After a successful response, if pagination is not finished, request the next page using `cursor` (URL-encode when composing the query string):

```javascript
const previous = await response.json();
const nextCursor = previous?.data?.page?.nextCursor;
const hasMore = previous?.data?.page?.hasMore;
if (!hasMore || nextCursor == null) {
  // no more pages
} else {
  const nextUrl = new URL("https://api.socialfetch.dev/v1/airbnb/search");
  nextUrl.searchParams.set("cursor", nextCursor);
  // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest");
  const nextResponse = await fetch(nextUrl.toString(), {
    headers: { "x-api-key": "YOUR_API_KEY" },
  });
  const nextData = await nextResponse.json();
}
```