View as Markdown
Token Metrics icon

Token Metrics ACTION

Get Correlation

Get the Top 10 and Bottom 10 correlation of tokens with the top 100 market cap tokens. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Token Metrics account once, then configure and run Get Correlation 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-correlation",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    token_metrics: { authProvisionId: "apn_xxxxxxx" },
    tokenId: ["Token IDs"],
    tokenName: ["Token Names"],
  },
})

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 Correlation inputs
Property Type Description
tokenId Token IDs string[]
Select one or more Token IDs to filter results. Example: 3375,3306
Optional
tokenName Token Names string[]
Select one or more crypto asset names to filter results. Example: Bitcoin,Ethereum
Optional
symbol Token Symbols string[]
Select one or more token symbols to filter results. Example: BTC,ETH
Optional
slug Token Slugs string[]
Comma separated token slugs. Example: bitcoin,ethereum
Optional
category Categories string[]
Select categories to filter results. Example: layer-1,nft
Optional
exchange Exchanges string[]
Select exchanges to filter results. Example: gate,binance
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-correlation
Version
0.1.1
App
Token Metrics
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes