get_disclosure
Get disclosure · salt-okunur
One disclosure with normalised metadata (company, ticker, published_at, subject, summary,
fiscal period, related tickers, attachments with ids, source_url) and, by default, the body
as plain text plus structured data flattened to 'path: value' lines.
Parametreler
| ad | tip | zorunlu | varsayılan | açıklama |
|---|---|---|---|---|
disclosure_id |
integerminimum=1 |
evet | — | KAP disclosure index |
format |
enum: summary | text | full |
— | "text" |
summary = metadata only; text = + body as plain text and flattened data; full = + raw KAP payload |
sub_report_list |
string |
— | — | Comma-separated sub-report ids (financial reports) |
max_chars |
integermaximum=200000, minimum=1000 |
— | 30000 |
Girdi şeması
{
"properties": {
"disclosure_id": {
"description": "KAP disclosure index",
"minimum": 1,
"title": "Disclosure Id",
"type": "integer"
},
"format": {
"default": "text",
"description": "summary = metadata only; text = + body as plain text and flattened data; full = + raw KAP payload",
"enum": [
"summary",
"text",
"full"
],
"title": "Format",
"type": "string"
},
"sub_report_list": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Comma-separated sub-report ids (financial reports)",
"title": "Sub Report List"
},
"max_chars": {
"default": 30000,
"maximum": 200000,
"minimum": 1000,
"title": "Max Chars",
"type": "integer"
}
},
"required": [
"disclosure_id"
],
"title": "get_disclosureArguments",
"type": "object"
}
Çıktı şeması
{
"additionalProperties": true,
"title": "get_disclosureDictOutput",
"type": "object"
}