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

> Search SUUMO (スーモ) for-sale properties by prefecture and category (used condominium, used/new house, land), optionally scoped to a city/ward or to a railway line and specific stations, with filters for price range, floor/building/land area range, floor-plan layout, maximum building age, maximum walking distance to the nearest station, per-category amenities (e.g. pets allowed, elevator, south-facing, city gas, flat ground) and sort order. Returns property cards with name, price, address, transport, area, building area, land area, layout, balcony area, build year-month and image.

**Price:** 5 credits per 30 results



## OpenAPI

````yaml /openapi/real-estate.json post /api/suumo/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/suumo/properties/search:
    post:
      tags:
        - /suumo
      summary: /suumo/properties/search
      description: >-
        Search SUUMO (スーモ) for-sale properties by prefecture and category (used
        condominium, used/new house, land), optionally scoped to a city/ward or
        to a railway line and specific stations, with filters for price range,
        floor/building/land area range, floor-plan layout, maximum building age,
        maximum walking distance to the nearest station, per-category amenities
        (e.g. pets allowed, elevator, south-facing, city gas, flat ground) and
        sort order. Returns property cards with name, price, address, transport,
        area, building area, land area, layout, balcony area, build year-month
        and image.


        **Price:** 5 credits per 30 results
      operationId: __api_suumo_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/SuumoPropertiesSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuumoPropertyCard'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SuumoPropertiesSearchPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        pref:
          $ref: '#/components/schemas/SuumoPref'
        ward:
          anyOf:
            - type: string
            - type: 'null'
        line:
          anyOf:
            - type: string
              minLength: 1
            - type: 'null'
        stations:
          items:
            type: string
          type: array
          default: []
        property_type:
          $ref: '#/components/schemas/SuumoSalePropertyType'
          default: used_mansion
        price_min:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        price_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'
        building_area_min:
          anyOf:
            - type: number
              minimum: 0
            - type: 'null'
        building_area_max:
          anyOf:
            - type: number
              minimum: 0
            - type: 'null'
        land_area_min:
          anyOf:
            - type: number
              minimum: 0
            - type: 'null'
        land_area_max:
          anyOf:
            - type: number
              minimum: 0
            - type: 'null'
        layouts:
          anyOf:
            - items:
                $ref: '#/components/schemas/SuumoSaleLayout'
              type: array
            - type: 'null'
        max_age:
          anyOf:
            - $ref: '#/components/schemas/SuumoSaleMaxAge'
            - type: 'null'
        walk_max:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
        sort:
          anyOf:
            - $ref: '#/components/schemas/SuumoSaleSort'
            - type: 'null'
        condo_facets:
          items:
            $ref: '#/components/schemas/SuumoSaleCondoFacet'
          type: array
          default: []
        house_facets:
          items:
            $ref: '#/components/schemas/SuumoSaleHouseFacet'
          type: array
          default: []
        land_facets:
          items:
            $ref: '#/components/schemas/SuumoSaleLandFacet'
          type: array
          default: []
        build_condition:
          anyOf:
            - $ref: '#/components/schemas/SuumoSaleBuildCondition'
            - type: 'null'
        count:
          type: integer
          minimum: 1
      type: object
      required:
        - pref
        - count
    SuumoPropertyCard:
      properties:
        '@type':
          type: string
          default: SuumoPropertyCard
        id:
          type: string
        url:
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
        headline:
          anyOf:
            - type: string
            - type: 'null'
        price:
          anyOf:
            - type: integer
            - type: 'null'
        address:
          anyOf:
            - type: string
            - type: 'null'
        transport:
          anyOf:
            - type: string
            - type: 'null'
        area:
          anyOf:
            - type: number
            - type: 'null'
        building_area:
          anyOf:
            - type: number
            - type: 'null'
        land_area:
          anyOf:
            - type: number
            - type: 'null'
        layout:
          anyOf:
            - type: string
            - type: 'null'
        balcony_area:
          anyOf:
            - type: string
            - type: 'null'
        built_year_month:
          anyOf:
            - type: string
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - 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
    SuumoSalePropertyType:
      type: string
      enum:
        - used_mansion
        - used_house
        - new_house
        - land
    SuumoSaleLayout:
      type: string
      enum:
        - studio
        - one_room
        - two_room
        - three_room
        - four_room
        - five_room_plus
    SuumoSaleMaxAge:
      type: string
      enum:
        - new
        - '1'
        - '3'
        - '5'
        - '7'
        - '10'
        - '15'
        - '20'
        - '25'
        - '30'
    SuumoSaleSort:
      type: string
      enum:
        - newest
        - price_asc
        - price_desc
        - area_asc
        - area_desc
        - built_oldest
        - built_newest
    SuumoSaleCondoFacet:
      type: string
      enum:
        - pets_allowed
        - parking_available
        - south_facing
        - elevator
        - roof_balcony
    SuumoSaleHouseFacet:
      type: string
      enum:
        - parking_two_cars
        - has_movie
        - city_gas
        - ldk_15_tatami_plus
        - south_facing
    SuumoSaleLandFacet:
      type: string
      enum:
        - hilltop
        - regular_shape
        - flat_ground
        - city_gas
        - public_sewer
    SuumoSaleBuildCondition:
      type: string
      enum:
        - without
        - with
    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

````