API reference · Financial Datasets
financial-datasets/kpi-metrics
Integrate this model through SandBase's unified API, with production-ready schemas and examples.
Production endpoint
Send your first request
OpenAI-compatible endpoint with unified authentication and usage tracking.
POST
https://api.sandbase.ai/v1/api/financial-datasets/kpi-metricsModel ID
financial-datasets/kpi-metrics01
Input Schema
7 parameters · 1 required · 6 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
ticker | string | Required | The ticker symbol. |
limit | integer | Optional | 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`. · Max: 50 · Default: 4 |
cursor | string | Optional | 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. |
period | string | Optional | Filter by period type: quarterly or annual. · Options: quarterly, annual · Default: "quarterly" quarterlyannual |
metric_name | string | Optional | Filter to a specific metric (e.g., load_factor, cet1_ratio). |
report_period_gte | string | Optional | Only return metrics on or after this date (YYYY-MM-DD). |
report_period_lte | string | Optional | Only return metrics on or before this date (YYYY-MM-DD). |
02
Output Schema
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the generation task |
status | string | Task status: pending, running, completed, failed, timeout |
model | string | Model used for the generation |
outputs | array | Array of output items |
outputs[].url | string | URL of the generated artifact |
outputs[].content_type | string | MIME type (e.g. image/png, video/mp4) |
error | object | null | Error details if failed, null on success |
error.type | string | Machine-readable error type code |
error.message | string | Human-readable error description |
03
Code Examples
Ready-to-run snippets
const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/api/financial-datasets/kpi-metrics", {
method: "POST",
headers: {
Authorization: `Bearer ${apiKey}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"limit": 4,
"period": "quarterly"
}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());