← Araçlar

search_disclosures

Search disclosures · salt-okunur

Search KAP disclosures by company, keywords, type/template and date range, newest first,
    with cursor paging. Covers: latest disclosures, a company's disclosures over a period,
    everything since an id (monitoring), topic hunts like 'sözleşme' or 'bedelsiz' across
    companies (use query_scope='content' for subject/summary matching).
    The KAP API only pages by index, so wide ranges scan many windows: check `scan_complete`;
    if false, continue with `cursor` or raise `max_pages`. Items carry `disclosure_id`,
    `templates` (KAP's topic template codes), ticker, company name and `source_url`.

Parametreler

adtipzorunluvarsayılanaçıklama
tickers array<string> — — Restrict to these BIST tickers (e.g. ['THYAO','PGSUS'])
company_id string — — Restrict to one KAP member id
query string — — Keywords (any word matches, Turkish-insensitive). With query_scope='metadata' they match the sender name and the disclosure template name (e.g. 'New Business Relation', 'Valuation Report'); with 'content' also the subject/summary of every scanned item (one KAP call per item, slower).
query_scope enum: metadata | content — "metadata" Where keywords are matched; see `query`
disclosure_type enum: FR | ODA | DG | DUY | FON | CA — — FR financial report, ODA material event, DG other, DUY regulator, FON fund, CA corporate action
disclosure_class enum: FR | ODA | DG | DUY — —
start_date string — — YYYY-MM-DD (inclusive). Resolved to an index via binary search.
end_date string — — YYYY-MM-DD (inclusive)
since_id integer — — Only disclosures newer than this id (polling). Overrides dates.
cursor integer — — `next_cursor` from a previous call to continue paging
limit integer
maximum=200, minimum=1		 — 20
order enum: desc | asc — "desc" desc = newest first
include_details boolean — false Also fetch published_at, subject, summary, attachments per item (one KAP call each)
max_pages integer — — Cap on 50-item index windows scanned (default 40, server max applies). Company/keyword filters on long ranges need more.

Girdi şeması

{
  "properties": {
    "tickers": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "maxItems": 10,
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Restrict to these BIST tickers (e.g. ['THYAO','PGSUS'])",
      "title": "Tickers"
    },
    "company_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Restrict to one KAP member id",
      "title": "Company Id"
    },
    "query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Keywords (any word matches, Turkish-insensitive). With query_scope='metadata' they match the sender name and the disclosure template name (e.g. 'New Business Relation', 'Valuation Report'); with 'content' also the subject/summary of every scanned item (one KAP call per item, slower).",
      "title": "Query"
    },
    "query_scope": {
      "default": "metadata",
      "description": "Where keywords are matched; see `query`",
      "enum": [
        "metadata",
        "content"
      ],
      "title": "Query Scope",
      "type": "string"
    },
    "disclosure_type": {
      "anyOf": [
        {
          "enum": [
            "FR",
            "ODA",
            "DG",
            "DUY",
            "FON",
            "CA"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "FR financial report, ODA material event, DG other, DUY regulator, FON fund, CA corporate action",
      "title": "Disclosure Type"
    },
    "disclosure_class": {
      "anyOf": [
        {
          "enum": [
            "FR",
            "ODA",
            "DG",
            "DUY"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Disclosure Class"
    },
    "start_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "YYYY-MM-DD (inclusive). Resolved to an index via binary search.",
      "title": "Start Date"
    },
    "end_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "YYYY-MM-DD (inclusive)",
      "title": "End Date"
    },
    "since_id": {
      "anyOf": [
        {
          "minimum": 538004,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Only disclosures newer than this id (polling). Overrides dates.",
      "title": "Since Id"
    },
    "cursor": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "`next_cursor` from a previous call to continue paging",
      "title": "Cursor"
    },
    "limit": {
      "default": 20,
      "maximum": 200,
      "minimum": 1,
      "title": "Limit",
      "type": "integer"
    },
    "order": {
      "default": "desc",
      "description": "desc = newest first",
      "enum": [
        "desc",
        "asc"
      ],
      "title": "Order",
      "type": "string"
    },
    "include_details": {
      "default": false,
      "description": "Also fetch published_at, subject, summary, attachments per item (one KAP call each)",
      "title": "Include Details",
      "type": "boolean"
    },
    "max_pages": {
      "anyOf": [
        {
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Cap on 50-item index windows scanned (default 40, server max applies). Company/keyword filters on long ranges need more.",
      "title": "Max Pages"
    }
  },
  "title": "search_disclosuresArguments",
  "type": "object"
}

Çıktı şeması

{
  "additionalProperties": true,
  "title": "search_disclosuresDictOutput",
  "type": "object"
}