/ullet/shareholders/holdings

POST /api/ullet/shareholders/holdings

Price: 5 credits

Get the Japanese listed companies a large shareholder holds on Ullet, by shareholder id: company code, name, industry, market, the name registered in the company's filings, and five years of shares, holding ratio, market value and share price

How to use it

Shareholder ids come from ullet/shareholders/search and the shareholders of ullet/companies. Shares are counted in shares and market values in yen.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — Ullet shareholder id or URL (examples: "89578", "https://www.ullet.com/s116918.html")
• count integer required — Max number of results (min: 1; max: 2000)
• sort_by string — Order of the holdings (default: "market_value"; one of: "market_value", "holding_ratio")

Response

• @type string (default: "UlletHolding")
• shareholder_id string required
• shareholder_name string nullable
• company_code string required
• company_name string required
• company_url string required
• industry string nullable
• market string nullable
• registered_name string nullable
• positions array (default: [])
  • @type string (default: "UlletPosition")
  • year integer nullable
  • period_end integer nullable
  • shares number nullable
  • holding_ratio number nullable
  • market_value number nullable
  • share_price 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 — No Ullet shareholder 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.