What a Santiment metric will actually serve, straight from the API's own
metric-metadatanot measuredmetricnot measured/v1/finance:santiment/metric-metadata1h cache2 paramschecking key…// npm i zpi-sdk
import { ZpiClient } from "zpi-sdk";
const client = new ZpiClient({ apiKey: "zpi_xxxxxxxxxxxxxxxxxxxxxxxx" });
const data = await client.run("finance:santiment", "metric-metadata", {
"metric": "social_volume_total",
"includeSlugs": "true"
});
console.log(data);curl -X GET "https://api.zpi.web.id/v1/finance:santiment/metric-metadata?metric=social_volume_total&includeSlugs=true" \
-H "x-api-key: zpi_xxxxxxxxxxxxxxxxxxxxxxxx"/v1/finance:santiment/metric-metadataWhat a Santiment metric will actually serve, straight from the API's ownmetricstringoptionalincludeSlugsenumoptionalcurl -X GET "https://api.zpi.web.id/v1/finance:santiment/metric-metadata?metric=social_volume_total&includeSlugs=true" \
-H "x-api-key: zpi_xxxxxxxxxxxxxxxxxxxxxxxx"{
"count": 0,
"items": [],
"total": null,
"metric": "social_volume_total",
"dataset": "metric-metadata",
"provider": "santiment",
"minInterval": "5m",
"isRestricted": true,
"restrictedTo": "2026-07-22T02:25:57Z",
"restrictedFrom": "2025-08-21T02:25:57Z",
"defaultAggregation": "SUM",
"availableAggregations": [
"ANY",
"SUM",
"AVG",
"MIN",
"MAX",
"LAST",
"FIRST",
"MEDIAN"
]
}/v1/finance:santiment/metricOne Santiment metric series, at the metric's own minimum interval.metricstringoptionalslugstringoptionalmetric-metadata endpoint lists every slug a metric covers.fromstringoptionalto. Must sit inside the restricted window.tostringoptionalintervalstringoptionalaggregationenumoptionalcurl -X GET "https://api.zpi.web.id/v1/finance:santiment/metric?metric=social_volume_total&slug=bitcoin&from=2026-07-20T00%3A00%3A00Z&to=2026-07-21T00%3A00%3A00Z&interval=5m&aggregation=SUM" \
-H "x-api-key: zpi_xxxxxxxxxxxxxxxxxxxxxxxx"{
"to": "2026-07-21T02:25:57Z",
"from": "2026-07-20T02:25:57Z",
"slug": "bitcoin",
"count": 288,
"items": [
{
"date": "2026-07-20T02:30:00Z",
"time": 1784514600,
"value": 3
},
{
"date": "2026-07-20T02:35:00Z",
"time": 1784514900,
"value": 4
},
{
"date": "2026-07-20T02:40:00Z",
"time": 1784515200,
"value": 3
},
{
"date": "2026-07-20T02:45:00Z",
"time": 1784515500,
"value": 6
},
{
"date": "2026-07-20T02:50:00Z",
"time": 1784515800,
"value": 5
},
{
"date": "2026-07-20T02:55:00Z",
"time": 1784516100,
"value": 3
},
{
"date": "2026-07-20T03:00:00Z",
"time": 1784516400,
"value": 5
},
{
"date": "2026-07-20T03:05:00Z",
"time": 1784516700,
"value": 5
}
],
"metric": "social_volume_total",
"dataset": "metric",
"interval": "5m",
"provider": "santiment",
"aggregation": "SUM",
"minInterval": "5m",
"isRestricted": true,
"restrictedTo": "2026-07-22T02:25:57Z",
"restrictedFrom": "2025-08-21T02:25:57Z"
}