-
Notifications
You must be signed in to change notification settings - Fork 19
Expand file tree
/
Copy pathopenapi.yaml
More file actions
23328 lines (22076 loc) · 856 KB
/
openapi.yaml
File metadata and controls
23328 lines (22076 loc) · 856 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.2
info:
title: Coin Metrics API v4
description: >-
[Coin Metrics Homepage](https://coinmetrics.io/)<br/>
[API Backward Compatibility Policy](https://docs.coinmetrics.io/access-our-data/api#backward-compatibility)<br/>
[Python API Client](https://coinmetrics.github.io/api-client-python/site/index.html)<br/><br/>
HTTP API root endpoint URL is `https://api.coinmetrics.io/v4`. Coin Metrics' paid product.<br/>
WebSocket API root endpoint is `wss://api.coinmetrics.io/v4`. Coin Metrics' paid product.<br/><br/>
The Community HTTP API root endpoint URL is `https://community-api.coinmetrics.io/v4`. API key is not required when accessing community endpoints.
Available to the community under the [Creative Commons](https://creativecommons.org/licenses/by-nc/4.0/) license.
# Authentication
<!-- ReDoc-Inject: <security-definitions> -->
# Response headers
Note that Coin Metrics API responses have a `CF-RAY` HTTP header e.g. `88a6ec1d2f930774-IAD` which can be used for diagnostic purposes.
When raising Support requests, please ensure to provide the value of this header.
termsOfService: https://coinmetrics.io/api/terms
contact:
name: Coin Metrics Support
url: https://coinmetrics.io/support/
email: support@coinmetrics.io
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 4.0.0 # of this document
servers:
- url: https://api.coinmetrics.io/v4
- url: wss://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
tags:
- name: Rate limits
description: >-
To ensure the quality of Coin Metrics services, API is subject to rate limiting.<br/>
The community version of API has the limit of 10 requests per 6 seconds sliding window for an IP address.<br/>
The trial version of API has the limit of 10 requests per 6 seconds sliding window for an API key.<br/>
The paid version of API has the limit of 6000 requests per 20 seconds sliding window for an API key.<br/>
The paid and community versions of the API have a limit of 10 parallel HTTP requests, after this limit is
reached further parallel requests will be queued, so performance will be slower. <br/>
The paid version of API has a limit of 200 concurrent websocket connections for an API Key. <br/>
If you reach the request-per-second limit, API starts to return `429 Too Many Requests` HTTP response status.<br/>
API also provides `X-RateLimit-*` response headers formatted according to https://tools.ietf.org/html/draft-polli-ratelimit-headers-03.
- name: Reference Data
description: >-
Metadata information of entities supported by Coin Metrics.
- name: Catalog
x-displayName: Catalog (deprecated)
description: >-
Catalog of available for your `api_key` data.<br/>
Use the [Full catalog](#tag/Full-catalog) endpoints for the full list of supported by Coin Metrics data.
<br/>DEPRECATED: See https://coinmetrics.io/important-changes-to-coin-metrics-api-catalog-endpoints/.
- name: Catalog v2
description: >-
Catalog of available for your `api_key` data.<br/>
Use the [Full catalog V2](#tag/Full-catalog-v2) endpoints for the full list of supported by Coin Metrics data.
- name: Full catalog
x-displayName: Full catalog (deprecated)
description: >-
The Full catalog returns the full range of data that is supported by Coin Metrics across all our products.<br/>
If you are a client looking to understand the data that is available for your API key and data license, please use the [Catalog](#tag/Catalog) endpoint.
<br/>DEPRECATED: See https://coinmetrics.io/important-changes-to-coin-metrics-api-catalog-endpoints/.
- name: Full catalog v2
description: >-
The Full catalog returns the full range of data that is supported by Coin Metrics across all our products.<br/>
If you are a client looking to understand the data that is available for your API key and data license, please use the [Catalog](#tag/Catalog-v2) endpoint.
- name: Timeseries
description: Endpoints for fetching metrics, market data, indexes and other time series data.
- name: Timeseries stream
description: WebSocket endpoints for getting a real-time stream of metrics, market data, indexes and other time series data.
- name: Taxonomy
description: Taxonomy endpoints
- name: Taxonomy Metadata
description: Taxonomy Metadata endpoints
- name: Profile
description: Profile endpoints
- name: List of blockchain entities v2
description: Endpoints for fetching lists of blockchain entities.
- name: Full blockchain entities v2
description: Endpoints for fetching full blockchain entities.
- name: Jobs
description: Jobs API endpoints
- name: Blockchain Explorer Job
description: Endpoints for creating async jobs for blockchain entities.
- name: Blockchain Explorer Job Results
description: Schema definitions of results of Blockchain Explorer Job endpoints.
- name: Chain Monitor tools
description: Endpoints for working with chain monitor data.
- name: Security Master
description: Security Master endpoints
- name: Constituent Snapshots
description: Endpoints for getting the snapshots of various constituents
- name: Constituent Timeframes
description: Endpoints for getting the timeframes of various constituents
- name: Blockchain Metadata
description: Blockchain metadata endpoints
x-tagGroups: # ReDoc-specific vendor extension
- name: General
tags:
- Rate limits
- name: Reference Data
tags:
- Reference Data
- Profile
- Taxonomy
- Taxonomy Metadata
- name: Catalog
tags:
- Catalog
- Full catalog
- Catalog v2
- Full catalog v2
- name: Timeseries
tags:
- Timeseries
- Timeseries stream
- name: Universal blockchain explorer
tags:
- List of blockchain entities v2
- Full blockchain entities v2
- Blockchain Explorer Job
- Blockchain Explorer Job Results
- name: Tools
tags:
- Chain Monitor tools
- name: Security Master
tags:
- Security Master
- name: Constituents
tags:
- Constituent Snapshots
- Constituent Timeframes
- name: Blockchain Metadata
tags:
- Blockchain Metadata
- name: Jobs
tags:
- Jobs
paths:
/reference-data/assets:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
summary: Assets
description: Returns a list of assets metadata.
operationId: getReferenceDataAssets
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/reference-data/assets?api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/reference-data/assets?api_key=<your_key>').json()
print(response)
tags:
- Reference Data
parameters:
- $ref: '#/components/parameters/CatalogAssetId'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PagingFromWithStartByDefault'
- $ref: '#/components/parameters/NextPageToken'
- $ref: '#/components/parameters/CatalogResponseFormat'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/ReferenceDataAssets'
400:
$ref: '#/components/responses/AssetNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/reference-data/exchanges:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
summary: Exchanges
description: Returns a list of exchanges metadata.
operationId: getReferenceDataExchanges
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/reference-data/exchanges?api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/reference-data/exchanges?api_key=<your_key>').json()
print(response)
tags:
- Reference Data
parameters:
- $ref: '#/components/parameters/CatalogExchangeId'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PagingFromWithStartByDefault'
- $ref: '#/components/parameters/NextPageToken'
- $ref: '#/components/parameters/CatalogResponseFormat'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/ReferenceDataExchanges'
400:
$ref: '#/components/responses/ExchangeNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/reference-data/markets:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
summary: Markets
description: Returns a list of markets metadata.
operationId: getReferenceDataMarkets
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/reference-data/markets?api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/reference-data/markets?api_key=<your_key>').json()
print(response)
tags:
- Reference Data
parameters:
- $ref: '#/components/parameters/CatalogMarketId'
- $ref: '#/components/parameters/Exchange'
- $ref: '#/components/parameters/MarketType'
- $ref: '#/components/parameters/MarketBase'
- $ref: '#/components/parameters/MarketQuote'
- $ref: '#/components/parameters/MarketAsset'
- $ref: '#/components/parameters/MarketSymbol'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PagingFromWithStartByDefault'
- $ref: '#/components/parameters/NextPageToken'
- $ref: '#/components/parameters/CatalogResponseFormat'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/ReferenceDataMarkets'
400:
$ref: '#/components/responses/MarketNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/reference-data/indexes:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
summary: Indexes
description: Returns a list of indexes metadata.
operationId: getReferenceDataIndexes
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/reference-data/indexes?api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/reference-data/indexes?api_key=<your_key>').json()
print(response)
tags:
- Reference Data
parameters:
- $ref: '#/components/parameters/CatalogIndexId'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PagingFromWithStartByDefault'
- $ref: '#/components/parameters/NextPageToken'
- $ref: '#/components/parameters/CatalogResponseFormat'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/ReferenceDataIndexes'
400:
$ref: '#/components/responses/IndexNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/reference-data/pairs:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
summary: Pairs
description: Returns a list of pairs metadata.
operationId: getReferenceDataPairs
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/reference-data/pair-metrics?api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/reference-data/pair-metrics?api_key=<your_key>').json()
print(response)
tags:
- Reference Data
parameters:
- $ref: '#/components/parameters/CatalogPairId'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PagingFromWithStartByDefault'
- $ref: '#/components/parameters/NextPageToken'
- $ref: '#/components/parameters/CatalogResponseFormat'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/ReferenceDataPairs'
400:
$ref: '#/components/responses/PairNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/reference-data/asset-metrics:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
summary: Asset metrics
description: Returns a list of asset metrics metadata.
operationId: getReferenceDataAssetMetrics
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/reference-data/asset-metrics?api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/reference-data/asset-metrics?api_key=<your_key>').json()
print(response)
tags:
- Reference Data
parameters:
- $ref: '#/components/parameters/CatalogMetric'
- $ref: '#/components/parameters/Reviewable'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PagingFromWithStartByDefault'
- $ref: '#/components/parameters/NextPageToken'
- $ref: '#/components/parameters/CatalogResponseFormat'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/ReferenceDataAssetMetrics'
400:
$ref: '#/components/responses/MetricNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/reference-data/exchange-metrics:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
summary: Exchange metrics
description: Returns a list of exchange metrics metadata.
operationId: getReferenceDataExchangeMetrics
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/reference-data/exchange-metrics?api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/reference-data/exchange-metrics?api_key=<your_key>').json()
print(response)
tags:
- Reference Data
parameters:
- $ref: '#/components/parameters/CatalogMetric'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PagingFromWithStartByDefault'
- $ref: '#/components/parameters/NextPageToken'
- $ref: '#/components/parameters/CatalogResponseFormat'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/ReferenceDataExchangeMetrics'
400:
$ref: '#/components/responses/MetricNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/reference-data/exchange-asset-metrics:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
summary: Exchange asset metrics
description: Returns a list of exchange asset metrics metadata.
operationId: getReferenceDataExchangeAssetMetrics
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/reference-data/exchange-asset-metrics?api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/reference-data/exchange-asset-metrics?api_key=<your_key>').json()
print(response)
tags:
- Reference Data
parameters:
- $ref: '#/components/parameters/CatalogMetric'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PagingFromWithStartByDefault'
- $ref: '#/components/parameters/NextPageToken'
- $ref: '#/components/parameters/CatalogResponseFormat'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/ReferenceDataExchangeAssetMetrics'
400:
$ref: '#/components/responses/MetricNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/reference-data/pair-metrics:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
summary: Pair metrics
description: Returns a list of pair metrics metadata.
operationId: getReferenceDataPairMetrics
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/reference-data/pair-metrics?api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/reference-data/pair-metrics?api_key=<your_key>').json()
print(response)
tags:
- Reference Data
parameters:
- $ref: '#/components/parameters/CatalogMetric'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PagingFromWithStartByDefault'
- $ref: '#/components/parameters/NextPageToken'
- $ref: '#/components/parameters/CatalogResponseFormat'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/ReferenceDataPairMetrics'
400:
$ref: '#/components/responses/MetricNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/reference-data/institution-metrics:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
summary: Institution metrics
description: Returns a list of institution metrics metadata.
operationId: getReferenceDataInstitutionMetrics
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/reference-data/institution-metrics?api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/reference-data/institution-metrics?api_key=<your_key>').json()
print(response)
tags:
- Reference Data
parameters:
- $ref: '#/components/parameters/CatalogMetric'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PagingFromWithStartByDefault'
- $ref: '#/components/parameters/NextPageToken'
- $ref: '#/components/parameters/CatalogResponseFormat'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/ReferenceDataInstitutionMetrics'
400:
$ref: '#/components/responses/MetricNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/reference-data/market-metrics:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
summary: Market metrics
description: Returns a list of market metrics metadata.
operationId: getReferenceDataMarketMetrics
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/reference-data/market-metrics?api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/reference-data/market-metrics?api_key=<your_key>').json()
print(response)
tags:
- Reference Data
parameters:
- $ref: '#/components/parameters/CatalogMetric'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PagingFromWithStartByDefault'
- $ref: '#/components/parameters/NextPageToken'
- $ref: '#/components/parameters/CatalogResponseFormat'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/ReferenceDataMarketMetrics'
400:
$ref: '#/components/responses/MetricNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/constituent-snapshots/asset-metrics:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
summary: Snapshots of asset metric constituents
description: |
Returns snapshots of asset metric constituents. \
Results are sorted by tuple (`time`, `constituent_name`), where `constituent_name` depends on a target metric.
E.g., the `volume_trusted_spot_usd_1d` metric constituents are exchanges,
i.e. the output will be sorted by (`time`, `exchange`).
operationId: getConstituentSnapshotsAssetMetrics
x-codeSamples:
- label: Shell
source: |
# Gets snapshots of asset metric constituents
curl --compressed "https://api.coinmetrics.io/v4/constituent-snapshots/asset-metrics?metric=volume_trusted_spot_usd_1d&api_key=<your_key>"
- label: Python
source: |
# Gets snapshots of asset metric constituents
import requests
response = requests.get('https://api.coinmetrics.io/v4/constituent-snapshots/asset-metrics?metric=volume_trusted_spot_usd_1d&api_key=<your_key>').json()
print(response)
tags:
- Constituent Snapshots
parameters:
- $ref: '#/components/parameters/ConstituentsMetricName'
- $ref: '#/components/parameters/ConstituentsAtTime'
- $ref: '#/components/parameters/ConstituentsStartTime'
- $ref: '#/components/parameters/ConstituentsEndTime'
- $ref: '#/components/parameters/NextPageToken'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PagingFrom'
- $ref: '#/components/parameters/Format'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/AssetMetricsConstituentSnapshots'
400:
$ref: '#/components/responses/MetricNotFound'
401:
$ref: '#/components/responses/Unauthorized'
403:
$ref: '#/components/responses/Forbidden'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/constituent-timeframes/asset-metrics:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
summary: Timeframes of asset metric constituents
description: |
Returns timeframes of asset metric constituents. \
Results are sorted by tuple (`start_time`, `constituent_name`), where constituent depends on a target metric.
E.g., the `volume_trusted_spot_usd_1d` metric constituents are exchanges,
i.e. the output will be sorted by (`start_time`, `exchange`).
operationId: getConstituentTimeframesAssetMetrics
x-codeSamples:
- label: Shell
source: |
# Gets timeframes of asset metric constituents
curl --compressed "https://api.coinmetrics.io/v4/constituent-timeframes/asset-metrics?metric=volume_trusted_spot_usd_1d&api_key=<your_key>"
- label: Python
source: |
# Gets timeframes of asset metric constituents
import requests
response = requests.get('https://api.coinmetrics.io/v4/constituent-timeframes/asset-metrics?metric=volume_trusted_spot_usd_1d&api_key=<your_key>').json()
print(response)
tags:
- Constituent Timeframes
parameters:
- $ref: '#/components/parameters/ConstituentsMetricName'
- $ref: '#/components/parameters/ConstituentId'
- $ref: '#/components/parameters/ConstituentsStartTime'
- $ref: '#/components/parameters/ConstituentsEndTime'
- $ref: '#/components/parameters/NextPageToken'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PagingFrom'
- $ref: '#/components/parameters/Format'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/AssetMetricsConstituentTimeframes'
400:
$ref: '#/components/responses/MetricNotFound'
401:
$ref: '#/components/responses/Unauthorized'
403:
$ref: '#/components/responses/Forbidden'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/catalog/assets:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
deprecated: true
summary: Available assets
description: Returns a list of available assets along with information for them like metrics, markets, exchanges and time ranges of available data.
operationId: getCatalogAssets
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/catalog/assets?pretty=true&api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/catalog/assets?pretty=true&api_key=<your_key>').json()
print(response)
tags:
- Catalog
parameters:
- $ref: '#/components/parameters/CatalogAssetId'
- $ref: '#/components/parameters/CatalogAssetIncludeFields'
- $ref: '#/components/parameters/CatalogAssetExcludeFields'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/Assets'
400:
$ref: '#/components/responses/AssetNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/catalog/metrics:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
deprecated: true
summary: Available metrics
description: Returns a list of available metrics along with information for them like
description, category and assets for which a metric is available.</br>This endpoint is deprecated, please use [/catalog/asset-metrics](#operation/getCatalogAssetMetrics) instead.
operationId: getCatalogMetrics
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/catalog/metrics?pretty=true&api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/catalog/metrics?pretty=true&api_key=<your_key>').json()
print(response)
tags:
- Catalog
parameters:
- $ref: '#/components/parameters/CatalogMetric'
- $ref: '#/components/parameters/Reviewable'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/CatalogMetrics'
400:
$ref: '#/components/responses/MetricNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/catalog/asset-metrics:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
deprecated: true
summary: Available asset metrics
description: Returns a list of available asset metrics along with information for them like
description, category and assets for which a metric is available.
operationId: getCatalogAssetMetrics
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/catalog/asset-metrics?pretty=true&api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/catalog/asset-metrics?pretty=true&api_key=<your_key>').json()
print(response)
tags:
- Catalog
parameters:
- $ref: '#/components/parameters/CatalogMetric'
- $ref: '#/components/parameters/Reviewable'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/CatalogAssetMetrics'
400:
$ref: '#/components/responses/MetricNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/catalog/exchange-metrics:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
deprecated: true
summary: Available exchange metrics
description: Returns a list of available exchange metrics along with information for them like
description, category and exchanges for which a metric is available.
operationId: getCatalogExchangeMetrics
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/catalog/exchange-metrics?pretty=true&api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/catalog/exchange-metrics?pretty=true&api_key=<your_key>').json()
print(response)
tags:
- Catalog
parameters:
- $ref: '#/components/parameters/CatalogMetric'
- $ref: '#/components/parameters/Reviewable'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/CatalogExchangeMetrics'
400:
$ref: '#/components/responses/MetricNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/catalog/exchange-asset-metrics:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
deprecated: true
summary: Available exchange-asset metrics
description: Returns a list of available exchange-asset metrics along with information for them like
description, category and exchange-asset pairs for which a metric is available.
operationId: getCatalogExchangeAssetMetrics
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/catalog/exchange-asset-metrics?pretty=true&api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/catalog/exchange-asset-metrics?pretty=true&api_key=<your_key>').json()
print(response)
tags:
- Catalog
parameters:
- $ref: '#/components/parameters/CatalogMetric'
- $ref: '#/components/parameters/Reviewable'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/CatalogExchangeAssetMetrics'
400:
$ref: '#/components/responses/MetricNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/catalog/pair-metrics:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
deprecated: true
summary: Available pair metrics
description: Returns a list of available pair metrics along with information for them like
description, category and pairs for which a metric is available.
operationId: getCatalogPairMetrics
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/catalog/pair-metrics?pretty=true&api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/catalog/pair-metrics?pretty=true&api_key=<your_key>').json()
print(response)
tags:
- Catalog
parameters:
- $ref: '#/components/parameters/CatalogMetric'
- $ref: '#/components/parameters/Reviewable'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/CatalogPairMetrics'
400:
$ref: '#/components/responses/MetricNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/catalog/institution-metrics:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
deprecated: true
summary: Available institution metrics
description: Returns a list of available institution metrics along with information for them like
description, category and institutions for which a metric is available.
operationId: getCatalogInstitutionMetrics
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/catalog/institution-metrics?pretty=true&api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/catalog/institution-metrics?pretty=true&api_key=<your_key>').json()
print(response)
tags:
- Catalog
parameters:
- $ref: '#/components/parameters/CatalogMetric'
- $ref: '#/components/parameters/Reviewable'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/CatalogInstitutionMetrics'
400:
$ref: '#/components/responses/MetricNotFound'
401:
$ref: '#/components/responses/Unauthorized'
414:
$ref: '#/components/responses/UriTooLong'
security:
- api_key: []
/catalog/exchanges:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
get:
deprecated: true
summary: Available exchanges
description: Returns a list of available exchanges along with available markets for them.
operationId: getCatalogExchanges
x-codeSamples:
- label: Shell
source: |
curl --compressed "https://api.coinmetrics.io/v4/catalog/exchanges?pretty=true&api_key=<your_key>"
- label: Python
source: |
import requests
response = requests.get('https://api.coinmetrics.io/v4/catalog/exchanges?pretty=true&api_key=<your_key>').json()
print(response)
tags:
- Catalog
parameters:
- $ref: '#/components/parameters/CatalogExchangeId'
- $ref: '#/components/parameters/Pretty'
responses:
200:
$ref: '#/components/responses/Exchanges'
400:
$ref: '#/components/responses/ExchangeNotFound'
401:
$ref: '#/components/responses/Unauthorized'
security:
- api_key: []
/catalog/exchange-assets:
servers:
- url: https://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4