View as Markdown
Token Metrics icon

Token Metrics ACTION

Get Indices Performance

The Indices Performance endpoint provides historical performance data for a given index, including cumulative return on investment (ROI) over time. This data is useful for analyzing index trends and evaluating investment performance. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Token Metrics account once, then configure and run Get Indices Performance from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "token_metrics-get-indices-performance",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    token_metrics: { authProvisionId: "apn_xxxxxxx" },
    id: 10,
    startDate: "Start Date",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Indices Performance inputs
Property Type Description
id ID integer
ID of the index. Example: 1
Required
startDate Start Date string
Start Date accepts date as a string - YYYY-MM-DD format. Example: 2025-01-01
Optional
endDate End Date string
End Date accepts date as a string - YYYY-MM-DD format. Example: 2025-06-01
Optional
limit Limit integer
Limit the number of items in response. Defaults to 50
Optional
page Page integer
Enables pagination and data retrieval control by skipping a specified number of items before fetching data
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
token_metrics-get-indices-performance
Version
0.1.1
App
Token Metrics
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes