/suumo/companies

POST /api/suumo/companies

Price: 5 credits

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.

How to use it

Fetch a single SUUMO (スーモ) rental agency shop by id 'kc_{ar}_{id}' (e.g. 'kc_030_107039021') or a full shop URL. Returns one item with id, name, tel, fax, address, stations (line/station/walk_min), business_hours, holidays, license_number, features, related_site, catch_copy, sales_points (title/text), staff (name/age/experience/specialty_areas/specialty_stations/comment) and image/images.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — SUUMO rental agency shop as kc_{ar}_{id} or a full shop URL (examples: "kc_030_107039021", "https://suumo.jp/chintai/kaisha/kc_030_107039021/"; minLength: 1)

Response

• @type string (default: "SuumoCompany")
• id string required
• url string required
• name string nullable
• tel string nullable
• fax string nullable
• address string nullable
• stations array (default: [])
  • @type string (default: "SuumoStation")
  • line string nullable
  • station string nullable
  • walk_min integer nullable
• business_hours string nullable
• holidays string nullable
• license_number string nullable
• features array (default: [])
• related_site string nullable
• catch_copy string nullable
• sales_points array (default: [])
  • @type string (default: "SuumoCompanySalesPoint")
  • text string nullable
• staff array (default: [])
  • @type string (default: "SuumoCompanyStaff")
  • name string nullable
  • age string nullable
  • experience string nullable
  • specialty_areas string nullable
  • specialty_stations string nullable
  • comment string nullable
• image string nullable
• images array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Agency shop not found (well-formed id but the shop page does not exist) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.