API reference · Financial Datasets
financial-datasets/financial-metrics-snapshot
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/financial-metrics-snapshotModel ID
financial-datasets/financial-metrics-snapshot01
Input Schema
5 parameters · 0 required · 5 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
cik | string | Optional | The Central Index Key (CIK) of the company. Can be used instead of ticker. |
isin | string | Optional | The ISIN (International Securities Identification Number) of a non-US listing. An alternative to `ticker` and `exchange`. |
market | string | Optional | market · Options: UK, US UKUS |
ticker | string | Optional | The ticker symbol of the company. |
exchange | string | Optional | The exchange the ticker is listed on. Omit for US listings. Use `LSE` for the London Stock Exchange; any ticker of the company, including a second share class, returns the company's metrics. Price-based values (market cap, enterprise value, valuation ratios, dividend yield) are not yet available for · Options: LSE LSE |
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/financial-metrics-snapshot", {
method: "POST",
headers: {
Authorization: `Bearer ${apiKey}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());