Get KPI metrics
Get sector-specific operational KPIs for a ticker. Includes metrics like load factor, CET1 ratio, same-store sales, FFO per share, and more. Sourced from SEC 8-K earnings releases.
Example code
// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";
const orthogonal = new Orthogonal({
apiKey: process.env.ORTHOGONAL_API_KEY,
});
const output = await orthogonal.run({
api: "financial-datasets",
path: "/kpi/metrics",
query: {
"ticker": "example"
}
});
console.log(output);Query parameters
The ticker symbol.
Filter to a specific metric (e.g., load_factor, cet1_ratio).
Filter by period type: quarterly or annual.
Only return metrics on or after this date (YYYY-MM-DD).
Only return metrics on or before this date (YYYY-MM-DD).
Number of periods to return. Returns all metrics for the N most recent periods. This is the total across all pages, not a page size: each page holds up to 10 records, linked by `next_page_url`.
Opaque pagination cursor from a previous response's next_page_url. When provided, all other query parameters are ignored: the cursor carries the original request's filters. Treat it as opaque; do not construct or modify it.