> For the complete documentation index, see [llms.txt](https://nasu-capital.gitbook.io/nasu-capital-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference.md).

# Tool reference

All 28 read-only tools, grouped by what they return.

All 28 tools are **read-only**.

{% hint style="info" icon="lock" %}
Access is **per key**. A key can be restricted to a list of tools or bound to a single investor — see [Per-key access control](https://nasu-capital.gitbook.io/nasu-capital-docs/access-control.md). Call `whoami` to see what the current key may do.
{% endhint %}

### Tool groups

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-chart-line" style="color:$primary;">:chart-line:</i></td><td><strong>Accounts &#x26; trading</strong></td><td><code>list_accounts</code> <code>get_account</code> <code>list_account_trades</code> <code>list_account_fills</code> <code>list_account_flows</code></td><td><a href="https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/accounts-and-trading.md">Accounts &amp; trading</a></td></tr><tr><td><i class="fa-money-bill-transfer" style="color:$primary;">:money-bill-transfer:</i></td><td><strong>Requests &#x26; fees</strong></td><td><code>list_requests</code> <code>get_request</code> <code>list_fees</code></td><td><a href="https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/requests-and-fees.md">Requests &amp; fees</a></td></tr><tr><td><i class="fa-clipboard-check" style="color:$primary;">:clipboard-check:</i></td><td><strong>The desk's checks</strong></td><td><code>get_reconciliation</code> <code>list_alerts</code></td><td><a href="https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/desk-checks.md">The desk's checks</a></td></tr><tr><td><i class="fa-users" style="color:$primary;">:users:</i></td><td><strong>Investors</strong></td><td><code>list_investors</code> <code>find_investor</code> <code>get_investor</code></td><td><a href="https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/investors.md">Investors</a></td></tr><tr><td><i class="fa-coins" style="color:$primary;">:coins:</i></td><td><strong>Holdings &#x26; OTC trades</strong></td><td><code>list_holdings</code> <code>get_holding</code> <code>list_otc_trades</code> <code>get_otc_trade</code></td><td><a href="https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/holdings-and-otc-trades.md">Holdings &amp; OTC trades</a></td></tr><tr><td><i class="fa-book-open" style="color:$primary;">:book-open:</i></td><td><strong>Narrative, reference data &#x26; documents</strong></td><td><code>get_active_thesis</code> <code>list_market_thesis</code> <code>list_docbox_terms</code> <code>get_exchange_rates</code> <code>get_platform_settings</code> <code>get_kyc_summary</code> <code>list_documents</code></td><td><a href="https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/fund-narrative-reference-data-and-documents.md">Narrative, reference data &amp; documents</a></td></tr><tr><td><i class="fa-clock-rotate-left" style="color:$primary;">:clock-rotate-left:</i></td><td><strong>Change history</strong></td><td><code>list_changes</code> <code>list_deleted_records</code> <code>get_last_updated</code></td><td><a href="https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/change-history.md">Change history</a></td></tr></tbody></table>

### Conventions

**Two conventions apply to every list tool.**

* **Dates.** `start_date`/`end_date` accept an ISO-8601 date or datetime and are optional; a bare `end_date` covers that whole day.
* **Paging.** Every list response carries `count` (this page), `total` (matching the filter), `limit`, `offset`, `has_more` and `next_offset` — **quote `total`, not `count`**, and follow `next_offset` until it is `null` to walk a full result set.

### All tools

| #  | Tool                    | Purpose                                                              | Group                                                                                                                             |
| -- | ----------------------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| 1  | `list_investors`        | Investors (masked identity, paged)                                   | [Investors](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/investors.md)                                        |
| 2  | `find_investor`         | Find investors by name when you have no UUID                         | [Investors](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/investors.md)                                        |
| 3  | `get_investor`          | One investor by UUID (masked)                                        | [Investors](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/investors.md)                                        |
| 4  | `list_holdings`         | Fund token holdings, lock-up status, valuation                       | [Holdings & OTC](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/holdings-and-otc-trades.md)                     |
| 5  | `get_holding`           | One holding + masked per-investor allocations                        | [Holdings & OTC](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/holdings-and-otc-trades.md)                     |
| 6  | `list_otc_trades`       | Over-the-counter trades and realized P\&L                            | [Holdings & OTC](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/holdings-and-otc-trades.md)                     |
| 7  | `get_otc_trade`         | One OTC trade by UUID                                                | [Holdings & OTC](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/holdings-and-otc-trades.md)                     |
| 8  | `get_active_thesis`     | The fund's current house view                                        | [Narrative](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/fund-narrative-reference-data-and-documents.md)      |
| 9  | `list_market_thesis`    | Thesis history, including superseded entries                         | [Narrative](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/fund-narrative-reference-data-and-documents.md)      |
| 10 | `list_docbox_terms`     | Investor-facing terms and disclosures                                | [Narrative](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/fund-narrative-reference-data-and-documents.md)      |
| 11 | `get_exchange_rates`    | USD-base rates + a `by_currency` map                                 | [Reference data](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/fund-narrative-reference-data-and-documents.md) |
| 12 | `get_platform_settings` | Maintenance mode, developer mode, announcement                       | [Reference data](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/fund-narrative-reference-data-and-documents.md) |
| 13 | `get_kyc_summary`       | KYC counts: every investor by status + compliance records            | [Reference data](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/fund-narrative-reference-data-and-documents.md) |
| 14 | `list_documents`        | Metadata of documents the fund filed                                 | [Documents](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/fund-narrative-reference-data-and-documents.md)      |
| 15 | `whoami`                | This key's limits                                                    | [Introspection](#introspection)                                                                                                   |
| 16 | `list_changes`          | What was created, changed or deleted, and when                       | [Change history](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/change-history.md)                              |
| 17 | `list_deleted_records`  | Records deleted in the dashboard, and when                           | [Change history](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/change-history.md)                              |
| 18 | `get_last_updated`      | When exchange rates and crypto prices were last refreshed            | [Change history](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/change-history.md)                              |
| 19 | `list_accounts`         | Clients' trading accounts: worth, net deposits, profit, return       | [Accounts & trading](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/accounts-and-trading.md)                    |
| 20 | `get_account`           | One account: the profit breakdown, fees paid and due, open positions | [Accounts & trading](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/accounts-and-trading.md)                    |
| 21 | `list_account_trades`   | An account's trades, each with its performance fee                   | [Accounts & trading](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/accounts-and-trading.md)                    |
| 22 | `list_account_fills`    | An account's executions                                              | [Accounts & trading](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/accounts-and-trading.md)                    |
| 23 | `list_account_flows`    | Deposits, withdrawals, fees to the fund and rewards of an account    | [Accounts & trading](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/accounts-and-trading.md)                    |
| 24 | `list_requests`         | Deposit and withdrawal requests                                      | [Requests & fees](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/requests-and-fees.md)                          |
| 25 | `get_request`           | One request with the transfers matched to it                         | [Requests & fees](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/requests-and-fees.md)                          |
| 26 | `list_fees`             | Performance fees, with what is paid and what is due                  | [Requests & fees](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/requests-and-fees.md)                          |
| 27 | `get_reconciliation`    | The latest reconciliation results of every account                   | [The desk's checks](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/desk-checks.md)                              |
| 28 | `list_alerts`           | The alerts raised for the fund's desk                                | [The desk's checks](https://nasu-capital.gitbook.io/nasu-capital-docs/tool-reference/desk-checks.md)                              |

### Introspection

#### `whoami`

No parameters.

Describes the calling key: its label, whether it is investor-scoped and its tool allowlist (`null` when unrestricted).

{% hint style="success" icon="lightbulb" %}
Check this first if a tool returns `tool_not_permitted` — it tells you whether the key is restricted rather than the platform being broken.
{% endhint %}
