/ullet/companies

POST /api/ullet/companies

Price: 10 credits

Get a Japanese listed company from Ullet by securities code: profile, five years of balance sheet, income statement, cash flow and key indicators, quarterly indicators, workforce and average salary by year, major shareholders with five years of holdings, officers with career, and the latest EDINET filings

How to use it

Statement values are in yen unless the item's unit says percent; each item's values follow period_ends. A shareholder_id goes to ullet/shareholders/holdings.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• code string required — TSE securities code or ullet.com company URL (examples: "7203", "543A", "https://www.ullet.com/6594.html")

Response

• @type string (default: "UlletCompany")
• code string required
• name string required
• url string required
• english_name string nullable
• industry string nullable
• market string nullable
• website string nullable
• address string nullable
• established_date integer nullable
• listed_year_month string nullable
• fiscal_year_end_month integer nullable
• dividend_per_share number nullable
• employees integer nullable
• employees_consolidated integer nullable
• average_age number nullable
• average_tenure_years number nullable
• average_salary number nullable
• average_salary_rank integer nullable
• highlights array (default: [])
  • @type string (default: "UlletHighlight")
  • metric string required
  • value number nullable
  • rank integer nullable
• statements array (default: [])
  • @type string (default: "UlletStatement")
  • statement string required
  • period_ends array (default: [])
  • line_items array (default: [])
    • @type string (default: "UlletStatementItem")
    • name string required
    • unit string required
    • values array (default: [])
• workforce array (default: [])
  • @type string (default: "UlletWorkforce")
  • period_end integer nullable
  • employees integer nullable
  • employees_consolidated integer nullable
  • average_age number nullable
  • average_tenure_years number nullable
  • average_salary number nullable
• major_shareholders array (default: [])
  • @type string (default: "UlletMajorShareholder")
  • name string required
  • registered_name string nullable
  • shareholder_id string nullable
  • company_code 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
  • filings array (default: [])
    • @type string (default: "UlletFiling")
    • document_id string nullable
    • filed_date integer nullable
    • filer string nullable
    • subject string nullable
    • subject_code string nullable
    • subject_shareholder_id string nullable
    • pdf_url string nullable
• officers array (default: [])
  • @type string (default: "UlletOfficer")
  • name string required
  • birth_date integer nullable
  • person_id string nullable
  • career string nullable
• filings array (default: [])
  • @type string (default: "UlletFiling")
  • document_id string nullable
  • filed_date integer nullable
  • filer string nullable
  • subject string nullable
  • subject_code string nullable
  • subject_shareholder_id string nullable
  • pdf_url 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 — No Ullet company under that securities 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.