/able/buildings

POST /api/able/buildings

Price: 5 credits

Get an Able (エイブル) archive building by id or URL: name, address, stations, age, type, structure, floors, parking, environment, facilities, Able rooms listed nearby and the Able shop covering it

How to use it

Building ids come from able/buildings/search and building_id in able/listings. nearby_listing_ids open in able/listings.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• building string required — Able building id or building URL (examples: "4173916", "https://www.able.co.jp/archive/tokyo/bld-4173916/"; minLength: 1)
• prefecture string nullable — Prefecture of the building; taken from the URL when one is given (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")

Response

• @type string (default: "AbleBuilding")
• id string required
• url string required
• name 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")
• 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
• built_at integer nullable
• age_years integer nullable
• building_type string nullable
• structure string nullable
• floors_total integer nullable
• parking string nullable
• environment array (default: [])
• facilities array (default: [])
• nearby_listing_ids array (default: [])
• shop object nullable
  • @type string (default: "AbleBuildingShop")
  • id string nullable
  • name string nullable
  • headline 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
  • address string nullable
  • specialty_stations string nullable
  • specialty_areas 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 archive building under that id in that prefecture 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.