/sse/companies/announcements

POST /api/sse/companies/announcements

Price: 5 credits

List the announcements a Shanghai-listed company has published on the Shanghai Stock Exchange, across its whole history: periodic reports, meetings, transactions, refinancing and every other category, with title, publication day, category, PDF link and attachments

How to use it

Newest first; the full history is searchable without a window. An unknown or non-Shanghai code returns an empty list.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Six-digit A-share stock code or SSE company page URL (examples: "600519", "688981", "https://www.sse.com.cn/assortment/stock/list/info/company/index.shtml?COMPANY_CODE=600519"; minLength: 1)
• count integer required — Max number of announcements to return (min: 1; max: 5000)
• keyword string nullable — Words to find in announcement titles (examples: "年度报告"; minLength: 1)
• published_from integer nullable — Earliest publication day, as unix seconds; day-granular (examples: 1577836800)
• published_to integer nullable — Latest publication day, as unix seconds; day-granular (examples: 1790812800)
• categories array nullable — Announcement categories to keep (one of: "periodic_reports", "annual_report", "q1_report", "interim_report", "q3_report", "board_meetings", "shareholder_meetings", "disclosable_transactions", "special_voting_rights", "over_allotment_option", "inquiry_transfers", "depositary_receipts", "ipo", "guarantees", "use_of_proceeds", "earnings_forecasts", "profit_distribution", "trading_anomalies", "share_unlocks_capital_changes", "shareholder_trading", "equity_changes_takeovers", "equity_refinancing", "other_refinancing", "major_restructuring", "mergers", "share_buybacks", "convertible_bonds", "incentive_plans", "related_party_transactions", "litigation", "pledges_freezes", "bankruptcy", "other_major_events", "basic_information_changes", "risk_warnings", "listing_suspension_termination", "corrections", "governance", "intermediary_reports", "trading_halts", "preferred_shares", "cross_border_disclosures", "other"; minItems: 1)

Response

• @type string (default: "SseAnnouncement")
• id string required
• pdf_url string nullable
• published_date integer nullable
• company_code string nullable
• company_name string nullable
• category string nullable
• year integer nullable
• is_shareholder_disclosure boolean nullable
• attachments array (default: [])
  • @type string (default: "SseAnnouncementAttachment")
  • pdf_url string nullable

Errors

• 422 — company is not a six-digit stock code, or published_to is before published_from 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.