-
Notifications
You must be signed in to change notification settings - Fork 93
/
openapi.yml
7557 lines (7538 loc) · 214 KB
/
openapi.yml
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.1.0
info:
title: REST api to TON blockchain explorer
version: 2.0.0
description: Provide access to indexed TON blockchain
contact:
name: Support
email: [email protected]
servers:
- url: "https://tonapi.io"
- url: "https://testnet.tonapi.io"
- url: "http://localhost:8081"
tags:
- name: Accounts
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/accounts
- name: NFT
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/nft
- name: Jettons
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/jettons
- name: DNS
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/dns
- name: Wallet
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/wallet
- name: Rates
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/rates
- name: Staking
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/staking
- name: Traces
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/traces
- name: Events
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/events
- name: Storage
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/storage
- name: Connect
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/connect
- name: Gasless
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/gasless
- name: Multisig
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/multisig
- name: Blockchain
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/blockchain
- name: Lite Server
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/liteserver
- name: Emulation
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/emulation
- name: Inscriptions
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/inscriptions
- name: Utilities
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/utilities
paths:
/v2/openapi.json:
get:
description: Get the openapi.json file
operationId: getOpenapiJson
tags:
- Utilities
responses:
'200':
content:
application/json:
schema: { } # Free-form JSON value
'default':
$ref: '#/components/responses/Error'
/v2/openapi.yml:
get:
description: Get the openapi.yml file
operationId: getOpenapiYml
tags:
- Utilities
responses:
'200':
content:
application/yaml:
schema:
type: string
format: binary
'default':
$ref: '#/components/responses/Error'
/v2/status:
get:
description: Status
operationId: status
tags:
- Utilities
responses:
'200':
description: status
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceStatus'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/reduced/blocks:
get:
description: Get reduced blockchain blocks data
operationId: getReducedBlockchainBlocks
tags:
- Blockchain
parameters:
- $ref: '#/components/parameters/fromQuery'
- $ref: '#/components/parameters/toQuery'
responses:
'200':
description: blockchain reduced blocks
content:
application/json:
schema:
$ref: '#/components/schemas/ReducedBlocks'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/blocks/{block_id}:
get:
description: Get blockchain block data
operationId: getBlockchainBlock
tags:
- Blockchain
parameters:
- $ref: '#/components/parameters/blockchainBlockIDParameter'
responses:
'200':
description: blockchain block
content:
application/json:
schema:
$ref: '#/components/schemas/BlockchainBlock'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/masterchain/{masterchain_seqno}/shards:
get:
description: Get blockchain block shards
operationId: getBlockchainMasterchainShards
tags:
- Blockchain
parameters:
- $ref: '#/components/parameters/masterchainSeqno'
responses:
'200':
description: blockchain block shards
content:
application/json:
schema:
$ref: '#/components/schemas/BlockchainBlockShards'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/masterchain/{masterchain_seqno}/blocks:
get:
description: Get all blocks in all shards and workchains between target and previous masterchain block according to shards last blocks snapshot in masterchain. We don't recommend to build your app around this method because it has problem with scalability and will work very slow in the future.
operationId: getBlockchainMasterchainBlocks
tags:
- Blockchain
parameters:
- $ref: '#/components/parameters/masterchainSeqno'
responses:
'200':
description: blockchain blocks
content:
application/json:
schema:
$ref: '#/components/schemas/BlockchainBlocks'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/masterchain/{masterchain_seqno}/transactions:
get:
description: Get all transactions in all shards and workchains between target and previous masterchain block according to shards last blocks snapshot in masterchain. We don't recommend to build your app around this method because it has problem with scalability and will work very slow in the future.
operationId: getBlockchainMasterchainTransactions
tags:
- Blockchain
parameters:
- $ref: '#/components/parameters/masterchainSeqno'
responses:
'200':
description: blockchain transactions
content:
application/json:
schema:
$ref: '#/components/schemas/Transactions'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/masterchain/{masterchain_seqno}/config:
get:
description: Get blockchain config from a specific block, if present.
operationId: getBlockchainConfigFromBlock
tags:
- Blockchain
parameters:
- $ref: '#/components/parameters/masterchainSeqno'
responses:
'200':
description: blockchain config
content:
application/json:
schema:
$ref: '#/components/schemas/BlockchainConfig'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/masterchain/{masterchain_seqno}/config/raw:
get:
description: Get raw blockchain config from a specific block, if present.
operationId: getRawBlockchainConfigFromBlock
tags:
- Blockchain
parameters:
- $ref: '#/components/parameters/masterchainSeqno'
responses:
'200':
description: blockchain config
content:
application/json:
schema:
$ref: '#/components/schemas/RawBlockchainConfig'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/blocks/{block_id}/transactions:
get:
description: Get transactions from block
operationId: getBlockchainBlockTransactions
tags:
- Blockchain
parameters:
- $ref: '#/components/parameters/blockchainBlockIDParameter'
responses:
'200':
description: blockchain block transactions
content:
application/json:
schema:
$ref: '#/components/schemas/Transactions'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/transactions/{transaction_id}:
get:
description: Get transaction data
operationId: getBlockchainTransaction
tags:
- Blockchain
parameters:
- $ref: '#/components/parameters/transactionIDParameter'
responses:
'200':
description: blockchain transaction
content:
application/json:
schema:
$ref: '#/components/schemas/Transaction'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/messages/{msg_id}/transaction:
get:
description: Get transaction data by message hash
operationId: getBlockchainTransactionByMessageHash
tags:
- Blockchain
parameters:
- $ref: '#/components/parameters/messageIDParameter'
responses:
'200':
description: transaction by message hash
content:
application/json:
schema:
$ref: '#/components/schemas/Transaction'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/validators:
get:
description: Get blockchain validators
operationId: getBlockchainValidators
tags:
- Blockchain
responses:
'200':
description: blockchain validators
content:
application/json:
schema:
$ref: '#/components/schemas/Validators'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/masterchain-head:
get:
description: Get last known masterchain block
operationId: getBlockchainMasterchainHead
tags:
- Blockchain
responses:
'200':
description: blockchain masterchain head
content:
application/json:
schema:
$ref: '#/components/schemas/BlockchainBlock'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/accounts/{account_id}:
get:
description: Get low-level information about an account taken directly from the blockchain.
operationId: getBlockchainRawAccount
tags:
- Blockchain
parameters:
- $ref: '#/components/parameters/accountIDParameter'
responses:
'200':
description: raw account
content:
application/json:
schema:
$ref: '#/components/schemas/BlockchainRawAccount'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/accounts/{account_id}/transactions:
get:
description: Get account transactions
operationId: getBlockchainAccountTransactions
tags:
- Blockchain
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- name: after_lt
in: query
description: "omit this parameter to get last transactions"
schema:
type: integer
format: int64
example: 39787624000003
x-js-format: bigint
- name: before_lt
in: query
description: "omit this parameter to get last transactions"
schema:
type: integer
format: int64
example: 39787624000003
x-js-format: bigint
- name: limit
in: query
schema:
type: integer
format: int32
maximum: 1000
default: 100
example: 100
minimum: 1
- name: sort_order
in: query
schema:
type: string
description: "used to sort the result-set in ascending or descending order by lt."
default: "desc"
enum:
- desc
- asc
responses:
'200':
description: blockchain account transactions
content:
application/json:
schema:
$ref: '#/components/schemas/Transactions'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/accounts/{account_id}/methods/{method_name}:
get:
description: Execute get method for account
operationId: execGetMethodForBlockchainAccount
tags:
- Blockchain
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/methodNameParameter'
- name: args
in: query
required: false
schema:
type: array
description: |-
Supported values:
"NaN" for NaN type,
"Null" for Null type,
10-base digits for tiny int type (Example: 100500),
0x-prefixed hex digits for int257 (Example: 0xfa01d78381ae32),
all forms of addresses for slice type (Example: 0:6e731f2e28b73539a7f85ac47ca104d5840b229351189977bb6151d36b5e3f5e),
single-root base64-encoded BOC for cell (Example: "te6ccgEBAQEAAgAAAA=="),
single-root hex-encoded BOC for slice (Example: b5ee9c72010101010002000000)
items:
type: string
example: [ "0:9a33970f617bcd71acf2cd28357c067aa31859c02820d8f01d74c88063a8f4d8" ]
- name: fix_order
in: query
required: false
schema:
type: boolean
description: |-
A temporary fix to switch to a scheme with direct ordering of arguments.
If equal to false, then the method takes arguments in direct order,
e.g. for get_nft_content(int index, cell individual_content) we pass a list of arguments [index, individual_content].
If equal to true, then the method takes arguments in reverse order, e.g. [individual_content, index].
default: true
responses:
'200':
description: method execution result
content:
application/json:
schema:
$ref: '#/components/schemas/MethodExecutionResult'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/message:
post:
description: Send message to blockchain
operationId: sendBlockchainMessage
tags:
- Blockchain
requestBody:
$ref: "#/components/requestBodies/BatchBoc"
responses:
'200':
description: the message has been sent
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/config:
get:
description: Get blockchain config
operationId: getBlockchainConfig
tags:
- Blockchain
responses:
'200':
description: blockchain config
content:
application/json:
schema:
$ref: '#/components/schemas/BlockchainConfig'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/config/raw:
get:
description: Get raw blockchain config
operationId: getRawBlockchainConfig
tags:
- Blockchain
responses:
'200':
description: blockchain config
content:
application/json:
schema:
$ref: '#/components/schemas/RawBlockchainConfig'
'default':
$ref: '#/components/responses/Error'
/v2/blockchain/accounts/{account_id}/inspect:
get:
description: Blockchain account inspect
operationId: blockchainAccountInspect
tags:
- Blockchain
parameters:
- $ref: '#/components/parameters/accountIDParameter'
responses:
'200':
description: blockchain account inspect
content:
application/json:
schema:
$ref: '#/components/schemas/BlockchainAccountInspect'
'default':
$ref: '#/components/responses/Error'
/v2/address/{account_id}/parse:
get:
description: parse address and display in all formats
operationId: addressParse
tags:
- Utilities
parameters:
- $ref: '#/components/parameters/accountIDParameter'
responses:
'200':
description: all forms and info
content:
application/json:
schema:
type: object
required:
- raw_form
- bounceable
- non_bounceable
- given_type
- test_only
properties:
raw_form:
type: string
format: address
example: "0:6e731f2e28b73539a7f85ac47ca104d5840b229351189977bb6151d36b5e3f5e"
bounceable:
required:
- b64
- b64url
type: object
properties:
b64:
type: string
b64url:
type: string
non_bounceable:
required:
- b64
- b64url
type: object
properties:
b64:
type: string
b64url:
type: string
given_type:
type: string
test_only:
type: boolean
default:
$ref: '#/components/responses/Error'
/v2/accounts/_bulk:
post:
description: Get human-friendly information about several accounts without low-level details.
operationId: getAccounts
tags:
- Accounts
parameters:
- $ref: "#/components/parameters/currencyQuery"
requestBody:
$ref: "#/components/requestBodies/AccountIDs"
responses:
'200':
description: a list of accounts
content:
application/json:
schema:
$ref: '#/components/schemas/Accounts'
'default':
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}:
get:
description: Get human-friendly information about an account without low-level details.
operationId: getAccount
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
responses:
'200':
description: account
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
'default':
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/dns/backresolve:
get:
description: Get account's domains
operationId: accountDnsBackResolve
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
responses:
'200':
description: account's domains
content:
application/json:
schema:
$ref: '#/components/schemas/DomainNames'
'default':
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/jettons:
get:
description: Get all Jettons balances by owner address
operationId: getAccountJettonsBalances
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/currenciesQuery'
- $ref: '#/components/parameters/supportedExtensions'
responses:
'200':
description: account jettons balances
content:
application/json:
schema:
$ref: '#/components/schemas/JettonsBalances'
'default':
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/jettons/{jetton_id}:
get:
description: Get Jetton balance by owner address
operationId: getAccountJettonBalance
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/jettonIDParameter'
- $ref: '#/components/parameters/currenciesQuery'
- $ref: '#/components/parameters/supportedExtensions'
responses:
'200':
description: account jetton balance
content:
application/json:
schema:
$ref: '#/components/schemas/JettonBalance'
'default':
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/jettons/history:
get:
description: Get the transfer jettons history for account
operationId: getAccountJettonsHistory
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/i18n'
- name: before_lt
in: query
description: "omit this parameter to get last events"
required: false
schema:
type: integer
format: int64
example: 25758317000002
x-js-format: bigint
- name: limit
in: query
required: true
schema:
type: integer
example: 100
maximum: 1000
minimum: 1
- name: start_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
- name: end_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
responses:
'200':
description: account jettons history
content:
application/json:
schema:
$ref: '#/components/schemas/AccountEvents'
'default':
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/jettons/{jetton_id}/history:
get:
description: Get the transfer jetton history for account and jetton
operationId: getAccountJettonHistoryByID
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/jettonIDParameter'
- $ref: '#/components/parameters/i18n'
- name: before_lt
in: query
description: "omit this parameter to get last events"
required: false
schema:
type: integer
format: int64
example: 25758317000002
x-js-format: bigint
- name: limit
in: query
required: true
schema:
type: integer
example: 100
maximum: 1000
minimum: 1
- name: start_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
- name: end_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
responses:
'200':
description: account jetton history
content:
application/json:
schema:
$ref: '#/components/schemas/AccountEvents'
'default':
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/nfts:
get:
description: Get all NFT items by owner address
operationId: getAccountNftItems
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/collectionQuery'
- $ref: '#/components/parameters/limitQuery'
- $ref: '#/components/parameters/offsetQuery'
- in: query
name: indirect_ownership
required: false
description: "Selling nft items in ton implemented usually via transfer items to special selling account. This option enables including items which owned not directly."
schema:
type: boolean
default: false
responses:
'200':
description: account nft items
content:
application/json:
schema:
$ref: '#/components/schemas/NftItems'
'default':
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/nfts/history:
get:
x-question: duplicate of getNftHistoryByID ?
description: Get the transfer nft history
operationId: getAccountNftHistory
tags:
- NFT
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/i18n'
- name: before_lt
in: query
description: "omit this parameter to get last events"
required: false
schema:
type: integer
format: int64
example: 25758317000002
x-js-format: bigint
- name: limit
in: query
required: true
schema:
type: integer
example: 100
maximum: 1000
minimum: 1
- name: start_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
- name: end_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
responses:
'200':
description: nft history
content:
application/json:
schema:
$ref: '#/components/schemas/AccountEvents'
'default':
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/events:
get:
description: Get events for an account. Each event is built on top of a trace which is a series of transactions caused by one inbound message. TonAPI looks for known patterns inside the trace and splits the trace into actions, where a single action represents a meaningful high-level operation like a Jetton Transfer or an NFT Purchase. Actions are expected to be shown to users. It is advised not to build any logic on top of actions because actions can be changed at any time.
operationId: getAccountEvents
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/i18n'
- $ref: '#/components/parameters/initiatorQuery'
- name: subject_only
in: query
description: "filter actions where requested account is not real subject (for example sender or receiver jettons)"
schema:
type: boolean
default: false
required: false
- name: before_lt
in: query
description: "omit this parameter to get last events"
required: false
schema:
type: integer
format: int64
example: 25758317000002
x-js-format: bigint
- name: limit
in: query
required: true
schema:
type: integer
example: 20
maximum: 100
minimum: 1
- name: start_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
- name: end_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
responses:
'200':
description: account's events
content:
application/json:
schema:
$ref: '#/components/schemas/AccountEvents'
'default':
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/events/{event_id}:
get:
description: Get event for an account by event_id
operationId: getAccountEvent
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/eventIDParameter'
- $ref: '#/components/parameters/i18n'
- name: subject_only
in: query
description: "filter actions where requested account is not real subject (for example sender or receiver jettons)"
schema:
type: boolean
default: false
required: false
responses:
'200':
description: account's event
content:
application/json:
schema:
$ref: '#/components/schemas/AccountEvent'
'default':
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/traces:
get:
description: Get traces for account
operationId: getAccountTraces
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- name: before_lt
in: query
description: "omit this parameter to get last events"
required: false
schema:
type: integer
format: int64
example: 25758317000002
x-js-format: bigint
- name: limit
in: query
schema:
type: integer
maximum: 1000
default: 100
example: 100
minimum: 1
responses:
'200':
description: account's traces
content:
application/json:
schema:
$ref: '#/components/schemas/TraceIDs'
'default':
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/subscriptions:
get:
description: Get all subscriptions by wallet address
operationId: getAccountSubscriptions
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
responses:
'200':
description: account's subscriptions
content:
application/json:
schema:
$ref: '#/components/schemas/Subscriptions'
'default':
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/reindex:
post:
description: Update internal cache for a particular account
operationId: reindexAccount
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
responses:
'200':
description: success
'default':
$ref: '#/components/responses/Error'
/v2/accounts/search:
get:
description: Search by account domain name
operationId: searchAccounts
tags:
- Accounts
parameters:
- name: name
in: query
required: true
schema:
type: string
minLength: 3
maxLength: 15
responses:
'200':
description: found accounts
content:
application/json: