# akkru_events

Corporate events US companies report to the SEC, one section per Item (e.g. 5.02, officer changes), each with a summary and a link to its place in the filing; amendments are merged into the filing they amend. Starter plan or higher; results stop at your plan's history window.

## Actions

| Action | What it does |
|---|---|
| `types` | The Item codes with their official titles. Free. |
| `list` | One company's (ticker or cik) event filings, newest first, with their ids, dates and Items. 10 credits per page. |
| `get` | One filing by filing_id: its sections, amendment history, and on request the original text and the attachments, at no extra cost. 30 credits. |
| `search` | Filings across companies by Items and filing dates, newest first, with the matching sections. Pro plan or higher; 65-280 credits per page. |

list, get and search are charged even when nothing matches or the filing or company is not found.

## Parameters

| Parameter | Type | Actions | Description |
|---|---|---|---|
| `ticker` | string | `list` | Company ticker, e.g. "AAPL" (US), "000100" (Korea), "1332" (Japan), "VIRI_F" (Europe), "600519_CN" (China A-share); any symbol the company has traded under. |
| `cik` | string | `list` | Company SEC CIK, digits, e.g. "320193"; any CIK the company has filed under. Give ticker or cik, not both. |
| `filing_id` | integer | `get` | Event filing id from action "list" or "search". |
| `items` | array of string | `get`, `search` | Item codes, e.g. ["5.02"] (1-33; action "types" lists them). get: only these sections; search: filings with these Items. Default: every Item. |
| `item_match` | string | `search` | "any" (default): a filing with at least one of items; "all": a filing with every one. One of `any`, `all`. |
| `include_original_raw_text` | boolean | `get` | true: also return the filing's complete original text. |
| `include_exhibits` | boolean | `get` | true: also return the filing's attachments with their text. |
| `as_of_date` | string | `get`, `search` | Date "YYYY-MM-DD", not in the future. get: the filing only if it was filed by then (404 otherwise); search: only filings filed by then. |
| `tickers` | array of string | `search` | Only these companies (up to 100); any symbol a company has traded under. Default: every company. |
| `start_date` | string | `search` | Earliest filing date, "YYYY-MM-DD". |
| `end_date` | string | `search` | Latest filing date, "YYYY-MM-DD". |
| `include_unresolved_amendments` | boolean | `search` | true: include amendments that could not be matched to their original filing. |
| `exclude_likely_merged` | boolean | `search` | true: leave out filings whose amendment match is only probable. |
| `page` | integer | `list`, `search` | Page number, from 1; the response's next_page gives the next one. |
| `page_size` | integer | `list`, `search` | list: filings per page, 1-100 (default 50); search: filings per page, 1-10 (default 5), with page times page_size at most 500. |
| `detail` | string | `list`, `get`, `search` | Response detail: "full" (default) returns the most detail available; "light" leaves out the bulkiest fields, such as breakdown lists; "minimal" returns the values with only what defines them. All three are charged the same. One of `full`, `light`, `minimal`. |

## Examples

```json
{"action": "types"}
```

```json
{"action": "list", "ticker": "CNP", "page_size": 5}
```

```json
{"action": "get", "filing_id": 4688, "items": ["5.02"]}
```

```json
{"action": "search", "tickers": ["CNP"], "items": ["5.02"], "start_date": "2023-01-01", "end_date": "2023-01-31"}
```