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

> Get a SUUMO (スーモ) rental agency shop (取り扱い店舗) by kc_{ar}_{id} (or shop URL): shop name, phone and fax, office address, nearest stations with walking time, business hours and regular holidays, real estate license number, shop feature tags, catch copy, sales points, staff profiles and photos.

**Price:** 5 credits

**⚠️ Common errors:** 412: Agency shop not found (well-formed id but the shop page does not exist)



## OpenAPI

````yaml /openapi/real-estate.json post /api/suumo/companies
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:
    post:
      tags:
        - /suumo
      summary: /suumo/companies
      description: >-
        Get a SUUMO (スーモ) rental agency shop (取り扱い店舗) by kc_{ar}_{id} (or shop
        URL): shop name, phone and fax, office address, nearest stations with
        walking time, business hours and regular holidays, real estate license
        number, shop feature tags, catch copy, sales points, staff profiles and
        photos.


        **Price:** 5 credits


        **⚠️ Common errors:** 412: Agency shop not found (well-formed id but the
        shop page does not exist)
      operationId: __api_suumo_companies_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuumoCompaniesPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuumoCompany'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SuumoCompaniesPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        company:
          type: string
          minLength: 1
      type: object
      required:
        - company
    SuumoCompany:
      properties:
        '@type':
          type: string
          default: SuumoCompany
        id:
          type: string
        url:
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
        tel:
          anyOf:
            - type: string
            - type: 'null'
        fax:
          anyOf:
            - type: string
            - type: 'null'
        address:
          anyOf:
            - type: string
            - type: 'null'
        stations:
          items:
            $ref: '#/components/schemas/SuumoStation'
          type: array
          default: []
        business_hours:
          anyOf:
            - type: string
            - type: 'null'
        holidays:
          anyOf:
            - type: string
            - type: 'null'
        license_number:
          anyOf:
            - type: string
            - type: 'null'
        features:
          items:
            type: string
          type: array
          default: []
        related_site:
          anyOf:
            - type: string
            - type: 'null'
        catch_copy:
          anyOf:
            - type: string
            - type: 'null'
        sales_points:
          items:
            $ref: '#/components/schemas/SuumoCompanySalesPoint'
          type: array
          default: []
        staff:
          items:
            $ref: '#/components/schemas/SuumoCompanyStaff'
          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
    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
    SuumoCompanySalesPoint:
      properties:
        '@type':
          type: string
          default: SuumoCompanySalesPoint
        text:
          anyOf:
            - type: string
            - type: 'null'
      type: object
    SuumoCompanyStaff:
      properties:
        '@type':
          type: string
          default: SuumoCompanyStaff
        name:
          anyOf:
            - type: string
            - type: 'null'
        age:
          anyOf:
            - type: string
            - type: 'null'
        experience:
          anyOf:
            - type: string
            - type: 'null'
        specialty_areas:
          anyOf:
            - type: string
            - type: 'null'
        specialty_stations:
          anyOf:
            - type: string
            - type: 'null'
        comment:
          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

````