/mlit_etsuran/real_estate_brokers

POST /api/mlit_etsuran/real_estate_brokers

Price: 1 credit

Get a Japanese licensed real-estate broker (宅地建物取引業者) from the national register by its licence id: licensing authority, renewal count and number, validity period, first licence date, name and kana, representative, head-office address and phone, staff and licensed agent counts, guarantee association, other businesses, capital and industry associations

How to use it

Take id from license_id of mlit_etsuran/real_estate_brokers/search. capital is in yen. For the broker's offices pass the same id to mlit_etsuran/real_estate_brokers/offices.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — Broker licence id: the licensing authority code followed by the six-digit licence number (examples: "04003998", "00000777"; pattern: ^\d{8}$)

Response

• @type string (default: "MlitEtsuranRealEstateBroker")
• id string required
• authority string nullable
• renewal_count integer nullable
• license_number string required
• valid_from integer nullable
• valid_to integer nullable
• legal_form string nullable
• first_license_date integer nullable
• name string required
• is_emlit_viewable boolean (default: false)
• name_kana string nullable
• representative string nullable
• representative_kana string nullable
• postal_code string nullable
• address string nullable
• employee_count integer nullable
• licensed_agent_count integer nullable
• phone string nullable
• guarantee_association string nullable
• other_businesses array (default: [])
• capital number nullable
• industry_associations 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 — No broker is licensed under that id 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.