Skip to content
Browsabledocs
↑ ↓ to navigate · Enter to openQuick links
Staging API reference · Requests use https://api-ingress-worker-staging.browsable-staging.workers.dev
Documentation Airbnb host listings
Markdown ↗
Airbnb APIs

Airbnb host listings

Read publicly exposed stays on an Airbnb host profile, with explicit pagination and completeness. Does not infer hidden listings.

POST/v1/airbnb/host/listings
Authenticate every request

Send Authorization: Bearer YOUR_API_KEY. Get an API key →

Parameters

Send these fields in a flat JSON body. Add _run to choose execution options.

urlstringRequired

Public Airbnb host profile URL. Minimum length: 1. Maximum length: 2000. Format: uri. Pattern: ^https://([a-z0-9-]+\.)?airbnb\.(com|co\.uk|fr|de|es|it|ca|com\.au)/users/(show|profile)/[^/?#]+/?([?].*)?$.

limitintegerOptional

Maximum results in this response. Default: 20. Minimum: 1. Maximum: 50.

currencystringOptional

Three-letter currency code, such as USD. Default: "USD". Pattern: ^[A-Z]{3}$.

localestringOptional

Language code for source content, such as en. Default: "en".

offsetintegerOptional

Number of results to skip. Start at 0. Default: 0. Minimum: 0. Maximum: 10000.

Response

Every response describes a run. Read result once run_status is succeeded.

run_id
The run to track. Keep it when contacting support.
run_status
Queued, running, waiting for sign-in, succeeded, or failed. Check this even after an HTTP 200.
status_url
Poll this URL while the run is pending. Keep the same run instead of starting another request.
result
The endpoint’s returned data. The example is illustrative; actual fields may be empty or unavailable.
error
On failure, inspect its code, message, retryable and action fields.
View the complete output schema
JSON
{
  "type": "object",
  "required": [
    "success",
    "fetched_at",
    "host_id",
    "profile_url",
    "listings",
    "pagination",
    "completeness"
  ],
  "properties": {
    "host_id": {
      "type": "string"
    },
    "success": {
      "type": "boolean",
      "const": true
    },
    "listings": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "listing_id",
          "url",
          "title",
          "picture_url",
          "room_type"
        ],
        "properties": {
          "url": {
            "type": "string"
          },
          "title": {
            "type": [
              "string",
              "null"
            ]
          },
          "room_type": {
            "type": [
              "string",
              "null"
            ]
          },
          "listing_id": {
            "type": "string"
          },
          "picture_url": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "fetched_at": {
      "type": "string",
      "format": "date-time"
    },
    "pagination": {
      "type": "object",
      "required": [
        "total_count",
        "offset",
        "limit",
        "has_more",
        "next_offset"
      ],
      "properties": {
        "limit": {
          "type": "integer"
        },
        "offset": {
          "type": "integer"
        },
        "has_more": {
          "type": "boolean"
        },
        "next_offset": {
          "type": [
            "integer",
            "null"
          ]
        },
        "total_count": {
          "type": [
            "number",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "profile_url": {
      "type": "string"
    },
    "completeness": {
      "type": "object",
      "required": [
        "status",
        "reason"
      ],
      "properties": {
        "reason": {
          "type": [
            "string",
            "null"
          ]
        },
        "status": {
          "enum": [
            "complete",
            "partial",
            "unknown"
          ],
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "host_id_type": {
      "enum": [
        "legacy",
        "contextual"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}
View a polled run response
JSON
{
  "run_id": "00000000-0000-4000-8000-000000000001",
  "task_key": "airbnb-host-listings",
  "task_name": "Airbnb host listings",
  "run_status": "succeeded",
  "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001",
  "result": {
    "host_id": "id-1",
    "success": true,
    "listings": [
      {
        "url": "https://example.com/item-1",
        "title": "Stylish Shoreditch Loft with Balcony",
        "room_type": "sample",
        "listing_id": "id-1",
        "picture_url": "https://example.com/item-1"
      }
    ],
    "fetched_at": "sample",
    "pagination": {
      "limit": 1,
      "offset": 1,
      "has_more": true,
      "next_offset": 1,
      "total_count": 1
    },
    "profile_url": "https://example.com/item-1",
    "completeness": {
      "reason": "sample",
      "status": "complete"
    },
    "host_id_type": "legacy"
  },
  "error": null
}

Errors & retries

  • 400Fix the fields listed in errors before retrying.
  • 428Connect the requested website account using the returned sign-in link.
  • 429Wait for the duration in Retry-After.
  • 5xxRetry transient failures with backoff. Keep the request ID.

A failed run has its own error inside the response. Retry it only when error.retryable is true.

Validation, pagination and recovery →

More examples

Async request with polling
RUN=$(curl -s -X POST "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/airbnb/host/listings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.airbnb.com/users/show/123456"}')

RUN_ID=$(echo "$RUN" | jq -er '.run_id // empty') || { echo "$RUN" >&2; exit 1; }
POLL_DELAY=3

while true; do
  RESULT=$(curl -s -H "Authorization: Bearer YOUR_API_KEY" "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/runs/$RUN_ID")
  STATUS=$(echo "$RESULT" | jq -r '.run_status')
  if [[ "$STATUS" =~ ^(succeeded|failed|errored|cancelled|canceled|expired)$ ]]; then
    echo "$RESULT"
    break
  fi
  sleep "$(awk "BEGIN { print $POLL_DELAY * (0.9 + ($RANDOM % 21) / 100) }")"
  POLL_DELAY=$((POLL_DELAY < 30 ? POLL_DELAY * 2 : 30))
  [ "$POLL_DELAY" -gt 30 ] && POLL_DELAY=30
done
Wait-for-results request
curl -X POST "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/airbnb/host/listings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.airbnb.com/users/show/123456","_run":{"async":false}}'
Canonical & compatibility routes

You can also send the same JSON body to /v1/tasks/airbnb-host-listings/runs.