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 calendar
Markdown ↗
Airbnb APIs

Airbnb calendar

Read public calendar availability and exposed stay restrictions. Unavailable does not mean booked; prices are displayed calendar prices, not stay quotes.

POST/v1/airbnb/calendar
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 HTTPS Airbnb listing 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)/rooms/[0-9]+/?([?].*)?$.

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".

monthsintegerOptional

Number of calendar months to retrieve. Default: 3. Minimum: 1. Maximum: 24.

start_monthintegerOptional

First calendar month, from 1 (January) to 12 (December); defaults to the current month. Minimum: 1. Maximum: 12.

start_yearintegerOptional

First calendar year to retrieve; defaults to the current year. Minimum: 2000. Maximum: 2100.

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",
    "listing_id",
    "listing_url",
    "currency",
    "months",
    "request",
    "availability_note"
  ],
  "properties": {
    "months": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "month",
          "year",
          "days"
        ],
        "properties": {
          "days": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "date",
                "available",
                "available_for_checkin",
                "available_for_checkout",
                "bookable",
                "min_nights",
                "max_nights",
                "local_price"
              ],
              "properties": {
                "date": {
                  "type": "string",
                  "format": "date"
                },
                "bookable": {
                  "type": [
                    "boolean",
                    "null"
                  ]
                },
                "available": {
                  "type": [
                    "boolean",
                    "null"
                  ]
                },
                "max_nights": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "min_nights": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "local_price": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "available_for_checkin": {
                  "type": [
                    "boolean",
                    "null"
                  ]
                },
                "available_for_checkout": {
                  "type": [
                    "boolean",
                    "null"
                  ]
                }
              },
              "additionalProperties": false
            }
          },
          "year": {
            "type": "integer"
          },
          "month": {
            "type": "integer"
          }
        },
        "additionalProperties": false
      }
    },
    "request": {
      "type": "object",
      "required": [
        "months",
        "start_month",
        "start_year"
      ],
      "properties": {
        "months": {
          "type": "integer"
        },
        "start_year": {
          "type": "integer"
        },
        "start_month": {
          "type": "integer"
        }
      },
      "additionalProperties": false
    },
    "success": {
      "type": "boolean",
      "const": true
    },
    "currency": {
      "type": "string"
    },
    "fetched_at": {
      "type": "string",
      "format": "date-time"
    },
    "listing_id": {
      "type": "string"
    },
    "listing_url": {
      "type": "string"
    },
    "availability_note": {
      "type": "string"
    }
  },
  "additionalProperties": false
}
View a polled run response
JSON
{
  "run_id": "00000000-0000-4000-8000-000000000001",
  "task_key": "airbnb-calendar",
  "task_name": "Airbnb calendar",
  "run_status": "succeeded",
  "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001",
  "result": {
    "months": [
      {
        "days": [
          {
            "date": "sample",
            "bookable": true,
            "available": true,
            "max_nights": 1.5,
            "min_nights": 1.5,
            "local_price": "180",
            "available_for_checkin": true,
            "available_for_checkout": true
          }
        ],
        "year": 1,
        "month": 1
      }
    ],
    "request": {
      "months": 1,
      "start_year": 1,
      "start_month": 1
    },
    "success": true,
    "currency": "USD",
    "fetched_at": "sample",
    "listing_id": "id-1",
    "listing_url": "https://example.com/item-1",
    "availability_note": "sample"
  },
  "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/calendar" \
  -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/calendar" \
  -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-calendar/runs.