forked from fireblocks/fireblocks-openapi-spec
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtest.yml
11651 lines (11454 loc) · 501 KB
/
test.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
version: "1.6.4"
contact:
email: [email protected]
servers:
- url: "https://api.fireblocks.io/v1"
x-readme:
explorer-enabled: false
samples-languages:
- curl
- javascript
- python
paths:
# VAULT
"/vault/accounts":
get:
summary: List vault accounts
description: Gets all vault accounts in your workspace.
tags:
- Vaults
x-readme:
code-samples:
- language: python
code: vault_accounts = fireblocks.get_vault_accounts()
name: Fireblocks SDK Python example
- language: javascript
code: const vaultAccounts = await fireblocks.getVaultAccounts();
name: Fireblocks SDK Javascript example
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: &req-id-header
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
content:
"*/*":
schema:
type: array
items:
$ref: "#/components/schemas/VaultAccount"
default:
$ref: "#/components/responses/Error"
post:
summary: Create a new vault account
description: Creates a new vault account with the requested name.
tags:
- Vaults
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
requestBody:
required: true
content:
application/json:
schema:
properties:
name:
description: Account Name
type: string
hiddenOnUI:
description: >-
Optional - if true, the created account and all related transactions will not be shown on Fireblocks console
type: boolean
customerRefId:
description: >-
Optional - Sets a customer reference ID
type: string
autoFuel:
description: Optional - Sets the autoFuel property of the vault account
type: boolean
responses:
"200":
description: A Vault Account object
headers: *req-id-header
content:
"*/*":
schema:
$ref: "#/components/schemas/VaultAccount"
default:
$ref: "#/components/responses/Error"
"/vault/accounts/bulk":
post:
summary: Creat new vault accounts in bulk
description: Start an offline job to create multiple vault accounts
tags:
- Vaults
requestBody:
required: true
content:
application/json:
schema:
properties:
count:
description: Count
type: integer
assetIds:
description: Array of asset IDs
type: array
items:
type: string
responses:
"200":
description: A JobCreated object
headers: *req-id-header
content:
"*/*":
schema:
$ref: "#/components/schemas/JobCreated"
default:
$ref: "#/components/responses/Error"
"/vault/accounts_paged":
get:
summary: List vault acounts (Paginated)
description: Gets all vault accounts in your workspace. This endpoint returns a limited amount of results with a quick response time.
tags:
- Vaults
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
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
- in: query
name: orderBy
required: false
schema:
type: string
enum: ["ASC", "DESC"]
default: "DESC"
- in: query
name: before
required: false
schema:
type: string
- in: query
name: after
required: false
schema:
type: string
- in: query
name: limit
required: false
schema:
type: number
minimum: 1
maximum: 500
default: 200
responses:
"200":
description: A VaultAccountsPagedResponse object
headers: *req-id-header
content:
"*/*":
schema:
$ref: "#/components/schemas/VaultAccountsPagedResponse"
"/vault/accounts/{vaultAccountId}":
get:
summary: Find a vault account by ID
description: Returns the requested vault account.
tags:
- Vaults
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
parameters:
- in: path
name: vaultAccountId
required: true
description: >-
The ID of the vault account to return
type: string
schema:
type: string
format: numeric
x-fb-entity: vault_account
responses:
"200":
description: A Vault Account object
headers: *req-id-header
content:
"*/*":
schema:
$ref: "#/components/schemas/VaultAccount"
default:
$ref: "#/components/responses/Error"
put:
summary: Rename a vault account
description: Renames the requested vault account.
tags:
- Vaults
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
parameters:
- in: path
name: vaultAccountId
required: true
description: >-
The ID of the vault account to edit
schema:
type: string
format: numeric
x-fb-entity: vault_account
requestBody:
required: true
content:
application/json:
schema:
properties:
name:
description: Account Name
type: string
responses:
"201":
description: OK
headers: *req-id-header
default:
$ref: "#/components/responses/Error"
"/vault/asset_wallets":
get:
summary: List asset wallets (Paginated)
description: |
Gets all asset wallets at all of the vault accounts in your workspace. An asset wallet is an asset at a vault account. This method allows fast traversal of all account balances.
**Note:**
- This API endpoint is in limited availability and available for selected customers. If you would like to get early access to this endpoint, please reach out to [Fireblocks Support](https://support.fireblocks.io/hc/en-us/requests/new?ticket_form_id=36000337220)
- This API call is subject to [rate limits](https://developers.fireblocks.com/reference/rate-limiting).
tags:
- Vaults
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
parameters:
- in: query
name: totalAmountLargerThan
description: When specified, only asset wallets with total balance larger than this amount are returned.
required: false
schema:
type: number
- in: query
name: assetId
required: false
description: When specified, only asset wallets cross vault accounts that have this asset ID are returned.
schema:
type: string
x-fb-entity: asset
- 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
- 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
- in: query
name: limit
required: false
description: The maximum number of asset 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: *req-id-header
content:
"*/*":
schema:
$ref: "#/components/schemas/PaginatedAssetWalletResponse"
"/vault/accounts/{vaultAccountId}/hide":
post:
summary: Hide a vault account in the console
description: Hides the requested vault account from the web console view.
tags:
- Vaults
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
parameters:
- in: path
name: vaultAccountId
required: true
description: The vault account to hide
schema:
type: string
minimum: 1
format: numeric
x-fb-entity: vault_account
responses:
"201":
description: OK
headers: *req-id-header
default:
$ref: "#/components/responses/Error"
"/vault/accounts/{vaultAccountId}/unhide":
post:
summary: Unhide a vault account in the console
description: Makes a hidden vault account visible in web console view.
tags:
- Vaults
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
parameters:
- in: path
name: vaultAccountId
required: true
description: The vault account to unhide
schema:
type: string
minimum: 1
format: numeric
x-fb-entity: vault_account
responses:
"201":
description: OK
headers: *req-id-header
default:
$ref: "#/components/responses/Error"
"/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).
tags:
- Vaults
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
parameters:
- in: path
name: vaultAccountId
required: true
description: >-
The ID of the vault account to return, or 'default' for the default vault account
schema:
type: string
format: numeric
x-fb-entity: vault_account
- in: path
name: assetId
required: true
description: The ID of the asset
schema:
type: string
x-fb-entity: asset
responses:
"200":
description: OK
headers: *req-id-header
content:
"*/*":
schema:
$ref: "#/components/schemas/CreateVaultAssetResponse"
default:
$ref: "#/components/responses/Error"
"/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.
tags:
- Vaults
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
parameters:
- in: path
name: vaultAccountId
required: true
description: The vault account ID
schema:
type: string
minimum: 1
format: numeric
x-fb-entity: vault_account
requestBody:
required: true
content:
application/json:
schema:
properties:
customerRefId:
description: Customer reference ID
type: string
responses:
"201":
description: OK
headers: *req-id-header
default:
$ref: "#/components/responses/Error"
"/vault/accounts/{vaultAccountId}/set_auto_fuel":
post:
summary: Turn autofueling on or off
description: Sets the autofueling property of the vault account to enabled or disabled.
tags:
- Vaults
x-readme:
code-samples:
- language: python
code: result = fireblocks.set_auto_feul(vault_account_id, auto_fuel)
name: Fireblocks SDK Python example
- language: javascript
code: const result = await fireblocks.setAutoFuel(vaultAccountId, autoFuel;
name: Fireblocks SDK Javascript example
parameters:
- in: path
name: vaultAccountId
required: true
description: The vault account ID
schema:
type: string
minimum: 1
format: numeric
x-fb-entity: vault_account
requestBody:
required: true
content:
application/json:
schema:
properties:
autoFuel:
description: Auto Fuel
type: boolean
responses:
"201":
description: OK
headers: *req-id-header
default:
$ref: "#/components/responses/Error"
"/vault/accounts/{vaultAccountId}/{assetId}":
get:
summary: Get the asset balance for a vault account
description: Returns a wallet for a specific asset of a vault account.
tags:
- Vaults
x-readme:
code-samples:
- language: python
code: vaultAsset = fireblocks.get_vault_account_asset(vault_account_id, asset_id)
name: Fireblocks SDK Python example
- language: javascript
code: const vaultAsset = await fireblocks.getVaultAccountAsset(vaultAccountId, assetId);
name: Fireblocks SDK Javascript example
parameters:
- in: path
name: vaultAccountId
required: true
description: >-
The ID of the vault account to return
schema:
type: string
format: numeric
x-fb-entity: vault_account
- in: path
name: assetId
required: true
description: The ID of the asset
schema:
type: string
x-fb-entity: asset
responses:
"200":
description: A VaultAsset object
content:
"*/*":
schema:
$ref: "#/components/schemas/VaultAsset"
default:
$ref: "#/components/responses/Error"
post:
summary: Create a new wallet
description: Creates a wallet for a specific asset in a vault account.
tags:
- Vaults
x-readme:
code-samples:
- language: python
code: vaultAsset = fireblocks.create_vault_asset(vault_account_id, asset_id)
name: Fireblocks SDK Python example
- language: javascript
code: const vaultAsset = await fireblocks.createVaultAsset(vaultAccountId, assetId);
name: Fireblocks SDK Javascript example
parameters:
- in: path
name: vaultAccountId
required: true
description: >-
The ID of the vault account to return, or 'default' for the default vault account
schema:
type: string
format: numeric
x-fb-entity: vault_account
- in: path
name: assetId
required: true
description: The ID of the asset
schema:
type: string
x-fb-entity: asset
requestBody:
required: false
content:
application/json:
schema:
properties:
eosAccountName:
description: Optional - when creating an EOS wallet, the account name. If not provided, a random name will be generated
type: string
responses:
"200":
description: OK
headers: *req-id-header
content:
"*/*":
schema:
$ref: "#/components/schemas/CreateVaultAssetResponse"
default:
$ref: "#/components/responses/Error"
"/vault/accounts/{vaultAccountId}/{assetId}/balance":
post:
summary: Refresh asset balance data
description: Updates the balance of a specific asset in a vault account.
tags:
- Vaults
x-readme:
code-samples:
- language: python
code: vaultAsset = fireblocks.refresh_vault_asset_balance(vault_account_id, asset_id)
name: Fireblocks SDK Python example
- language: javascript
code: const vaultAsset = await fireblocks.refreshVaultAssetBalance(vaultAccountId, assetId);
name: Fireblocks SDK Javascript example
parameters:
- in: path
name: vaultAccountId
required: true
description: >-
The ID of the vault account to return
schema:
type: string
format: numeric
x-fb-entity: vault_account
- in: path
name: assetId
required: true
description: The ID of the asset
schema:
type: string
x-fb-entity: asset
requestBody:
required: false
content:
"*/*":
schema:
type: object
responses:
"200":
description: A VaultAsset object
headers: *req-id-header
content:
"*/*":
schema:
$ref: "#/components/schemas/VaultAsset"
default:
$ref: "#/components/responses/Error"
"/vault/accounts/{vaultAccountId}/{assetId}/addresses":
get:
summary: Get asset addresses
description: Lists all addresses for specific asset of vault account.
tags:
- Vaults
x-readme:
code-samples:
- language: python
code: depositAddresses = fireblocks.get_deposit_addresses(vault_account_id, asset_id)
name: Fireblocks SDK Python example
- language: javascript
code: const depositAddresses = await fireblocks.getDepositAddresses(vaultAccountId, assetId);
name: Fireblocks SDK Javascript example
parameters:
- in: path
name: vaultAccountId
required: true
description: >-
The ID of the vault account to return
schema:
type: string
format: numeric
x-fb-entity: vault_account
- in: path
name: assetId
required: true
description: The ID of the asset
schema:
type: string
x-fb-entity: asset
responses:
"200":
description: A list of deposit addresses
headers: *req-id-header
content:
"*/*":
schema:
type: array
items:
$ref: "#/components/schemas/VaultWalletAddress"
default:
$ref: "#/components/responses/Error"
post:
summary: Create new asset deposit address
description: Creates a new deposit address for an asset of a vault account.
tags:
- Vaults
x-readme:
code-samples:
- language: python
code: address = fireblocks.generate_new_address(vault_account_id, asset_id, description, customer_ref_id)
name: Fireblocks SDK Python example
- language: javascript
code: const address = await fireblocks.generateNewAddress(vaultAccountId, assetId, description, customerRefId);
name: Fireblocks SDK Javascript example
requestBody:
required: false
content:
application/json:
schema:
properties:
description:
description: (Optional) Attach a description to the new address
type: string
customerRefId:
description: >-
Optional - Sets a customer reference ID
type: string
parameters:
- in: path
name: vaultAccountId
required: true
description: >-
The ID of the vault account to return
schema:
type: string
format: numeric
x-fb-entity: vault_account
- in: path
name: assetId
required: true
description: The ID of the asset
schema:
type: string
x-fb-entity: asset
responses:
"200":
description: The created address
headers: *req-id-header
content:
"*/*":
schema:
$ref: "#/components/schemas/CreateAddressResponse"
default:
$ref: "#/components/responses/Error"
"/vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount":
get:
summary: Get the maximum spendable amount in a single transaction.
description: Get the maximum amount of a particular asset that can be spent in a single transaction from a specified vault account (UTXO assets only, with a limitation on number of inputs embedded). Send several transactions if you want to spend more than the maximum spendable amount.
tags:
- Vaults
x-readme:
code-samples:
- language: python
code: address = fireblocks.set_address_description(vault_account_id, asset_id, address, tag, description)
name: Fireblocks SDK Python example
- language: javascript
code: const address = await fireblocks.setAddressDescription(vaultAccountId, assetId, address, tag, description);
name: Fireblocks SDK Javascript example
parameters:
- in: path
name: vaultAccountId
required: true
description: >-
The ID of the vault account, or 'default' for the default vault account
schema:
type: string
format: numeric
x-fb-entity: vault_account
- in: path
name: assetId
required: true
description: The ID of the asset
schema:
type: string
x-fb-entity: asset
- in: query
name: manualSignging
required: false
description: False by default. The maximum number of inputs depends if the transaction will be signed by an automated co-signer server or on a mobile device.
schema:
type: boolean
responses:
"200":
description: OK
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
"/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}":
put:
summary: Update address description
description: Updates the description of an existing address of an asset in a vault account.
tags:
- Vaults
x-readme:
code-samples:
- language: python
code: address = fireblocks.set_address_description(vault_account_id, asset_id, address, tag, description)
name: Fireblocks SDK Python example
- language: javascript
code: const address = await fireblocks.setAddressDescription(vaultAccountId, assetId, address, tag, description);
name: Fireblocks SDK Javascript example
requestBody:
required: false
content:
application/json:
schema:
properties:
description:
description: The address description
type: string
parameters:
- in: path
name: vaultAccountId
required: true
description: >-
The ID of the vault account
schema:
type: string
format: numeric
x-fb-entity: vault_account
- in: path
name: assetId
required: true
description: The ID of the asset
schema:
type: string
x-fb-entity: asset
- in: path
name: addressId
required: true
description: >-
The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address
schema:
type: string
responses:
"201":
description: OK
headers: *req-id-header
default:
$ref: "#/components/responses/Error"
"/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id":
post:
summary: Assign AML customer reference ID
description: Sets an AML/KYT customer reference ID for a specific address.
tags:
- Vaults
x-readme:
code-samples:
- language: python
code: vaultAsset = fireblocks.set_customer_ref_id_for_address(vault_account_id, asset_id, address_id, customer_ref_id)
name: Fireblocks SDK Python example
- language: javascript
code: const vaultAsset = await fireblocks.setCustomerRefIdForAddress(vaultAccountId, assetId, addressId, customerRefId);
name: Fireblocks SDK Javascript 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
- in: path
name: assetId
required: true
description: The ID of the asset
schema:
type: string
x-fb-entity: asset
- in: path
name: addressId
required: true
description: >-
The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
properties:
customerRefId:
description: Customer reference ID
type: string
responses:
"201":
description: OK
headers: *req-id-header
default:
$ref: "#/components/responses/Error"
"/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy":
post:
summary: Convert a segwit address to legacy format
description: Converts an existing segwit address to the legacy format.
tags:
- Vaults
parameters:
- in: path
name: vaultAccountId
required: true
description: >-
The ID of the vault account
schema:
type: string
format: numeric
x-fb-entity: vault_account
- in: path
name: assetId
required: true
description: The ID of the asset
schema:
type: string
x-fb-entity: asset
- in: path
name: addressId
required: true
description: >-
The segwit address to translate
schema:
type: string
responses:
"200":
description: The created address
headers: *req-id-header
content:
"*/*":
schema:
$ref: "#/components/schemas/CreateAddressResponse"
default:
$ref: "#/components/responses/Error"
"/vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs":
get:
summary: Get UTXO unspent inputs information
description: Returns unspent inputs information of an asset in a vault account.
tags:
- Vaults
x-readme:
code-samples:
- language: python
code: vaultAsset = fireblocks.get_unspent_inputs(vault_account_id, asset_id)
name: Fireblocks SDK Python example
- language: javascript
code: const vaultAsset = await fireblocks.getUnspentInputs(vaultAccountId, assetId);
name: Fireblocks SDK Javascript 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
- in: path
name: assetId
required: true
description: The ID of the asset
schema:
type: string
x-fb-entity: asset
responses:
"200":
description: List of Unspent information per input
headers: *req-id-header
content:
"*/*":
schema:
type: array
items:
$ref: "#/components/schemas/UnspentInputsResponse"
default:
$ref: "#/components/responses/Error"
"/vault/public_key_info/":
get:
summary: Get the public key information
description: Gets the public key information based on derivation path and signing algorithm.
tags: