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

> Search SUUMO (スーモ) rental agency shops (取り扱い店舗) around a station within a prefecture, with filters for access/opening-hours features, staff features, services and amenities, published SUUMO media and a free-text keyword, with sort order. Returns agency cards with shop name, headline, number of listings, office address, nearest station and walking time, business hours, regular holidays, phone, feature tags and image — each linking to the agency shop by its kc_{ar}_{id} id.

**Price:** 10 credits per 100 results



## OpenAPI

````yaml /openapi/real-estate.json post /api/suumo/companies/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/companies/search:
    post:
      tags:
        - /suumo
      summary: /suumo/companies/search
      description: >-
        Search SUUMO (スーモ) rental agency shops (取り扱い店舗) around a station within
        a prefecture, with filters for access/opening-hours features, staff
        features, services and amenities, published SUUMO media and a free-text
        keyword, with sort order. Returns agency cards with shop name, headline,
        number of listings, office address, nearest station and walking time,
        business hours, regular holidays, phone, feature tags and image — each
        linking to the agency shop by its kc_{ar}_{id} id.


        **Price:** 10 credits per 100 results
      operationId: __api_suumo_companies_search_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuumoCompaniesSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuumoCompanyCard'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SuumoCompaniesSearchPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        pref:
          $ref: '#/components/schemas/SuumoPref'
        station:
          type: string
          minLength: 1
        line:
          anyOf:
            - type: string
              minLength: 1
            - type: 'null'
        access:
          anyOf:
            - items:
                $ref: '#/components/schemas/SuumoCompanyAccess'
              type: array
            - type: 'null'
        staff_features:
          anyOf:
            - items:
                $ref: '#/components/schemas/SuumoCompanyStaffFeature'
              type: array
            - type: 'null'
        services:
          anyOf:
            - items:
                $ref: '#/components/schemas/SuumoCompanyService'
              type: array
            - type: 'null'
        media:
          anyOf:
            - items:
                $ref: '#/components/schemas/SuumoCompanyMedia'
              type: array
            - type: 'null'
        keyword:
          anyOf:
            - type: string
            - type: 'null'
        sort:
          anyOf:
            - $ref: '#/components/schemas/SuumoCompanySearchSort'
            - type: 'null'
        count:
          type: integer
          minimum: 1
      type: object
      required:
        - pref
        - station
        - count
    SuumoCompanyCard:
      properties:
        '@type':
          type: string
          default: SuumoCompanyCard
        id:
          type: string
        url:
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
        headline:
          anyOf:
            - type: string
            - type: 'null'
        listing_count:
          anyOf:
            - type: integer
            - type: 'null'
        address:
          anyOf:
            - type: string
            - type: 'null'
        station:
          anyOf:
            - type: string
            - type: 'null'
        walk:
          anyOf:
            - type: string
            - type: 'null'
        business_hours:
          anyOf:
            - type: string
            - type: 'null'
        holidays:
          anyOf:
            - type: string
            - type: 'null'
        tel:
          anyOf:
            - type: string
            - type: 'null'
        features:
          items:
            type: string
          type: array
          default: []
        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
    SuumoCompanyAccess:
      type: string
      enum:
        - open_late
        - near_station
        - open_year_round
        - parking
        - car_pickup
    SuumoCompanyStaffFeature:
      type: string
      enum:
        - foreign_language
        - female_staff
        - consulting_master
    SuumoCompanyService:
      type: string
      enum:
        - local_10_years
        - multi_store
        - kids_service
        - barrier_free
        - rent_guarantor
        - no_guarantor_ok
        - move_in_loan
        - mover_referral
        - management_24h
        - handles_sales
        - corporate_contracts
        - company_housing
    SuumoCompanyMedia:
      type: string
      enum:
        - has_video
        - has_coupon
        - has_staff_comment
    SuumoCompanySearchSort:
      type: string
      enum:
        - name_asc
        - name_desc
        - listings_desc
        - listings_asc
    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

````