Skip to main content
GET
Narratives data

Authorizations

Authorization
string
header
required

Pass your API key as a Bearer token in the Authorization header: Authorization: Bearer sk_live_...

Query Parameters

narrative
string

Narrative to return detail for: the config id (e.g. dex) or the URL slug (e.g. dex-tokens, layer-1, ai-agents). An unknown value returns 400 invalid_parameter listing the valid values.

correlation
string

Set to "true" to include correlation data.

timeframe
string

Timeframe for correlation data.

sort
enum<string>

List only: order narratives by 24h return, highest (-return24h) or lowest (return24h) first; a narrative without a 24h return is last either way.

Available options:
-return24h,
return24h
top
integer

List only: add top, the N narratives with the highest 24h change.

Required range: 1 <= x <= 50
bottom
integer

List only: add bottom, the N narratives with the lowest 24h change.

Required range: 1 <= x <= 50
format
enum<string>
default:json

Response format. When set to "csv", the response Content-Type is text/csv instead of JSON.

Available options:
json,
csv

Response

Narratives data returned successfully.

data
object
required

Endpoint-specific response payload. See the operation response schema.

meta
object
required