> ## Documentation Index
> Fetch the complete documentation index at: https://docs.asteragents.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Lumonic

> Connect Lumonic to your Agent for portfolio data and financial reporting

## Overview

The Lumonic integration enables your agents to access portfolio data, financial metrics, covenant compliance, and documents from Lumonic. Built for investment teams that need to query entity financials, monitor covenants, and generate portfolio-level analysis.

## Features

* **Entity Search**: Find companies, funds, securities, facilities, and covenants by name
* **Financial Metrics**: Retrieve specific measures with date range and period type filtering
* **Covenant Monitoring**: Check compliance status with historical data
* **Portfolio Analytics**: Tabular views and aggregations across portfolio entities
* **Data Catalog**: Discover available measures, fields, and formulas
* **Document Access**: List and retrieve documents by entity, type, and date range

## Prerequisites

* Active Lumonic account with API access
* Lumonic API key

## Setup Guide

<Steps>
  <Step title="Get Your API Key">
    Obtain your Lumonic API key from your Lumonic account representative or admin portal.
  </Step>

  <Step title="Enable Lumonic Integration">
    In Aster Agents, navigate to **Control Hub > Integrations** and locate the Lumonic card. Click **Connect** and provide your API key.
  </Step>

  <Step title="Add Tools to Your Agent">
    Edit your agent and enable the Lumonic tools you need. We recommend enabling all tools so the agent can discover available data before querying.
  </Step>
</Steps>

## Available Tools

### Entity & Search

* **Lumonic Search Entities** — Search entities across namespaces: Company, Fund, Security, Facility, or Covenant
* **Lumonic List Data Catalog** — Discover available measures (fields and formulas) with filtering by namespace and type

### Financial Data

* **Lumonic Get Entity Financials** — Retrieve specific financial metrics for an entity with date range and period type filtering (Daily, Monthly, Quarterly, Yearly, LTM, NTM, YTD, etc.)
* **Lumonic Portfolio Table** — Get a tabular view of portfolio entities with multiple financial metrics as columns
* **Lumonic Portfolio Aggregate** — Aggregate a metric across entities using SUM, AVG, MIN, MAX, COUNT, or MEDIAN with optional time-series granularity

### Covenants & Documents

* **Lumonic List Covenants** — List covenant definitions with filtering by namespace, entity, or search term
* **Lumonic Get Covenant Status** — Check covenant compliance status with historical data and period filtering
* **Lumonic List Documents** — List documents with filtering by entity, document type, and date range

## Security Considerations

* **Protect your API key** — it provides access to your organization's portfolio data
* **Rotate API keys** periodically
* **Use agent-level tool permissions** to control which agents can access financial data

## Troubleshooting

<AccordionGroup>
  <Accordion title="Authentication Failed">
    * Verify your API key is correct and active
    * Contact your Lumonic administrator to confirm API access is enabled
  </Accordion>

  <Accordion title="No Results Returned">
    * Use **Lumonic Search Entities** to verify entity names and IDs
    * Use **Lumonic List Data Catalog** to discover available measures — measure names must match exactly
    * Check your date range and period type filters
  </Accordion>

  <Accordion title="Missing Metrics">
    * Not all measures are available for all entities or namespaces
    * Use the Data Catalog tool to see which measures are available for your target namespace
    * Some metrics may require specific period types (e.g., quarterly vs. monthly)
  </Accordion>
</AccordionGroup>

## Related Tools

* **Lumonic Search Entities** (`lumonic_search_entities`) - Find entities by name
* **Lumonic Get Entity Financials** (`lumonic_get_entity_financials`) - Retrieve financial metrics
* **Lumonic Portfolio Table** (`lumonic_portfolio_table`) - Tabular portfolio views