# Get Indices Performance — Token Metrics

> 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…

- Key: `token_metrics-get-indices-performance`
- Type: Action (Write)
- Version: 0.1.1
- App: Token Metrics (`token_metrics`) — https://pipedream.com/apps/token-metrics.md
- This page (HTML): https://pipedream.com/apps/token-metrics/actions/get-indices-performance
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/token_metrics/actions/get-indices-performance/get-indices-performance.mjs

## Description

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](https://developers.tokenmetrics.com/v3/reference/indices-performance)

## Props

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

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "token_metrics",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "token_metrics-get-indices-performance",
  arguments: {
    id: 10,
    startDate: "Start Date",
  },
})
```

**TypeScript**

```ts
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)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "token_metrics-get-indices-performance",
    "configured_props": {
      "token_metrics": { "authProvisionId": "apn_xxxxxxx" },
      "id": 10,
      "startDate": "Start Date"
    }
  }'
```

---

- App: https://pipedream.com/apps/token-metrics.md · All apps: https://pipedream.com/apps