/apamanshop/buildings

POST /api/apamanshop/buildings

Price: 10 credits

Get an Apamanshop (アパマンショップ) building by code or URL: name, type, address, location, stations, rent, layout and size ranges, floors, build date and every room listed in it now

How to use it

Building codes come from building_id in apamanshop/listings/search and apamanshop/buildings/search; pass the city_code searched with a bare code. Pass a rooms[].id to apamanshop/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 — Apamanshop building code or building URL (examples: "52020102800135", "https://www.apamanshop.com/tokyo/112/b52020102800135/"; minLength: 1)
• city_code string nullable — Japanese city code (JIS) of the building; taken from the URL when one is given

Response

• @type string (default: "ApamanshopBuilding")
• id string required
• url string required
• name string nullable
• building_type string nullable
• address string nullable
• latitude number nullable
• longitude number 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_min integer nullable
• rent_max integer nullable
• layouts string nullable
• area_min number nullable
• area_max number nullable
• floors_total integer nullable
• built_at integer nullable
• images array (default: [])
  • @type string (default: "ApamanshopImage")
  • url string required
  • caption string nullable
• rooms array (default: [])
  • @type string (default: "ApamanshopRoom")
  • id string required
  • url string required
  • building_id string nullable
  • building_name string nullable
  • building_type 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
  • floors_total integer nullable
  • age_years integer nullable
  • structure string nullable
  • building_image string nullable
  • floor integer nullable
  • rent integer nullable
  • management_fee integer nullable
  • deposit string nullable
  • key_money string nullable
  • layout string nullable
  • area number nullable
  • floor_plan_image string nullable
  • comment string nullable
  • tags array (default: [])
  • shop object nullable
    • @type string (default: "ApamanshopRoomShop")
    • id string nullable
    • name string nullable
    • rating number 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 — Apamanshop has no building under that code in that city 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.