/apamanshop/listings

POST /api/apamanshop/listings

Price: 5 credits

Get an Apamanshop (アパマンショップ) rental room by room code or URL: rent, total monthly estimate, fees, deposit and key money, layout, size, floor, facing, age, structure, equipment, contract terms, costs, surroundings, photos and every handling shop

How to use it

Room codes come from apamanshop/listings/search and apamanshop/buildings. building_id opens the building in apamanshop/buildings and each shops[].id opens the shop in apamanshop/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 — Apamanshop room code or room URL (examples: "20260413009823", "https://www.apamanshop.com/tokyo/112/b52026040600236/20260413009823/"; minLength: 1)

Response

• @type string (default: "ApamanshopListing")
• id string required
• url string required
• building_id string nullable
• building_name string nullable
• building_type string nullable
• room_number 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 integer nullable
• total_monthly_estimate integer nullable
• management_fee integer nullable
• amortization string nullable
• deposit string nullable
• key_money string nullable
• layout string nullable
• room_sizes string nullable
• area number nullable
• floor integer nullable
• floors_total integer nullable
• facing string nullable
• built_at integer nullable
• structure string nullable
• total_units integer nullable
• parking string nullable
• equipment array (default: [])
• conditions string nullable
• other_initial_costs string nullable
• other_monthly_costs string nullable
• move_out_costs string nullable
• surroundings string nullable
• contract_period string nullable
• insurance string nullable
• move_in string nullable
• guarantor_company string nullable
• remarks string nullable
• published_at integer nullable
• next_update_at integer nullable
• images array (default: [])
  • @type string (default: "ApamanshopImage")
  • url string required
  • caption string nullable
• shops array (default: [])
  • @type string (default: "ApamanshopListingShop")
  • id string nullable
  • url string nullable
  • name string nullable
  • rating number nullable
  • company string nullable
  • address string nullable
  • business_hours string nullable
  • license string nullable
  • transaction_type string nullable
  • association string nullable
  • fair_trade_council string nullable
  • property_number string nullable
  • comment string nullable
  • image 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 — Apamanshop 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.