-
Notifications
You must be signed in to change notification settings - Fork 2
/
LND REST API.postman_collection.json
4395 lines (4395 loc) · 170 KB
/
LND REST API.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": "208bdb51-7459-42bf-a620-41539f8f3672",
"name": "LND REST API",
"description": "# Introduction\n\nWelcome to the REST API reference documentation for LND, the Lightning Network\nDaemon.\n\nThis site features the API documentation for Python and JavaScript, along with\nbarebones examples using `curl`, for HTTP requests. It is intended for those who\nalready understand how to work with LND. If this is your first time or you need\na refresher, you may consider perusing our LND developer site featuring a\ntutorial, resources and guides at [dev.lightning.community](https://dev.lightning.community).\n\nThe examples to the right assume that the there is a local `lnd` instance\nrunning and listening for REST connections on port 8080. `LND_DIR` will be used\nas a placeholder to denote the base directory of the `lnd` instance. By default,\nthis is `~/.lnd` on Linux and `~/Library/Application Support/Lnd` on macOS.\n\nAt the time of writing this documentation, two things are needed in order to\nmake an HTTP request to an `lnd` instance: a TLS/SSL connection and a macaroon\nused for RPC authentication. The examples to the right will show how these can\nbe used in order to make a successful, secure, and authenticated HTTP request.\n\nThe original `rpc.proto` file from which the gRPC documentation was generated\ncan be found [here](https://github.com/lightningnetwork/lnd/blob/master/lnrpc/rpc.proto).\n\nNOTE: The documentation is currently lacking how to receive streaming responses\nfrom streaming endpoints in JavaScript. If you would like to contribute this\nchange, please take a look at [https://github.com/lightninglabs/lightning-api](https://github.com/lightninglabs/lightning-api).\n\nNOTE: The `byte` field type must be set as the base64 encoded string\nrepresentation of a raw byte array.\n\nAlternatively, the gRPC documentation can be found [here](https://api.lightning.community/).\n\n## About Postman\n\nPostman is an excellent tool that allows a user to conveniently execute and test REST APIs. If you encounter any errors, or see anything out of date, please create and issue and I'll try and fix it asap.\n\n# Definitions\n\n## ChannelCloseSummaryClosureType\n\nThis definition has no parameters.\n\n\n## PendingChannelsResponseClosedChannel\n\nField | Type | Description\n----- | ---- | ----------- \nchannel | [PendingChannelsResponsePendingChannel](#pendingchannelsresponsependingchannel) | / The pending channel to be closed\nclosing_txid | string | / The transaction id of the closing transaction\n\n\n## PendingChannelsResponseForceClosedChannel\n\nField | Type | Description\n----- | ---- | ----------- \nchannel | [PendingChannelsResponsePendingChannel](#pendingchannelsresponsependingchannel) | / The pending channel to be force closed\nclosing_txid | string | / The transaction id of the closing transaction\nlimbo_balance | string | / The balance in satoshis encumbered in this pending channel\nmaturity_height | int64 | / The height at which funds can be sweeped into the wallet\nblocks_til_maturity | int32 | Remaining # of blocks until the commitment output can be swept. Negative values indicate how many blocks have passed since becoming mature.\nrecovered_balance | string | / The total value of funds successfully recovered from this channel\npending_htlcs | [array PendingHTLC](#pendinghtlc) | \n\n\n## PendingChannelsResponsePendingChannel\n\nField | Type | Description\n----- | ---- | ----------- \nremote_node_pub | string | \nchannel_point | string | \ncapacity | string | \nlocal_balance | string | \nremote_balance | string | \n\n\n## PendingChannelsResponsePendingOpenChannel\n\nField | Type | Description\n----- | ---- | ----------- \nchannel | [PendingChannelsResponsePendingChannel](#pendingchannelsresponsependingchannel) | / The pending channel\nconfirmation_height | int64 | / The height at which this channel will be confirmed\ncommit_fee | string | * The amount calculated to be paid in fees for the current set of commitment transactions. The fee amount is persisted with the channel in order to allow the fee amount to be removed and recalculated with each channel state update, including updates that happen after a system restart.\ncommit_weight | string | / The weight of the commitment transaction\nfee_per_kw | string | * The required number of satoshis per kilo-weight that the requester will pay at all times, for both the funding transaction and commitment transaction. This value can later be updated once the channel is open.\n\n\n## PendingChannelsResponseWaitingCloseChannel\n\nField | Type | Description\n----- | ---- | ----------- \nchannel | [PendingChannelsResponsePendingChannel](#pendingchannelsresponsependingchannel) | / The pending channel waiting for closing tx to confirm\nlimbo_balance | string | / The balance in satoshis encumbered in this channel\n\n\n## AbandonChannelResponse\n\nThis definition has no parameters.\n\n\n## AddInvoiceResponse\n\nField | Type | Description\n----- | ---- | ----------- \nr_hash | byte | \npayment_request | string | * A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient.\nadd_index | string | * The \"add\" index of this invoice. Each newly created invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all added invoices with an add_index greater than this one.\n\n\n## ChangePasswordRequest\n\nField | Type | Description\n----- | ---- | ----------- \ncurrent_password | byte | * current_password should be the current valid passphrase used to unlock the daemon.\nnew_password | byte | * new_password should be the new passphrase that will be needed to unlock the daemon.\n\n\n## ChangePasswordResponse\n\nThis definition has no parameters.\n\n\n## Channel\n\nField | Type | Description\n----- | ---- | ----------- \nactive | boolean | / Whether this channel is active or not\nremote_pubkey | string | / The identity pubkey of the remote node\nchannel_point | string | * The outpoint (txid:index) of the funding transaction. With this value, Bob will be able to generate a signature for Alice's version of the commitment transaction.\nchan_id | string | * The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.\ncapacity | string | / The total amount of funds held in this channel\nlocal_balance | string | / This node's current balance in this channel\nremote_balance | string | / The counterparty's current balance in this channel\ncommit_fee | string | * The amount calculated to be paid in fees for the current set of commitment transactions. The fee amount is persisted with the channel in order to allow the fee amount to be removed and recalculated with each channel state update, including updates that happen after a system restart.\ncommit_weight | string | / The weight of the commitment transaction\nfee_per_kw | string | * The required number of satoshis per kilo-weight that the requester will pay at all times, for both the funding transaction and commitment transaction. This value can later be updated once the channel is open.\nunsettled_balance | string | / The unsettled balance in this channel\ntotal_satoshis_sent | string | * The total number of satoshis we've sent within this channel.\ntotal_satoshis_received | string | * The total number of satoshis we've received within this channel.\nnum_updates | string | * The total number of updates conducted within this channel.\npending_htlcs | [array HTLC](#htlc) | * The list of active, uncleared HTLCs currently pending within the channel.\ncsv_delay | int64 | * The CSV delay expressed in relative blocks. If the channel is force closed, we'll need to wait for this many blocks before we can regain our funds.\nprivate | boolean | / Whether this channel is advertised to the network or not\n\n\n## ChannelBalanceResponse\n\nField | Type | Description\n----- | ---- | ----------- \nbalance | string | / Sum of channels balances denominated in satoshis\npending_open_balance | string | / Sum of channels pending balances denominated in satoshis\n\n\n## ChannelCloseSummary\n\nField | Type | Description\n----- | ---- | ----------- \nchannel_point | string | / The outpoint (txid:index) of the funding transaction.\nchan_id | string | / The unique channel ID for the channel.\nchain_hash | string | / The hash of the genesis block that this channel resides within.\nclosing_tx_hash | string | / The txid of the transaction which ultimately closed this channel.\nremote_pubkey | string | / Public key of the remote peer that we formerly had a channel with.\ncapacity | string | / Total capacity of the channel.\nclose_height | int64 | / Height at which the funding transaction was spent.\nsettled_balance | string | / Settled balance at the time of channel closure\ntime_locked_balance | string | / The sum of all the time-locked outputs at the time of channel closure\nclose_type | [ChannelCloseSummaryClosureType](#channelclosesummaryclosuretype) | / Details on how the channel was closed.\n\n\n## ChannelCloseUpdate\n\nField | Type | Description\n----- | ---- | ----------- \nclosing_txid | byte | \nsuccess | boolean | \n\n\n## ChannelEdge\n\nField | Type | Description\n----- | ---- | ----------- \nchannel_id | string | * The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.\nchan_point | string | \nlast_update | int64 | \nnode1_pub | string | \nnode2_pub | string | \ncapacity | string | \nnode1_policy | [RoutingPolicy](#routingpolicy) | \nnode2_policy | [RoutingPolicy](#routingpolicy) | \n\n\n## ChannelEdgeUpdate\n\nField | Type | Description\n----- | ---- | ----------- \nchan_id | string | * The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.\nchan_point | [ChannelPoint](#channelpoint) | \ncapacity | string | \nrouting_policy | [RoutingPolicy](#routingpolicy) | \nadvertising_node | string | \nconnecting_node | string | \n\n\n## ChannelFeeReport\n\nField | Type | Description\n----- | ---- | ----------- \nchan_point | string | / The channel that this fee report belongs to.\nbase_fee_msat | string | / The base fee charged regardless of the number of milli-satoshis sent.\nfee_per_mil | string | / The amount charged per milli-satoshis transferred expressed in millionths of a satoshi.\nfee_rate | double | / The effective fee rate in milli-satoshis. Computed by dividing the fee_per_mil value by 1 million.\n\n\n## ChannelGraph\n\nField | Type | Description\n----- | ---- | ----------- \nnodes | [array LightningNode](#lightningnode) | / The list of `LightningNode`s in this channel graph\nedges | [array ChannelEdge](#channeledge) | / The list of `ChannelEdge`s in this channel graph\n\n\n## ChannelOpenUpdate\n\nField | Type | Description\n----- | ---- | ----------- \nchannel_point | [ChannelPoint](#channelpoint) | \n\n\n## ChannelPoint\n\nField | Type | Description\n----- | ---- | ----------- \nfunding_txid_bytes | byte | / Txid of the funding transaction\nfunding_txid_str | string | / Hex-encoded string representing the funding transaction\noutput_index | int64 | / The index of the output of the funding transaction\n\n\n## CloseStatusUpdate\n\nField | Type | Description\n----- | ---- | ----------- \nclose_pending | [PendingUpdate](#pendingupdate) | \nconfirmation | [ConfirmationUpdate](#confirmationupdate) | \nchan_close | [ChannelCloseUpdate](#channelcloseupdate) | \n\n\n## ClosedChannelUpdate\n\nField | Type | Description\n----- | ---- | ----------- \nchan_id | string | * The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.\ncapacity | string | \nclosed_height | int64 | \nchan_point | [ChannelPoint](#channelpoint) | \n\n\n## ClosedChannelsResponse\n\nField | Type | Description\n----- | ---- | ----------- \nchannels | [array ChannelCloseSummary](#channelclosesummary) | \n\n\n## ConfirmationUpdate\n\nField | Type | Description\n----- | ---- | ----------- \nblock_sha | byte | \nblock_height | int32 | \nnum_confs_left | int64 | \n\n\n## ConnectPeerRequest\n\nField | Type | Description\n----- | ---- | ----------- \naddr | [LightningAddress](#lightningaddress) | / Lightning address of the peer, in the format `<pubkey>@host`\nperm | boolean | * If set, the daemon will attempt to persistently connect to the target peer. Otherwise, the call will be synchronous.\n\n\n## ConnectPeerResponse\n\nThis definition has no parameters.\n\n\n## DebugLevelResponse\n\nField | Type | Description\n----- | ---- | ----------- \nsub_systems | string | \n\n\n## DeleteAllPaymentsResponse\n\nThis definition has no parameters.\n\n\n## DisconnectPeerResponse\n\nThis definition has no parameters.\n\n\n## FeeLimit\n\nField | Type | Description\n----- | ---- | ----------- \nfixed | string | / The fee limit expressed as a fixed amount of satoshis.\npercent | string | / The fee limit expressed as a percentage of the payment amount.\n\n\n## FeeReportResponse\n\nField | Type | Description\n----- | ---- | ----------- \nchannel_fees | [array ChannelFeeReport](#channelfeereport) | / An array of channel fee reports which describes the current fee schedule for each channel.\nday_fee_sum | string | / The total amount of fee revenue (in satoshis) the switch has collected over the past 24 hrs.\nweek_fee_sum | string | / The total amount of fee revenue (in satoshis) the switch has collected over the past 1 week.\nmonth_fee_sum | string | / The total amount of fee revenue (in satoshis) the switch has collected over the past 1 month.\n\n\n## ForwardingEvent\n\nField | Type | Description\n----- | ---- | ----------- \ntimestamp | string | / Timestamp is the time (unix epoch offset) that this circuit was completed.\nchan_id_in | string | / The incoming channel ID that carried the HTLC that created the circuit.\nchan_id_out | string | / The outgoing channel ID that carried the preimage that completed the circuit.\namt_in | string | / The total amount of the incoming HTLC that created half the circuit.\namt_out | string | / The total amount of the outgoign HTLC that created the second half of the circuit.\nfee | string | / The total fee that this payment circuit carried.\n\n\n## ForwardingHistoryRequest\n\nField | Type | Description\n----- | ---- | ----------- \nstart_time | string | / Start time is the starting point of the forwarding history request. All records beyond this point will be included, respecting the end time, and the index offset.\nend_time | string | / End time is the end point of the forwarding history request. The response will carry at most 50k records between the start time and the end time. The index offset can be used to implement pagination.\nindex_offset | int64 | / Index offset is the offset in the time series to start at. As each response can only contain 50k records, callers can use this to skip around within a packed time series.\nnum_max_events | int64 | / The max number of events to return in the response to this query.\n\n\n## ForwardingHistoryResponse\n\nField | Type | Description\n----- | ---- | ----------- \nforwarding_events | [array ForwardingEvent](#forwardingevent) | / A list of forwarding events from the time slice of the time series specified in the request.\nlast_offset_index | int64 | / The index of the last time in the set of returned forwarding events. Can be used to seek further, pagination style.\n\n\n## GenSeedResponse\n\nField | Type | Description\n----- | ---- | ----------- \ncipher_seed_mnemonic | array string | * cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed cipher seed obtained by the user. This field is optional, as if not provided, then the daemon will generate a new cipher seed for the user. Otherwise, then the daemon will attempt to recover the wallet state linked to this cipher seed.\nenciphered_seed | byte | * enciphered_seed are the raw aezeed cipher seed bytes. This is the raw cipher text before run through our mnemonic encoding scheme.\n\n\n## GetInfoResponse\n\nField | Type | Description\n----- | ---- | ----------- \nidentity_pubkey | string | / The identity pubkey of the current node.\nalias | string | / If applicable, the alias of the current node, e.g. \"bob\"\nnum_pending_channels | int64 | / Number of pending channels\nnum_active_channels | int64 | / Number of active channels\nnum_peers | int64 | / Number of peers\nblock_height | int64 | / The node's current view of the height of the best block\nblock_hash | string | / The node's current view of the hash of the best block\nsynced_to_chain | boolean | / Whether the wallet's view is synced to the main chain\ntestnet | boolean | / Whether the current node is connected to testnet\nchains | array string | / A list of active chains the node is connected to\nuris | array string | / The URIs of the current node.\nbest_header_timestamp | string | / Timestamp of the block best known to the wallet\nversion | string | / The version of the LND software that the node is running.\n\n\n## GraphTopologyUpdate\n\nField | Type | Description\n----- | ---- | ----------- \nnode_updates | [array NodeUpdate](#nodeupdate) | \nchannel_updates | [array ChannelEdgeUpdate](#channeledgeupdate) | \nclosed_chans | [array ClosedChannelUpdate](#closedchannelupdate) | \n\n\n## HTLC\n\nField | Type | Description\n----- | ---- | ----------- \nincoming | boolean | \namount | string | \nhash_lock | byte | \nexpiration_height | int64 | \n\n\n## Hop\n\nField | Type | Description\n----- | ---- | ----------- \nchan_id | string | * The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.\nchan_capacity | string | \namt_to_forward | string | \nfee | string | \nexpiry | int64 | \namt_to_forward_msat | string | \nfee_msat | string | \n\n\n## HopHint\n\nField | Type | Description\n----- | ---- | ----------- \nnode_id | string | / The public key of the node at the start of the channel.\nchan_id | string | / The unique identifier of the channel.\nfee_base_msat | int64 | / The base fee of the channel denominated in millisatoshis.\nfee_proportional_millionths | int64 | * The fee rate of the channel for sending one satoshi across it denominated in millionths of a satoshi.\ncltv_expiry_delta | int64 | / The time-lock delta of the channel.\n\n\n## InitWalletRequest\n\nField | Type | Description\n----- | ---- | ----------- \nwallet_password | byte | * wallet_password is the passphrase that should be used to encrypt the wallet. This MUST be at least 8 chars in length. After creation, this password is required to unlock the daemon.\ncipher_seed_mnemonic | array string | * cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed cipher seed obtained by the user. This may have been generated by the GenSeed method, or be an existing seed.\naezeed_passphrase | byte | * aezeed_passphrase is an optional user provided passphrase that will be used to encrypt the generated aezeed cipher seed.\nrecovery_window | int32 | * recovery_window is an optional argument specifying the address lookahead when restoring a wallet seed. The recovery window applies to each invdividual branch of the BIP44 derivation paths. Supplying a recovery window of zero indicates that no addresses should be recovered, such after the first initialization of the wallet.\n\n\n## InitWalletResponse\n\nThis definition has no parameters.\n\n\n## Invoice\n\nField | Type | Description\n----- | ---- | ----------- \nmemo | string | * An optional memo to attach along with the invoice. Used for record keeping purposes for the invoice's creator, and will also be set in the description field of the encoded payment request if the description_hash field is not being used.\nreceipt | byte | / An optional cryptographic receipt of payment\nr_preimage | byte | * The hex-encoded preimage (32 byte) which will allow settling an incoming HTLC payable to this preimage\nr_hash | byte | / The hash of the preimage\nvalue | string | / The value of this invoice in satoshis\nsettled | boolean | / Whether this invoice has been fulfilled\ncreation_date | string | / When this invoice was created\nsettle_date | string | / When this invoice was settled\npayment_request | string | * A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient.\ndescription_hash | byte | * Hash (SHA-256) of a description of the payment. Used if the description of payment (memo) is too long to naturally fit within the description field of an encoded payment request.\nexpiry | string | / Payment request expiry time in seconds. Default is 3600 (1 hour).\nfallback_addr | string | / Fallback on-chain address.\ncltv_expiry | string | / Delta to use for the time-lock of the CLTV extended to the final hop.\nroute_hints | [array RouteHint](#routehint) | * Route hints that can each be individually used to assist in reaching the invoice's destination.\nprivate | boolean | / Whether this invoice should include routing hints for private channels.\nadd_index | string | * The \"add\" index of this invoice. Each newly created invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all added invoices with an add_index greater than this one.\nsettle_index | string | * The \"settle\" index of this invoice. Each newly settled invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all settled invoices with an settle_index greater than this one.\namt_paid | string | / Deprecated, use amt_paid_sat or amt_paid_msat.\namt_paid_sat | string | * The amount that was accepted for this invoice, in satoshis. This will ONLY be set if this invoice has been settled. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well.\namt_paid_msat | string | * The amount that was accepted for this invoice, in millisatoshis. This will ONLY be set if this invoice has been settled. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well.\n\n\n## LightningAddress\n\nField | Type | Description\n----- | ---- | ----------- \npubkey | string | / The identity pubkey of the Lightning node\nhost | string | / The network location of the lightning node, e.g. `69.69.69.69:1337` or `localhost:10011`\n\n\n## LightningNode\n\nField | Type | Description\n----- | ---- | ----------- \nlast_update | int64 | \npub_key | string | \nalias | string | \naddresses | [array NodeAddress](#nodeaddress) | \ncolor | string | \n\n\n## ListChannelsResponse\n\nField | Type | Description\n----- | ---- | ----------- \nchannels | [array Channel](#channel) | / The list of active channels\n\n\n## ListInvoiceResponse\n\nField | Type | Description\n----- | ---- | ----------- \ninvoices | [array Invoice](#invoice) | * A list of invoices from the time slice of the time series specified in the request.\nlast_index_offset | string | * The index of the last item in the set of returned invoices. This can be used to seek further, pagination style.\nfirst_index_offset | string | * The index of the last item in the set of returned invoices. This can be used to seek backwards, pagination style.\n\n\n## ListPaymentsResponse\n\nField | Type | Description\n----- | ---- | ----------- \npayments | [array Payment](#payment) | / The list of payments\n\n\n## ListPeersResponse\n\nField | Type | Description\n----- | ---- | ----------- \npeers | [array Peer](#peer) | / The list of currently connected peers\n\n\n## NetworkInfo\n\nField | Type | Description\n----- | ---- | ----------- \ngraph_diameter | int64 | \navg_out_degree | double | \nmax_out_degree | int64 | \nnum_nodes | int64 | \nnum_channels | int64 | \ntotal_network_capacity | string | \navg_channel_size | double | \nmin_channel_size | string | \nmax_channel_size | string | \n\n\n## NewAddressResponse\n\nField | Type | Description\n----- | ---- | ----------- \naddress | string | / The newly generated wallet address\n\n\n## NodeAddress\n\nField | Type | Description\n----- | ---- | ----------- \nnetwork | string | \naddr | string | \n\n\n## NodeInfo\n\nField | Type | Description\n----- | ---- | ----------- \nnode | [LightningNode](#lightningnode) | * An individual vertex/node within the channel graph. A node is connected to other nodes by one or more channel edges emanating from it. As the graph is directed, a node will also have an incoming edge attached to it for each outgoing edge.\nnum_channels | int64 | \ntotal_capacity | string | \n\n\n## NodeUpdate\n\nField | Type | Description\n----- | ---- | ----------- \naddresses | array string | \nidentity_key | string | \nglobal_features | byte | \nalias | string | \n\n\n## OpenChannelRequest\n\nField | Type | Description\n----- | ---- | ----------- \nnode_pubkey | byte | / The pubkey of the node to open a channel with\nnode_pubkey_string | string | / The hex encoded pubkey of the node to open a channel with\nlocal_funding_amount | string | / The number of satoshis the wallet should commit to the channel\npush_sat | string | / The number of satoshis to push to the remote side as part of the initial commitment state\ntarget_conf | int32 | / The target number of blocks that the funding transaction should be confirmed by.\nsat_per_byte | string | / A manual fee rate set in sat/byte that should be used when crafting the funding transaction.\nprivate | boolean | / Whether this channel should be private, not announced to the greater network.\nmin_htlc_msat | string | / The minimum value in millisatoshi we will require for incoming HTLCs on the channel.\nremote_csv_delay | int64 | / The delay we require on the remote's commitment transaction. If this is not set, it will be scaled automatically with the channel size.\nmin_confs | int32 | / The minimum number of confirmations each one of your outputs used for the funding transaction must satisfy.\nspend_unconfirmed | boolean | / Whether unconfirmed outputs should be used as inputs for the funding transaction.\n\n\n## OpenStatusUpdate\n\nField | Type | Description\n----- | ---- | ----------- \nchan_pending | [PendingUpdate](#pendingupdate) | \nconfirmation | [ConfirmationUpdate](#confirmationupdate) | \nchan_open | [ChannelOpenUpdate](#channelopenupdate) | \n\n\n## PayReq\n\nField | Type | Description\n----- | ---- | ----------- \ndestination | string | \npayment_hash | string | \nnum_satoshis | string | \ntimestamp | string | \nexpiry | string | \ndescription | string | \ndescription_hash | string | \nfallback_addr | string | \ncltv_expiry | string | \nroute_hints | [array RouteHint](#routehint) | \n\n\n## Payment\n\nField | Type | Description\n----- | ---- | ----------- \npayment_hash | string | / The payment hash\nvalue | string | / Deprecated, use value_sat or value_msat.\ncreation_date | string | / The date of this payment\npath | array string | / The path this payment took\nfee | string | / The fee paid for this payment in satoshis\npayment_preimage | string | / The payment preimage\nvalue_sat | string | / The value of the payment in satoshis\nvalue_msat | string | / The value of the payment in milli-satoshis\n\n\n## Peer\n\nField | Type | Description\n----- | ---- | ----------- \npub_key | string | / The identity pubkey of the peer\naddress | string | / Network address of the peer; eg `127.0.0.1:10011`\nbytes_sent | string | / Bytes of data transmitted to this peer\nbytes_recv | string | / Bytes of data transmitted from this peer\nsat_sent | string | / Satoshis sent to this peer\nsat_recv | string | / Satoshis received from this peer\ninbound | boolean | / A channel is inbound if the counterparty initiated the channel\nping_time | string | / Ping time to this peer\n\n\n## PendingChannelsResponse\n\nField | Type | Description\n----- | ---- | ----------- \ntotal_limbo_balance | string | / The balance in satoshis encumbered in pending channels\npending_open_channels | [array PendingChannelsResponsePendingOpenChannel](#pendingchannelsresponsependingopenchannel) | / Channels pending opening\npending_closing_channels | [array PendingChannelsResponseClosedChannel](#pendingchannelsresponseclosedchannel) | / Channels pending closing\npending_force_closing_channels | [array PendingChannelsResponseForceClosedChannel](#pendingchannelsresponseforceclosedchannel) | / Channels pending force closing\nwaiting_close_channels | [array PendingChannelsResponseWaitingCloseChannel](#pendingchannelsresponsewaitingclosechannel) | / Channels waiting for closing tx to confirm\n\n\n## PendingHTLC\n\nField | Type | Description\n----- | ---- | ----------- \nincoming | boolean | / The direction within the channel that the htlc was sent\namount | string | / The total value of the htlc\noutpoint | string | / The final output to be swept back to the user's wallet\nmaturity_height | int64 | / The next block height at which we can spend the current stage\nblocks_til_maturity | int32 | * The number of blocks remaining until the current stage can be swept. Negative values indicate how many blocks have passed since becoming mature.\nstage | int64 | / Indicates whether the htlc is in its first or second stage of recovery\n\n\n## PendingUpdate\n\nField | Type | Description\n----- | ---- | ----------- \ntxid | byte | \noutput_index | int64 | \n\n\n## PolicyUpdateRequest\n\nField | Type | Description\n----- | ---- | ----------- \nglobal | boolean | / If set, then this update applies to all currently active channels.\nchan_point | [ChannelPoint](#channelpoint) | / If set, this update will target a specific channel.\nbase_fee_msat | string | / The base fee charged regardless of the number of milli-satoshis sent.\nfee_rate | double | / The effective fee rate in milli-satoshis. The precision of this value goes up to 6 decimal places, so 1e-6.\ntime_lock_delta | int64 | / The required timelock delta for HTLCs forwarded over the channel.\n\n\n## PolicyUpdateResponse\n\nThis definition has no parameters.\n\n\n## QueryRoutesResponse\n\nField | Type | Description\n----- | ---- | ----------- \nroutes | [array Route](#route) | \n\n\n## Route\n\nField | Type | Description\n----- | ---- | ----------- \ntotal_time_lock | int64 | * The cumulative (final) time lock across the entire route. This is the CLTV value that should be extended to the first hop in the route. All other hops will decrement the time-lock as advertised, leaving enough time for all hops to wait for or present the payment preimage to complete the payment.\ntotal_fees | string | * The sum of the fees paid at each hop within the final route. In the case of a one-hop payment, this value will be zero as we don't need to pay a fee it ourself.\ntotal_amt | string | * The total amount of funds required to complete a payment over this route. This value includes the cumulative fees at each hop. As a result, the HTLC extended to the first-hop in the route will need to have at least this many satoshis, otherwise the route will fail at an intermediate node due to an insufficient amount of fees.\nhops | [array Hop](#hop) | * Contains details concerning the specific forwarding details at each hop.\ntotal_fees_msat | string | * The total fees in millisatoshis.\ntotal_amt_msat | string | * The total amount in millisatoshis.\n\n\n## RouteHint\n\nField | Type | Description\n----- | ---- | ----------- \nhop_hints | [array HopHint](#hophint) | * A list of hop hints that when chained together can assist in reaching a specific destination.\n\n\n## RoutingPolicy\n\nField | Type | Description\n----- | ---- | ----------- \ntime_lock_delta | int64 | \nmin_htlc | string | \nfee_base_msat | string | \nfee_rate_milli_msat | string | \ndisabled | boolean | \n\n\n## SendCoinsRequest\n\nField | Type | Description\n----- | ---- | ----------- \naddr | string | / The address to send coins to\namount | string | / The amount in satoshis to send\ntarget_conf | int32 | / The target number of blocks that this transaction should be confirmed by.\nsat_per_byte | string | / A manual fee rate set in sat/byte that should be used when crafting the transaction.\n\n\n## SendCoinsResponse\n\nField | Type | Description\n----- | ---- | ----------- \ntxid | string | / The transaction ID of the transaction\n\n\n## SendManyResponse\n\nField | Type | Description\n----- | ---- | ----------- \ntxid | string | / The id of the transaction\n\n\n## SendRequest\n\nField | Type | Description\n----- | ---- | ----------- \ndest | byte | / The identity pubkey of the payment recipient\ndest_string | string | / The hex-encoded identity pubkey of the payment recipient\namt | string | / Number of satoshis to send.\npayment_hash | byte | / The hash to use within the payment's HTLC\npayment_hash_string | string | / The hex-encoded hash to use within the payment's HTLC\npayment_request | string | * A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient.\nfinal_cltv_delta | int32 | * The CLTV delta from the current height that should be used to set the timelock for the final hop.\nfee_limit | [FeeLimit](#feelimit) | * The maximum number of satoshis that will be paid as a fee of the payment. This value can be represented either as a percentage of the amount being sent, or as a fixed amount of the maximum fee the user is willing the pay to send the payment.\n\n\n## SendResponse\n\nField | Type | Description\n----- | ---- | ----------- \npayment_error | string | \npayment_preimage | byte | \npayment_route | [Route](#route) | \n\n\n## SendToRouteRequest\n\nField | Type | Description\n----- | ---- | ----------- \npayment_hash | byte | / The payment hash to use for the HTLC.\npayment_hash_string | string | / An optional hex-encoded payment hash to be used for the HTLC.\nroutes | [array Route](#route) | / The set of routes that should be used to attempt to complete the payment.\n\n\n## SignMessageResponse\n\nField | Type | Description\n----- | ---- | ----------- \nsignature | string | / The signature for the given message\n\n\n## StopResponse\n\nThis definition has no parameters.\n\n\n## Transaction\n\nField | Type | Description\n----- | ---- | ----------- \ntx_hash | string | / The transaction hash\namount | string | / The transaction amount, denominated in satoshis\nnum_confirmations | int32 | / The number of confirmations\nblock_hash | string | / The hash of the block this transaction was included in\nblock_height | int32 | / The height of the block this transaction was included in\ntime_stamp | string | / Timestamp of this transaction\ntotal_fees | string | / Fees paid for this transaction\ndest_addresses | array string | / Addresses that received funds for this transaction\n\n\n## TransactionDetails\n\nField | Type | Description\n----- | ---- | ----------- \ntransactions | [array Transaction](#transaction) | / The list of transactions relevant to the wallet.\n\n\n## UnlockWalletRequest\n\nField | Type | Description\n----- | ---- | ----------- \nwallet_password | byte | * wallet_password should be the current valid passphrase for the daemon. This will be required to decrypt on-disk material that the daemon requires to function properly.\nrecovery_window | int32 | * recovery_window is an optional argument specifying the address lookahead when restoring a wallet seed. The recovery window applies to each invdividual branch of the BIP44 derivation paths. Supplying a recovery window of zero indicates that no addresses should be recovered, such after the first initialization of the wallet.\n\n\n## UnlockWalletResponse\n\nThis definition has no parameters.\n\n\n## VerifyMessageResponse\n\nField | Type | Description\n----- | ---- | ----------- \nvalid | boolean | / Whether the signature was valid over the given message\npubkey | string | / The pubkey recovered from the signature\n\n\n## WalletBalanceResponse\n\nField | Type | Description\n----- | ---- | ----------- \ntotal_balance | string | / The balance of the wallet\nconfirmed_balance | string | / The confirmed balance of a wallet(with >= 1 confirmations)\nunconfirmed_balance | string | / The unconfirmed balance of a wallet(with 0 confirmations)\n",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Balance",
"item": [
{
"name": "/v1/balance/blockchain",
"request": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"value": "macaroon",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/balance/blockchain",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"balance",
"blockchain"
]
},
"description": "### GET /v1/balance/blockchain\nWalletBalance returns total unspent outputs(confirmed and unconfirmed), all confirmed unspent outputs and all unconfirmed unspent outputs under control of the wallet.\n\nThis request has no parameters.\n\n### Response \n\nField | Type | Description\n----- | ---- | ----------- \ntotal_balance | string | / The balance of the wallet \nconfirmed_balance | string | / The confirmed balance of a wallet(with >= 1 confirmations) \nunconfirmed_balance | string | / The unconfirmed balance of a wallet(with 0 confirmations)"
},
"response": [
{
"name": "/v1/balance/blockchain",
"originalRequest": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/balance/blockchain",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"balance",
"blockchain"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "plain",
"header": [
{
"key": "Content-Type",
"value": "text/plain; charset=utf-8"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Date",
"value": "Mon, 19 Nov 2018 03:53:40 GMT"
},
{
"key": "Content-Length",
"value": "19"
}
],
"cookie": [],
"body": "{ \n \"total_balance\": <string>, \n \"confirmed_balance\": <string>, \n \"unconfirmed_balance\": <string>, \n}"
}
]
},
{
"name": "/v1/balance/channels",
"request": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/balance/channels",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"balance",
"channels"
]
},
"description": "### GET /v1/balance/channels\nChannelBalance returns the total funds available across all open channels in satoshis.\n\nThis request has no parameters.\n\n### Response \n\nField | Type | Description\n----- | ---- | ----------- \nbalance | string | / Sum of channels balances denominated in satoshis \npending_open_balance | string | / Sum of channels pending balances denominated in satoshis"
},
"response": [
{
"name": "/v1/balance/blockchain",
"originalRequest": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/balance/blockchain",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"balance",
"blockchain"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "plain",
"header": [
{
"key": "Content-Type",
"value": "text/plain; charset=utf-8"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Date",
"value": "Mon, 19 Nov 2018 03:53:40 GMT"
},
{
"key": "Content-Length",
"value": "19"
}
],
"cookie": [],
"body": "{ \n \"total_balance\": <string>, \n \"confirmed_balance\": <string>, \n \"unconfirmed_balance\": <string>, \n}"
},
{
"name": "/v1/balance/channels",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/balance/channels",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"balance",
"channels"
]
}
},
"_postman_previewlanguage": null,
"header": null,
"cookie": [],
"body": "{ \n \"balance\": <string>, \n \"pending_open_balance\": <string>, \n}"
}
]
}
]
},
{
"name": "Channels",
"item": [
{
"name": "/v1/channels",
"request": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/channels",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"channels"
]
},
"description": "ListChannels returns a description of all the open channels that this node is a participant in.\n\nField | Type | Placement | Description\n----- | :----: | :---------: | -----------: \nactive_only | boolean | query | |\ninactive_only | boolean | query | |\npublic_only | boolean | query | |\nprivate_only | boolean | query | |\n\n### Response\n\nField | Type | Description\n----- | ---- | ----------- \nchannels | array Channel | / The list of active channels"
},
"response": [
{
"name": "/v1/balance/blockchain",
"originalRequest": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/balance/blockchain",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"balance",
"blockchain"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "plain",
"header": [
{
"key": "Content-Type",
"value": "text/plain; charset=utf-8"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Date",
"value": "Mon, 19 Nov 2018 03:53:40 GMT"
},
{
"key": "Content-Length",
"value": "19"
}
],
"cookie": [],
"body": "{ \n \"total_balance\": <string>, \n \"confirmed_balance\": <string>, \n \"unconfirmed_balance\": <string>, \n}"
},
{
"name": "/v1/channels",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/channels",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"channels"
]
}
},
"_postman_previewlanguage": null,
"header": null,
"cookie": [],
"body": "{ \n \"channels\": <array Channel>, \n}"
},
{
"name": "/v1/balance/channels",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/balance/channels",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"balance",
"channels"
]
}
},
"_postman_previewlanguage": null,
"header": null,
"cookie": [],
"body": "{ \n \"balance\": <string>, \n \"pending_open_balance\": <string>, \n}"
}
]
},
{
"name": "/v1/channels",
"request": {
"method": "POST",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/channels",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"channels"
]
},
"description": "### POST /v1/channels\n* OpenChannelSync is a synchronous version of the OpenChannel RPC call. This call is meant to be consumed by clients to the REST proxy. As with all other sync calls, all byte slices are intended to be populated as hex encoded strings.\n\nField | Type | Placement | Description\n----- | ---- | --------- | ----------- \nnode_pubkey | byte | body | / The pubkey of the node to open a channel with\nnode_pubkey_string | string | body | / The hex encoded pubkey of the node to open a channel with\nlocal_funding_amount | string | body | / The number of satoshis the wallet should commit to the channel\npush_sat | string | body | / The number of satoshis to push to the remote side as part of the initial commitment state\ntarget_conf | int32 | body | / The target number of blocks that the funding transaction should be confirmed by.\nsat_per_byte | string | body | / A manual fee rate set in sat/byte that should be used when crafting the funding transaction.\nprivate | boolean | body | / Whether this channel should be private, not announced to the greater network.\nmin_htlc_msat | string | body | / The minimum value in millisatoshi we will require for incoming HTLCs on the channel.\nremote_csv_delay | int64 | body | / The delay we require on the remote's commitment transaction. If this is not set, it will be scaled automatically with the channel size.\nmin_confs | int32 | body | / The minimum number of confirmations each one of your outputs used for the funding transaction must satisfy.\nspend_unconfirmed | boolean | body | / Whether unconfirmed outputs should be used as inputs for the funding transaction.\n\n### Response \n\n\nField | Type | Description\n----- | ---- | ----------- \nfunding_txid_bytes | byte | / Txid of the funding transaction \nfunding_txid_str | string | / Hex-encoded string representing the funding transaction \noutput_index | int64 | / The index of the output of the funding transaction"
},
"response": [
{
"name": "/v1/balance/blockchain",
"originalRequest": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/balance/blockchain",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"balance",
"blockchain"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "plain",
"header": [
{
"key": "Content-Type",
"value": "text/plain; charset=utf-8"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Date",
"value": "Mon, 19 Nov 2018 03:53:40 GMT"
},
{
"key": "Content-Length",
"value": "19"
}
],
"cookie": [],
"body": "{ \n \"total_balance\": <string>, \n \"confirmed_balance\": <string>, \n \"unconfirmed_balance\": <string>, \n}"
},
{
"name": "/v1/balance/channels",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/balance/channels",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"balance",
"channels"
]
}
},
"_postman_previewlanguage": null,
"header": null,
"cookie": [],
"body": "{ \n \"balance\": <string>, \n \"pending_open_balance\": <string>, \n}"
},
{
"name": "/v1/channels",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/channels",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"channels"
]
}
},
"_postman_previewlanguage": null,
"header": null,
"cookie": [],
"body": "{ \n \"channels\": <array Channel>, \n}"
}
]
},
{
"name": "/v1/channels",
"request": {
"method": "DELETE",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/channels/:channel_point.funding_txid_str/:channel_point.output_index",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"channels",
":channel_point.funding_txid_str",
":channel_point.output_index"
],
"variable": [
{
"key": "channel_point",
"value": ""
},
{
"key": "channel_point",
"value": ""
}
]
},
"description": "AbandonChannel removes all channel state from the database except for a close summary. This method can be used to get rid of permanently unusable channels due to bugs fixed in newer versions of lnd. Only available when in debug builds of lnd.\n\n\nField | Type | Placement | Description\n----- | ---- | --------- | ----------- \nchannel_point.funding_txid_str | string | path | |\nchannel_point.output_index | int64 | path | |\n\n### Response \n\nThis response has no parameters."
},
"response": [
{
"name": "/v1/channels",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/channels",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"channels"
]
}
},
"_postman_previewlanguage": null,
"header": null,
"cookie": [],
"body": "{ \n \"channels\": <array Channel>, \n}"
},
{
"name": "/v1/balance/blockchain",
"originalRequest": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/balance/blockchain",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"balance",
"blockchain"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "plain",
"header": [
{
"key": "Content-Type",
"value": "text/plain; charset=utf-8"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Date",
"value": "Mon, 19 Nov 2018 03:53:40 GMT"
},
{
"key": "Content-Length",
"value": "19"
}
],
"cookie": [],
"body": "{ \n \"total_balance\": <string>, \n \"confirmed_balance\": <string>, \n \"unconfirmed_balance\": <string>, \n}"
},
{
"name": "/v1/balance/channels",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/balance/channels",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"balance",
"channels"
]
}
},
"_postman_previewlanguage": null,
"header": null,
"cookie": [],
"body": "{ \n \"balance\": <string>, \n \"pending_open_balance\": <string>, \n}"
}
]
},
{
"name": "/v1/channels/closed",
"request": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/channels/closed",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"channels",
"closed"
]
},
"description": "ClosedChannels returns a description of all the closed channels that this node was a participant in.\n\nField | Type | Placement | Description\n----- | ---- | --------- | ----------- \ncooperative | boolean | query | |\nlocal_force | boolean | query | |\nremote_force | boolean | query | |\nbreach | boolean | query | |\nfunding_canceled | boolean | query | |\nabandoned | boolean | query | |\n\n### Response \n\nField | Type | Description\n----- | ---- | ----------- \nchannels | array ChannelCloseSummary | |"
},
"response": [
{
"name": "/v1/balance/blockchain",
"originalRequest": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/balance/blockchain",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"balance",
"blockchain"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "plain",
"header": [
{
"key": "Content-Type",
"value": "text/plain; charset=utf-8"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Date",
"value": "Mon, 19 Nov 2018 03:53:40 GMT"
},
{
"key": "Content-Length",
"value": "19"
}
],
"cookie": [],
"body": "{ \n \"total_balance\": <string>, \n \"confirmed_balance\": <string>, \n \"unconfirmed_balance\": <string>, \n}"
},
{
"name": "/v1/channels",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/channels",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"channels"
]
}
},
"_postman_previewlanguage": null,
"header": null,
"cookie": [],
"body": "{ \n \"channels\": <array Channel>, \n}"
},
{
"name": "/v1/balance/channels",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/balance/channels",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"balance",
"channels"
]
}
},
"_postman_previewlanguage": null,
"header": null,
"cookie": [],
"body": "{ \n \"balance\": <string>, \n \"pending_open_balance\": <string>, \n}"
}
]
},
{
"name": "/v1/channels/pending",
"request": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/channels/pending",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"channels",
"pending"
]
},
"description": "### GET /v1/channels/pending\nPendingChannels returns a list of all the channels that are currently considered \"pending\". A channel is pending if it has finished the funding workflow and is waiting for confirmations for the funding txn, or is in the process of closure, either initiated cooperatively or non-cooperatively.\n\nThis request has no parameters.\n\n### Response \n\nField | Type | Description\n----- | ---- | ----------- \ntotal_limbo_balance | string | / The balance in satoshis encumbered in pending channels \npending_open_channels | array [PendingChannelsResponsePendingOpenChannel] | / Channels pending opening \npending_closing_channels | array [PendingChannelsResponseClosedChannel] | / Channels pending closing \npending_force_closing_channels | array [PendingChannelsResponseForceClosedChannel] | / Channels pending force closing \nwaiting_close_channels | array [PendingChannelsResponseWaitingCloseChannel] | / Channels waiting for closing tx to confirm"
},
"response": [
{
"name": "/v1/channels",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/channels",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"channels"
]
}
},
"_postman_previewlanguage": null,
"header": null,
"cookie": [],
"body": "{ \n \"channels\": <array Channel>, \n}"
},
{
"name": "/v1/balance/blockchain",
"originalRequest": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/balance/blockchain",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"balance",
"blockchain"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "plain",
"header": [
{
"key": "Content-Type",
"value": "text/plain; charset=utf-8"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Date",
"value": "Mon, 19 Nov 2018 03:53:40 GMT"
},
{
"key": "Content-Length",
"value": "19"
}
],
"cookie": [],
"body": "{ \n \"total_balance\": <string>, \n \"confirmed_balance\": <string>, \n \"unconfirmed_balance\": <string>, \n}"
},
{
"name": "/v1/balance/channels",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/balance/channels",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"balance",
"channels"
]
}
},
"_postman_previewlanguage": null,
"header": null,
"cookie": [],
"body": "{ \n \"balance\": <string>, \n \"pending_open_balance\": <string>, \n}"
}
]
},
{
"name": "/v1/channels/transactions",
"request": {
"method": "POST",
"header": [
{
"key": "Grpc-Metadata-macaroon",
"type": "text",
"value": "macaroon"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{ \n\t\"dest\": <byte>, \n \"dest_string\": <string>, \n \"amt\": <string>, \n \"payment_hash\": <byte>, \n \"payment_hash_string\": <string>, \n \"payment_request\": <string>, \n \"final_cltv_delta\": <int32>, \n \"fee_limit\": <FeeLimit>, \n}"
},
"url": {
"raw": "{{http}}://{{url}}:{{port}}/v1/channels/transactions",
"protocol": "{{http}}",
"host": [
"{{url}}"
],
"port": "{{port}}",
"path": [
"v1",
"channels",
"transactions"
]
},
"description": "### POST /v1/channels/transactions\n* SendPaymentSync is the synchronous non-streaming version of SendPayment. This RPC is intended to be consumed by clients of the REST proxy. Additionally, this RPC expects the destination's public key and the payment hash (if any) to be encoded as hex strings.\n\nField | Type | Placement | Description\n----- | ---- | --------- | ----------- \ndest | byte | body | / The identity pubkey of the payment recipient\ndest_string | string | body | / The hex-encoded identity pubkey of the payment recipient\namt | string | body | / Number of satoshis to send.\npayment_hash | byte | body | / The hash to use within the payment's HTLC\npayment_hash_string | string | body | / The hex-encoded hash to use within the payment's HTLC\npayment_request | string | body | * A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient.\nfinal_cltv_delta | int32 | body | * The CLTV delta from the current height that should be used to set the timelock for the final hop.\nfee_limit | FeeLimit | body | * The maximum number of satoshis that will be paid as a fee of the payment. This value can be represented either as a percentage of the amount being sent, or as a fixed amount of the maximum fee the user is willing the pay to send the payment.\n\n### Response \n\nField | Type | Description\n----- | ---- | ----------- \npayment_error | string | |\npayment_preimage | byte | |\npayment_route | Route | |"
},
"response": [
{
"name": "/v1/balance/blockchain",
"originalRequest": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},