-
Notifications
You must be signed in to change notification settings - Fork 8
/
bitcoin.postman_collection.json
1578 lines (1578 loc) · 81.2 KB
/
bitcoin.postman_collection.json
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
{
"info": {
"_postman_id": "1f9f0cbe-be41-43ef-9850-20bcf366eee6",
"name": "bitcoin",
"description": "Connecting Postman to a bitcoin node.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Blockchain",
"item": [
{
"name": "getblockhash",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getblockhash\",\n \"params\": [\n {{height}}\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# `getblockhash`\nReturns hash of block in best-block-chain at height provided.\n\n## Argument #1 - height\nType: numeric, required\n\nThe height index"
},
"response": []
},
{
"name": "getbestblockhash",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getbestblockhash\",\n \"params\": []\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# `getblockhash`\nReturns hash of block in best-block-chain at height provided.\n\n## Argument #1 - height\nType: numeric, required\n\nThe height index"
},
"response": []
},
{
"name": "gettxout",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"gettxout\",\n \"params\": [\n \"{{txid}}\",\n {{vout}},\n {{include_mempool}}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# gettxout\n`gettxout \"txid\" n ( include_mempool )`\n\nReturns details about an unspent transaction output.\n\n## Argument #1 - txid\n**Type**: string, required\n\nThe transaction id\n\n## Argument #2 - n\n**Type**: numeric, required\n\nvout number\n\n## Argument #3 - include_mempool\n**Type**: boolean, optional, default=true\n\nWhether to include the mempool. Note that an unspent output that is spent in the mempool won’t appear.\n\n## Result\n```\n{ (json object)\n \"bestblock\" : \"hex\", (string) The hash of the block at the tip of the chain\n \"confirmations\" : n, (numeric) The number of confirmations\n \"value\" : n, (numeric) The transaction value in BTC\n \"scriptPubKey\" : { (json object)\n \"asm\" : \"hex\", (string)\n \"hex\" : \"hex\", (string)\n \"reqSigs\" : n, (numeric) Number of required signatures\n \"type\" : \"hex\", (string) The type, eg pubkeyhash\n \"addresses\" : [ (json array) array of bitcoin addresses\n \"str\", (string) bitcoin address\n ...\n ]\n },\n \"coinbase\" : true|false (boolean) Coinbase or not\n}\n```\n## Examples\n```\nGet unspent transactions:\n\nbitcoin-cli listunspent\nView the details:\n\nbitcoin-cli gettxout \"txid\" 1\nAs a JSON-RPC call:\n\ncurl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"gettxout\", \"params\": [\"txid\", 1]}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n```"
},
"response": []
},
{
"name": "getblock",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getblock\",\n \"params\": [\n \"{{blockhash}}\",\n {{verbosity}}\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
}
},
"response": []
},
{
"name": "getchaintxstats",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getchaintxstats\",\n \"params\": [\n {{nblocks}},\n \"{{blockhash}}\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# getchaintxstats\n`getchaintxstats ( nblocks \"blockhash\" )`\n\nCompute statistics about the total number and rate of transactions in the chain.\n\n## Argument #1 - nblocks\nType: numeric, optional, default=one month\n\nSize of the window in number of blocks\n\n## Argument #2 - blockhash\nType: string, optional, default=chain tip\n\nThe hash of the block that ends the window.\n\n## Result\n```\n{ (json object)\n \"time\" : xxx, (numeric) The timestamp for the final block in the window, expressed in UNIX epoch time\n \"txcount\" : n, (numeric) The total number of transactions in the chain up to that point\n \"window_final_block_hash\" : \"hex\", (string) The hash of the final block in the window\n \"window_final_block_height\" : n, (numeric) The height of the final block in the window.\n \"window_block_count\" : n, (numeric) Size of the window in number of blocks\n \"window_tx_count\" : n, (numeric) The number of transactions in the window. Only returned if \"window_block_count\" is > 0\n \"window_interval\" : n, (numeric) The elapsed time in the window in seconds. Only returned if \"window_block_count\" is > 0\n \"txrate\" : n (numeric) The average rate of transactions per second in the window. Only returned if \"window_interval\" is > 0\n}\n```\n## Examples\n```\nbitcoin-cli getchaintxstats\ncurl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"getchaintxstats\", \"params\": [2016]}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n```"
},
"response": []
},
{
"name": "getblockheader",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getblockheader\",\n \"params\": [\n \"{{blockhash}}\",\n {{verbose}}\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# getblockheader\n`getblockheader \"blockhash\" ( verbose )`\n\nIf verbose is false, returns a string that is serialized, hex-encoded data for blockheader ‘hash’.\n\nIf verbose is true, returns an Object with information about blockheader ‘hash’.\n\n## Argument #1 - blockhash\n**Type**: string, required\n\nThe block hash\n\n## Argument #2 - verbose\n**Type**: boolean, optional, default=true\n\ntrue for a json object, false for the hex-encoded data\n\n## Result (for verbose = true)\n```\n{ (json object)\n \"hash\" : \"hex\", (string) the block hash (same as provided)\n \"confirmations\" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain\n \"height\" : n, (numeric) The block height or index\n \"version\" : n, (numeric) The block version\n \"versionHex\" : \"hex\", (string) The block version formatted in hexadecimal\n \"merkleroot\" : \"hex\", (string) The merkle root\n \"time\" : xxx, (numeric) The block time expressed in UNIX epoch time\n \"mediantime\" : xxx, (numeric) The median block time expressed in UNIX epoch time\n \"nonce\" : n, (numeric) The nonce\n \"bits\" : \"hex\", (string) The bits\n \"difficulty\" : n, (numeric) The difficulty\n \"chainwork\" : \"hex\", (string) Expected number of hashes required to produce the current chain\n \"nTx\" : n, (numeric) The number of transactions in the block\n \"previousblockhash\" : \"hex\", (string) The hash of the previous block\n \"nextblockhash\" : \"hex\" (string) The hash of the next block\n}\n```\n## Result (for verbose=false)\nName\n\nType\n\nDescription\n\nhex\n\nstring\n\nA string that is serialized, hex-encoded data for block ‘hash’\n\n## Examples\n```\nbitcoin-cli getblockheader \"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"\ncurl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"getblockheader\", \"params\": [\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"]}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n```"
},
"response": []
},
{
"name": "getblockchaintips",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getchaintips\",\n \"params\": []\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
}
},
"response": []
},
{
"name": "getblockstats",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "username",
"value": "{{username}}",
"type": "string"
},
{
"key": "password",
"value": "{{password}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getblockstats\",\n \"params\": [\n {{height}},\n []\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# getblockstats\n`getblockstats hash_or_height ( stats )`\n\nCompute per block statistics for a given window. All amounts are in satoshis.\n\nIt won’t work for some heights with pruning.\n\n## Argument #1 - hash_or_height\n**Type**: string or numeric, required\n\nThe block hash or height of the target block\n\n## Argument #2 - stats\n**Type**: json array, optional, default=all values\n\nValues to plot (see result below)\n```\n[\n \"height\", (string) Selected statistic\n \"time\", (string) Selected statistic\n ...\n]\n```\nResult\n```\n{ (json object)\n \"avgfee\" : n, (numeric) Average fee in the block\n \"avgfeerate\" : n, (numeric) Average feerate (in satoshis per virtual byte)\n \"avgtxsize\" : n, (numeric) Average transaction size\n \"blockhash\" : \"hex\", (string) The block hash (to check for potential reorgs)\n \"feerate_percentiles\" : [ (json array) Feerates at the 10th, 25th, 50th, 75th, and 90th percentile weight unit (in satoshis per virtual byte)\n n, (numeric) The 10th percentile feerate\n n, (numeric) The 25th percentile feerate\n n, (numeric) The 50th percentile feerate\n n, (numeric) The 75th percentile feerate\n n (numeric) The 90th percentile feerate\n ],\n \"height\" : n, (numeric) The height of the block\n \"ins\" : n, (numeric) The number of inputs (excluding coinbase)\n \"maxfee\" : n, (numeric) Maximum fee in the block\n \"maxfeerate\" : n, (numeric) Maximum feerate (in satoshis per virtual byte)\n \"maxtxsize\" : n, (numeric) Maximum transaction size\n \"medianfee\" : n, (numeric) Truncated median fee in the block\n \"mediantime\" : n, (numeric) The block median time past\n \"mediantxsize\" : n, (numeric) Truncated median transaction size\n \"minfee\" : n, (numeric) Minimum fee in the block\n \"minfeerate\" : n, (numeric) Minimum feerate (in satoshis per virtual byte)\n \"mintxsize\" : n, (numeric) Minimum transaction size\n \"outs\" : n, (numeric) The number of outputs\n \"subsidy\" : n, (numeric) The block subsidy\n \"swtotal_size\" : n, (numeric) Total size of all segwit transactions\n \"swtotal_weight\" : n, (numeric) Total weight of all segwit transactions\n \"swtxs\" : n, (numeric) The number of segwit transactions\n \"time\" : n, (numeric) The block time\n \"total_out\" : n, (numeric) Total amount in all outputs (excluding coinbase and thus reward [ie subsidy + totalfee])\n \"total_size\" : n, (numeric) Total size of all non-coinbase transactions\n \"total_weight\" : n, (numeric) Total weight of all non-coinbase transactions\n \"totalfee\" : n, (numeric) The fee total\n \"txs\" : n, (numeric) The number of transactions (including coinbase)\n \"utxo_increase\" : n, (numeric) The increase/decrease in the number of unspent outputs\n \"utxo_size_inc\" : n (numeric) The increase/decrease in size for the utxo index (not discounting op_return and similar)\n}\n```\nExamples\n```\nbitcoin-cli getblockstats '\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"' '[\"minfeerate\",\"avgfeerate\"]'\nbitcoin-cli getblockstats 1000 '[\"minfeerate\",\"avgfeerate\"]'\ncurl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"getblockstats\", \"params\": [\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\", [\"minfeerate\",\"avgfeerate\"]]}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\ncurl --user myusername --data-binary '{\"jsonrpc\": \"1.\n```"
},
"response": []
},
{
"name": "getblockchaininfo",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getblockchaininfo\",\n \"params\": []\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# getblockchaininfo\n`getblockchaininfo`\n\nReturns an object containing various state info regarding blockchain processing.\n\n## Result\n```\n{ (json object)\n \"chain\" : \"str\", (string) current network name (main, test, regtest)\n \"blocks\" : n, (numeric) the height of the most-work fully-validated chain. The genesis block has height 0\n \"headers\" : n, (numeric) the current number of headers we have validated\n \"bestblockhash\" : \"str\", (string) the hash of the currently best block\n \"difficulty\" : n, (numeric) the current difficulty\n \"mediantime\" : n, (numeric) median time for the current best block\n \"verificationprogress\" : n, (numeric) estimate of verification progress [0..1]\n \"initialblockdownload\" : true|false, (boolean) (debug information) estimate of whether this node is in Initial Block Download mode\n \"chainwork\" : \"hex\", (string) total amount of work in active chain, in hexadecimal\n \"size_on_disk\" : n, (numeric) the estimated size of the block and undo files on disk\n \"pruned\" : true|false, (boolean) if the blocks are subject to pruning\n \"pruneheight\" : n, (numeric) lowest-height complete block stored (only present if pruning is enabled)\n \"automatic_pruning\" : true|false, (boolean) whether automatic pruning is enabled (only present if pruning is enabled)\n \"prune_target_size\" : n, (numeric) the target size used by pruning (only present if automatic pruning is enabled)\n \"softforks\" : { (json object) status of softforks\n \"xxxx\" : { (json object) name of the softfork\n \"type\" : \"str\", (string) one of \"buried\", \"bip9\"\n \"bip9\" : { (json object) status of bip9 softforks (only for \"bip9\" type)\n \"status\" : \"str\", (string) one of \"defined\", \"started\", \"locked_in\", \"active\", \"failed\"\n \"bit\" : n, (numeric) the bit (0-28) in the block version field used to signal this softfork (only for \"started\" status)\n \"start_time\" : xxx, (numeric) the minimum median time past of a block at which the bit gains its meaning\n \"timeout\" : xxx, (numeric) the median time past of a block at which the deployment is considered failed if not yet locked in\n \"since\" : n, (numeric) height of the first block to which the status applies\n \"statistics\" : { (json object) numeric statistics about BIP9 signalling for a softfork (only for \"started\" status)\n \"period\" : n, (numeric) the length in blocks of the BIP9 signalling period\n \"threshold\" : n, (numeric) the number of blocks with the version bit set required to activate the feature\n \"elapsed\" : n, (numeric) the number of blocks elapsed since the beginning of the current period\n \"count\" : n, (numeric) the number of blocks with the version bit set in the current period\n \"possible\" : true|false (boolean) returns false if there are not enough blocks left in this period to pass activation threshold\n }\n },\n \"height\" : n, (numeric) height of the first block which the rules are or will be enforced (only for \"buried\" type, or \"bip9\" type with \"active\" status)\n \"active\" : true|false (boolean) true if the rules are enforced for the mempool and the next block\n },\n ...\n },\n \"warnings\" : \"str\" (string) any network and blockchain warnings\n}\n```\n## Examples\n```\nbitcoin-cli getblockchaininfo\ncurl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"getblockchaininfo\", \"params\": []}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n```"
},
"response": []
},
{
"name": "getchaintxstats",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getchaintxstats\",\n \"params\": [{{height}}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# getchaintxstats\n`getchaintxstats ( nblocks \"blockhash\" )`\n\nCompute statistics about the total number and rate of transactions in the chain.\n\nArgument #1 - `nblocks`\nType: numeric, optional, default=one month\n\nSize of the window in number of blocks\n\nArgument #2 - `blockhash`\nType: string, optional, default=chain tip\n\nThe hash of the block that ends the window."
},
"response": []
},
{
"name": "getblockcount",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getblockcount\",\n \"params\": []\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
}
},
"response": []
},
{
"name": "getdifficulty",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getdifficulty\",\n \"params\": []\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# getdifficulty\n`getdifficulty`\n\nReturns the proof-of-work difficulty as a multiple of the minimum difficulty.\n\n## Result\nName\n\nType\n\nDescription\n\nn\n\nnumeric\n\nthe proof-of-work difficulty as a multiple of the minimum difficulty.\n\n## Examples\n```\nbitcoin-cli getdifficulty\ncurl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"getdifficulty\", \"params\": []}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n```"
},
"response": []
},
{
"name": "getblockfilter",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getblockfilter\",\n \"params\": [\n \"{{blockhash}}\",\n \"basic\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# getblockfilter\n\n`getblockfilter \"blockhash\" ( \"filtertype\" )`\n\nRetrieve a BIP 157 content filter for a particular block.\n\n## Argument #1 - blockhash\n\n**Type:** string, required\n\nThe hash of the block\n\n## Argument #2 - filtertype\n\n**Type:** string, optional, default=basic\n\nThe type name of the filter\n\n## Result\n\n```\n{ (json object)\n \"filter\" : \"hex\", (string) the hex-encoded filter data\n \"header\" : \"hex\" (string) the hex-encoded filter header}\n```\n\n## Examples\n\n``` bash\nbitcoin-cli getblockfilter \"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\" \"basic\"\n```\n\n``` bash\ncurl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"getblockfilter\", \"params\": [\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\", \"basic\"]}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n```\n\n# TAKE NOTE! \n\nMay not work on your node. See [https://bitcoin.stackexchange.com/questions/96752/getblockfilter-error-index-is-not-enabled-for-filtertype-basic](https://bitcoin.stackexchange.com/questions/96752/getblockfilter-error-index-is-not-enabled-for-filtertype-basic)"
},
"response": []
},
{
"name": "getmempoolinfo",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getmempoolinfo\",\n \"params\": []\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# getmempoolinfo\n`getmempoolinfo`\n\nReturns details on the active state of the TX memory pool.\n\n## Result\n```\n{ (json object)\n \"loaded\" : true|false, (boolean) True if the mempool is fully loaded\n \"size\" : n, (numeric) Current tx count\n \"bytes\" : n, (numeric) Sum of all virtual transaction sizes as defined in BIP 141. Differs from actual serialized size because witness data is discounted\n \"usage\" : n, (numeric) Total memory usage for the mempool\n \"maxmempool\" : n, (numeric) Maximum memory usage for the mempool\n \"mempoolminfee\" : n, (numeric) Minimum fee rate in BTC/kB for tx to be accepted. Is the maximum of minrelaytxfee and minimum mempool fee\n \"minrelaytxfee\" : n, (numeric) Current minimum relay fee for transactions\n \"unbroadcastcount\" : n (numeric) Current number of transactions that haven't passed initial broadcast yet\n}\n```\n## Examples\n```\nbitcoin-cli getmempoolinfo\ncurl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"getmempoolinfo\", \"params\": []}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n```"
},
"response": []
},
{
"name": "getrawmempool",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getrawmempool\",\n \"params\": [{{verbose}}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# getrawmempool\n`getrawmempool ( verbose mempool_sequence )`\n\nReturns all transaction ids in memory pool as a json array of string transaction ids.\n\nHint: use `getmempoolentry` to fetch a specific transaction from the mempool.\n\n## Argument #1 - verbose\n**Type**: boolean, optional, default=false\n\nTrue for a json object, false for array of transaction ids\n\n## Argument #2 - mempool_sequence\n**Type**: boolean, optional, default=false\n\nIf verbose=false, returns a json object with transaction list and mempool sequence number attached.\n\n## Result (for verbose = false)\n```\n[ (json array)\n \"hex\", (string) The transaction id\n ...\n]\n``\n## Result (for verbose = true)\n```\n{ (json object)\n \"transactionid\" : { (json object)\n \"vsize\" : n, (numeric) virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted.\n \"weight\" : n, (numeric) transaction weight as defined in BIP 141.\n \"fee\" : n, (numeric) transaction fee in BTC (DEPRECATED)\n \"modifiedfee\" : n, (numeric) transaction fee with fee deltas used for mining priority (DEPRECATED)\n \"time\" : xxx, (numeric) local time transaction entered pool in seconds since 1 Jan 1970 GMT\n \"height\" : n, (numeric) block height when transaction entered pool\n \"descendantcount\" : n, (numeric) number of in-mempool descendant transactions (including this one)\n \"descendantsize\" : n, (numeric) virtual transaction size of in-mempool descendants (including this one)\n \"descendantfees\" : n, (numeric) modified fees (see above) of in-mempool descendants (including this one) (DEPRECATED)\n \"ancestorcount\" : n, (numeric) number of in-mempool ancestor transactions (including this one)\n \"ancestorsize\" : n, (numeric) virtual transaction size of in-mempool ancestors (including this one)\n \"ancestorfees\" : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one) (DEPRECATED)\n \"wtxid\" : \"hex\", (string) hash of serialized transaction, including witness data\n \"fees\" : { (json object)\n \"base\" : n, (numeric) transaction fee in BTC\n \"modified\" : n, (numeric) transaction fee with fee deltas used for mining priority in BTC\n \"ancestor\" : n, (numeric) modified fees (see above) of in-mempool ancestors (including this one) in BTC\n \"descendant\" : n (numeric) modified fees (see above) of in-mempool descendants (including this one) in BTC\n },\n \"depends\" : [ (json array) unconfirmed transactions used as inputs for this transaction\n \"hex\", (string) parent transaction id\n ...\n ],\n \"spentby\" : [ (json array) unconfirmed transactions spending outputs from this transaction\n \"hex\", (string) child transaction id\n ...\n ],\n \"bip125-replaceable\" : true|false, (boolean) Whether this transaction could be replaced due to BIP125 (replace-by-fee)\n \"unbroadcast\" : true|false (boolean) Whether this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers)\n },\n ...\n}\nResult (for verbose = false and mempool_sequence = true)\n{ (json object)\n \"txids\" : [ (json array)\n \"hex\", (string) The transaction id\n ...\n ],\n \"mempool_sequence\" : n (numeric) The mempool sequence value.\n}\n```\n## Examples\n```\nbitcoin-cli getrawmempool true\ncurl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"getrawmempool\", \"params\": [true]}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n```"
},
"response": []
}
]
},
{
"name": "Mining",
"item": [
{
"name": "getblocktemplate",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getblocktemplate\",\n \"params\": [{\"rules\": [\"segwit\"]}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
}
},
"response": []
},
{
"name": "getmininginfo",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getmininginfo\",\n \"params\": []\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# getmininginfo\n`getmininginfo`\n\nReturns a json object containing mining-related information.\n\n## Result\n```\n{ (json object)\n \"blocks\" : n, (numeric) The current block\n \"currentblockweight\" : n, (numeric, optional) The block weight of the last assembled block (only present if a block was ever assembled)\n \"currentblocktx\" : n, (numeric, optional) The number of block transactions of the last assembled block (only present if a block was ever assembled)\n \"difficulty\" : n, (numeric) The current difficulty\n \"networkhashps\" : n, (numeric) The network hashes per second\n \"pooledtx\" : n, (numeric) The size of the mempool\n \"chain\" : \"str\", (string) current network name (main, test, regtest)\n \"warnings\" : \"str\" (string) any network and blockchain warnings\n}\n```\n## Examples\n```\nbitcoin-cli getmininginfo\ncurl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"getmininginfo\", \"params\": []}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n```"
},
"response": []
},
{
"name": "getnetworkhashps",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getnetworkhashps\",\n \"params\": [{{nblocks}},{{height}}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# getnetworkhashps\n`getnetworkhashps ( nblocks height )`\n\nReturns the estimated network hashes per second based on the last n blocks.\n\nPass in [`blocks`] to override # of blocks, -1 specifies since last difficulty change.\n\nPass in [`height`] to estimate the network speed at the time when a certain block was found.\n\n## Argument #1 - nblocks\n**Type**: numeric, optional, default=120\n\nThe number of blocks, or -1 for blocks since last difficulty change.\n\n## Argument #2 - height\n**Type**: numeric, optional, default=-1\n\nTo estimate at the time of the given height.\n\n## Result\nName\n\nType\n\nDescription\n\nn\n\nnumeric\n\nHashes per second estimated\n\n## Examples\n```\nbitcoin-cli getnetworkhashps\ncurl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"getnetworkhashps\", \"params\": []}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n```"
},
"response": []
}
]
},
{
"name": "Control",
"item": [
{
"name": "uptime",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"uptime\",\n \"params\": []\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# `uptime`\n\nReturns the total uptime of the server."
},
"response": []
},
{
"name": "help",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"help\",\n \"params\": []\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# help \n`help ( \"command\" )`\n\nList all commands, or get help for a specified command.\n\n## Argument #1 - command\n**Type**: string, optional, default=all commands\n\nThe command to get help on"
},
"response": []
},
{
"name": "getrpcinfo",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getrpcinfo\",\n \"params\": []\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# getrpcinfo¶\n`getrpcinfo`\n\nReturns details of the RPC server.\n\n## Result\n```\n{ (json object)\n \"active_commands\" : [ (json array) All active commands\n { (json object) Information about an active command\n \"method\" : \"str\", (string) The name of the RPC command\n \"duration\" : n (numeric) The running time in microseconds\n },\n ...\n ],\n \"logpath\" : \"str\" (string) The complete file path to the debug log\n}\n```\n## Examples\n```\nbitcoin-cli getrpcinfo\ncurl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"getrpcinfo\", \"params\": []}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n```"
},
"response": []
},
{
"name": "getmemoryinfo",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{password}}",
"type": "string"
},
{
"key": "username",
"value": "{{username}}",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"method\": \"getmemoryinfo\",\n \"params\": [\"stats\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{protocol}}://{{server}}:{{port}}",
"protocol": "{{protocol}}",
"host": [
"{{server}}"
],
"port": "{{port}}"
},
"description": "# getmemoryinfo\n`getmemoryinfo ( \"mode\" )`\n\nReturns an object containing information about memory usage.\n\n## Argument #1 - mode\n**Type**: string, optional, default=”stats”\n\ndetermines what kind of information is returned.\n“stats” returns general statistics about memory usage in the daemon.\n\n“mallocinfo” returns an XML string describing low-level heap state (only available if compiled with glibc 2.10+).\n\n## Result (mode “stats”)\n```\n{ (json object)\n \"locked\" : { (json object) Information about locked memory manager\n \"used\" : n, (numeric) Number of bytes used\n \"free\" : n, (numeric) Number of bytes available in current arenas\n \"total\" : n, (numeric) Total number of bytes managed\n \"locked\" : n, (numeric) Amount of bytes that succeeded locking. If this number is smaller than total, locking pages failed at some point and key data could be swapped to disk.\n \"chunks_used\" : n, (numeric) Number allocated chunks\n \"chunks_free\" : n (numeric) Number unused chunks\n }\n}\n```\nResult (mode “mallocinfo”)\nName\n\nType\n\nDescription\n\nstr\n\nstring\n\n“<malloc version=”1”>…”\n\n## Examples\n```\nbitcoin-cli getmemoryinfo\ncurl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"getmemoryinfo\", \"params\": []}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n```"
},
"response": []
}
]
},
{
"name": "Network",
"item": [
{
"name": "getpeerinfo",
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"auth": {
"type": "basic",
"basic": [
{