Skip to content
Browsabledocs
Staging API reference · Requests use https://api-ingress-worker-staging.browsable-staging.workers.dev
Documentation Airbnb room
Markdown ↗
Airbnb APIs

Airbnb room

Fetch an Airbnb room/listing page and return normalized details, photos, host info, amenities, reviews, policies, and availability.

POST/v1/airbnb/room
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

Full Airbnb room URL. Minimum length: 1. Maximum length: 2000.

adultsintegerOptional

Number of adult guests or travellers. Minimum: 1. Maximum: 16.

checkinstringOptional

Check-in date. Overrides check_in in the URL; supply with checkout. Format: date.

checkoutstringOptional

Check-out date. Overrides check_out in the URL. Format: date.

childrenintegerOptional

Number of child guests. Minimum: 0. Maximum: 16.

currencystringOptional

Display currency; defaults to URL currency or site default. Pattern: ^[A-Z]{3}$.

include_quotebooleanOptional

Fetch a read-only tax-inclusive quote and full attributes for the room identified by the URL. Requires dates. Does not book.

infantsintegerOptional

Number of infant guests. Minimum: 0. Maximum: 16.

petsintegerOptional

Number of pets. Minimum: 0. Maximum: 16.

Advanced & compatibility inputs 1
rate_plan_idstringOptional

Optional rate plan from hotel.offers; used with include_quote. Pattern: ^[0-9]+$.

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",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "success",
    "listing_id",
    "listing_url",
    "locale",
    "currency",
    "requested_stay",
    "review_request",
    "calendar_request",
    "photos",
    "reviews"
  ],
  "properties": {
    "host": {
      "anyOf": [
        {
          "type": "object"
        },
        {
          "type": "null"
        }
      ]
    },
    "hotel": {
      "type": "object",
      "properties": {
        "title": {
          "type": [
            "string",
            "null"
          ]
        },
        "offers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "room_id": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "capacity": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "currency": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "room_url": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "available": {
                "type": [
                  "boolean",
                  "null"
                ]
              },
              "breakdown": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "label": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "amount": {
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "display_price": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "additionalProperties": true
                }
              },
              "room_name": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "attributes": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "rate_plans": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "add_ons": {
                      "type": "array",
                      "items": {}
                    },
                    "selected": {
                      "type": "boolean"
                    },
                    "refundable": {
                      "type": [
                        "boolean",
                        "null"
                      ]
                    },
                    "cancellation": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "rate_plan_id": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "price_adjustment": {
                      "type": [
                        "number",
                        "null"
                      ]
                    },
                    "cancellation_details": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "price_adjustment_type": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "additionalProperties": true
                }
              },
              "tax_status": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "disclaimers": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "price_basis": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "credit_offer": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "display_price": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "selected_dates": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "displayed_total": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "price_qualifier": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "selected_rate_plan_id": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "total_including_taxes": {
                "type": [
                  "number",
                  "null"
                ]
              }
            },
            "additionalProperties": true
          }
        },
        "address": {
          "type": [
            "string",
            "null"
          ]
        },
        "coverage": {
          "type": [
            "string",
            "null"
          ]
        },
        "returned_rooms": {
          "type": [
            "number",
            "null"
          ]
        },
        "advertised_rooms": {
          "type": [
            "number",
            "null"
          ]
        }
      },
      "additionalProperties": true
    },
    "title": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "locale": {
      "type": "string"
    },
    "photos": {
      "type": "object"
    },
    "pricing": {
      "anyOf": [
        {
          "type": "object"
        },
        {
          "type": "null"
        }
      ]
    },
    "reviews": {
      "type": "object"
    },
    "success": {
      "type": "boolean"
    },
    "calendar": {
      "anyOf": [
        {
          "type": "object"
        },
        {
          "type": "null"
        }
      ]
    },
    "currency": {
      "type": "string"
    },
    "location": {
      "anyOf": [
        {
          "type": "object"
        },
        {
          "type": "null"
        }
      ]
    },
    "overview": {
      "type": "object"
    },
    "policies": {
      "anyOf": [
        {
          "type": "object"
        },
        {
          "type": "null"
        }
      ]
    },
    "amenities": {
      "type": "object"
    },
    "share_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "highlights": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "icon": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "title": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "subtitle": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "listing_id": {
      "type": "string"
    },
    "description": {
      "type": "object"
    },
    "hotel_quote": {
      "type": "object",
      "properties": {
        "reason": {
          "type": [
            "string",
            "null"
          ]
        },
        "source": {
          "type": [
            "string",
            "null"
          ]
        },
        "currency": {
          "type": [
            "string",
            "null"
          ]
        },
        "available": {
          "type": "boolean"
        },
        "meal_plan": {
          "type": "object",
          "properties": {
            "evidence": {
              "type": [
                "string",
                "null"
              ]
            },
            "rate_add_ons": {
              "type": "array",
              "items": {}
            },
            "breakfast_included": {
              "type": [
                "boolean",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "room_name": {
          "type": [
            "string",
            "null"
          ]
        },
        "hotel_name": {
          "type": [
            "string",
            "null"
          ]
        },
        "observed_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "price_items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "label": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "amount": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "details": {
                "type": "array",
                "items": {
                  "type": "object"
                }
              },
              "display": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "currency": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "additionalProperties": true
          }
        },
        "cancellation": {
          "type": [
            "string",
            "null"
          ]
        },
        "rate_plan_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "room_details": {
          "type": "object",
          "properties": {
            "amenities": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "title": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "subtitle": {
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "additionalProperties": true
              }
            },
            "attributes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "photo_urls": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "source_total": {
          "type": [
            "number",
            "null"
          ]
        },
        "tax_evidence": {
          "type": [
            "string",
            "null"
          ]
        },
        "observed_stay": {
          "type": "object",
          "properties": {
            "pets": {
              "type": [
                "number",
                "null"
              ]
            },
            "adults": {
              "type": [
                "number",
                "null"
              ]
            },
            "checkin": {
              "type": [
                "string",
                "null"
              ]
            },
            "infants": {
              "type": [
                "number",
                "null"
              ]
            },
            "room_id": {
              "type": [
                "string",
                "null"
              ]
            },
            "checkout": {
              "type": [
                "string",
                "null"
              ]
            },
            "children": {
              "type": [
                "number",
                "null"
              ]
            }
          },
          "additionalProperties": true
        },
        "stay_verified": {
          "type": "boolean"
        },
        "quote_complete": {
          "type": "boolean"
        },
        "rate_selection": {
          "type": [
            "string",
            "null"
          ]
        },
        "payment_options": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "title": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "subtitle": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "disclaimer": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "additionalProperties": true
          }
        },
        "amounts_reconcile": {
          "type": "boolean"
        },
        "rate_plan_verified": {
          "type": "boolean"
        },
        "total_including_taxes": {
          "type": [
            "number",
            "null"
          ]
        },
        "cancellation_milestones": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      },
      "additionalProperties": true
    },
    "listing_url": {
      "type": "string"
    },
    "canonical_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "property_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "summary_title": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "requested_stay": {
      "type": "object"
    },
    "review_request": {
      "type": "object"
    },
    "person_capacity": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ]
    },
    "calendar_request": {
      "type": "object"
    },
    "location_summary": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "sleeping_arrangements": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "images": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "id": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                },
                "caption": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "additionalProperties": false
            }
          },
          "subtitle": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": true
}
View a polled run response
JSON
{
  "run_id": "00000000-0000-4000-8000-000000000001",
  "task_key": "airbnb-room",
  "task_name": "Airbnb room",
  "run_status": "succeeded",
  "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001",
  "result": {
    "host": {},
    "hotel": {
      "title": "Stylish Shoreditch Loft with Balcony",
      "offers": [
        {
          "room_id": "id-1",
          "capacity": 1.5,
          "currency": "USD",
          "room_url": "https://example.com/item-1",
          "available": true,
          "breakdown": [
            {
              "label": "Stylish Shoreditch Loft with Balcony",
              "amount": 180,
              "display_price": "GBP 210 total"
            }
          ],
          "room_name": "Stylish Shoreditch Loft with Balcony",
          "attributes": [
            "sample"
          ],
          "rate_plans": [
            {
              "add_ons": [
                "sample"
              ],
              "selected": true,
              "refundable": true,
              "cancellation": "sample",
              "rate_plan_id": "id-1",
              "price_adjustment": 180,
              "cancellation_details": "2 guests",
              "price_adjustment_type": "180"
            }
          ],
          "tax_status": "sample",
          "disclaimers": [
            "sample"
          ],
          "price_basis": "180",
          "credit_offer": "sample",
          "display_price": "GBP 210 total",
          "selected_dates": "sample",
          "displayed_total": 180,
          "price_qualifier": "for 1 night",
          "selected_rate_plan_id": "id-1",
          "total_including_taxes": 180
        }
      ],
      "address": "sample",
      "coverage": "sample",
      "returned_rooms": 1.5,
      "advertised_rooms": 1.5
    },
    "title": "Stylish Shoreditch Loft with Balcony",
    "locale": "sample",
    "photos": {},
    "pricing": {},
    "reviews": {},
    "success": true,
    "calendar": {},
    "currency": "USD",
    "location": {},
    "overview": {},
    "policies": {},
    "amenities": {},
    "share_url": "https://example.com/item-1",
    "highlights": [
      {
        "icon": "https://images.example.com/icon-1.jpg",
        "type": "sample",
        "title": "Stylish Shoreditch Loft with Balcony",
        "subtitle": "Stylish Shoreditch Loft with Balcony"
      }
    ],
    "listing_id": "id-1",
    "description": {},
    "hotel_quote": {
      "reason": "sample",
      "source": "sample",
      "currency": "USD",
      "available": true,
      "meal_plan": {
        "evidence": "id-1",
        "rate_add_ons": [
          "sample"
        ],
        "breakfast_included": true
      },
      "room_name": "Stylish Shoreditch Loft with Balcony",
      "hotel_name": "Stylish Shoreditch Loft with Balcony",
      "observed_at": "sample",
      "price_items": [
        {
          "type": "sample",
          "label": "Stylish Shoreditch Loft with Balcony",
          "amount": 180,
          "details": [
            {}
          ],
          "display": "sample",
          "currency": "USD"
        }
      ],
      "cancellation": "sample",
      "rate_plan_id": "id-1",
      "room_details": {
        "amenities": [
          {
            "title": "Stylish Shoreditch Loft with Balcony",
            "subtitle": "Stylish Shoreditch Loft with Balcony"
          }
        ],
        "attributes": [
          "sample"
        ],
        "photo_urls": [
          "https://images.example.com/photo_urls-1.jpg"
        ],
        "description": "Sample description 1"
      },
      "source_total": 180,
      "tax_evidence": "id-1",
      "observed_stay": {
        "pets": 1.5,
        "adults": 1,
        "checkin": "2026-06-14",
        "infants": 1.5,
        "room_id": "id-1",
        "checkout": "2026-06-21",
        "children": 1
      },
      "stay_verified": true,
      "quote_complete": true,
      "rate_selection": "sample",
      "payment_options": [
        {
          "type": "sample",
          "title": "Stylish Shoreditch Loft with Balcony",
          "subtitle": "Stylish Shoreditch Loft with Balcony",
          "disclaimer": "sample"
        }
      ],
      "amounts_reconcile": true,
      "rate_plan_verified": true,
      "total_including_taxes": 180,
      "cancellation_milestones": [
        {}
      ]
    },
    "listing_url": "https://example.com/item-1",
    "canonical_url": "https://example.com/item-1",
    "property_type": "sample",
    "summary_title": "Stylish Shoreditch Loft with Balcony",
    "requested_stay": {},
    "review_request": {},
    "person_capacity": 1.5,
    "calendar_request": {},
    "location_summary": "Sample location_summary 1",
    "sleeping_arrangements": [
      {
        "title": "Stylish Shoreditch Loft with Balcony",
        "images": [
          {
            "id": "id-1",
            "url": "https://example.com/item-1",
            "caption": "sample"
          }
        ],
        "subtitle": "Stylish Shoreditch Loft with Balcony"
      }
    ]
  },
  "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/room" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.airbnb.com/rooms/21944286"}')

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/room" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.airbnb.com/rooms/21944286","_run":{"async":false}}'
Canonical & compatibility routes

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