/lifull/companies

POST /api/lifull/companies

Price: 10 credits

Get a LIFULL HOME'S (homes.co.jp) real-estate company (不動産会社) by id or /realtor/mid-{id}/ URL: name, name kana, address, transit, business hours, holidays, phone, fax, license number, industry associations, guarantee associations, rent/sale deal categories and features.

How to use it

Fetch a LIFULL HOME'S (homes.co.jp) real-estate company (不動産会社) by company id ('mid-...') or a full '/realtor/mid-{id}/' URL. Returns name, name_kana, address, transit (list), business_hours, holidays, tel, fax, license_number (免許番号), associations (industry bodies), guarantee_associations, rent_deals and sale_deals (handled property categories) and features.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — LIFULL HOME'S real-estate company id (mid-...) or a full /realtor/mid-{id}/ URL (examples: "https://www.homes.co.jp/realtor/mid-109083hNUl2kTJ4S74/", "109083hNUl2kTJ4S74"; minLength: 1)

Response

• @type string (default: "LifullCompany")
• id string required
• url string required
• name string nullable
• name_kana string nullable
• homepage_url string nullable
• address string nullable
• transit array (default: [])
• business_hours string nullable
• holidays string nullable
• tel string nullable
• fax string nullable
• license_number string nullable
• associations array (default: [])
• guarantee_associations array (default: [])
• rent_deals string nullable
• sale_deals 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 — Company not found (well-formed id/URL but the company page does not exist) 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.