Skip to Content
Tool ReferenceOperational KPIsOperational KPI Drivers

Operational KPI Drivers

Extract non-XBRL operational KPI values and driver growth rates from filing narrative.

Tier: paid | Cache: llm-call | Playground: authenticated only | Contract: 1.0.0

When To Use It

Use these tools for operational metrics that are not consistently modeled as standard XBRL financial concepts.

Request Examples

BASE_URL="${EDGAR_API_URL:-https://www.edgarparser.com}" curl -sS -G "$BASE_URL/api/operational-kpis/drivers" \ -H "Authorization: Bearer $EDGAR_API_KEY" \ --data-urlencode "ticker=AAPL" \ --data-urlencode "year=2025" \ --data-urlencode "quarter=4"
import os import requests base_url = os.getenv("EDGAR_API_URL", "https://www.edgarparser.com") headers = {"Authorization": f"Bearer {os.environ['EDGAR_API_KEY']}"} params = { "ticker": "AAPL", "year": 2025, "quarter": 4 } response = requests.get(f"{base_url}/api/operational-kpis/drivers", headers=headers, params=params, timeout=30) response.raise_for_status() data = response.json()

Response Fields To Inspect

  • Driver name, value, units, period, and source evidence before using a KPI in an answer.
  • Coverage or provenance fields when a KPI comes from narrative disclosures.
  • Directional and period-comparison fields before describing a trend.

Errors And Coverage

  • 401 or 403: the API key is missing, expired, or not allowed to use this tier.
  • 429: retry after the rate-limit window, and prefer broader batch or series tools over repeated single-period calls.
  • Paid or LLM-backed paths should be used only when cheaper fact, filing, table, or text tools cannot answer the question.
  • Treat partial coverage, empty arrays, and warning fields as answer-quality signals even when HTTP status is 200.

Filing Document, Filing Evidence, Search Extractions

Generated Reference

Contract

FieldValue
Toolget_operational_kpi_drivers
MethodGET
Path/api/operational-kpis/drivers
Contract version1.0.0
Schema fingerprintsha256:6edc6f27040654758ec78a1c3bd01f7a9467524933356f79bc9aa08f0d0a43de

Parameters

NameLocationRequiredTypeNotes
tickerqueryyesstring
yearqueryyesinteger
quarterqueryyesinteger
sourcequerynostring | null
topicquerynostring | null
filter_to_topicquerynoboolean
include_non_numericquerynoboolean

Response Schema (200)

{ "additionalProperties": true, "type": "object" }