added correlation tokens endpoint action

Author: HarshGautam7101

components/token_metrics/actions/get-correlation/get-correlation.mjs

@@ -0,0 +1,83 @@
+import tokenMetrics from "../../token_metrics.app.mjs";
+import { ENDPOINTS, FILTER_DEFINITIONS } from "../../common/constants.mjs";
+import { buildParams, generateFilterSummary } from "../../common/utils.mjs";
+
+const endpoint = ENDPOINTS.CORRELATION;
+
+export default {
+  key: "token_metrics-get-correlation",
+  name: "Get Correlation",
+  description: `${endpoint.description}. [See the documentation](https://developers.tokenmetrics.com/reference/correlation)`,
+  version: "0.0.1",
+  type: "action",
+  props: {
+    tokenMetrics,
+    // Filter props based on endpoint configuration and API documentation
+    tokenId: {
+      ...FILTER_DEFINITIONS.token_id,
+      description: "Comma Separated Token IDs. Click here to access the list of token IDs. Example: 3375,3306",
+    },
+    symbol: {
+      ...FILTER_DEFINITIONS.symbol,
+      description: "Comma Separated Token Symbols. Click here to access the list of token symbols. Example: BTC,ETH",
+    },
+    category: {
+      ...FILTER_DEFINITIONS.category,
+      description: "Comma separated category name. Click here to access the list of categories. Example: layer-1,nft",
+    },
+    exchange: {
+      ...FILTER_DEFINITIONS.exchange,
+      description: "Comma separated exchange name. Click here to access the list of exchanges. Example: gate,binance",
+    },
+    // Pagination props
+    limit: {
+      propDefinition: [
+        tokenMetrics,
+        "limit",
+      ],
+      description: "Limit the number of items in response. Defaults to 50",
+      default: 50,
+    },
+    page: {
+      propDefinition: [
+        tokenMetrics,
+        "page",
+      ],
+      description: "Enables pagination and data retrieval control by skipping a specified number of items before fetching data. Page should be a non-negative integer, with 1 indicating the beginning of the dataset. Defaults to 1",
+      default: 1,
+    },
+  },
+  async run({ $ }) {
+    // Build parameters using utility function
+    const params = buildParams(this, endpoint.filters);
+
+    try {
+      const response = await this.tokenMetrics.getCorrelation({
+        $,
+        params,
+      });
+
+      // Generate summary using utility function
+      const filterSummary = generateFilterSummary(this, endpoint.filters);
+      
+      // Use $ context for export
+      if ($ && $.export) {
+        const dataLength = response.data?.length || 0;
+        $.export("$summary", `Successfully retrieved correlation data for ${dataLength} tokens${filterSummary}`);
+      }
+      
+      return response;
+    } catch (error) {
+      // Enhanced error handling
+      const errorMessage = error.response?.data?.message || error.message || "An error occurred";
+      const statusCode = error.response?.status;
+      
+      if ($ && $.export) {
+        $.export("$summary", `Error: ${errorMessage}`);
+      }
+      
+      // Throw a more descriptive error
+      throw new Error(`Token Metrics API Error (${statusCode || 'Unknown'}): ${errorMessage}`);
+    }
+  },
+};

components/token_metrics/common/constants.mjs

@@ -188,6 +188,16 @@ export const ENDPOINTS = {
       "symbol",
     ],
   },
+  CORRELATION: {
+    path: "/correlation",
+    description: "Get the Top 10 and Bottom 10 correlation of tokens with the top 100 market cap tokens",
+    filters: [
+      "token_id",
+      "symbol",
+      "category",
+      "exchange",
+    ],
+  },
 };
 
 // Common filter definitions that can be reused across endpoints

components/token_metrics/token_metrics.app.mjs

@@ -261,5 +261,15 @@ export default {
         params,
       });
     },
+    async getCorrelation({
+      $ = this,
+      params = {},
+    }) {
+      return this.makeApiCall({
+        $,
+        endpoint: "/correlation",
+        params,
+      });
+    },
   },
 };