Martingale42/nautilus-dev / skills/nt-signals
nt-signals
UnverifiedUse when working with indicators, signal generation, bar aggregation, custom data types, analysis statistics, or tearsheets in NautilusTrader.
references/python/analysis/reporter.py
View on GitHub# -------------------------------------------------------------------------------------------------
# Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
# https://nautechsystems.io
#
# Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
# You may not use this file except in compliance with the License.
# You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# -------------------------------------------------------------------------------------------------
import pandas as pd
from nautilus_trader.accounting.accounts.base import Account
from nautilus_trader.core.datetime import unix_nanos_to_dt
from nautilus_trader.model.events import AccountState
from nautilus_trader.model.events import OrderFilled
from nautilus_trader.model.orders import Order
from nautilus_trader.model.position import Position
class ReportProvider:
"""
Provides various portfolio analysis reports.
"""
@staticmethod
def generate_orders_report(orders: list[Order]) -> pd.DataFrame:
"""
Generate an orders report.
Parameters
----------
orders : list[Order]
The orders for the report.
Returns
-------
pd.DataFrame
"""
if not orders:
return pd.DataFrame()
orders_all = [o.to_dict() for o in orders]
return pd.DataFrame(data=orders_all).set_index("client_order_id").sort_index()
@staticmethod
def generate_order_fills_report(orders: list[Order]) -> pd.DataFrame:
"""
Generate an order fills report.
This report provides a row per order.
Parameters
----------
orders : list[Order]
The orders for the report.
Returns
-------
pd.DataFrame
"""
if not orders:
return pd.DataFrame()
filled_orders = [o.to_dict() for o in orders if o.filled_qty > 0]
if not filled_orders:
return pd.DataFrame()
report = pd.DataFrame(data=filled_orders).set_index("client_order_id").sort_index()
report["ts_last"] = [unix_nanos_to_dt(ts_last or 0) for ts_last in report["ts_last"]]
report["ts_init"] = [unix_nanos_to_dt(ts_init) for ts_init in report["ts_init"]]
return report
@staticmethod
def generate_fills_report(orders: list[Order]) -> pd.DataFrame:
"""
Generate a fills report.
This report provides a row per individual fill event.
Parameters
----------
orders : list[Order]
The orders for the report.
Returns
-------
pd.DataFrame
"""
if not orders:
return pd.DataFrame()
fills = [
OrderFilled.to_dict(e) for o in orders for e in o.events if isinstance(e, OrderFilled)
]
if not fills:
return pd.DataFrame()
report = pd.DataFrame(data=fills).set_index("client_order_id").sort_index()
report["ts_event"] = [unix_nanos_to_dt(ts_last or 0) for ts_last in report["ts_event"]]
report["ts_init"] = [unix_nanos_to_dt(ts_init) for ts_init in report["ts_init"]]
del report["type"]
return report
@staticmethod
def generate_positions_report(
positions: list[Position],
snapshots: list[Position] | None = None,
) -> pd.DataFrame:
"""
Generate a positions report.
Parameters
----------
positions : list[Position]
The positions for the report.
snapshots : list[Position], optional
The position snapshots to include in the report.
These will be marked with an 'is_snapshot' column.
Returns
-------
pd.DataFrame
The positions report.
"""
# Combine positions and snapshots
all_positions = positions.copy()
snapshot_ids = set()
if snapshots:
all_positions.extend(snapshots)
snapshot_ids = {str(p.id) for p in snapshots}
if not all_positions:
return pd.DataFrame()
positions_data = [p.to_dict() for p in all_positions]
if not positions_data:
return pd.DataFrame()
sort = ["ts_opened", "ts_closed", "position_id"]
report = pd.DataFrame(data=positions_data).set_index("position_id").sort_values(sort)
del report["signed_qty"]
del report["quote_currency"]
del report["base_currency"]
del report["settlement_currency"]
report["ts_opened"] = [unix_nanos_to_dt(ts_opened) for ts_opened in report["ts_opened"]]
report["ts_closed"] = [
unix_nanos_to_dt(ts_closed) if not pd.isna(ts_closed) else pd.NA
for ts_closed in report["ts_closed"]
]
# Add is_snapshot column
report["is_snapshot"] = report.index.isin(snapshot_ids)
return report
@staticmethod
def generate_account_report(account: Account) -> pd.DataFrame:
"""
Generate an account report for the given optional time range.
Parameters
----------
account : Account
The account for the report.
Returns
-------
pd.DataFrame
"""
states = account.events
if not states:
return pd.DataFrame()
account_states = [AccountState.to_dict(s) for s in states]
balances = [
{**balance, **state}
for state in account_states
for balance in state.pop("balances", [])
]
if not account_states:
return pd.DataFrame()
report = pd.DataFrame(data=balances).set_index("ts_event").sort_index()
report.index = [unix_nanos_to_dt(ts_event) for ts_event in report.index]
del report["ts_init"]
del report["type"]
del report["event_id"]
return report
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |