/chintai/listings

POST /api/chintai/listings

Price: 5 credits

Get a CHINTAI (チンタイ) rental room by room code or URL: rent, fees, deposit and key money, layout, size, building age, floor, structure, stations, equipment groups, contract terms, photos and handling agencies

How to use it

Room codes come from chintai/listings/search. building_id opens the building in chintai/buildings and each companies[].id opens the agency in chintai/companies.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• listing string required — CHINTAI room code or room URL (examples: "C010078470000000001004070037", "https://www.chintai.net/detail/bk-0000000920000000007215330003/"; minLength: 1)

Response

• @type string (default: "ChintaiListing")
• id string required
• url string required
• building_name string nullable
• building_id string nullable
• prefecture string nullable (one of: "hokkaido", "aomori", "iwate", "miyagi", "akita", "yamagata", "fukushima", "ibaraki", "tochigi", "gunma", "saitama", "chiba", "tokyo", "kanagawa", "niigata", "toyama", "ishikawa", "fukui", "yamanashi", "nagano", "gifu", "shizuoka", "aichi", "mie", "shiga", "kyoto", "osaka", "hyogo", "nara", "wakayama", "tottori", "shimane", "okayama", "hiroshima", "yamaguchi", "tokushima", "kagawa", "ehime", "kochi", "fukuoka", "saga", "nagasaki", "kumamoto", "oita", "miyazaki", "kagoshima", "okinawa")
• city_code string nullable
• city string nullable
• address string nullable
• stations array (default: [])
  • @type string (default: "JpRentalStation")
  • line string nullable
  • station string nullable
  • walk_minutes integer nullable
  • bus_minutes integer nullable
  • access string nullable
• rent integer nullable
• management_fee integer nullable
• deposit string nullable
• guarantee_deposit string nullable
• key_money string nullable
• amortization string nullable
• layout string nullable
• room_sizes string nullable
• area number nullable
• built_at integer nullable
• age_years integer nullable
• facing string nullable
• building_type string nullable
• structure string nullable
• floor integer nullable
• floors_total integer nullable
• parking string nullable
• conditions string nullable
• guarantor_company string nullable
• insurance string nullable
• move_in string nullable
• contract_period string nullable
• transaction_type string nullable
• management_code string nullable
• updated_at integer nullable
• next_update_at integer nullable
• lead string nullable
• remarks string nullable
• features array (default: [])
• equipment array (default: [])
  • @type string (default: "ChintaiEquipmentGroup")
  • group string required
  • features array (default: [])
• images array (default: [])
  • @type string (default: "ChintaiImage")
  • url string required
  • caption string nullable
• companies array (default: [])
  • @type string (default: "ChintaiListingCompany")
  • id string nullable
  • url string nullable
  • name string nullable
  • license string nullable
  • phone string nullable
  • address string nullable
  • station string nullable
  • business_hours string nullable
  • holidays string nullable
  • inquiry_number string nullable
  • image string nullable
  • features 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 — CHINTAI has no room under that code 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.