Metadata-Version: 2.5
Name: llama-index-tools-netnest
Version: 0.1.3
Summary: LlamaIndex tools for the NetNest Design Fundamentals API: company fundamentals and SEC filing events, with the source filing on every number.
Project-URL: Homepage, https://api.netnestdesign.com/docs
Project-URL: Source, https://github.com/NetNest-Design/netnest-fundamentals
Author-email: NetNest Design LLC <registrations@netnestdesign.com>
License-Expression: MIT
License-File: LICENSE
Keywords: edgar,financial data,fundamentals,llama-index,llamaindex,sec,tools
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Office/Business :: Financial
Requires-Python: >=3.10
Requires-Dist: llama-index-core>=0.12
Requires-Dist: netnest-fundamentals>=0.1.0
Provides-Extra: test
Requires-Dist: pytest>=8; extra == 'test'
Description-Content-Type: text/markdown

# llama-index-tools-netnest

LlamaIndex tools for the [NetNest Design Fundamentals API](https://api.netnestdesign.com/docs): company fundamentals
and SEC filing events, with the source filing on every number.

```bash
pip install llama-index-tools-netnest
```

```python
from llama_index.tools.netnest import NetNestToolSpec

tools = NetNestToolSpec(api_key="demo").to_tool_list()  # or your key; defaults to NETNEST_API_KEY
# give tools to FunctionAgent(tools=tools, llm=...)
```

* Tools: `search_company`, `get_company`, `get_fundamentals`, `get_history`, `get_events`, `get_events_head`. Each
  returns the API's JSON as a string.
* An API refusal (unknown ticker, a limit) comes back as `{"error": {...}}` for the agent to read, not an exception.

Data from SEC filings. Not investment advice. MIT licensed; use of the API is governed by its
[terms](https://api.netnestdesign.com/terms). NetNest Design LLC.
