> ## 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/search

> Search Hostelworld properties (hostels, hotels, B&Bs) in a city. Returns property cards with name, type, description, address, district, city, coordinates, distance from the city centre, star rating, guest rating breakdown, review count, facilities by category, photos and the lowest nightly prices. Provide a check-in date to get live nightly prices.

**Price:** 10 credits per 20 results

**⚠️ Common errors:** 412: City not found (no Hostelworld city matches the given name)



## OpenAPI

````yaml /openapi/travel-hospitality.json post /api/hostelworld/properties/search
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/search:
    post:
      tags:
        - /hostelworld
      summary: /hostelworld/properties/search
      description: >-
        Search Hostelworld properties (hostels, hotels, B&Bs) in a city. Returns
        property cards with name, type, description, address, district, city,
        coordinates, distance from the city centre, star rating, guest rating
        breakdown, review count, facilities by category, photos and the lowest
        nightly prices. Provide a check-in date to get live nightly prices.


        **Price:** 10 credits per 20 results


        **⚠️ Common errors:** 412: City not found (no Hostelworld city matches
        the given name)
      operationId: __api_hostelworld_properties_search_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HostelworldPropertiesSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HostelworldSearchProperty'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HostelworldPropertiesSearchPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        city:
          type: string
          minLength: 1
        check_in:
          anyOf:
            - type: string
              pattern: ^\d{4}-\d{2}-\d{2}$
            - type: 'null'
        nights:
          type: integer
          minimum: 1
          default: 1
        guests:
          type: integer
          minimum: 1
          default: 1
        currency:
          type: string
          maxLength: 3
          minLength: 3
          default: USD
        count:
          type: integer
          minimum: 1
      type: object
      required:
        - city
        - count
    HostelworldSearchProperty:
      properties:
        '@type':
          type: string
          default: HostelworldSearchProperty
        id:
          type: string
        url:
          anyOf:
            - type: string
            - type: 'null'
        name:
          anyOf:
            - type: string
            - type: 'null'
        property_type:
          anyOf:
            - type: string
            - type: 'null'
        star_rating:
          anyOf:
            - type: integer
            - type: 'null'
        is_new:
          anyOf:
            - type: boolean
            - type: 'null'
        is_featured:
          anyOf:
            - type: boolean
            - type: 'null'
        is_promoted:
          anyOf:
            - type: boolean
            - type: 'null'
        is_very_popular:
          anyOf:
            - type: boolean
            - type: 'null'
        is_hostelworld_recommended:
          anyOf:
            - type: boolean
            - type: 'null'
        has_free_cancellation:
          anyOf:
            - type: boolean
            - type: 'null'
        sustainability_levels:
          items:
            type: string
          type: array
          default: []
        address:
          anyOf:
            - type: string
            - type: 'null'
        district:
          anyOf:
            - type: string
            - type: 'null'
        districts:
          items:
            type: string
          type: array
          default: []
        city:
          anyOf:
            - $ref: '#/components/schemas/HostelworldCity'
            - type: 'null'
        country:
          anyOf:
            - type: string
            - type: 'null'
        latitude:
          anyOf:
            - type: number
            - type: 'null'
        longitude:
          anyOf:
            - type: number
            - type: 'null'
        distance_from_center:
          anyOf:
            - type: number
            - type: 'null'
        distance_unit:
          anyOf:
            - type: string
            - type: 'null'
        review_count:
          anyOf:
            - type: integer
            - type: 'null'
        rating:
          anyOf:
            - $ref: '#/components/schemas/HostelworldRating'
            - type: 'null'
        currency:
          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'
        promotions:
          items:
            $ref: '#/components/schemas/HostelworldPromotion'
          type: array
          default: []
        images:
          items:
            type: string
          type: array
          default: []
        facilities:
          items:
            $ref: '#/components/schemas/HostelworldFacilityCategory'
          type: array
          default: []
      type: object
      required:
        - id
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    HostelworldCity:
      properties:
        '@type':
          type: string
          default: HostelworldCity
        id:
          anyOf:
            - type: string
            - type: 'null'
        name:
          anyOf:
            - type: string
            - type: 'null'
        country:
          anyOf:
            - type: string
            - type: 'null'
      type: object
    HostelworldRating:
      properties:
        '@type':
          type: string
          default: HostelworldRating
        overall:
          anyOf:
            - type: integer
            - type: 'null'
        value:
          anyOf:
            - type: integer
            - type: 'null'
        security:
          anyOf:
            - type: integer
            - type: 'null'
        location:
          anyOf:
            - type: integer
            - type: 'null'
        staff:
          anyOf:
            - type: integer
            - type: 'null'
        atmosphere:
          anyOf:
            - type: integer
            - type: 'null'
        cleanliness:
          anyOf:
            - type: integer
            - type: 'null'
        facilities:
          anyOf:
            - type: integer
            - type: 'null'
      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
    HostelworldFacilityCategory:
      properties:
        '@type':
          type: string
          default: HostelworldFacilityCategory
        name:
          type: string
        facilities:
          items:
            type: string
          type: array
          default: []
      type: object
      required:
        - name
    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
  securitySchemes:
    AccessToken:
      type: apiKey
      in: header
      name: access-token
      description: API token from the dashboard

````