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

> Search SUUMO (スーモ) new-build / pre-sale condominium (新築分譲マンション) projects by prefecture, optionally scoped to a city/ward, with filters for price range, exclusive floor-area range, floor-plan layout, maximum walking distance to the nearest station, required features (e.g. pets allowed, floor heating, corner unit, performance certificate) and sort order. Returns project cards with name, marketing description, address, nearest stations, delivery time, price range (JPY), most-frequent layout/area range, number of layout types, per-phase price points and photos.

**Price:** 20 credits per 50 results



## OpenAPI

````yaml /openapi/real-estate.json post /api/suumo/projects/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/projects/search:
    post:
      tags:
        - /suumo
      summary: /suumo/projects/search
      description: >-
        Search SUUMO (スーモ) new-build / pre-sale condominium (新築分譲マンション) projects
        by prefecture, optionally scoped to a city/ward, with filters for price
        range, exclusive floor-area range, floor-plan layout, maximum walking
        distance to the nearest station, required features (e.g. pets allowed,
        floor heating, corner unit, performance certificate) and sort order.
        Returns project cards with name, marketing description, address, nearest
        stations, delivery time, price range (JPY), most-frequent layout/area
        range, number of layout types, per-phase price points and photos.


        **Price:** 20 credits per 50 results
      operationId: __api_suumo_projects_search_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuumoProjectsSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuumoProjectCard'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SuumoProjectsSearchPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        pref:
          $ref: '#/components/schemas/SuumoPref'
        ward:
          anyOf:
            - type: string
            - type: 'null'
        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'
        layouts:
          items:
            $ref: '#/components/schemas/SuumoNewBuildLayout'
          type: array
          default: []
        walk_max:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
        facets:
          items:
            $ref: '#/components/schemas/SuumoNewBuildFacet'
          type: array
          default: []
        sort:
          anyOf:
            - $ref: '#/components/schemas/SuumoNewBuildSort'
            - type: 'null'
        count:
          type: integer
          minimum: 1
      type: object
      required:
        - pref
        - count
    SuumoProjectCard:
      properties:
        '@type':
          type: string
          default: SuumoProjectCard
        id:
          type: string
        url:
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
        address:
          anyOf:
            - type: string
            - type: 'null'
        stations:
          items:
            $ref: '#/components/schemas/SuumoStation'
          type: array
          default: []
        delivery_time:
          anyOf:
            - type: string
            - type: 'null'
        price:
          anyOf:
            - type: integer
            - type: 'null'
        price_max:
          anyOf:
            - type: integer
            - type: 'null'
        price_band:
          anyOf:
            - type: string
            - type: 'null'
        layout:
          anyOf:
            - type: string
            - type: 'null'
        area_range:
          anyOf:
            - type: string
            - type: 'null'
        layout_type_count:
          anyOf:
            - type: integer
            - type: 'null'
        prices:
          items:
            $ref: '#/components/schemas/SuumoProjectPrice'
          type: array
          default: []
        image:
          anyOf:
            - type: string
            - type: 'null'
        images:
          items:
            type: string
          type: array
          default: []
      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
    SuumoNewBuildLayout:
      type: string
      enum:
        - studio
        - one_room
        - two_room
        - three_room
        - four_room
        - five_room_plus
    SuumoNewBuildFacet:
      type: string
      enum:
        - new_arrival
        - has_floor_plan
        - has_coverage_report
        - disposer
        - induction_cooker
        - water_purifier
        - full_parking
        - pets_allowed
        - enhanced_security
        - front_service
        - shared_facilities
        - manned_24h
        - garbage_24h
        - earthquake_resistant
        - above_20_floors
        - performance_certificate
        - external_insulation
        - fiber_optic
        - all_electric
        - multiple_lines
        - terminal_station
        - supermarket_5min
        - sea_10min
        - category1_low_rise
        - tokyo_tower_view
        - mount_fuji_view
        - double_floor_ceiling
        - floor_heating
        - barrier_free
        - large_bathroom
        - roof_balcony
        - private_garden
        - walk_in_closet
        - large_living
        - high_sash
        - wide_span
        - high_ceiling
        - top_floor
        - above_10th_floor
        - corner_unit
        - below_4th_floor
        - south_facing
    SuumoNewBuildSort:
      type: string
      enum:
        - newest
        - price_asc
        - price_desc
        - area_asc
        - area_desc
        - layout_asc
        - layout_desc
        - total_units_asc
        - total_units_desc
    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
    SuumoProjectPrice:
      properties:
        '@type':
          type: string
          default: SuumoProjectPrice
        price:
          anyOf:
            - type: integer
            - type: 'null'
        price_max:
          anyOf:
            - type: integer
            - type: 'null'
        price_text:
          anyOf:
            - type: string
            - type: 'null'
        sales_phase:
          anyOf:
            - type: string
            - type: 'null'
        layout:
          anyOf:
            - type: string
            - type: 'null'
        area_range:
          anyOf:
            - type: string
            - 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

````