`get_corporate_actions`

Corporate actions · salt-okunur

Dividends, bonus/rights issues, capital changes, buybacks and general meetings for a company.
    Yahoo supplies exact ex-dates and per-share cash amounts; KAP supplies the disclosures,
    classified by a fixed title keyword table (type 'other' when unmatched). Amounts inside
    KAP bodies are not parsed — read the referenced disclosure. Optionally returns KAP process
    statuses for given reference ids.

Parametreler

ad	tip	zorunlu	varsayılan	açıklama
`ticker`	`string`	evet	—	BIST ticker
`types`	`array<enum: dividend \| capital_increase \| capital_decrease \| capital_change \| bonus_issue \| rights_issue \| share_buyback \| general_meeting \| split \| other>`	—	—	Filter: dividend, capital_increase, capital_decrease, bonus_issue, rights_issue, share_buyback, general_meeting, split
`start_date`	`string`	—	—	YYYY-MM-DD
`end_date`	`string`	—	—	YYYY-MM-DD
`limit`	`integer` maximum=200, minimum=1	—	`30`
`include_kap`	`boolean`	—	`true`	Scan KAP disclosures (needs KAP key; bounded by max_pages)
`max_pages`	`integer`	—	—
`process_ref_ids`	`array<integer>`	—	—	KAP corporate-action process reference ids to get their status

Girdi şeması

{
  "properties": {
    "ticker": {
      "description": "BIST ticker",
      "title": "Ticker",
      "type": "string"
    },
    "types": {
      "anyOf": [
        {
          "items": {
            "enum": [
              "dividend",
              "capital_increase",
              "capital_decrease",
              "capital_change",
              "bonus_issue",
              "rights_issue",
              "share_buyback",
              "general_meeting",
              "split",
              "other"
            ],
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Filter: dividend, capital_increase, capital_decrease, bonus_issue, rights_issue, share_buyback, general_meeting, split",
      "title": "Types"
    },
    "start_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "YYYY-MM-DD",
      "title": "Start Date"
    },
    "end_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "YYYY-MM-DD",
      "title": "End Date"
    },
    "limit": {
      "default": 30,
      "maximum": 200,
      "minimum": 1,
      "title": "Limit",
      "type": "integer"
    },
    "include_kap": {
      "default": true,
      "description": "Scan KAP disclosures (needs KAP key; bounded by max_pages)",
      "title": "Include Kap",
      "type": "boolean"
    },
    "max_pages": {
      "anyOf": [
        {
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Max Pages"
    },
    "process_ref_ids": {
      "anyOf": [
        {
          "items": {
            "type": "integer"
          },
          "maxItems": 100,
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "KAP corporate-action process reference ids to get their status",
      "title": "Process Ref Ids"
    }
  },
  "required": [
    "ticker"
  ],
  "title": "get_corporate_actionsArguments",
  "type": "object"
}

Çıktı şeması

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