Skip to content

Commit 41f1a3c

Browse files
ivaylopivanovivaylopivanov
committed
feat: filter metrics by multiple params
1 parent 8161a86 commit 41f1a3c

5 files changed

Lines changed: 110 additions & 19 deletions

File tree

‎README.md‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,13 +104,32 @@ gn asset describe BTC
104104

105105
### `gn metric list`
106106

107-
List all available metrics, optionally filtered by asset.
107+
List all available metrics, optionally filtered by [metadata query parameters](https://docs.glassnode.com/basic-api/metadata#query-parameters-1).
108108

109109
```bash
110110
gn metric list
111111
gn metric list --asset BTC
112+
gn metric list -a BTC -e binance -i 24h
113+
gn metric list --assets BTC --assets ETH
114+
gn metric list --from-exchange binance --to-exchange coinbase
112115
```
113116

117+
| Flag | Short | Description |
118+
|------|-------|-------------|
119+
| `--asset` | `-a` | Filter by asset (single) |
120+
| `--assets` | | Filter by multiple assets (repeat for each, e.g. `--assets BTC --assets ETH`) |
121+
| `--currency` | `-c` | Filter by currency (e.g. `native`, `usd`) |
122+
| `--exchange` | `-e` | Filter by exchange (e.g. `binance`, `coinbase`) |
123+
| `--format` | `-f` | Filter by response format (e.g. `json`, `csv`) |
124+
| `--interval` | `-i` | Filter by time interval (e.g. `1h`, `24h`) |
125+
| `--from-exchange` | | Source exchange for inter-exchange metrics |
126+
| `--to-exchange` | | Destination exchange for inter-exchange metrics |
127+
| `--miner` | | Miner identifier for mining-related metrics |
128+
| `--maturity` | | Maturity period for derivatives metrics |
129+
| `--network` | | Network/blockchain for cross-chain metrics |
130+
| `--period` | | Time period for aggregation |
131+
| `--quote-symbol` | | Quote currency symbol for trading pairs |
132+
114133
### `gn metric describe <path>`
115134

116135
Show metadata for a metric: supported assets, intervals, exchanges, currencies, and parameters.

‎cmd/metric_list.go‎

Lines changed: 69 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,11 @@ var metricListCmd = &cobra.Command{
1919
}
2020
client := api.NewClient(apiKey)
2121

22-
asset, _ := cmd.Flags().GetString("asset")
22+
params, repeatedParams := metricListParamsFromFlags(cmd)
2323

2424
dryRun, _ := cmd.Flags().GetBool("dry-run")
2525
if dryRun {
26-
params := map[string]string{}
27-
if asset != "" {
28-
params["a"] = asset
29-
}
30-
u, err := client.BuildURL("/v1/metadata/metrics", params, nil)
26+
u, err := client.BuildURL("/v1/metadata/metrics", params, repeatedParams)
3127
if err != nil {
3228
return err
3329
}
@@ -36,7 +32,7 @@ var metricListCmd = &cobra.Command{
3632
return nil
3733
}
3834

39-
metrics, err := client.ListMetrics(cmd.Context(), asset)
35+
metrics, err := client.ListMetrics(cmd.Context(), params, repeatedParams)
4036
if err != nil {
4137
return err
4238
}
@@ -46,6 +42,71 @@ var metricListCmd = &cobra.Command{
4642
},
4743
}
4844

45+
func metricListParamsFromFlags(cmd *cobra.Command) (map[string]string, map[string][]string) {
46+
params := map[string]string{}
47+
repeatedParams := map[string][]string{}
48+
49+
var assets []string
50+
if v, _ := cmd.Flags().GetString("asset"); v != "" {
51+
assets = append(assets, v)
52+
}
53+
if extra, _ := cmd.Flags().GetStringArray("assets"); len(extra) > 0 {
54+
assets = append(assets, extra...)
55+
}
56+
if len(assets) == 1 {
57+
params["a"] = assets[0]
58+
} else if len(assets) > 1 {
59+
repeatedParams["a"] = assets
60+
}
61+
if v, _ := cmd.Flags().GetString("currency"); v != "" {
62+
params["c"] = v
63+
}
64+
if v, _ := cmd.Flags().GetString("exchange"); v != "" {
65+
params["e"] = v
66+
}
67+
if v, _ := cmd.Flags().GetString("format"); v != "" {
68+
params["f"] = v
69+
}
70+
if v, _ := cmd.Flags().GetString("interval"); v != "" {
71+
params["i"] = v
72+
}
73+
if v, _ := cmd.Flags().GetString("from-exchange"); v != "" {
74+
params["from_exchange"] = v
75+
}
76+
if v, _ := cmd.Flags().GetString("to-exchange"); v != "" {
77+
params["to_exchange"] = v
78+
}
79+
if v, _ := cmd.Flags().GetString("miner"); v != "" {
80+
params["miner"] = v
81+
}
82+
if v, _ := cmd.Flags().GetString("maturity"); v != "" {
83+
params["maturity"] = v
84+
}
85+
if v, _ := cmd.Flags().GetString("network"); v != "" {
86+
params["network"] = v
87+
}
88+
if v, _ := cmd.Flags().GetString("period"); v != "" {
89+
params["period"] = v
90+
}
91+
if v, _ := cmd.Flags().GetString("quote-symbol"); v != "" {
92+
params["quote_symbol"] = v
93+
}
94+
95+
return params, repeatedParams
96+
}
97+
4998
func init() {
50-
metricListCmd.Flags().StringP("asset", "a", "", "filter by asset")
99+
metricListCmd.Flags().StringP("asset", "a", "", "filter by asset (single)")
100+
metricListCmd.Flags().StringArray("assets", nil, "filter by assets (multiple, e.g. --assets BTC --assets ETH)")
101+
metricListCmd.Flags().StringP("currency", "c", "", "filter by currency (e.g. native, usd)")
102+
metricListCmd.Flags().StringP("exchange", "e", "", "filter by exchange (e.g. binance, coinbase)")
103+
metricListCmd.Flags().StringP("format", "f", "", "filter by response format (e.g. json, csv)")
104+
metricListCmd.Flags().StringP("interval", "i", "", "filter by time interval (e.g. 1h, 24h)")
105+
metricListCmd.Flags().String("from-exchange", "", "source exchange for inter-exchange metrics")
106+
metricListCmd.Flags().String("to-exchange", "", "destination exchange for inter-exchange metrics")
107+
metricListCmd.Flags().String("miner", "", "miner identifier for mining-related metrics")
108+
metricListCmd.Flags().String("maturity", "", "maturity period for derivatives metrics")
109+
metricListCmd.Flags().String("network", "", "network/blockchain for cross-chain metrics")
110+
metricListCmd.Flags().String("period", "", "time period for aggregation")
111+
metricListCmd.Flags().String("quote-symbol", "", "quote currency symbol for trading pairs")
51112
}

‎internal/api/client_test.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ func TestListMetrics(t *testing.T) {
234234
client.BaseURL = server.URL
235235
client.HTTPClient = server.Client()
236236

237-
metrics, err := client.ListMetrics(context.Background(), "")
237+
metrics, err := client.ListMetrics(context.Background(), nil, nil)
238238
if err != nil {
239239
t.Fatalf("ListMetrics: %v", err)
240240
}
@@ -262,7 +262,7 @@ func TestListMetrics_WithAsset(t *testing.T) {
262262
client.BaseURL = server.URL
263263
client.HTTPClient = server.Client()
264264

265-
_, err := client.ListMetrics(context.Background(), "BTC")
265+
_, err := client.ListMetrics(context.Background(), map[string]string{"a": "BTC"}, nil)
266266
if err != nil {
267267
t.Fatalf("ListMetrics: %v", err)
268268
}
@@ -418,7 +418,7 @@ func TestListMetrics_InvalidJSONReturnsError(t *testing.T) {
418418
client.BaseURL = server.URL
419419
client.HTTPClient = server.Client()
420420

421-
_, err := client.ListMetrics(context.Background(), "")
421+
_, err := client.ListMetrics(context.Background(), nil, nil)
422422
if err == nil {
423423
t.Error("expected error for invalid JSON")
424424
}
@@ -491,7 +491,7 @@ func TestListMetrics_EmptyArray(t *testing.T) {
491491
client.BaseURL = server.URL
492492
client.HTTPClient = server.Client()
493493

494-
metrics, err := client.ListMetrics(context.Background(), "")
494+
metrics, err := client.ListMetrics(context.Background(), nil, nil)
495495
if err != nil {
496496
t.Fatalf("ListMetrics: %v", err)
497497
}

‎internal/api/metadata.go‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -127,12 +127,19 @@ func (c *Client) ListAssets(ctx context.Context, filter string) ([]Asset, error)
127127
return resp.Data, nil
128128
}
129129

130-
func (c *Client) ListMetrics(ctx context.Context, asset string) ([]string, error) {
131-
params := map[string]string{}
132-
if asset != "" {
133-
params["a"] = asset
134-
}
135-
body, err := c.Do(ctx, "GET", "/v1/metadata/metrics", params)
130+
// ListMetrics lists available metric paths, optionally filtered by query parameters.
131+
// See https://docs.glassnode.com/basic-api/metadata#query-parameters-1
132+
// params: a (asset), c (currency), e (exchange), f (format), i (interval),
133+
// from_exchange, to_exchange, miner, maturity, network, period, quote_symbol.
134+
// repeatedParams: use key "a" for multiple assets (e.g. a=BTC&a=ETH).
135+
func (c *Client) ListMetrics(ctx context.Context, params map[string]string, repeatedParams map[string][]string) ([]string, error) {
136+
if params == nil {
137+
params = map[string]string{}
138+
}
139+
if repeatedParams == nil {
140+
repeatedParams = map[string][]string{}
141+
}
142+
body, err := c.DoWithRepeatedParams(ctx, "GET", "/v1/metadata/metrics", params, repeatedParams)
136143
if err != nil {
137144
return nil, fmt.Errorf("listing metrics: %w", err)
138145
}

‎skills/glassnode-cli/SKILL.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,11 @@ gn asset describe BTC
3838
```bash
3939
gn metric list
4040
gn metric list --asset BTC
41+
gn metric list -a BTC -e binance -i 24h
42+
gn metric list --assets BTC --assets ETH
43+
gn metric list --from-exchange binance --to-exchange coinbase
4144
```
45+
Filter by any [metadata query parameters](https://docs.glassnode.com/basic-api/metadata#query-parameters-1): `--currency`, `--exchange`, `--interval`, `--from-exchange`, `--to-exchange`, `--miner`, `--maturity`, `--network`, `--period`, `--quote-symbol`, or multiple `--assets`.
4246

4347
### Describe a metric (discover valid parameters)
4448
```bash

0 commit comments

Comments
 (0)