> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anysite.io/llms.txt
> Use this file to discover all available pages before exploring further.

# /hostelworld/properties/availability

> Get live room availability and nightly prices for a Hostelworld property over a date range: dorm and private rooms with per-room type, capacity, ensuite, beds and rooms available, lowest price per night, rate plans (deposit/non-refundable) with average and total price plus a night-by-night price breakdown, lowest dorm and private prices, deposit, free-cancellation policy and cancellation terms.

**Price:** 1 credit per 24 results

**⚠️ Common errors:** 412: Property not found (well-formed but nonexistent or inactive property id)



## OpenAPI

````yaml /openapi/travel-hospitality.json post /api/hostelworld/properties/availability
openapi: 3.1.0
info:
  title: Any Site API
  description: >+
    Any Site API provides programmatic access to data from LinkedIn, Instagram,
    Twitter, and other platforms.


    ## Authentication


    All API endpoints require an `access-token` header with a valid API token.
    Tokens can be created in the [dashboard](https://app.anysite.io/).


    ## Pricing


    Each endpoint has a credit cost listed in its description. Credits are
    deducted from your token balance per request.

  version: 0.0.1
servers: []
security:
  - AccessToken: []
paths:
  /api/hostelworld/properties/availability:
    post:
      tags:
        - /hostelworld
      summary: /hostelworld/properties/availability
      description: >-
        Get live room availability and nightly prices for a Hostelworld property
        over a date range: dorm and private rooms with per-room type, capacity,
        ensuite, beds and rooms available, lowest price per night, rate plans
        (deposit/non-refundable) with average and total price plus a
        night-by-night price breakdown, lowest dorm and private prices, deposit,
        free-cancellation policy and cancellation terms.


        **Price:** 1 credit per 24 results


        **⚠️ Common errors:** 412: Property not found (well-formed but
        nonexistent or inactive property id)
      operationId: __api_hostelworld_properties_availability_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HostelworldAvailabilityPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HostelworldAvailability'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HostelworldAvailabilityPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        property:
          type: string
          minLength: 1
        checkin:
          type: string
        checkout:
          type: string
        guests:
          type: integer
          maximum: 8
          minimum: 1
          default: 1
      type: object
      required:
        - property
        - checkin
        - checkout
    HostelworldAvailability:
      properties:
        '@type':
          type: string
          default: HostelworldAvailability
        property_id:
          type: string
        url:
          anyOf:
            - type: string
            - type: 'null'
        checkin:
          type: string
        checkout:
          type: string
        nights:
          type: integer
        guests:
          type: integer
        currency:
          anyOf:
            - type: string
            - type: 'null'
        is_available:
          anyOf:
            - type: boolean
            - type: 'null'
        deposit_percentage:
          anyOf:
            - type: integer
            - type: 'null'
        has_free_cancellation:
          anyOf:
            - type: boolean
            - type: 'null'
        free_cancellation_until:
          anyOf:
            - type: string
            - type: 'null'
        lowest_price_per_night:
          anyOf:
            - type: number
            - type: 'null'
        lowest_dorm_price_per_night:
          anyOf:
            - type: number
            - type: 'null'
        lowest_private_price_per_night:
          anyOf:
            - type: number
            - type: 'null'
        lowest_average_price_per_night:
          anyOf:
            - type: number
            - type: 'null'
        lowest_average_dorm_price_per_night:
          anyOf:
            - type: number
            - type: 'null'
        lowest_average_private_price_per_night:
          anyOf:
            - type: number
            - type: 'null'
        promotions:
          items:
            $ref: '#/components/schemas/HostelworldPromotion'
          type: array
          default: []
        cancellation_policies:
          items:
            $ref: '#/components/schemas/HostelworldCancellationPolicy'
          type: array
          default: []
        rooms:
          items:
            $ref: '#/components/schemas/HostelworldRoom'
          type: array
          default: []
      type: object
      required:
        - property_id
        - checkin
        - checkout
        - nights
        - guests
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    HostelworldPromotion:
      properties:
        '@type':
          type: string
          default: HostelworldPromotion
        id:
          type: string
        type:
          anyOf:
            - type: string
            - type: 'null'
        name:
          anyOf:
            - type: string
            - type: 'null'
        discount:
          anyOf:
            - type: number
            - type: 'null'
        stack:
          anyOf:
            - type: boolean
            - type: 'null'
      type: object
      required:
        - id
    HostelworldCancellationPolicy:
      properties:
        '@type':
          type: string
          default: HostelworldCancellationPolicy
        label:
          anyOf:
            - type: string
            - type: 'null'
      type: object
    HostelworldRoom:
      properties:
        '@type':
          type: string
          default: HostelworldRoom
        id:
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
        room_type:
          anyOf:
            - type: string
            - type: 'null'
        extended_type:
          anyOf:
            - type: string
            - type: 'null'
        is_private:
          anyOf:
            - type: boolean
            - type: 'null'
        label_description:
          anyOf:
            - type: string
            - type: 'null'
        capacity:
          anyOf:
            - type: integer
            - type: 'null'
        is_ensuite:
          anyOf:
            - type: boolean
            - type: 'null'
        grade:
          anyOf:
            - type: string
            - type: 'null'
        is_available:
          anyOf:
            - type: boolean
            - type: 'null'
        total_beds_available:
          anyOf:
            - type: integer
            - type: 'null'
        total_rooms_available:
          anyOf:
            - type: integer
            - type: 'null'
        guests_per_room:
          anyOf:
            - type: integer
            - type: 'null'
        price_per_night:
          anyOf:
            - type: number
            - type: 'null'
        images:
          items:
            type: string
          type: array
          default: []
        rate_plans:
          items:
            $ref: '#/components/schemas/HostelworldRatePlan'
          type: array
          default: []
      type: object
      required:
        - id
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
        input: {}
        ctx:
          type: object
      type: object
      required:
        - loc
        - msg
        - type
    HostelworldRatePlan:
      properties:
        '@type':
          type: string
          default: HostelworldRatePlan
        id:
          type: string
        payment_type:
          anyOf:
            - type: string
            - type: 'null'
        payment_label:
          anyOf:
            - type: string
            - type: 'null'
        is_default:
          anyOf:
            - type: boolean
            - type: 'null'
        rate_plan_type:
          anyOf:
            - type: string
            - type: 'null'
        average_price_per_night:
          anyOf:
            - type: number
            - type: 'null'
        total_price:
          anyOf:
            - type: number
            - type: 'null'
        nightly_prices:
          items:
            $ref: '#/components/schemas/HostelworldNightlyPrice'
          type: array
          default: []
      type: object
      required:
        - id
    HostelworldNightlyPrice:
      properties:
        '@type':
          type: string
          default: HostelworldNightlyPrice
        date:
          type: string
        price:
          anyOf:
            - type: number
            - type: 'null'
      type: object
      required:
        - date
  securitySchemes:
    AccessToken:
      type: apiKey
      in: header
      name: access-token
      description: API token from the dashboard

````