# akkru_initial_holdings

What insiders report holding when they become insiders (SEC Form 3), nested filing then holdings; no_securities_owned true means the filer reported holding nothing. Rows failing a consistency check carry data_quality_flags and are left out unless include_anomalies is true.

## Actions

| Action | What it does |
|---|---|
| `list` | One company's (ticker or cik) and/or one insider's (insider_cik) Form 3 filings. 30 credits per page. |
| `stats` | Totals over a filing-date window, with the ids of every holding counted. 40 credits plus 5 per 1,000 holdings counted. shares_owned_total and underlying_shares_total are in different units. |
| `get` | Holdings by id (from stats), up to 100. 10 credits per 5 ids. |
| `insiders` | Everyone who filed a Form 3 for one company, one row per CIK. 30 credits. |
| `tickers` | The companies with Form 3 data, 500 per page. 30 credits per page. |
| `search` | Screen every company's holdings with holding_filters and aggregate_filters. Pro plan or higher; 65-920 credits. |

A company outside your plan's coverage returns 403 and the call is still charged.

## Parameters

| Parameter | Type | Actions | Description |
|---|---|---|---|
| `ticker` | string | `list`, `stats`, `insiders` | 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`, `stats`, `insiders` | Company SEC CIK, digits, e.g. "320193"; any CIK the company has filed under. Give ticker or cik, not both. |
| `insider_cik` | string | `list`, `stats` | Insider SEC CIK, digits (from action "insiders"). |
| `relationship` | array of string | `list`, `stats`, `insiders` | list, stats: the role on the filing, any of "is_director", "is_officer", "is_ten_percent_owner", "is_other". insiders: a role ever reported, any of "ever_director", "ever_officer", "ever_ten_percent_owner", "ever_other". |
| `no_securities_owned` | boolean | `list` | true: only filings that report holding nothing; false: only filings with holdings; default both. |
| `include_unresolved_amendments` | boolean | `list`, `stats` | true: include amendments that could not be matched to their original filing. |
| `exclude_likely_merged` | boolean | `list`, `stats` | true: leave out filings whose amendment match is only probable. |
| `include_anomalies` | boolean | `list`, `stats` | true: include rows that fail a consistency check (left out by default). |
| `start_date` | string | `stats`, `search` | Window start, filing date "YYYY-MM-DD". |
| `as_of_date` | string | `stats`, `search` | Window end, filing date "YYYY-MM-DD" (not in the future). |
| `is_derivative` | boolean | `stats` | true: derivative rows only; false: non-derivative rows only. |
| `ids_page` | integer | `stats` | Page of holding_ids in the stats response (default 1). |
| `ids_page_size` | integer | `stats` | holding_ids per page, 1-1,000 (default 200). |
| `holding_ids` | array of integer | `get` | Holding ids from action "stats" (1-100). |
| `tickers` | array of string | `search` | Only these companies (up to 100); any symbol a company has traded under. Default: every company. |
| `exclude_tickers` | array of string | `search` | Leave these companies out (up to 100). |
| `sectors` | array of string | `search` | Only companies in these sectors (names from akkru_metrics action "catalog"). Pro plan or higher. |
| `holding_filters` | object | `search` | Holding-level filters: relationship, is_derivative, direct_or_indirect (D or I), include_anomalies, exclude_likely_merged, include_unresolved_amendments, and up to 8 conditions {field, op, value} on shares_owned, split_adjusted_shares_owned, underlying_security_shares, split_adjusted_underlying_security_shares or conversion_or_exercise_price. |
| `aggregate_filters` | array of object | `search` | Company-level conditions (up to 8) {metric, op, value} on filing_count, no_securities_filing_count, distinct_insiders, holdings_count or shares_owned_total. Operators for both: >, >=, <, <=, between ([low, high]). |
| `group_by_ticker` | boolean | `search` | true (default): one row per company; false: one row per holding. |
| `sort_by` | string | `search` | Grouped: ticker, holdings_count or shares_owned_total. One row per holding: filing_date, shares_owned, split_adjusted_shares_owned, underlying_security_shares or conversion_or_exercise_price. |
| `sort_order` | string | `search` | "desc" (default) or "asc". |
| `page` | integer | `list`, `get`, `tickers`, `search` | Page number, from 1; the response's next_page gives the next one. |
| `page_size` | integer | `list`, `get`, `tickers`, `search` | list, get: filings per page; search: rows per page, with page times page_size at most 500; tickers: companies per page, up to 500. |
| `detail` | string | `list`, `stats`, `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": "list", "ticker": "TSLA", "page_size": 5}
```

```json
{"action": "stats", "ticker": "TSLA", "start_date": "2020-01-01"}
```

```json
{"action": "get", "holding_ids": [1234, 1235]}
```

```json
{"action": "insiders", "ticker": "TSLA"}
```

```json
{"action": "tickers", "page": 1}
```

```json
{"action": "search", "tickers": ["TSLA"], "holding_filters": {"is_derivative": false}, "page_size": 10}
```
