Santiment
What a Santiment metric will actually serve, straight from the API's own
2 endpoints629 calls2/2 passing
Metric Metadata
GET
/v1/finance:santiment/metric-metadatapassing · 0.6s1h cache
Parameters
| Name | Type | In | Description |
|---|---|---|---|
| metric | string | query | Metric name. Default social_volume_total. |
| includeSlugs | enum | query | Include every asset slug this metric covers. Thousands of entries, roughly 37 KB. Default false. One of true, false. |
Example response
{"project":"finance:santiment", "data": {"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" ] },"timestamp":"2026-08-21T02:25:56Z"}
Errors
- 401Missing or invalid x-api-key
- 404Not found or private
- 429Rate limit or monthly quota reached
Metric
One Santiment metric series, at the metric's own minimum interval.
GET
/v1/finance:santiment/metricpassing · 0.3s1h cache
Parameters
| Name | Type | In | Description |
|---|---|---|---|
| metric | string | query | Metric name. Default social_volume_total, which publishes every 5 minutes. |
| slug | string | query | Asset slug as Santiment spells it. Default bitcoin. The `metric-metadata` endpoint lists every slug a metric covers. |
| from | string | query | ISO-8601 start. Default 24 hours before `to`. Must sit inside the restricted window. |
| to | string | query | ISO-8601 end. Default 31 days ago, the newest point the free tier serves. |
| interval | string | query | Bucket size as Nm, Nh, Nd or Nw. Default 5m. Cannot be finer than the metric's own floor. |
| aggregation | enum | query | How points inside a bucket combine. Defaults to the metric's own aggregation. One of ANY, SUM, AVG, MIN, MAX, LAST, FIRST, MEDIAN, COUNT, OHLC. |
Example response
{"project":"finance:santiment", "data": {"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" },"timestamp":"2026-08-21T02:25:56Z"}
Errors
- 401Missing or invalid x-api-key
- 404Not found or private
- 429Rate limit or monthly quota reached
Try it
Live request with your key
const data = await client.run( "finance:santiment", "metric-metadata", { metric: "social_volume_total", includeSlugs: "true" });
Santiment
What a Santiment metric will actually serve, straight from the API's own
2 endpoints629 calls2/2 passing
GET
/v1/…santiment/metric-metadatapassing · 0.6s1h cache
Try it
Parameters
metric
string · query · optional
Metric name. Default social_volume_total.
includeSlugs
enum · query · optional
Include every asset slug this metric covers. Thousands of entries, roughly 37 KB. Default false.
Example response
{"project":"finance:santiment", "data": {"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" ] },"timestamp":"2026-08-21T02:25:56Z"}
Errors
- 401Missing or invalid x-api-key
- 404Not found or private
- 429Rate limit or monthly quota reached
Code
const data = await client.run( "finance:santiment", "metric-metadata", { metric: "social_volume_total", includeSlugs: "true" });