/ullet/companies/performance_ranking

POST /api/ullet/companies/performance_ranking

Price: 5 credits

Rank and screen Japanese listed companies on Ullet by revenue, net income, operating cash flow, total assets, cash or equity, filtered by market, industry, revenue and profit trend and revenue or profit range: rank, code, name, industry, market, the six figures and average salary

How to use it

Figures are from the latest annual statements, in yen. Pass a code to ullet/companies for details.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of results (min: 1; max: 4000)
• metric string — Figure to rank companies by (default: "revenue"; one of: "revenue", "net_income", "operating_cash_flow", "total_assets", "cash", "equity")
• ascending boolean — Rank from the smallest figure up (default: false)
• markets array nullable — Stock markets to include (one of: "prime", "standard", "growth", "other")
• industry string nullable — TSE industry sector (one of: "fishery_agriculture_forestry", "mining", "construction", "foods", "textiles", "pulp_paper", "chemicals", "pharmaceuticals", "oil_coal", "rubber", "glass_ceramics", "iron_steel", "nonferrous_metals", "metal_products", "machinery", "electric_appliances", "transportation_equipment", "precision_instruments", "other_products", "electric_power_gas", "land_transportation", "marine_transportation", "air_transportation", "warehousing", "information_communication", "wholesale", "retail", "banks", "securities", "insurance", "other_financing", "real_estate", "services")
• revenue_trends array nullable — Revenue trend over the last fiscal years (one of: "growing", "v_shaped_recovery", "slowing", "declining")
• profit_trends array nullable — Net income trend over the last fiscal years (one of: "growing", "v_shaped_recovery", "slowing", "declining")
• revenue_min integer nullable — Minimum revenue in yen, applied in units of 100 million yen (min: 0)
• revenue_max integer nullable — Maximum revenue in yen, applied in units of 100 million yen (min: 0)
• net_income_min integer nullable — Minimum net income in yen, applied in units of 100 million yen
• net_income_max integer nullable — Maximum net income in yen, applied in units of 100 million yen

Response

• @type string (default: "UlletCompanyRow")
• rank integer nullable
• code string required
• name string required
• url string required
• industry string nullable
• market string nullable
• attention_stars integer nullable
• revenue number nullable
• net_income number nullable
• operating_cash_flow number nullable
• total_assets number nullable
• cash number nullable
• equity number nullable
• average_salary number nullable
• employees integer nullable
• average_age number nullable
• shareholder_id 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 — The entity was not found, or a precondition failed 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.