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

# /suumo/listings/search

> Search SUUMO (スーモ) rental listings by prefecture, optionally narrowed to a railway line and specific stations, with filters: rent range, floor-area range, walking distance to the nearest station, floor-plan layout, building type, maximum building age, rent-cost conditions (management fee included, no key money, no deposit), an extensive amenity catalogue (e.g. separate bath/toilet, auto-lock, pets allowed, floor heating, tower mansion, barrier-free, free internet) and sort order (recommended, cheapest/most expensive rent, newest listings, newest building, largest area, by address). Returns listing cards with building name and type, address, nearest stations, age, floor, rent, management fee, deposit/key money, layout, area and image.

**Price:** 10 credits per 50 results



## OpenAPI

````yaml /openapi/real-estate.json post /api/suumo/listings/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/suumo/listings/search:
    post:
      tags:
        - /suumo
      summary: /suumo/listings/search
      description: >-
        Search SUUMO (スーモ) rental listings by prefecture, optionally narrowed to
        a railway line and specific stations, with filters: rent range,
        floor-area range, walking distance to the nearest station, floor-plan
        layout, building type, maximum building age, rent-cost conditions
        (management fee included, no key money, no deposit), an extensive
        amenity catalogue (e.g. separate bath/toilet, auto-lock, pets allowed,
        floor heating, tower mansion, barrier-free, free internet) and sort
        order (recommended, cheapest/most expensive rent, newest listings,
        newest building, largest area, by address). Returns listing cards with
        building name and type, address, nearest stations, age, floor, rent,
        management fee, deposit/key money, layout, area and image.


        **Price:** 10 credits per 50 results
      operationId: __api_suumo_listings_search_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuumoListingsSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuumoListingCard'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SuumoListingsSearchPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        pref:
          $ref: '#/components/schemas/SuumoPref'
        line:
          anyOf:
            - type: string
              minLength: 1
            - type: 'null'
        stations:
          items:
            type: string
          type: array
          default: []
        rent_min:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        rent_max:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        area_min:
          anyOf:
            - type: number
              minimum: 0
            - type: 'null'
        area_max:
          anyOf:
            - type: number
              minimum: 0
            - type: 'null'
        walk_max:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
        layouts:
          items:
            $ref: '#/components/schemas/SuumoLayout'
          type: array
          default: []
        building_types:
          items:
            $ref: '#/components/schemas/SuumoBuildingType'
          type: array
          default: []
        max_age:
          anyOf:
            - $ref: '#/components/schemas/SuumoMaxAge'
            - type: 'null'
        facets:
          items:
            $ref: '#/components/schemas/SuumoFacet'
          type: array
          default: []
        rent_conditions:
          items:
            $ref: '#/components/schemas/SuumoRentCondition'
          type: array
          default: []
        sort:
          $ref: '#/components/schemas/SuumoListingSort'
          default: recommended
        count:
          type: integer
          minimum: 1
      type: object
      required:
        - pref
        - count
    SuumoListingCard:
      properties:
        '@type':
          type: string
          default: SuumoListingCard
        id:
          type: string
        building_id:
          type: string
        room_id:
          type: string
        url:
          type: string
        building_name:
          anyOf:
            - type: string
            - type: 'null'
        building_type:
          anyOf:
            - type: string
            - type: 'null'
        address:
          anyOf:
            - type: string
            - type: 'null'
        stations:
          items:
            $ref: '#/components/schemas/SuumoStation'
          type: array
          default: []
        age:
          anyOf:
            - type: string
            - type: 'null'
        total_floors:
          anyOf:
            - type: string
            - type: 'null'
        floor:
          anyOf:
            - type: string
            - type: 'null'
        rent:
          anyOf:
            - type: integer
            - type: 'null'
        management_fee:
          anyOf:
            - type: integer
            - type: 'null'
        deposit:
          anyOf:
            - type: string
            - type: 'null'
        key_money:
          anyOf:
            - type: string
            - type: 'null'
        layout:
          anyOf:
            - type: string
            - type: 'null'
        area:
          anyOf:
            - type: number
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - id
        - building_id
        - room_id
        - url
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    SuumoPref:
      type: string
      enum:
        - tokyo
        - kanagawa
        - osaka
        - saitama
        - chiba
        - aichi
        - hyogo
        - fukuoka
        - hokkaido
        - kyoto
    SuumoLayout:
      type: string
      enum:
        - one_room
        - 1k
        - 1dk
        - 1ldk
        - 2k
        - 2dk
        - 2ldk
        - 3k
        - 3dk
        - 3ldk
        - 4k
        - 4dk
        - 4ldk
        - 5k_plus
    SuumoBuildingType:
      type: string
      enum:
        - mansion
        - apartment
        - house
        - other
    SuumoMaxAge:
      type: string
      enum:
        - new
        - within_1_year
        - within_3_years
        - within_5_years
        - within_7_years
        - within_10_years
        - within_15_years
        - within_20_years
        - within_25_years
        - within_30_years
    SuumoFacet:
      type: string
      enum:
        - above_2nd_floor
        - top_floor
        - corner_room
        - south_facing
        - first_floor
        - gas_stove_ready
        - ih_stove
        - two_plus_burners
        - all_electric
        - system_kitchen
        - counter_kitchen
        - separate_bath_toilet
        - washlet
        - bathroom_dryer
        - reheating_bath
        - shower_room
        - internet_available
        - bs_antenna
        - cs_antenna
        - cable_tv
        - free_internet
        - indoor_washer_space
        - separate_washroom
        - flooring
        - maisonette
        - loft
        - soundproof_room
        - basement
        - furnished
        - air_conditioner
        - floor_heating
        - kerosene_heating
        - gas_heating
        - under_floor_storage
        - shoe_box
        - trunk_room
        - walk_in_closet
        - auto_lock
        - caretaker
        - video_intercom
        - security_company
        - security_camera
        - parking
        - bicycle_parking
        - motorcycle_parking
        - elevator
        - delivery_box
        - on_site_garbage_area
        - balcony
        - roof_balcony
        - private_garden
        - parking_two_plus
        - on_site_parking
        - city_gas
        - propane_gas
        - barrier_free
        - designers
        - condo_for_rent
        - no_guarantor
        - tower_mansion
        - reformed
        - renovated
        - online_contract
        - initial_cost_card_payment
        - rent_card_payment
        - immediate_move_in
        - pets_allowed
        - instruments_allowed
        - office_use_allowed
        - room_share_allowed
        - exclude_fixed_term
        - diy_allowed
        - women_only
        - customizable
        - elderly_welcome
        - lgbt_friendly
        - free_rent
        - specified_quality_rental
        - floor_plan_image
        - photo
        - new_today
        - new_recent
        - property_video
        - panorama
    SuumoRentCondition:
      type: string
      enum:
        - management_fee_included
        - no_key_money
        - no_deposit
    SuumoListingSort:
      type: string
      enum:
        - recommended
        - rent_asc
        - rent_desc
        - newest
        - age_newest
        - area_desc
        - by_address
    SuumoStation:
      properties:
        '@type':
          type: string
          default: SuumoStation
        line:
          anyOf:
            - type: string
            - type: 'null'
        station:
          anyOf:
            - type: string
            - type: 'null'
        walk_min:
          anyOf:
            - type: integer
            - type: 'null'
      type: object
    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

````