/able/listings

POST /api/able/listings

Price: 5 credits

Get an Able (エイブル) rental room by room code or URL: rent, fees, deposit and key money, layout, size, age, floor, facing, room features, kitchen and bath, equipment, payment, contract terms, costs, brokerage fee discounts, photos and the handling Able shop

How to use it

Room codes come from able/listings/search. building_id opens the building in able/buildings and shop.id the shop in able/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 — Able room code or room URL (examples: "000000092721533003", "https://www.able.co.jp/detail/Detail.do?bk=000000092721533003&prefkey=tokyo"; minLength: 1)

Response

• @type string (default: "AbleListing")
• id string required
• url string required
• building_name string nullable
• building_id 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
• building_type string nullable
• structure string nullable
• floor integer nullable
• floors_total integer nullable
• facing string nullable
• room_features array (default: [])
• kitchen_bath array (default: [])
• equipment array (default: [])
• shared_space_features array (default: [])
• security array (default: [])
• payment string nullable
• parking string nullable
• insurance string nullable
• transaction_type string nullable
• guarantor_company string nullable
• move_in string nullable
• inquiry_number string nullable
• conditions string nullable
• remarks string nullable
• contract string nullable
• other_costs string nullable
• updated_at integer nullable
• next_update_at integer nullable
• brokerage_fees array (default: [])
  • @type string (default: "AbleBrokerageFee")
  • condition string nullable
  • amount integer nullable
• images array (default: [])
  • @type string (default: "AbleImage")
  • url string required
  • caption string nullable
• shop object nullable
  • @type string (default: "AbleListingShop")
  • id string nullable
  • url string nullable
  • name string nullable
  • address string nullable
  • business_hours string nullable
  • phone string nullable
  • license string nullable
  • inquiry_number string nullable
• shops array (default: [])
  • @type string (default: "AbleListingShop")
  • id string nullable
  • url string nullable
  • name string nullable
  • address string nullable
  • business_hours string nullable
  • phone string nullable
  • license string nullable
  • inquiry_number string nullable

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 — Able 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.