-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathchainstack-ton-node-api-openapi.yml
More file actions
5083 lines (5083 loc) · 156 KB
/
chainstack-ton-node-api-openapi.yml
File metadata and controls
5083 lines (5083 loc) · 156 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Chainstack TON Node API
version: 1.0.0
description: Chainstack-managed RPC node API for the TON blockchain. Endpoints follow the canonical JSON-RPC over HTTPS
interface for the network. Authenticate against your Chainstack node's per-node URL (e.g. https://nd-XXX-XXX-XXX.p2pify.com/<key>).
Merged from the Chainstack Developer Portal per-method fragments at https://github.com/chainstack/dev-portal/tree/main/openapi/ton_node_api.
contact:
name: Chainstack API Support
email: support@chainstack.com
license:
name: Chainstack Terms
url: https://chainstack.com/terms-of-service/
servers:
- url: https://{node_id}.p2pify.com/{api_key}
description: Chainstack-managed node endpoint
variables:
node_id:
default: nd-000-000-000
description: Your Chainstack node identifier
api_key:
default: <api-key>
description: Per-node access key
tags:
- name: V2
- name: V3
paths:
/detectAddress:
get:
tags:
- V2
summary: detectAddress
operationId: detectAddress
parameters:
- name: address
in: query
required: true
description: The address to detect
schema:
type: string
default: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2
example: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2
responses:
'200':
description: Information about the detected address
content:
application/json:
schema:
type: object
properties:
raw_form:
type: string
description: The raw form of the address
bounceable:
type: object
properties:
b64:
type: string
description: The bounceable address in base64 format
b64url:
type: string
description: The bounceable address in base64url format
non_bounceable:
type: object
properties:
b64:
type: string
description: The non-bounceable address in base64 format
b64url:
type: string
description: The non-bounceable address in base64url format
given_type:
type: string
description: The type of the given address
test_only:
type: boolean
description: Whether the address is for testnet only
/estimateFee:
post:
tags:
- V2
summary: estimateFee
operationId: estimateFee
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
address:
type: string
description: The address to send the message from
default: EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs
body:
type: string
description: The body of the message in base64 format
default: te6cckEBAQEAAgAAAEysuc0=
init_code:
type: string
description: Optional init code in base64 format for contract deployment
init_data:
type: string
description: Optional init data in base64 format for contract deployment
ignore_chksig:
type: boolean
description: Whether to ignore the signature check
default: true
required:
- address
- body
responses:
'200':
description: The estimated fee for the message
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
description: Whether the operation was successful
result:
type: object
properties:
'@type':
type: string
description: The type of the result
source_fees:
type: object
properties:
'@type':
type: string
in_fwd_fee:
type: integer
description: The incoming forward fee
storage_fee:
type: integer
description: The storage fee
gas_fee:
type: integer
description: The gas fee
fwd_fee:
type: integer
description: The forward fee
destination_fees:
type: array
items:
type: object
description: Array of destination fees
'@extra':
type: string
description: Extra information
/getAddressBalance:
get:
tags:
- V2
summary: getAddressBalance
operationId: getAddressBalance
parameters:
- name: address
in: query
required: true
description: The address to get the balance for
schema:
type: string
default: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2
example: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2
responses:
'200':
description: The balance of the specified address
content:
application/json:
schema:
type: object
properties:
balance:
type: string
description: The balance of the address in nanotons
/getAddressInformation:
get:
tags:
- V2
summary: getAddressInformation
operationId: getAddressInformation
parameters:
- name: address
in: query
required: true
description: The address to get information for
schema:
type: string
default: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2
example: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2
responses:
'200':
description: Information about the specified address
content:
application/json:
schema:
type: object
properties:
balance:
type: string
description: The balance of the address
state:
type: string
description: The state of the address
code:
type: string
description: The code of the address
data:
type: string
description: The data of the address
last_transaction_id:
type: object
properties:
lt:
type: string
description: The logical time of the last transaction
hash:
type: string
description: The hash of the last transaction
error:
type: object
id:
type: integer
/getAddressState:
get:
tags:
- V2
summary: getAddressState
operationId: getAddressState
parameters:
- name: address
in: query
required: true
description: The address to get the state for
schema:
type: string
default: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2
example: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2
responses:
'200':
description: The current state of the specified address
content:
application/json:
schema:
type: object
properties:
state:
type: string
description: The current state of the address
enum:
- active
- uninitialized
- frozen
/getBlockHeader:
get:
tags:
- V2
summary: getBlockHeader
operationId: getBlockHeader
parameters:
- name: workchain
in: query
required: true
description: The workchain ID
schema:
type: integer
default: -1
example: -1
- name: shard
in: query
required: true
description: The shard ID
schema:
type: string
default: '-9223372036854775808'
example: '-9223372036854775808'
- name: seqno
in: query
required: true
description: The sequence number of the block
schema:
type: integer
default: 39064874
example: 39064874
responses:
'200':
description: The header of the specified block
content:
application/json:
schema:
type: object
properties:
id:
type: object
properties:
workchain:
type: integer
description: The workchain ID of the block
shard:
type: string
description: The shard ID of the block
seqno:
type: integer
description: The sequence number of the block
root_hash:
type: string
description: The root hash of the block
file_hash:
type: string
description: The file hash of the block
global_id:
type: integer
description: The global ID of the block
version:
type: integer
description: The version of the block
after_merge:
type: boolean
description: Whether the block was created after a merge
before_split:
type: boolean
description: Whether the block was created before a split
after_split:
type: boolean
description: Whether the block was created after a split
want_merge:
type: boolean
description: Whether the block wants to merge
want_split:
type: boolean
description: Whether the block wants to split
validator_list_hash_short:
type: integer
description: The short hash of the validator list
catchain_seqno:
type: integer
description: The sequence number in the catchain
min_ref_mc_seqno:
type: integer
description: The minimum referenced masterchain sequence number
is_key_block:
type: boolean
description: Whether the block is a key block
prev_key_block_seqno:
type: integer
description: The sequence number of the previous key block
start_lt:
type: string
description: The start logical time of the block
end_lt:
type: string
description: The end logical time of the block
gen_utime:
type: integer
description: The generation time of the block
vert_seqno:
type: integer
description: The vertical sequence number of the block
/getBlockTransactions:
get:
tags:
- V2
summary: getBlockTransactions
operationId: getBlockTransactions
parameters:
- name: workchain
in: query
required: true
description: The workchain ID
schema:
type: integer
default: -1
example: -1
- name: shard
in: query
required: true
description: The shard ID
schema:
type: string
default: '-9223372036854775808'
example: '-9223372036854775808'
- name: seqno
in: query
required: true
description: The sequence number of the block
schema:
type: integer
default: 39064874
example: 39064874
- name: count
in: query
required: false
description: The maximum number of transactions to return
schema:
type: integer
default: 40
example: 40
responses:
'200':
description: Transactions from the specified block
content:
application/json:
schema:
type: object
properties:
id:
type: object
properties:
workchain:
type: integer
description: The workchain ID of the block
shard:
type: string
description: The shard ID of the block
seqno:
type: integer
description: The sequence number of the block
root_hash:
type: string
description: The root hash of the block
file_hash:
type: string
description: The file hash of the block
transactions:
type: array
items:
type: object
properties:
account:
type: string
description: The account address involved in the transaction
hash:
type: string
description: The transaction hash
lt:
type: string
description: The logical time of the transaction
incomplete:
type: boolean
description: Indicates if the returned list is incomplete
/getBlockTransactionsExt:
get:
tags:
- V2
summary: getBlockTransactionsExt
operationId: getBlockTransactionsExt
parameters:
- name: workchain
in: query
required: true
description: The workchain ID
schema:
type: integer
default: -1
example: -1
- name: shard
in: query
required: true
description: The shard ID
schema:
type: string
default: '-9223372036854775808'
example: '-9223372036854775808'
- name: seqno
in: query
required: true
description: The sequence number of the block
schema:
type: integer
default: 39064874
example: 39064874
- name: count
in: query
required: false
description: The maximum number of transactions to return
schema:
type: integer
default: 40
example: 40
responses:
'200':
description: Extended transaction information from the specified block
content:
application/json:
schema:
type: object
properties:
id:
type: object
properties:
workchain:
type: integer
description: The workchain ID of the block
shard:
type: string
description: The shard ID of the block
seqno:
type: integer
description: The sequence number of the block
root_hash:
type: string
description: The root hash of the block
file_hash:
type: string
description: The file hash of the block
transactions:
type: array
items:
type: object
properties:
account:
type: string
description: The account address involved in the transaction
hash:
type: string
description: The transaction hash
lt:
type: string
description: The logical time of the transaction
transaction:
type: object
description: Detailed transaction information
incomplete:
type: boolean
description: Indicates if the returned list is incomplete
/getConfigParam:
get:
tags:
- V2
summary: getConfigParam
operationId: getConfigParam
parameters:
- name: config_id
in: query
required: true
description: The ID of the configuration parameter to retrieve
schema:
type: integer
default: 5
example: 5
responses:
'200':
description: The requested configuration parameter
content:
application/json:
schema:
type: object
properties:
config_id:
type: integer
description: The ID of the configuration parameter
value:
type: object
description: The value of the configuration parameter
additionalProperties: true
/getConsensusBlock:
get:
tags:
- V2
summary: getConsensusBlock
operationId: getConsensusBlock
responses:
'200':
description: Information about the latest consensus block
content:
application/json:
schema:
type: object
properties:
consensus_block:
type: integer
description: The sequence number of the latest consensus block
timestamp:
type: integer
description: The Unix timestamp of the latest consensus block
timestamp_string:
type: string
description: The human-readable timestamp of the latest consensus block
/getExtendedAddressInformation:
get:
tags:
- V2
summary: getExtendedAddressInformation
operationId: getExtendedAddressInformation
parameters:
- name: address
in: query
required: true
description: The address to get extended information for
schema:
type: string
default: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2
example: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2
responses:
'200':
description: Extended information about the specified address
content:
application/json:
schema:
type: object
properties:
address:
type: string
description: The address in human-readable form
balance:
type: string
description: The balance of the address in nanotons
state:
type: string
description: The state of the address (active, uninitialized, etc.)
last_transaction_id:
type: object
properties:
lt:
type: string
description: The logical time of the last transaction
hash:
type: string
description: The hash of the last transaction
block_id:
type: object
properties:
workchain:
type: integer
description: The workchain ID
shard:
type: string
description: The shard ID
seqno:
type: integer
description: The sequence number
code_hash:
type: string
description: The hash of the contract code
data_hash:
type: string
description: The hash of the contract data
acc_type:
type: integer
description: The account type
acc_type_name:
type: string
description: The human-readable account type name
/getMasterchainBlockSignatures:
get:
tags:
- V2
summary: getMasterchainBlockSignatures
operationId: getMasterchainBlockSignatures
parameters:
- name: seqno
in: query
required: true
description: The sequence number of the masterchain block
schema:
type: integer
default: 39064874
example: 39064874
responses:
'200':
description: Signatures of the specified masterchain block
content:
application/json:
schema:
type: object
properties:
signatures:
type: array
items:
type: object
properties:
node_id:
type: string
description: The ID of the validator node
r:
type: string
description: The 'r' component of the signature
s:
type: string
description: The 's' component of the signature
validator_set_hash:
type: string
description: The hash of the validator set
catchain_seqno:
type: integer
description: The sequence number in the catchain
/getMasterchainInfo:
get:
tags:
- V2
summary: getMasterchainInfo
operationId: getMasterchainInfo
responses:
'200':
description: Information about the current state of the TON masterchain
content:
application/json:
schema:
type: object
properties:
last:
type: object
properties:
seqno:
type: integer
description: The sequence number of the last masterchain block
shard:
type: string
description: The shard identifier of the last masterchain block
workchain:
type: integer
description: The workchain identifier of the last masterchain block
fileHash:
type: string
description: The file hash of the last masterchain block
rootHash:
type: string
description: The root hash of the last masterchain block
init:
type: object
properties:
fileHash:
type: string
description: The file hash of the initial masterchain block
rootHash:
type: string
description: The root hash of the initial masterchain block
stateRootHash:
type: string
description: The state root hash of the masterchain
version:
type: integer
description: The version of the masterchain
/getShardBlockProof:
get:
tags:
- V2
summary: getShardBlockProof
operationId: getShardBlockProof
parameters:
- name: workchain
in: query
required: true
description: The workchain ID
schema:
type: integer
default: -1
example: -1
- name: shard
in: query
required: true
description: The shard ID
schema:
type: string
default: '-9223372036854775808'
example: '-9223372036854775808'
- name: seqno
in: query
required: true
description: The sequence number of the block
schema:
type: integer
default: 39064874
example: 39064874
responses:
'200':
description: Proof of the specified shard block
content:
application/json:
schema:
type: object
properties:
masterchain_block_root_hash:
type: string
description: The root hash of the masterchain block
masterchain_block_seq_no:
type: integer
description: The sequence number of the masterchain block
links:
type: array
items:
type: object
properties:
from:
type: string
description: The source block hash
to:
type: string
description: The destination block hash
dest_proof:
type: string
description: The proof of the destination block
proof:
type: string
description: The proof of the link
block_header:
type: string
description: The header of the shard block
/getTokenData:
get:
tags:
- V2
summary: getTokenData
operationId: getTokenData
parameters:
- name: address
in: query
required: true
description: The address of the token contract
schema:
type: string
default: EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs
example: EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs
responses:
'200':
description: Data about the specified token
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the token
symbol:
type: string
description: The symbol of the token
decimals:
type: integer
description: The number of decimal places for the token
totalSupply:
type: string
description: The total supply of the token
mintable:
type: boolean
description: Whether the token is mintable
burnable:
type: boolean
description: Whether the token is burnable
address:
type: string
description: The address of the token contract
/getTransactions:
get:
tags:
- V2
summary: getTransactions
operationId: getTransactions
parameters:
- name: address
in: query
required: true
description: The address to get transactions for
schema:
type: string
default: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2
example: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2
- name: limit
in: query
required: false
description: The maximum number of transactions to return
schema:
type: integer
default: 10
example: 10
- name: to_lt
in: query
required: false
description: The logical time to start the search from (0 means from the latest)
schema:
type: integer
default: 0
example: 0
- name: archival
in: query
required: false
description: Whether to use archival node for the query
schema:
type: boolean
default: false
example: false
responses:
'200':
description: Transaction history for the specified address
content:
application/json:
schema:
type: array
items:
type: object
properties:
transaction_id:
type: object
properties:
lt:
type: string
description: The logical time of the transaction
hash:
type: string
description: The hash of the transaction
utime:
type: integer
description: Unix timestamp of the transaction
fee:
type: string
description: The fee for the transaction in nanotons
storage_fee:
type: string
description: The storage fee for the transaction in nanotons
other_fee:
type: string
description: Other fees for the transaction in nanotons
transaction_type:
type: string
description: The type of the transaction
compute:
type: object
description: Computation details of the transaction
action:
type: object
description: Action details of the transaction
in_msg:
type: object
description: Details of the incoming message
out_msgs:
type: array
description: Details of the outgoing messages
/getWalletInformation:
get:
tags:
- V2
summary: getWalletInformation
operationId: getWalletInformation
parameters:
- name: address
in: query
required: true
description: The address to get wallet information for
schema:
type: string
default: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2
example: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2
responses:
'200':
description: Wallet information for the specified address
content:
application/json:
schema:
type: object
properties:
wallet:
type: boolean
description: Indicates if the address is a wallet
balance:
type: string
description: The balance of the wallet in nanotons
account_state:
type: string
description: The state of the account (active, uninitialized, etc.)
wallet_type:
type: string
description: The type of the wallet contract
seqno:
type: integer
description: The current sequence number of the wallet
last_transaction_id:
type: object
properties:
lt:
type: string
description: The logical time of the last transaction
hash:
type: string
description: The hash of the last transaction
/jsonRPC:
post:
tags:
- V2
summary: Jsonrpc Handler
description: All methods in the API are available through JSON-RPC protocol ([spec](https://www.jsonrpc.org/specification)).
operationId: jsonrpc_handler_jsonRPC_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TonRequestJsonRPC'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DeprecatedTonResponseJsonRPC'
'422':
description: Validation Error