Metrics Reference
Overview

Metrics Reference

Complete dictionary of all metrics displayed in Funding Yield OS.

Metric Categories

CategoryDescription
Screener MetricsOpportunity-level metrics in the screener
Simulator MetricsPosition simulation outputs
Planner MetricsPortfolio allocation metrics
Stress MetricsStress test scenario outputs

Common Conventions

Units

Unit TypeFormatExample
Percent pointsXX.X%45.2%
RatioXX.XX%35.50%
USD$X,XXX.XX$1,234.56
HoursXXh24h
ScoreXX.X72.5

Rounding Rules

Metric TypePrecision
APR values1 decimal
Ratios2 decimals
Scores1 decimal
USD (large)Compact notation
USD (small)2 decimals
Hours0-1 decimal

Metric Quality

All metrics include quality metadata:

FieldMeaning
valueThe computed metric value
sourceComputation source (materialized/derived)
freshnessTime since last update
confidenceReliability indicator

Null Handling

When a metric cannot be computed:

  • Display shows "—" or "N/A"
  • Sorting treats null as lowest value
  • Filters exclude null unless explicitly included

Data Lineage

Each metric traces back to:

  1. Raw data source — Exchange API endpoint
  2. Computation path — Formula chain
  3. Materialization time — When computed
  4. Dependencies — Other metrics used

This enables full auditability of any displayed value.

Cookie preferences
We use essential cookies for docs functionality and optional analytics cookies to improve the beta documentation experience. You can accept or reject non-essential cookies. Learn more in our Privacy Policy.