glassnode-api 0.1.0 → 0.1.4

package/README.md

@@ -5,7 +5,7 @@ A Node.js client for the [Glassnode API](https://docs.glassnode.com/).
 ## Installation
 
 ```bash
-yarn add glassnode-api
+npm install glassnode-api
 ```
 
 ## Usage
@@ -43,30 +43,36 @@ async function getMetrics() {
 
 ## Examples
 
-Check the `examples` directory for usage examples. To run the examples:
+Explore our [detailed examples](./examples/README.md) to learn how to use the Glassnode API client effectively. The examples demonstrate:
+
+- Fetching and validating asset metadata
+- Working with metric lists and metadata
+- Calling metrics with parameters
+
+To run the examples:
 
 1. Navigate to the examples directory
-2. Create a `.env` file based on `.env.example` with your API key
-3. Install dependencies with `yarn install`
-4. Run an example with `yarn ts-node metadata.ts`
+2. Create a `.env` file with your API key: `GLASSNODE_API_KEY=your_key_here`
+3. Install dependencies with `npm install`
+4. Run an example with `npx ts-node metadata.validation.ts`
 
 ## Development
 
 ```bash
 # Install dependencies
-yarn install
+npm install
 
 # Build the project
-yarn build
+npm run build
 
 # Run tests
-yarn test
+npm test
 
 # Lint code
-yarn lint
+npm run lint
 
 # Format code
-yarn format
+npm run format
 ```
 
 ## License

package/dist/examples/metadata.validation.d.ts

@@ -0,0 +1 @@
+import 'dotenv/config';

package/dist/examples/metadata.validation.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const src_1 = require("../src");
+const zod_1 = require("zod");
+require("dotenv/config");
+// Create an instance of the API client
+const api = new src_1.GlassnodeAPI({
+    apiKey: process.env.GLASSNODE_API_KEY || '', // Get API key from .env file
+});
+async function fetchAssetMetadata() {
+    try {
+        // Get asset metadata
+        console.log('Fetching asset metadata...');
+        const assetMetadata = await api.getAssetMetadata();
+        // Show total number of assets
+        console.log(`Found ${assetMetadata.length} assets in total`);
+        // Custom validation: Check if USDC is present in the response
+        const USDCSchema = zod_1.z.object({
+            symbol: zod_1.z.literal('USDC'),
+            name: zod_1.z.literal('USDC'),
+            asset_type: zod_1.z.literal('TOKEN'),
+        });
+        // Create a refine function that looks for USDC
+        const usdc = assetMetadata.find((asset) => asset.symbol === 'USDC');
+        if (usdc) {
+            try {
+                USDCSchema.parse(usdc);
+                console.log('✅ USDC validation successful');
+                // Print 3 first blockchains for USDC
+                console.log('First 3 blockchains for USDC:');
+                usdc.blockchains.slice(0, 3).forEach((blockchain) => {
+                    console.log(`  - ${blockchain.blockchain} - ${blockchain.address}`);
+                });
+            }
+            catch (error) {
+                if (error instanceof zod_1.z.ZodError) {
+                    console.error('❌ Schema validation failed:', error.errors);
+                }
+                else {
+                    throw error;
+                }
+            }
+        }
+        else {
+            console.log('❌ USDC not found in response');
+        }
+    }
+    catch (error) {
+        console.error('Error fetching asset metadata:', error);
+    }
+}
+async function fetchMetricList() {
+    try {
+        console.log('\nFetching metric list...');
+        const metricList = await api.getMetricList();
+        // Display basic metrics information
+        console.log(`Found ${metricList.length} metrics in total`);
+        // Check for market metrics
+        const marketMetrics = metricList.filter((metric) => metric.startsWith('/market/'));
+        if (marketMetrics.length > 0) {
+            console.log(`✅ Found ${marketMetrics.length} market metrics`);
+            console.log(`First 3 market metrics:`);
+            marketMetrics.slice(0, 3).forEach((metric) => console.log(`  - ${metric}`));
+        }
+        else {
+            console.log('❌ No market metrics found');
+        }
+    }
+    catch (error) {
+        console.error('Error fetching metric list:', error);
+    }
+}
+async function fetchExchangeBalanceMetadata() {
+    try {
+        console.log('\nFetching exchange balance metadata...');
+        const metricPath = '/distribution/balance_exchanges';
+        const metadata = await api.getMetricMetadata(metricPath);
+        console.log('✅ Exchange balance metadata:');
+        console.log(`  Path: ${metadata.path}`);
+        console.log(`  Tier: ${metadata.tier}`);
+        console.log(`  Modified: ${metadata.modified?.toISOString()}`);
+        // Display available parameters
+        console.log('\nAvailable parameters:');
+        // Only print the firt 3 values per parameter
+        Object.entries(metadata.parameters).forEach(([key, values]) => {
+            console.log(`  ${key}: ${values.slice(0, 3).join(', ')}`);
+        });
+        // Display documentation links
+        if (metadata.refs.docs) {
+            console.log(`\nDocumentation: ${metadata.refs.docs}`);
+        }
+        if (metadata.refs.studio) {
+            console.log(`Studio: ${metadata.refs.studio}`);
+        }
+    }
+    catch (error) {
+        console.error('Error fetching exchange balance metadata:', error);
+    }
+}
+async function fetchExchangeBalanceWithParams() {
+    try {
+        console.log('\nFetching exchange balance metadata with specific parameters...');
+        const metricPath = '/distribution/balance_exchanges';
+        const params = { a: 'BTC' };
+        const metadata = await api.getMetricMetadata(metricPath, params);
+        console.log('✅ Exchange balance metadata for BTC:');
+        console.log(`  Path: ${metadata.path}`);
+        console.log(`  Tier: ${metadata.tier}`);
+        // Display queried parameters
+        console.log('\nQueried parameters:');
+        Object.entries(metadata.queried).forEach(([key, value]) => {
+            console.log(`  ${key}: ${value}`);
+        });
+    }
+    catch (error) {
+        console.error('Error fetching exchange balance metadata with parameters:', error);
+    }
+}
+// Execute the examples
+async function runExamples() {
+    await fetchAssetMetadata();
+    await fetchMetricList();
+    await fetchExchangeBalanceMetadata();
+    await fetchExchangeBalanceWithParams();
+}
+runExamples();

package/dist/examples/metric.dump.d.ts

@@ -0,0 +1 @@
+import 'dotenv/config';

package/dist/examples/metric.dump.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const src_1 = require("../src");
+require("dotenv/config");
+// Create an instance of the API client
+const api = new src_1.GlassnodeAPI({
+    apiKey: process.env.GLASSNODE_API_KEY || '', // Get API key from .env file
+});
+// Execute the examples
+async function runExamples() {
+    //const assetMetadata = await api.getAssetMetadata();
+    const metricList = await api.getMetricList();
+    for (const metric of metricList.slice(0, 10)) {
+        const metricMetadata = await api.getMetricMetadata(metric);
+        const params = metricMetadata.parameters;
+        // create params object from params array
+        const paramsObject = {};
+        for (const param of Object.keys(params)) {
+            // Fix: params[param] is an array of strings, not an object with values property
+            if (Array.isArray(params[param]) && params[param].length > 0) {
+                paramsObject[param] = params[param][0];
+            }
+        }
+        const result = (await api.callMetric(metric, paramsObject));
+        console.log(result[0]);
+    }
+}
+runExamples();

package/dist/{glassnode-api.js → src/glassnode-api.js}

@@ -32,6 +32,7 @@ class GlassnodeAPI {
             api_key: this.apiKey,
         });
         const url = `${this.apiUrl}${endpoint}?${queryParams}`;
+        console.log('  API call:', url);
         try {
             const response = await fetch(url);
             if (!response.ok) {
@@ -85,7 +86,7 @@ class GlassnodeAPI {
      * @returns Promise resolving to the response data
      */
     async callMetric(metricPath, params = {}) {
-        const response = await this.request('https://api.glassnode.com/v1/metrics/addresses' + metricPath, params);
+        const response = await this.request('/v1/metrics' + metricPath, { ...params, f: 'json' });
         return response;
     }
 }

package/dist/{types → src/types}/metadata.d.ts

@@ -252,7 +252,7 @@ export declare const MetricMetadataSchema: z.ZodObject<{
     /**
      * The last date that the metadata was updated
      */
-    modified: z.ZodEffects<z.ZodNumber, Date, number>;
+    modified: z.ZodEffects<z.ZodOptional<z.ZodNumber>, Date | undefined, number | undefined>;
     /**
      * Next parameter for the metric
      */
@@ -281,24 +281,24 @@ export declare const MetricMetadataSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     path: string;
     tier: number;
-    modified: Date;
     refs: {
         docs?: string | undefined;
         studio?: string | undefined;
     };
     queried: Record<string, any>;
     parameters: Record<string, string[]>;
+    modified?: Date | undefined;
     next_param?: string | undefined;
 }, {
     path: string;
     tier: number;
-    modified: number;
     refs: {
         docs?: string | undefined;
         studio?: string | undefined;
     };
     queried: Record<string, any>;
     parameters: Record<string, string[]>;
+    modified?: number | undefined;
     next_param?: string | undefined;
 }>;
 /**
@@ -320,7 +320,7 @@ export declare const MetricMetadataResponseSchema: z.ZodObject<{
     /**
      * The last date that the metadata was updated
      */
-    modified: z.ZodEffects<z.ZodNumber, Date, number>;
+    modified: z.ZodEffects<z.ZodOptional<z.ZodNumber>, Date | undefined, number | undefined>;
     /**
      * Next parameter for the metric
      */
@@ -349,24 +349,24 @@ export declare const MetricMetadataResponseSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     path: string;
     tier: number;
-    modified: Date;
     refs: {
         docs?: string | undefined;
         studio?: string | undefined;
     };
     queried: Record<string, any>;
     parameters: Record<string, string[]>;
+    modified?: Date | undefined;
     next_param?: string | undefined;
 }, {
     path: string;
     tier: number;
-    modified: number;
     refs: {
         docs?: string | undefined;
         studio?: string | undefined;
     };
     queried: Record<string, any>;
     parameters: Record<string, string[]>;
+    modified?: number | undefined;
     next_param?: string | undefined;
 }>;
 /**

package/dist/{types → src/types}/metadata.js

@@ -90,7 +90,10 @@ exports.MetricMetadataSchema = zod_1.z.object({
     /**
      * The last date that the metadata was updated
      */
-    modified: zod_1.z.number().transform((val) => new Date(val * 1000)),
+    modified: zod_1.z
+        .number()
+        .optional()
+        .transform((val) => (val ? new Date(val * 1000) : undefined)),
     /**
      * Next parameter for the metric
      */

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "glassnode-api",
-  "version": "0.1.0",
+  "version": "0.1.4",
   "description": "Node.js client for the Glassnode API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/planadecu/glassnode-api-node.git"
+  },
   "scripts": {
     "build": "tsc",
     "test": "jest",
@@ -34,7 +38,7 @@
     "prettier": "^3.5.3",
     "ts-jest": "^29.3.2",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.32.0"
+    "typescript-eslint": "^8.32.1"
   },
   "lint-staged": {
     "*.{js,ts,mjs}": [

package/dist/types/response.d.ts

@@ -1,39 +0,0 @@
-import { z } from 'zod';
-/**
- * Generic API response schema
- */
-export declare const ResponseSchema: <T extends z.ZodTypeAny>(dataSchema: T) => z.ZodObject<{
-    /**
-     * Response data
-     */
-    data: T;
-}, "strip", z.ZodTypeAny, z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
-    /**
-     * Response data
-     */
-    data: T;
-}>, any> extends infer T_1 ? { [k in keyof T_1]: z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
-    /**
-     * Response data
-     */
-    data: T;
-}>, any>[k]; } : never, z.baseObjectInputType<{
-    /**
-     * Response data
-     */
-    data: T;
-}> extends infer T_2 ? { [k_1 in keyof T_2]: z.baseObjectInputType<{
-    /**
-     * Response data
-     */
-    data: T;
-}>[k_1]; } : never>;
-/**
- * Generic API response type
- */
-export type Response<T> = {
-    /**
-     * Response data
-     */
-    data: T;
-};

package/dist/types/response.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResponseSchema = void 0;
-const zod_1 = require("zod");
-/**
- * Generic API response schema
- */
-const ResponseSchema = (dataSchema) => zod_1.z.object({
-    /**
-     * Response data
-     */
-    data: dataSchema
-});
-exports.ResponseSchema = ResponseSchema;