-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathapi-spec-scalar.yml
26423 lines (25787 loc) · 887 KB
/
api-spec-scalar.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.0.0
info:
title: Fireblocks API
description: >
Fireblocks provides a robust REST API for developers to leverage Fireblocks' capabilities programmatically.
Our REST API is the base layer for all Fireblocks SDKs.
>
Each endpoint is described with the required user role for interacting with it.
For more information about the different user roles, please read the [Manage Users](https://developers.fireblocks.com/docs/manage-users) guide.
- Visit our website for more information: [Fireblocks
Website](https://fireblocks.com)
- Visit our developer docs: [Fireblocks Developer
Portal](https://developers.fireblocks.com)
- Get a free Sandbox Workspace: [Sandbox
Signup](https://www.fireblocks.com/developer-sandbox-sign-up/)
version: 1.8.0
contact:
email: [email protected]
servers:
- url: https://api.fireblocks.io/v1
description: Fireblocks Production Environment Base URL
- url: https://sandbox-api.fireblocks.io/v1
description: Fireblocks Sandbox Environment Base URL
security:
- ApiKeyAuth: []
bearerTokenAuth: []
tags:
- name: Vault Accounts
description: >
Vault Accounts Management APIs.
Learn more about Fireblocks Vault Accounts in the following
[guide](https://developers.fireblocks.com/reference/create-vault-account)
- name: Vault Wallets
description: >
Vault Wallets Management APIs.
Learn more about Fireblocks Vault Wallets in the following
[guide](https://developers.fireblocks.com/reference/create-vault-wallet)
- name: Balances
description: Vault Wallets' Balances APIs
- name: Transactions Management
description: >
Transactions Management APIs.
Learn more about Fireblocks Transactions management in the following
[guide](https://developers.fireblocks.com/reference/create-transactions)
- name: Fee Management
description: >
Transaction Fee Management APIs.
Learn more about Fireblocks Fee Management in the following
[guide](https://developers.fireblocks.com/reference/estimate-transaction-fee)
- name: Gas Station
description: >
Fireblocks Gas Station Management APIs.
Learn more about the Fireblocks Gas Station in the following
[guide](https://developers.fireblocks.com/docs/work-with-gas-station)
- name: External Wallets
description: >
Whitelisted External Wallets APIs:
External Wallets are entities that hold addresses external to your
Fireblocks workspace and are not under your ownership.
Whitelisted addresses under External Wallets will not display the current
on-chain balance of these addresses.
Learn more about Whitelisted External Wallet Addresses
[here](https://developers.fireblocks.com/docs/whitelist-addresses#external-wallets).
- name: Internal Wallets
description: >
Whitelisted Internal Wallets APIs:
Internal Wallets are entities that hold addresses external to your
Fireblocks workspace but are under your ownership.
Whitelisted addresses under Internal Wallets will also display the current
on-chain balance of these addresses.
Learn more about Whitelisted Internal Addresses
[here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets)/
- name: Contracts
description: >
Whitelisted Contracts APIs:
Whitelisted Contracts contain the addresses of the smart contracts you
intend to interact with.
Learn more about Whitelisted Smart Contracts
[here](https://developers.fireblocks.com/docs/whitelist-addresses#contracts).
- name: Users Management
description: >
Users Management APIs.
Learn more about Fireblocks Users management in the following
[guide](https://developers.fireblocks.com/docs/manage-users)
- name: API Keys Management
description: >
API Keys Management APIs.
Learn more about Fireblocks API Keys management in the following
[guide](https://developers.fireblocks.com/docs/manage-api-keys)
- name: Workspace Settings
description: Workspace Settings APIs
- name: Transaction Authorization Policy (Beta)
description: >
Transaction Authorization Policy Management APIs.
Learn more about Fireblocks Transaction Authorization Policy in the
following
[guide](https://developers.fireblocks.com/docs/set-transaction-authorization-policy)
- name: Travel Rule
description: >
Travel Rule Policies APIs.
Learn more about Fireblocks Travel Rule management in the following
[guide](https://developers.fireblocks.com/docs/define-travel-rule-policies)
- name: AML Policy
description: >
Anti Money Laundering Policies APIs.
Learn more about Fireblocks AML management in the following
[guide](https://developers.fireblocks.com/docs/define-aml-policies)
- name: Audit Log
description: Audit Logs APIs
- name: Network Connections
description: >
Fireblocks Network Connections APIs.
Learn more about Fireblocks Network in the following
[guide](https://developers.fireblocks.com/docs/connect-to-the-fireblocks-network)
- name: Network IDs
description: Fireblocks Network IDs APIs
- name: Smart Transfers
description: >
Smart Transfers APIs.
Learn more about Fireblocks Smart Transfers in the following
[guide](https://developers.fireblocks.com/docs/execute-smart-transfers)
- name: Tokens
description: Tokenization APIs
- name: Contract Templates
description: Smart Contract Templates APIs
- name: Contract Interactions
description: Contract Interactions Management APIs
- name: Deployed Contracts
description: Deployed Contracts Management APIs
- name: NFTs
description: >
NFTs Management APIs.
Learn more about Fireblocks NFT management in the following
[guide](https://developers.fireblocks.com/reference/deploy-an-nft-collection)
- name: Supported Assets
description: >
Supported Assets APIs.
Learn more about Supporting Additional Assets in Fireblocks in the
following
[guide](https://developers.fireblocks.com/docs/add-your-tokens-1)
- name: Payouts
description: >
Payouts Management APIs.
Learn more about Fireblocks Payments - Payouts in the following
[guide](https://developers.fireblocks.com/docs/create-payouts)
- name: Flows
description: >
Flows Management APIs.
Learn more about Fireblocks Payments - Flows in the following
[guide](https://developers.fireblocks.com/docs/payment-flows-copy)
- name: Exchange Accounts
description: >
Exchange Accounts Management APIs.
Learn more about Fireblocks Exchange Connectivity in the following
[guide](https://developers.fireblocks.com/docs/connect-to-exchanges-and-fiat-providers)
- name: FIAT Accounts
description: >
FIAT Accounts Management APIs.
Learn more about Fireblocks FIAT Connectivity in the following
[guide](https://developers.fireblocks.com/docs/connect-to-exchanges-and-fiat-providers)
- name: Off Exchange
description: >
Off Exchange Management APIs.
Learn more about Fireblocks Off Exchange in the following
[guide](https://developers.fireblocks.com/docs/off-exchange)
- name: Staking
description: >
Fireblocks Staking APIs.
Learn more about Staking in Fireblocks in the following
[guide](https://developers.fireblocks.com/docs/stake-assets)
- name: Dapp Connections
description: >
Dapp Connections Management APIs.
Learn more about Fireblocks Wallet Link in the following
[guide](https://developers.fireblocks.com/docs/web3-wallet-link)
- name: Webhooks
description: >
Webhooks Management APIs.
Learn more about Fireblocks Webhooks in the following
[guide](https://developers.fireblocks.com/docs/configure-webhooks)
- name: Cosigners (Beta)
description: Cosigners Management APIs
- name: Key Link (Beta)
description: Key Link Management APIs
- name: Tokenization
description: Tokenization collections.
paths:
/vault/accounts:
get:
x-internal: true
deprecated: true
summary: Get vault accounts
description: >-
DEPRECATED - Please use `/vault/accounts_paged` endpoint instead.
>
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
tags:
- Vault Accounts
parameters:
- in: query
name: namePrefix
required: false
schema:
type: string
- in: query
name: nameSuffix
required: false
schema:
type: string
- in: query
name: minAmountThreshold
required: false
schema:
type: number
- in: query
name: assetId
required: false
schema:
type: string
x-fb-entity: asset
responses:
'200':
description: A list of vault accounts
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/GetVaultAccountsResponse'
default:
$ref: '#/components/responses/Error'
operationId: getVaultAccounts
post:
summary: Create a new vault account
operationId: createVaultAccount
description: >-
Creates a new vault account with the requested name.
>
Learn more in the following
[guide](https://developers.fireblocks.com/reference/create-vault-account).
>
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
tags:
- Vault Accounts
x-readme:
code-samples:
- language: python
code: >-
vaultAccount = fireblocks.create_vault_account(name, hiddenOnUI,
customer_ref_id, auto_fueling)
name: Fireblocks SDK Python example
- language: javascript
code: >-
const vaultAccount = await fireblocks.createVaultAccount(name,
hiddenOnUI, customerRefId, autoFueling);
name: Fireblocks SDK Javascript example
- language: typescript
code: >-
const response: Promise<FireblocksResponse<VaultAccount>> =
fireblocks.vaultAccounts.createVaultAccount(vaultAccountsApiCreateVaultAccountRequest);
name: Fireblocks SDK TypeScript example
- language: java
code: >-
CompletableFuture<ApiResponse<VaultAccount>> response =
fireblocks.vaultAccounts().createVaultAccount(createVaultAccountRequest,
idempotencyKey);
name: Fireblocks SDK Java example
parameters:
- $ref: '#/components/parameters/X-Idempotency-Key'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVaultAccountRequest'
responses:
'200':
description: A Vault Account object
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/VaultAccount'
default:
$ref: '#/components/responses/Error'
x-codeSamples:
- lang: Python
label: Python
source: >-
vaultAccount = fireblocks.create_vault_account(name, hiddenOnUI,
customer_ref_id, auto_fueling)
- lang: javascript
label: Javascript
source: >-
const vaultAccount = await fireblocks.createVaultAccount(name,
hiddenOnUI, customerRefId, autoFueling);
/vault/accounts_paged:
get:
summary: Get vault accounts
description: >-
Gets all vault accounts in your workspace. This endpoint returns a
limited amount of results with a quick response time.
>
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
tags:
- Vault Accounts
x-readme:
code-samples:
- language: python
code: >-
vault_accounts =
fireblocks.get_vault_accounts_with_page_info(filters)
name: Fireblocks SDK Python example
- language: javascript
code: >-
const vaultAccounts = await
fireblocks.getVaultAccountsWithPageInfo(filters);
name: Fireblocks SDK Javascript example
- language: typescript
code: >-
const response:
Promise<FireblocksResponse<VaultAccountsPagedResponse>> =
fireblocks.vaultAccounts.getPagedVaultAccounts(vaultAccountsApiGetPagedVaultAccountsRequest);
name: Fireblocks SDK TypeScript example
- language: java
code: >-
CompletableFuture<ApiResponse<VaultAccountsPagedResponse>>
response =
fireblocks.vaultAccounts().getPagedVaultAccounts(namePrefix,
nameSuffix, minAmountThreshold, assetId, orderBy, before, after,
limit);
name: Fireblocks SDK Java example
parameters:
- in: query
name: namePrefix
required: false
schema:
type: string
example: MyVaultPrefix
- in: query
name: nameSuffix
required: false
schema:
type: string
example: MyVaultSuffix
- in: query
name: minAmountThreshold
required: false
description: >-
Specifying minAmountThreshold will filter accounts with balances
greater than this value, otherwise, it will return all accounts.
The amount set in this parameter is the native asset amount and not its USD value.
schema:
type: number
example: 10
- in: query
name: assetId
required: false
schema:
type: string
x-fb-entity: asset
example: ETH
- in: query
name: orderBy
required: false
schema:
type: string
enum:
- ASC
- DESC
default: DESC
- in: query
name: before
required: false
schema:
type: string
example: c3RhcnRpbmdWYXVsdElkeD04NTgzNzA2Mw==
- in: query
name: after
required: false
schema:
type: string
example: c3RhcnRpbmdWYXVsdElkeD01NTM1NzUzNg==
- in: query
name: limit
required: false
schema:
type: number
minimum: 1
maximum: 500
default: 200
responses:
'200':
description: A VaultAccountsPagedResponse object
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/VaultAccountsPagedResponse'
operationId: getPagedVaultAccounts
x-codeSamples:
- lang: python
label: Python
source: >-
vault_accounts =
fireblocks.get_vault_accounts_with_page_info(filters)
- lang: javascript
label: Javascript
source: >-
const vaultAccounts = await
fireblocks.getVaultAccountsWithPageInfo(filters);
/vault/accounts/{vaultAccountId}:
get:
summary: Get a vault account by ID
description: >-
Gets a vault account by its unique ID.
>
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor,
Viewer.
tags:
- Vault Accounts
x-readme:
code-samples:
- language: python
code: vault_account = fireblocks.get_vault_account(vault_account_id)
name: Fireblocks SDK Python example
- language: javascript
code: >-
const vaultAccount = await
fireblocks.getVaultAccount(vault_account_id);
name: Fireblocks SDK Javascript example
- language: typescript
code: >-
const response: Promise<FireblocksResponse<VaultAccount>> =
fireblocks.vaultAccounts.getVaultAccount(vaultAccountsApiGetVaultAccountRequest);
name: Fireblocks SDK TypeScript example
- language: java
code: >-
CompletableFuture<ApiResponse<VaultAccount>> response =
fireblocks.vaultAccounts().getVaultAccount(vaultAccountId);
name: Fireblocks SDK Java example
parameters:
- in: path
name: vaultAccountId
required: true
description: The ID of the vault account
schema:
type: string
format: numeric
x-fb-entity: vault_account
example: '0'
responses:
'200':
description: A Vault Account object
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/VaultAccount'
default:
$ref: '#/components/responses/Error'
operationId: getVaultAccount
x-codeSamples:
- lang: python
label: Python
source: vault_account = fireblocks.get_vault_account(vault_account_id)
- lang: javascript
label: Javascript
source: >-
const vaultAccount = await
fireblocks.getVaultAccount(vault_account_id);
put:
summary: Rename a vault account
description: |-
Renames the requested vault account.
>
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver.
tags:
- Vault Accounts
x-readme:
code-samples:
- language: python
code: >-
vaultAccount = fireblocks.update_vault_account(vault_account_id,
name)
name: Fireblocks SDK Python example
- language: javascript
code: >-
const vaultAccount = await
fireblocks.updateVaultAccount(vautlAccountId, name);
name: Fireblocks SDK Javascript example
- language: typescript
code: >-
const response:
Promise<FireblocksResponse<RenameVaultAccountResponse>> =
fireblocks.vaultAccounts.updateVaultAccount(vaultAccountsApiUpdateVaultAccountRequest);
name: Fireblocks SDK TypeScript example
- language: java
code: >-
CompletableFuture<ApiResponse<RenameVaultAccountResponse>>
response =
fireblocks.vaultAccounts().updateVaultAccount(updateVaultAccountRequest,
vaultAccountId, idempotencyKey);
name: Fireblocks SDK Java example
parameters:
- in: path
name: vaultAccountId
required: true
description: The ID of the vault account
schema:
type: string
format: numeric
x-fb-entity: vault_account
example: '0'
- $ref: '#/components/parameters/X-Idempotency-Key'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateVaultAccountRequest'
responses:
'201':
description: OK
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/RenameVaultAccountResponse'
default:
$ref: '#/components/responses/Error'
operationId: updateVaultAccount
x-codeSamples:
- lang: python
label: Python
source: >-
vaultAccount = fireblocks.update_vault_account(vault_account_id,
name)
- lang: javascript
label: Javascript
source: >-
const vaultAccount = await
fireblocks.updateVaultAccount(vautlAccountId, name);
/vault/asset_wallets:
get:
summary: Get vault wallets (Paginated)
description: >-
Retrieves all vault wallets of the vault accounts in your workspace. A
vault wallet is an asset in a vault account.
This method allows fast traversal of all account balances.
>
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor,
Viewer.
tags:
- Vault Wallets
x-readme:
code-samples:
- language: python
code: vault_accounts = fireblocks.get_asset_wallets(filters)
name: Fireblocks SDK Python example
- language: javascript
code: const vaultAccounts = await fireblocks.getAssetWallets(filters);
name: Fireblocks SDK Javascript example
- language: typescript
code: >-
const response:
Promise<FireblocksResponse<PaginatedAssetWalletResponse>> =
fireblocks.vaultWallets.getAssetWallets(vaultWalletsApiGetAssetWalletsRequest);
name: Fireblocks SDK TypeScript example
- language: java
code: >-
CompletableFuture<ApiResponse<PaginatedAssetWalletResponse>>
response =
fireblocks.vaultWallets().getAssetWallets(totalAmountLargerThan,
assetId, orderBy, before, after, limit);
name: Fireblocks SDK Java example
parameters:
- in: query
name: totalAmountLargerThan
description: >-
When specified, only vault wallets with total balance greater than
this amount are returned.
required: false
schema:
type: number
example: 14
- in: query
name: assetId
required: false
description: >-
When specified, only vault wallets with the specified ID are
returned.
schema:
type: string
x-fb-entity: asset
example: ETH
- in: query
name: orderBy
required: false
schema:
type: string
enum:
- ASC
- DESC
default: DESC
- in: query
name: before
required: false
description: >
Fetches the next paginated response before this element.
This element is a cursor and is returned at the response of the
previous page.
schema:
type: string
example: c3RhcnRpbmdWYXVsdElkeD04NTgzNzA2Mw
- in: query
name: after
required: false
description: >-
Fetches the next paginated response after this element. This element
is a cursor and is returned at the response of the previous page.
schema:
type: string
example: c3RhcnRpbmdWYXVsdElkeD01NTM1NzUzNg
- in: query
name: limit
required: false
description: |
The maximum number of vault wallets in a single response.
The default is 200 and the maximum is 1000.
schema:
type: number
minimum: 1
maximum: 1000
default: 200
responses:
'200':
description: A PaginatedAssetWalletResponse object
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAssetWalletResponse'
operationId: getAssetWallets
x-codeSamples:
- lang: python
label: Python
source: vault_accounts = fireblocks.get_asset_wallets(filters)
- lang: javascript
label: Javascript
source: const vaultAccounts = await fireblocks.getAssetWallets(filters);
/vault/accounts/{vaultAccountId}/hide:
post:
summary: Hide a vault account in the console
description: >-
Hides the requested vault account from the web console view. This
operation is required when creating thousands of vault accounts to serve
your end-users. Used for preventing the web console to be swamped with
too much vault accounts.
>
NOTE: Hiding the vault account from the web console will also hide all
the related transactions to/from this vault.
>
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
>
Learn more in the following
[guide](https://developers.fireblocks.com/docs/create-direct-custody-wallets#hiding-vault-accounts)
tags:
- Vault Accounts
x-readme:
code-samples:
- language: python
code: vaultAsset = fireblocks.hide_vault_account(vault_account_id)
name: Fireblocks SDK Python example
- language: javascript
code: >-
const vaultAsset = await
fireblocks.hideVaultAccount(vaultAccountId);
name: Fireblocks SDK Javascript example
- language: typescript
code: >-
const response: Promise<FireblocksResponse<VaultActionStatus>> =
fireblocks.vaultAccounts.hideVaultAccount(vaultAccountsApiHideVaultAccountRequest);
name: Fireblocks SDK TypeScript example
- language: java
code: >-
CompletableFuture<ApiResponse<VaultActionStatus>> response =
fireblocks.vaultAccounts().hideVaultAccount(vaultAccountId,
idempotencyKey);
name: Fireblocks SDK Java example
parameters:
- in: path
name: vaultAccountId
required: true
description: The vault account to hide
schema:
type: string
format: numeric
x-fb-entity: vault_account
example: '0'
- $ref: '#/components/parameters/X-Idempotency-Key'
responses:
'201':
description: OK
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/VaultActionStatus'
default:
$ref: '#/components/responses/Error'
operationId: hideVaultAccount
x-codeSamples:
- lang: python
label: Python
source: vaultAsset = fireblocks.hide_vault_account(vault_account_id)
- lang: javascript
label: Javascript
source: >-
const vaultAsset = await
fireblocks.hideVaultAccount(vaultAccountId);
/vault/accounts/{vaultAccountId}/unhide:
post:
summary: Unhide a vault account in the console
description: |-
Makes a hidden vault account visible in web console view.
>
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
tags:
- Vault Accounts
x-readme:
code-samples:
- language: python
code: vaultAsset = fireblocks.unhide_vault_account(vault_account_id)
name: Fireblocks SDK Python example
- language: javascript
code: >-
const vaultAsset = await
fireblocks.unhideVaultAccount(vaultAccountId);
name: Fireblocks SDK Javascript example
- language: typescript
code: >-
const response: Promise<FireblocksResponse<VaultActionStatus>> =
fireblocks.vaultAccounts.unhideVaultAccount(vaultAccountsApiUnhideVaultAccountRequest);
name: Fireblocks SDK TypeScript example
- language: java
code: >-
CompletableFuture<ApiResponse<VaultActionStatus>> response =
fireblocks.vaultAccounts().unhideVaultAccount(vaultAccountId,
idempotencyKey);
name: Fireblocks SDK Java example
parameters:
- in: path
name: vaultAccountId
required: true
description: The vault account to unhide
schema:
type: string
format: numeric
x-fb-entity: vault_account
example: '0'
- $ref: '#/components/parameters/X-Idempotency-Key'
responses:
'201':
description: OK
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/VaultActionStatus'
default:
$ref: '#/components/responses/Error'
operationId: unhideVaultAccount
x-codeSamples:
- lang: python
label: Python
source: vaultAsset = fireblocks.unhide_vault_account(vault_account_id)
- lang: javascript
label: Javascript
source: >-
const vaultAsset = await
fireblocks.unhideVaultAccount(vaultAccountId);
/vault/accounts/{vaultAccountId}/{assetId}/activate:
post:
summary: Activate a wallet in a vault account
description: >-
Initiates activation for a wallet in a vault account. Activation is
required for tokens that need an on-chain transaction for creation (XLM
tokens, SOL tokens etc).
>
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
x-readme:
code-samples:
- language: python
code: >-
vaultAsset = fireblocks.activate_vault_asset(vault_account_id,
asset_id)
name: Fireblocks SDK Python example
- language: javascript
code: >-
const vaultAsset = await
fireblocks.activateVaultAsset(vautlAccountId, assetId);
name: Fireblocks SDK Javascript example
- language: typescript
code: >-
const response:
Promise<FireblocksResponse<CreateVaultAssetResponse>> =
fireblocks.vaultWallets.activateAssetForVaultAccount(vaultWalletsApiActivateAssetForVaultAccountRequest);
name: Fireblocks SDK TypeScript example
- language: java
code: >-
CompletableFuture<ApiResponse<CreateVaultAssetResponse>> response
=
fireblocks.vaultWallets().activateAssetForVaultAccount(vaultAccountId,
assetId, idempotencyKey);
name: Fireblocks SDK Java example
tags:
- Vault Wallets
parameters:
- in: path
name: vaultAccountId
required: true
description: The ID of the vault account
schema:
type: string
format: numeric
x-fb-entity: vault_account
example: '0'
- in: path
name: assetId
required: true
description: The ID of the asset
schema:
type: string
x-fb-entity: asset
example: SOL_USDC_PTHX
- $ref: '#/components/parameters/X-Idempotency-Key'
responses:
'200':
description: OK
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVaultAssetResponse'
default:
$ref: '#/components/responses/Error'
operationId: activateAssetForVaultAccount
x-codeSamples:
- lang: python
label: Python
source: >-
vaultAsset = fireblocks.activate_vault_asset(vault_account_id,
asset_id)
- lang: javascript
label: Javascript
source: >-
const vaultAsset = await
fireblocks.activateVaultAsset(vautlAccountId, assetId);
/vault/accounts/{vaultAccountId}/set_customer_ref_id:
post:
summary: Set an AML/KYT customer reference ID for a vault account
description: |-
Assigns an AML/KYT customer reference ID for the vault account.
>
Endpoint Permission: Admin, Non-Signing Admin.
tags:
- AML Policy
x-readme:
code-samples:
- language: python
code: >-
vaultAsset =
fireblocks.set_vault_account_customer_ref_id(vault_account_id,
customer_ref_id)
name: Fireblocks SDK Python example
- language: javascript
code: >
const vaultAsset = await
fireblocks.setCustomerRefIdForVaultAccount(
vaultAccountId,
customerRefId
);
name: Fireblocks SDK Javascript example
- language: typescript
code: >-
const response: Promise<FireblocksResponse<VaultActionStatus>> =
fireblocks.aMLPolicy.setVaultAccountCustomerRefId(aMLPolicyApiSetVaultAccountCustomerRefIdRequest);
name: Fireblocks SDK TypeScript example
- language: java
code: >-
CompletableFuture<ApiResponse<VaultActionStatus>> response =
fireblocks.aMLPolicy().setVaultAccountCustomerRefId(setCustomerRefIdRequest,
vaultAccountId, idempotencyKey);
name: Fireblocks SDK Java example
parameters:
- in: path
name: vaultAccountId
required: true
description: The vault account ID
schema:
type: string
format: numeric
x-fb-entity: vault_account
example: '0'
- $ref: '#/components/parameters/X-Idempotency-Key'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SetCustomerRefIdRequest'
responses:
'201':
description: OK
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/VaultActionStatus'
default:
$ref: '#/components/responses/Error'
operationId: setVaultAccountCustomerRefId
x-codeSamples:
- lang: python
label: Python
source: >-
vaultAsset =
fireblocks.set_vault_account_customer_ref_id(vault_account_id,
customer_ref_id)
- lang: javascript