@vaultsfyi/sdk 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,3956 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+
6
+ export interface paths {
7
+ '/v1/health': {
8
+ parameters: {
9
+ query?: never
10
+ header?: never
11
+ path?: never
12
+ cookie?: never
13
+ }
14
+ get: {
15
+ parameters: {
16
+ query?: never
17
+ header?: never
18
+ path?: never
19
+ cookie?: never
20
+ }
21
+ requestBody?: never
22
+ responses: {
23
+ /** @description Default Response */
24
+ 200: {
25
+ headers: {
26
+ [name: string]: unknown
27
+ }
28
+ content: {
29
+ 'application/json': {
30
+ status: string
31
+ message: string
32
+ }
33
+ }
34
+ }
35
+ }
36
+ }
37
+ put?: never
38
+ post?: never
39
+ delete?: never
40
+ options?: never
41
+ head?: never
42
+ patch?: never
43
+ trace?: never
44
+ }
45
+ '/v1/transactions/vaults/actions/details': {
46
+ parameters: {
47
+ query?: never
48
+ header?: never
49
+ path?: never
50
+ cookie?: never
51
+ }
52
+ get: {
53
+ parameters: {
54
+ query: {
55
+ network:
56
+ | 'mainnet'
57
+ | 'optimism'
58
+ | 'arbitrum'
59
+ | 'polygon'
60
+ | 'gnosis'
61
+ | 'base'
62
+ | 'unichain'
63
+ | 'swellchain'
64
+ | 'celo'
65
+ | 'eip155:1'
66
+ | 'eip155:10'
67
+ | 'eip155:42161'
68
+ | 'eip155:137'
69
+ | 'eip155:100'
70
+ | 'eip155:8453'
71
+ | 'eip155:130'
72
+ | 'eip155:1923'
73
+ | 'eip155:42220'
74
+ userAddress: string
75
+ vaultAddress: string
76
+ }
77
+ header?: never
78
+ path?: never
79
+ cookie?: never
80
+ }
81
+ requestBody?: never
82
+ responses: {
83
+ /** @description Default Response */
84
+ 200: {
85
+ headers: {
86
+ [name: string]: unknown
87
+ }
88
+ content: {
89
+ 'application/json': {
90
+ currentDepositStep: string
91
+ depositSteps: {
92
+ actions: string[]
93
+ actionsUrl: string
94
+ /** @enum {string} */
95
+ name: 'deposit'
96
+ }[]
97
+ currentRedeemStep: string
98
+ redeemSteps: {
99
+ actions: string[]
100
+ actionsUrl: string
101
+ /** @enum {string} */
102
+ name: 'redeem' | 'requestRedeem' | 'claimRedeem'
103
+ }[]
104
+ lpTokenBalance: string
105
+ idleAssets: {
106
+ [key: string]: string
107
+ }
108
+ lockedValueInAssets: {
109
+ [key: string]: string
110
+ }
111
+ childrenLpTokenBalances?: {
112
+ [key: string]: string
113
+ }
114
+ childrenLockedValueInAssets?: {
115
+ [key: string]: {
116
+ [key: string]: string
117
+ }
118
+ }
119
+ unclaimedAssets: {
120
+ [key: string]: string
121
+ }
122
+ vaultSpecificData?: {
123
+ [key: string]: unknown
124
+ }
125
+ rewards?: {
126
+ claimable: {
127
+ amount: string
128
+ token: {
129
+ address: string
130
+ name: string
131
+ symbol: string
132
+ decimals: number
133
+ /** @enum {string} */
134
+ network:
135
+ | 'mainnet'
136
+ | 'optimism'
137
+ | 'arbitrum'
138
+ | 'polygon'
139
+ | 'gnosis'
140
+ | 'base'
141
+ | 'unichain'
142
+ | 'swellchain'
143
+ | 'celo'
144
+ }
145
+ }[]
146
+ currentStep: string
147
+ steps: {
148
+ actions: string[]
149
+ actionsUrl: string
150
+ /** @enum {string} */
151
+ name: 'claim'
152
+ }[]
153
+ }
154
+ }
155
+ }
156
+ }
157
+ }
158
+ }
159
+ put?: never
160
+ post?: never
161
+ delete?: never
162
+ options?: never
163
+ head?: never
164
+ patch?: never
165
+ trace?: never
166
+ }
167
+ '/v1/transactions/vaults/deposit': {
168
+ parameters: {
169
+ query?: never
170
+ header?: never
171
+ path?: never
172
+ cookie?: never
173
+ }
174
+ get: {
175
+ parameters: {
176
+ query: {
177
+ network:
178
+ | 'mainnet'
179
+ | 'optimism'
180
+ | 'arbitrum'
181
+ | 'polygon'
182
+ | 'gnosis'
183
+ | 'base'
184
+ | 'unichain'
185
+ | 'swellchain'
186
+ | 'celo'
187
+ | 'eip155:1'
188
+ | 'eip155:10'
189
+ | 'eip155:42161'
190
+ | 'eip155:137'
191
+ | 'eip155:100'
192
+ | 'eip155:8453'
193
+ | 'eip155:130'
194
+ | 'eip155:1923'
195
+ | 'eip155:42220'
196
+ sender: string
197
+ simulate?: 'true' | 'false'
198
+ assetAddress: string
199
+ vaultAddress: string
200
+ amount: string
201
+ }
202
+ header?: never
203
+ path?: never
204
+ cookie?: never
205
+ }
206
+ requestBody?: never
207
+ responses: {
208
+ /** @description Default Response */
209
+ 200: {
210
+ headers: {
211
+ [name: string]: unknown
212
+ }
213
+ content: {
214
+ 'application/json': {
215
+ currentActionIndex: number
216
+ actions: {
217
+ name: string
218
+ tx: {
219
+ to: string
220
+ chainId: number
221
+ data?: string
222
+ value?: string
223
+ }
224
+ simulation?: {
225
+ url: string
226
+ /** @enum {string} */
227
+ status: 'success' | 'failure' | 'internal server error'
228
+ tokensReceived?: {
229
+ [key: string]: string
230
+ }
231
+ tokensSpent?: {
232
+ [key: string]: string
233
+ }
234
+ }
235
+ }[]
236
+ }
237
+ }
238
+ }
239
+ }
240
+ }
241
+ put?: never
242
+ post?: never
243
+ delete?: never
244
+ options?: never
245
+ head?: never
246
+ patch?: never
247
+ trace?: never
248
+ }
249
+ '/v1/transactions/vaults/redeem': {
250
+ parameters: {
251
+ query?: never
252
+ header?: never
253
+ path?: never
254
+ cookie?: never
255
+ }
256
+ get: {
257
+ parameters: {
258
+ query: {
259
+ network:
260
+ | 'mainnet'
261
+ | 'optimism'
262
+ | 'arbitrum'
263
+ | 'polygon'
264
+ | 'gnosis'
265
+ | 'base'
266
+ | 'unichain'
267
+ | 'swellchain'
268
+ | 'celo'
269
+ | 'eip155:1'
270
+ | 'eip155:10'
271
+ | 'eip155:42161'
272
+ | 'eip155:137'
273
+ | 'eip155:100'
274
+ | 'eip155:8453'
275
+ | 'eip155:130'
276
+ | 'eip155:1923'
277
+ | 'eip155:42220'
278
+ sender: string
279
+ simulate?: 'true' | 'false'
280
+ assetAddress: string
281
+ vaultAddress: string
282
+ amount: string
283
+ all?: 'true' | 'false'
284
+ }
285
+ header?: never
286
+ path?: never
287
+ cookie?: never
288
+ }
289
+ requestBody?: never
290
+ responses: {
291
+ /** @description Default Response */
292
+ 200: {
293
+ headers: {
294
+ [name: string]: unknown
295
+ }
296
+ content: {
297
+ 'application/json': {
298
+ currentActionIndex: number
299
+ actions: {
300
+ name: string
301
+ tx: {
302
+ to: string
303
+ chainId: number
304
+ data?: string
305
+ value?: string
306
+ }
307
+ simulation?: {
308
+ url: string
309
+ /** @enum {string} */
310
+ status: 'success' | 'failure' | 'internal server error'
311
+ tokensReceived?: {
312
+ [key: string]: string
313
+ }
314
+ tokensSpent?: {
315
+ [key: string]: string
316
+ }
317
+ }
318
+ }[]
319
+ }
320
+ }
321
+ }
322
+ }
323
+ }
324
+ put?: never
325
+ post?: never
326
+ delete?: never
327
+ options?: never
328
+ head?: never
329
+ patch?: never
330
+ trace?: never
331
+ }
332
+ '/v1/transactions/vaults/request-redeem': {
333
+ parameters: {
334
+ query?: never
335
+ header?: never
336
+ path?: never
337
+ cookie?: never
338
+ }
339
+ get: {
340
+ parameters: {
341
+ query: {
342
+ network:
343
+ | 'mainnet'
344
+ | 'optimism'
345
+ | 'arbitrum'
346
+ | 'polygon'
347
+ | 'gnosis'
348
+ | 'base'
349
+ | 'unichain'
350
+ | 'swellchain'
351
+ | 'celo'
352
+ | 'eip155:1'
353
+ | 'eip155:10'
354
+ | 'eip155:42161'
355
+ | 'eip155:137'
356
+ | 'eip155:100'
357
+ | 'eip155:8453'
358
+ | 'eip155:130'
359
+ | 'eip155:1923'
360
+ | 'eip155:42220'
361
+ sender: string
362
+ simulate?: 'true' | 'false'
363
+ assetAddress: string
364
+ vaultAddress: string
365
+ amount: string
366
+ }
367
+ header?: never
368
+ path?: never
369
+ cookie?: never
370
+ }
371
+ requestBody?: never
372
+ responses: {
373
+ /** @description Default Response */
374
+ 200: {
375
+ headers: {
376
+ [name: string]: unknown
377
+ }
378
+ content: {
379
+ 'application/json': {
380
+ currentActionIndex: number
381
+ actions: {
382
+ name: string
383
+ tx: {
384
+ to: string
385
+ chainId: number
386
+ data?: string
387
+ value?: string
388
+ }
389
+ simulation?: {
390
+ url: string
391
+ /** @enum {string} */
392
+ status: 'success' | 'failure' | 'internal server error'
393
+ tokensReceived?: {
394
+ [key: string]: string
395
+ }
396
+ tokensSpent?: {
397
+ [key: string]: string
398
+ }
399
+ }
400
+ }[]
401
+ }
402
+ }
403
+ }
404
+ }
405
+ }
406
+ put?: never
407
+ post?: never
408
+ delete?: never
409
+ options?: never
410
+ head?: never
411
+ patch?: never
412
+ trace?: never
413
+ }
414
+ '/v1/transactions/vaults/claim-redeem': {
415
+ parameters: {
416
+ query?: never
417
+ header?: never
418
+ path?: never
419
+ cookie?: never
420
+ }
421
+ get: {
422
+ parameters: {
423
+ query: {
424
+ network:
425
+ | 'mainnet'
426
+ | 'optimism'
427
+ | 'arbitrum'
428
+ | 'polygon'
429
+ | 'gnosis'
430
+ | 'base'
431
+ | 'unichain'
432
+ | 'swellchain'
433
+ | 'celo'
434
+ | 'eip155:1'
435
+ | 'eip155:10'
436
+ | 'eip155:42161'
437
+ | 'eip155:137'
438
+ | 'eip155:100'
439
+ | 'eip155:8453'
440
+ | 'eip155:130'
441
+ | 'eip155:1923'
442
+ | 'eip155:42220'
443
+ sender: string
444
+ simulate?: 'true' | 'false'
445
+ assetAddress: string
446
+ vaultAddress: string
447
+ }
448
+ header?: never
449
+ path?: never
450
+ cookie?: never
451
+ }
452
+ requestBody?: never
453
+ responses: {
454
+ /** @description Default Response */
455
+ 200: {
456
+ headers: {
457
+ [name: string]: unknown
458
+ }
459
+ content: {
460
+ 'application/json': {
461
+ currentActionIndex: number
462
+ actions: {
463
+ name: string
464
+ tx: {
465
+ to: string
466
+ chainId: number
467
+ data?: string
468
+ value?: string
469
+ }
470
+ simulation?: {
471
+ url: string
472
+ /** @enum {string} */
473
+ status: 'success' | 'failure' | 'internal server error'
474
+ tokensReceived?: {
475
+ [key: string]: string
476
+ }
477
+ tokensSpent?: {
478
+ [key: string]: string
479
+ }
480
+ }
481
+ }[]
482
+ }
483
+ }
484
+ }
485
+ }
486
+ }
487
+ put?: never
488
+ post?: never
489
+ delete?: never
490
+ options?: never
491
+ head?: never
492
+ patch?: never
493
+ trace?: never
494
+ }
495
+ '/v1/transactions/vaults/claim-rewards': {
496
+ parameters: {
497
+ query?: never
498
+ header?: never
499
+ path?: never
500
+ cookie?: never
501
+ }
502
+ get: {
503
+ parameters: {
504
+ query: {
505
+ network:
506
+ | 'mainnet'
507
+ | 'optimism'
508
+ | 'arbitrum'
509
+ | 'polygon'
510
+ | 'gnosis'
511
+ | 'base'
512
+ | 'unichain'
513
+ | 'swellchain'
514
+ | 'celo'
515
+ | 'eip155:1'
516
+ | 'eip155:10'
517
+ | 'eip155:42161'
518
+ | 'eip155:137'
519
+ | 'eip155:100'
520
+ | 'eip155:8453'
521
+ | 'eip155:130'
522
+ | 'eip155:1923'
523
+ | 'eip155:42220'
524
+ sender: string
525
+ simulate?: 'true' | 'false'
526
+ assetAddress: string
527
+ vaultAddress: string
528
+ }
529
+ header?: never
530
+ path?: never
531
+ cookie?: never
532
+ }
533
+ requestBody?: never
534
+ responses: {
535
+ /** @description Default Response */
536
+ 200: {
537
+ headers: {
538
+ [name: string]: unknown
539
+ }
540
+ content: {
541
+ 'application/json': {
542
+ currentActionIndex: number
543
+ actions: {
544
+ name: string
545
+ tx: {
546
+ to: string
547
+ chainId: number
548
+ data?: string
549
+ value?: string
550
+ }
551
+ simulation?: {
552
+ url: string
553
+ /** @enum {string} */
554
+ status: 'success' | 'failure' | 'internal server error'
555
+ tokensReceived?: {
556
+ [key: string]: string
557
+ }
558
+ tokensSpent?: {
559
+ [key: string]: string
560
+ }
561
+ }
562
+ }[]
563
+ }
564
+ }
565
+ }
566
+ }
567
+ }
568
+ put?: never
569
+ post?: never
570
+ delete?: never
571
+ options?: never
572
+ head?: never
573
+ patch?: never
574
+ trace?: never
575
+ }
576
+ '/v1/transactions/assets': {
577
+ parameters: {
578
+ query?: never
579
+ header?: never
580
+ path?: never
581
+ cookie?: never
582
+ }
583
+ get: {
584
+ parameters: {
585
+ query: {
586
+ network:
587
+ | 'mainnet'
588
+ | 'optimism'
589
+ | 'arbitrum'
590
+ | 'polygon'
591
+ | 'gnosis'
592
+ | 'base'
593
+ | 'unichain'
594
+ | 'swellchain'
595
+ | 'celo'
596
+ | 'eip155:1'
597
+ | 'eip155:10'
598
+ | 'eip155:42161'
599
+ | 'eip155:137'
600
+ | 'eip155:100'
601
+ | 'eip155:8453'
602
+ | 'eip155:130'
603
+ | 'eip155:1923'
604
+ | 'eip155:42220'
605
+ }
606
+ header?: never
607
+ path?: never
608
+ cookie?: never
609
+ }
610
+ requestBody?: never
611
+ responses: {
612
+ /** @description Default Response */
613
+ 200: {
614
+ headers: {
615
+ [name: string]: unknown
616
+ }
617
+ content: {
618
+ 'application/json': {
619
+ address: string
620
+ name: string
621
+ symbol: string
622
+ decimals: number
623
+ /** @enum {string} */
624
+ network:
625
+ | 'mainnet'
626
+ | 'optimism'
627
+ | 'arbitrum'
628
+ | 'polygon'
629
+ | 'gnosis'
630
+ | 'base'
631
+ | 'unichain'
632
+ | 'swellchain'
633
+ | 'celo'
634
+ }[]
635
+ }
636
+ }
637
+ }
638
+ }
639
+ put?: never
640
+ post?: never
641
+ delete?: never
642
+ options?: never
643
+ head?: never
644
+ patch?: never
645
+ trace?: never
646
+ }
647
+ '/v1/transactions/vaults': {
648
+ parameters: {
649
+ query?: never
650
+ header?: never
651
+ path?: never
652
+ cookie?: never
653
+ }
654
+ get: {
655
+ parameters: {
656
+ query: {
657
+ network:
658
+ | 'mainnet'
659
+ | 'optimism'
660
+ | 'arbitrum'
661
+ | 'polygon'
662
+ | 'gnosis'
663
+ | 'base'
664
+ | 'unichain'
665
+ | 'swellchain'
666
+ | 'celo'
667
+ | 'eip155:1'
668
+ | 'eip155:10'
669
+ | 'eip155:42161'
670
+ | 'eip155:137'
671
+ | 'eip155:100'
672
+ | 'eip155:8453'
673
+ | 'eip155:130'
674
+ | 'eip155:1923'
675
+ | 'eip155:42220'
676
+ }
677
+ header?: never
678
+ path?: never
679
+ cookie?: never
680
+ }
681
+ requestBody?: never
682
+ responses: {
683
+ /** @description Default Response */
684
+ 200: {
685
+ headers: {
686
+ [name: string]: unknown
687
+ }
688
+ content: {
689
+ 'application/json': {
690
+ name: string
691
+ protocol: string
692
+ address: string
693
+ lpTokenAddress: string
694
+ /** @enum {string} */
695
+ network:
696
+ | 'mainnet'
697
+ | 'optimism'
698
+ | 'arbitrum'
699
+ | 'polygon'
700
+ | 'gnosis'
701
+ | 'base'
702
+ | 'unichain'
703
+ | 'swellchain'
704
+ | 'celo'
705
+ assets: {
706
+ address: string
707
+ name: string
708
+ symbol: string
709
+ decimals: number
710
+ /** @enum {string} */
711
+ network:
712
+ | 'mainnet'
713
+ | 'optimism'
714
+ | 'arbitrum'
715
+ | 'polygon'
716
+ | 'gnosis'
717
+ | 'base'
718
+ | 'unichain'
719
+ | 'swellchain'
720
+ | 'celo'
721
+ }[]
722
+ }[]
723
+ }
724
+ }
725
+ }
726
+ }
727
+ put?: never
728
+ post?: never
729
+ delete?: never
730
+ options?: never
731
+ head?: never
732
+ patch?: never
733
+ trace?: never
734
+ }
735
+ '/v1/vaults': {
736
+ parameters: {
737
+ query?: never
738
+ header?: never
739
+ path?: never
740
+ cookie?: never
741
+ }
742
+ /** @description Get a list of vaults given a specific filters */
743
+ get: {
744
+ parameters: {
745
+ query?: {
746
+ /** @description List of tags to filter by all of the tags must be present on the vault to be included in the results */
747
+ tags?: string[]
748
+ /** @description Name or symbol of the token to filter by */
749
+ token?: string
750
+ /** @description Network name or caip to filter by */
751
+ network?:
752
+ | 'mainnet'
753
+ | 'optimism'
754
+ | 'arbitrum'
755
+ | 'polygon'
756
+ | 'gnosis'
757
+ | 'base'
758
+ | 'unichain'
759
+ | 'swellchain'
760
+ | 'celo'
761
+ | 'eip155:1'
762
+ | 'eip155:10'
763
+ | 'eip155:42161'
764
+ | 'eip155:137'
765
+ | 'eip155:100'
766
+ | 'eip155:8453'
767
+ | 'eip155:130'
768
+ | 'eip155:1923'
769
+ | 'eip155:42220'
770
+ /** @description Minimum TVL in USD to filter by */
771
+ tvl_min?: number
772
+ /** @description Maximum TVL in USD to filter by */
773
+ tvl_max?: number
774
+ /** @description Return only vaults that support transactional endpoints */
775
+ transactionalOnly?: 'true' | 'false'
776
+ /** @description Return only vaults that support transactional endpoints and are featured in app.vaults.fyi */
777
+ transactionalFeaturedOnly?: 'true' | 'false'
778
+ }
779
+ header?: never
780
+ path?: never
781
+ cookie?: never
782
+ }
783
+ requestBody?: never
784
+ responses: {
785
+ /** @description Array of vaults addresses and their networks */
786
+ 200: {
787
+ headers: {
788
+ [name: string]: unknown
789
+ }
790
+ content: {
791
+ 'application/json': {
792
+ /** @description Address of a vault */
793
+ address: string
794
+ /**
795
+ * @description Network name on which vault exists
796
+ * @enum {string}
797
+ */
798
+ network:
799
+ | 'mainnet'
800
+ | 'optimism'
801
+ | 'arbitrum'
802
+ | 'polygon'
803
+ | 'gnosis'
804
+ | 'base'
805
+ | 'unichain'
806
+ | 'swellchain'
807
+ | 'celo'
808
+ }[]
809
+ }
810
+ }
811
+ }
812
+ }
813
+ put?: never
814
+ post?: never
815
+ delete?: never
816
+ options?: never
817
+ head?: never
818
+ patch?: never
819
+ trace?: never
820
+ }
821
+ '/v1/tags': {
822
+ parameters: {
823
+ query?: never
824
+ header?: never
825
+ path?: never
826
+ cookie?: never
827
+ }
828
+ /** @description Get list of tags present in vaults.fyi database */
829
+ get: {
830
+ parameters: {
831
+ query?: never
832
+ header?: never
833
+ path?: never
834
+ cookie?: never
835
+ }
836
+ requestBody?: never
837
+ responses: {
838
+ /** @description Array of tags */
839
+ 200: {
840
+ headers: {
841
+ [name: string]: unknown
842
+ }
843
+ content: {
844
+ 'application/json': string[]
845
+ }
846
+ }
847
+ }
848
+ }
849
+ put?: never
850
+ post?: never
851
+ delete?: never
852
+ options?: never
853
+ head?: never
854
+ patch?: never
855
+ trace?: never
856
+ }
857
+ '/v1/tokens': {
858
+ parameters: {
859
+ query?: never
860
+ header?: never
861
+ path?: never
862
+ cookie?: never
863
+ }
864
+ /** @description Get list of tokens present in vaults.fyi database */
865
+ get: {
866
+ parameters: {
867
+ query?: never
868
+ header?: never
869
+ path?: never
870
+ cookie?: never
871
+ }
872
+ requestBody?: never
873
+ responses: {
874
+ /** @description Array of tokens */
875
+ 200: {
876
+ headers: {
877
+ [name: string]: unknown
878
+ }
879
+ content: {
880
+ 'application/json': {
881
+ /** @description Address of the token */
882
+ assetAddress: string
883
+ assetCaip: string
884
+ /** @description Decimals of the token */
885
+ decimals: number
886
+ /** @description Name of the token */
887
+ name: string
888
+ network: {
889
+ /**
890
+ * @description Name of the network on which token exists
891
+ * @enum {string}
892
+ */
893
+ name:
894
+ | 'mainnet'
895
+ | 'optimism'
896
+ | 'arbitrum'
897
+ | 'polygon'
898
+ | 'gnosis'
899
+ | 'base'
900
+ | 'unichain'
901
+ | 'swellchain'
902
+ | 'celo'
903
+ /** @description Chain ID of the network on which token exists */
904
+ chainId: number
905
+ }
906
+ /** @description Symbol of the token */
907
+ symbol: string
908
+ }[]
909
+ }
910
+ }
911
+ }
912
+ }
913
+ put?: never
914
+ post?: never
915
+ delete?: never
916
+ options?: never
917
+ head?: never
918
+ patch?: never
919
+ trace?: never
920
+ }
921
+ '/v1/networks': {
922
+ parameters: {
923
+ query?: never
924
+ header?: never
925
+ path?: never
926
+ cookie?: never
927
+ }
928
+ /** @description Get list of networks present in vaults.fyi database */
929
+ get: {
930
+ parameters: {
931
+ query?: never
932
+ header?: never
933
+ path?: never
934
+ cookie?: never
935
+ }
936
+ requestBody?: never
937
+ responses: {
938
+ /** @description Array of networks */
939
+ 200: {
940
+ headers: {
941
+ [name: string]: unknown
942
+ }
943
+ content: {
944
+ 'application/json': {
945
+ /** @description Name of the network */
946
+ name: string
947
+ /** @description Chain ID of the network */
948
+ chainId: number
949
+ }[]
950
+ }
951
+ }
952
+ }
953
+ }
954
+ put?: never
955
+ post?: never
956
+ delete?: never
957
+ options?: never
958
+ head?: never
959
+ patch?: never
960
+ trace?: never
961
+ }
962
+ '/v1/detailed/vaults': {
963
+ parameters: {
964
+ query?: never
965
+ header?: never
966
+ path?: never
967
+ cookie?: never
968
+ }
969
+ /** @description Get a detailed list of vaults filtered by given parameters */
970
+ get: {
971
+ parameters: {
972
+ query?: {
973
+ /** @description Page number */
974
+ page?: number
975
+ /** @description Number of items per page */
976
+ per_page?: number
977
+ /** @description List of tags to filter by all of the tags must be present on the vault to be included in the results */
978
+ tags?: string[]
979
+ /** @description Name or symbol of the token to filter by */
980
+ token?: string
981
+ /** @description Network name or caip to filter by */
982
+ network?:
983
+ | 'mainnet'
984
+ | 'optimism'
985
+ | 'arbitrum'
986
+ | 'polygon'
987
+ | 'gnosis'
988
+ | 'base'
989
+ | 'unichain'
990
+ | 'swellchain'
991
+ | 'celo'
992
+ | 'eip155:1'
993
+ | 'eip155:10'
994
+ | 'eip155:42161'
995
+ | 'eip155:137'
996
+ | 'eip155:100'
997
+ | 'eip155:8453'
998
+ | 'eip155:130'
999
+ | 'eip155:1923'
1000
+ | 'eip155:42220'
1001
+ /** @description Minimum TVL in USD to filter by */
1002
+ tvl_min?: number
1003
+ /** @description Maximum TVL in USD to filter by */
1004
+ tvl_max?: number
1005
+ /** @description Return only vaults that support transactional endpoints */
1006
+ transactionalOnly?: 'true' | 'false'
1007
+ /** @description Return only vaults that support transactional endpoints and are featured in app.vaults.fyi */
1008
+ transactionalFeaturedOnly?: 'true' | 'false'
1009
+ }
1010
+ header?: never
1011
+ path?: never
1012
+ cookie?: never
1013
+ }
1014
+ requestBody?: never
1015
+ responses: {
1016
+ /** @description Default Response */
1017
+ 200: {
1018
+ headers: {
1019
+ [name: string]: unknown
1020
+ }
1021
+ content: {
1022
+ 'application/json': {
1023
+ /** @description Next page number */
1024
+ next_page?: number
1025
+ /** @description Array describing the vaults */
1026
+ data: {
1027
+ /** @description Name of the vault */
1028
+ name: string
1029
+ /** @description Address of a vault */
1030
+ address: string
1031
+ /**
1032
+ * @description Network name on which vault exists
1033
+ * @enum {string}
1034
+ */
1035
+ network:
1036
+ | 'mainnet'
1037
+ | 'optimism'
1038
+ | 'arbitrum'
1039
+ | 'polygon'
1040
+ | 'gnosis'
1041
+ | 'base'
1042
+ | 'unichain'
1043
+ | 'swellchain'
1044
+ | 'celo'
1045
+ /** @description Protocol name to which the vault belongs */
1046
+ protocol: string
1047
+ /** @description Object containing a breakdown of TVL for a vault both in native token and USD */
1048
+ tvlDetails: {
1049
+ /** @description Total value locked in Vault token */
1050
+ tvlNative: string
1051
+ /** @description Total value locked in USD */
1052
+ tvlUsd: string
1053
+ /** @description Locked amount in Vault token */
1054
+ lockedNative: string
1055
+ /** @description Locked amount in USD */
1056
+ lockedUsd: string
1057
+ /** @description Liquid amount in Vault token */
1058
+ liquidNative: string
1059
+ /** @description Liquid amount in USD */
1060
+ liquidUsd: string
1061
+ }
1062
+ /** @description Number of holders of vault LP tokens */
1063
+ numberOfHolders: number | null
1064
+ /** @description Lend link of the vault */
1065
+ lendLink: string | null
1066
+ /** @description Array of tags present on vault */
1067
+ tags: string[]
1068
+ /** @description Object describing the token of the vault */
1069
+ token: {
1070
+ /** @description Name of the asset */
1071
+ name: string
1072
+ /** @description Address of the asset */
1073
+ assetAddress: string
1074
+ assetCaip: string
1075
+ /** @description Symbol of the asset */
1076
+ symbol: string
1077
+ /** @description Decimals of the asset */
1078
+ decimals: number
1079
+ }
1080
+ /** @description Object describing the base APY of the vault given different APY windows */
1081
+ apy: {
1082
+ /** @description Object describing the base APY of the vault given different APY windows */
1083
+ base: {
1084
+ /** @description APY in BIPS with 1 day window */
1085
+ '1day': number
1086
+ /** @description APY in BIPS with 7 day window */
1087
+ '7day': number
1088
+ /** @description APY in BIPS with 30 day window */
1089
+ '30day': number
1090
+ }
1091
+ /** @description Object describing the base APY of the vault given different APY windows */
1092
+ rewards?: {
1093
+ /** @description APY in BIPS with 1 day window */
1094
+ '1day': number
1095
+ /** @description APY in BIPS with 7 day window */
1096
+ '7day': number
1097
+ /** @description APY in BIPS with 30 day window */
1098
+ '30day': number
1099
+ }
1100
+ /** @description Object describing the base APY of the vault given different APY windows */
1101
+ total: {
1102
+ /** @description APY in BIPS with 1 day window */
1103
+ '1day': number
1104
+ /** @description APY in BIPS with 7 day window */
1105
+ '7day': number
1106
+ /** @description APY in BIPS with 30 day window */
1107
+ '30day': number
1108
+ }
1109
+ }
1110
+ /** @description Description of the vault */
1111
+ description: string | null
1112
+ /** @description Additional incentives of the vault */
1113
+ additionalIncentives: string | null
1114
+ /** @description Array of rewards present on vault */
1115
+ rewards: {
1116
+ /** @description Object describing the APY of the reward given different APY windows */
1117
+ apy: {
1118
+ /** @description APY in BIPS with 1 day window */
1119
+ '1day': number
1120
+ /** @description APY in BIPS with 7 day window */
1121
+ '7day': number
1122
+ /** @description APY in BIPS with 30 day window */
1123
+ '30day': number
1124
+ }
1125
+ /** @description Price of the asset in USD 1e8 precision */
1126
+ assetPriceInUsd: number
1127
+ /** @description Object describing the reward asset */
1128
+ asset: {
1129
+ /** @description Name of the asset */
1130
+ name: string
1131
+ /** @description Address of the asset */
1132
+ assetAddress: string
1133
+ assetCaip: string
1134
+ /** @description Symbol of the asset */
1135
+ symbol: string
1136
+ /** @description Decimals of the asset */
1137
+ decimals: number
1138
+ }
1139
+ }[]
1140
+ /** @description Boolean indicating if the vault is transactional */
1141
+ isTransactional: boolean
1142
+ score: {
1143
+ /** @description Score of the vault */
1144
+ vaultScore: number
1145
+ /** @description Score of the vault TVL */
1146
+ vaultTvlScore: number
1147
+ /** @description Score of the protocol TVL */
1148
+ protocolTvlScore: number
1149
+ /** @description Score of the vault holders */
1150
+ holderScore: number
1151
+ /** @description Score of the network */
1152
+ networkScore: number
1153
+ /** @description Score of the asset */
1154
+ assetScore: number
1155
+ }
1156
+ /** @description Array of derivative vaults */
1157
+ children?: string[]
1158
+ }[]
1159
+ }
1160
+ }
1161
+ }
1162
+ }
1163
+ }
1164
+ put?: never
1165
+ post?: never
1166
+ delete?: never
1167
+ options?: never
1168
+ head?: never
1169
+ patch?: never
1170
+ trace?: never
1171
+ }
1172
+ '/v1/top-vault/{network}/{userAddress}': {
1173
+ parameters: {
1174
+ query?: never
1175
+ header?: never
1176
+ path?: never
1177
+ cookie?: never
1178
+ }
1179
+ /** @description Get the best vault for the user */
1180
+ get: {
1181
+ parameters: {
1182
+ query?: never
1183
+ header?: never
1184
+ path: {
1185
+ /** @description User wallet address */
1186
+ userAddress: string
1187
+ /** @description Network name or caip */
1188
+ network:
1189
+ | 'mainnet'
1190
+ | 'optimism'
1191
+ | 'arbitrum'
1192
+ | 'polygon'
1193
+ | 'gnosis'
1194
+ | 'base'
1195
+ | 'unichain'
1196
+ | 'swellchain'
1197
+ | 'celo'
1198
+ | 'eip155:1'
1199
+ | 'eip155:10'
1200
+ | 'eip155:42161'
1201
+ | 'eip155:137'
1202
+ | 'eip155:100'
1203
+ | 'eip155:8453'
1204
+ | 'eip155:130'
1205
+ | 'eip155:1923'
1206
+ | 'eip155:42220'
1207
+ }
1208
+ cookie?: never
1209
+ }
1210
+ requestBody?: never
1211
+ responses: {
1212
+ /** @description Default Response */
1213
+ 200: {
1214
+ headers: {
1215
+ [name: string]: unknown
1216
+ }
1217
+ content: {
1218
+ 'application/json': {
1219
+ /** @description User wallet address */
1220
+ userAddress: string
1221
+ /** @description Best vault for the user */
1222
+ bestVault: {
1223
+ name?: string
1224
+ protocol: {
1225
+ name: string
1226
+ product?: string | null
1227
+ version?: string | null
1228
+ }
1229
+ vaultAddress: string
1230
+ /** @enum {string} */
1231
+ networkName:
1232
+ | 'mainnet'
1233
+ | 'optimism'
1234
+ | 'arbitrum'
1235
+ | 'polygon'
1236
+ | 'gnosis'
1237
+ | 'base'
1238
+ | 'unichain'
1239
+ | 'swellchain'
1240
+ | 'celo'
1241
+ tvlInUsd: number
1242
+ apy: number
1243
+ projectedEarnings: number
1244
+ asset: {
1245
+ assetAddress: string
1246
+ decimals: number
1247
+ name: string
1248
+ symbol: string
1249
+ }
1250
+ } | null
1251
+ /** @description Best ETH vault for the user */
1252
+ bestEthVault: {
1253
+ name?: string
1254
+ protocol: {
1255
+ name: string
1256
+ product?: string | null
1257
+ version?: string | null
1258
+ }
1259
+ vaultAddress: string
1260
+ /** @enum {string} */
1261
+ networkName:
1262
+ | 'mainnet'
1263
+ | 'optimism'
1264
+ | 'arbitrum'
1265
+ | 'polygon'
1266
+ | 'gnosis'
1267
+ | 'base'
1268
+ | 'unichain'
1269
+ | 'swellchain'
1270
+ | 'celo'
1271
+ tvlInUsd: number
1272
+ apy: number
1273
+ projectedEarnings: number
1274
+ } | null
1275
+ }
1276
+ }
1277
+ }
1278
+ }
1279
+ }
1280
+ put?: never
1281
+ post?: never
1282
+ delete?: never
1283
+ options?: never
1284
+ head?: never
1285
+ patch?: never
1286
+ trace?: never
1287
+ }
1288
+ '/v1/benchmarks': {
1289
+ parameters: {
1290
+ query?: never
1291
+ header?: never
1292
+ path?: never
1293
+ cookie?: never
1294
+ }
1295
+ /** @description Get vaults.fyi benchmark rates */
1296
+ get: {
1297
+ parameters: {
1298
+ query?: never
1299
+ header?: never
1300
+ path?: never
1301
+ cookie?: never
1302
+ }
1303
+ requestBody?: never
1304
+ responses: {
1305
+ /** @description Default Response */
1306
+ 200: {
1307
+ headers: {
1308
+ [name: string]: unknown
1309
+ }
1310
+ content: {
1311
+ 'application/json': {
1312
+ usd: {
1313
+ name: string
1314
+ /** @description Object describing the base APY of the vault given different APY windows */
1315
+ apy: {
1316
+ /** @description APY in BIPS with 1 day window */
1317
+ '1day': number
1318
+ /** @description APY in BIPS with 7 day window */
1319
+ '7day': number
1320
+ /** @description APY in BIPS with 30 day window */
1321
+ '30day': number
1322
+ }
1323
+ vaults: {
1324
+ name: string
1325
+ /** @enum {string} */
1326
+ network:
1327
+ | 'mainnet'
1328
+ | 'optimism'
1329
+ | 'arbitrum'
1330
+ | 'polygon'
1331
+ | 'gnosis'
1332
+ | 'base'
1333
+ | 'unichain'
1334
+ | 'swellchain'
1335
+ | 'celo'
1336
+ address: string
1337
+ }[]
1338
+ }
1339
+ eth: {
1340
+ name: string
1341
+ /** @description Object describing the base APY of the vault given different APY windows */
1342
+ apy: {
1343
+ /** @description APY in BIPS with 1 day window */
1344
+ '1day': number
1345
+ /** @description APY in BIPS with 7 day window */
1346
+ '7day': number
1347
+ /** @description APY in BIPS with 30 day window */
1348
+ '30day': number
1349
+ }
1350
+ vaults: {
1351
+ name: string
1352
+ /** @enum {string} */
1353
+ network:
1354
+ | 'mainnet'
1355
+ | 'optimism'
1356
+ | 'arbitrum'
1357
+ | 'polygon'
1358
+ | 'gnosis'
1359
+ | 'base'
1360
+ | 'unichain'
1361
+ | 'swellchain'
1362
+ | 'celo'
1363
+ address: string
1364
+ }[]
1365
+ }
1366
+ }
1367
+ }
1368
+ }
1369
+ }
1370
+ }
1371
+ put?: never
1372
+ post?: never
1373
+ delete?: never
1374
+ options?: never
1375
+ head?: never
1376
+ patch?: never
1377
+ trace?: never
1378
+ }
1379
+ '/v1/vaults/{network}/{vaultAddress}/': {
1380
+ parameters: {
1381
+ query?: never
1382
+ header?: never
1383
+ path?: never
1384
+ cookie?: never
1385
+ }
1386
+ /** @description Get a vault information given a specific address and network */
1387
+ get: {
1388
+ parameters: {
1389
+ query?: never
1390
+ header?: never
1391
+ path: {
1392
+ /** @description Address of a vault */
1393
+ vaultAddress: string
1394
+ /** @description Network name or caip */
1395
+ network:
1396
+ | 'mainnet'
1397
+ | 'optimism'
1398
+ | 'arbitrum'
1399
+ | 'polygon'
1400
+ | 'gnosis'
1401
+ | 'base'
1402
+ | 'unichain'
1403
+ | 'swellchain'
1404
+ | 'celo'
1405
+ | 'eip155:1'
1406
+ | 'eip155:10'
1407
+ | 'eip155:42161'
1408
+ | 'eip155:137'
1409
+ | 'eip155:100'
1410
+ | 'eip155:8453'
1411
+ | 'eip155:130'
1412
+ | 'eip155:1923'
1413
+ | 'eip155:42220'
1414
+ }
1415
+ cookie?: never
1416
+ }
1417
+ requestBody?: never
1418
+ responses: {
1419
+ /** @description Object describing the vault */
1420
+ 200: {
1421
+ headers: {
1422
+ [name: string]: unknown
1423
+ }
1424
+ content: {
1425
+ 'application/json': {
1426
+ /** @description Name of the vault */
1427
+ name: string
1428
+ /** @description Address of a vault */
1429
+ address: string
1430
+ /**
1431
+ * @description Network name on which vault exists
1432
+ * @enum {string}
1433
+ */
1434
+ network:
1435
+ | 'mainnet'
1436
+ | 'optimism'
1437
+ | 'arbitrum'
1438
+ | 'polygon'
1439
+ | 'gnosis'
1440
+ | 'base'
1441
+ | 'unichain'
1442
+ | 'swellchain'
1443
+ | 'celo'
1444
+ /** @description Protocol name to which the vault belongs */
1445
+ protocol: string
1446
+ /** @description Object containing a breakdown of TVL for a vault both in native token and USD */
1447
+ tvlDetails: {
1448
+ /** @description Total value locked in Vault token */
1449
+ tvlNative: string
1450
+ /** @description Total value locked in USD */
1451
+ tvlUsd: string
1452
+ /** @description Locked amount in Vault token */
1453
+ lockedNative: string
1454
+ /** @description Locked amount in USD */
1455
+ lockedUsd: string
1456
+ /** @description Liquid amount in Vault token */
1457
+ liquidNative: string
1458
+ /** @description Liquid amount in USD */
1459
+ liquidUsd: string
1460
+ }
1461
+ /** @description Number of holders of vault LP tokens */
1462
+ numberOfHolders: number | null
1463
+ /** @description Lend link of the vault */
1464
+ lendLink: string | null
1465
+ /** @description Array of tags present on vault */
1466
+ tags: string[]
1467
+ /** @description Object describing the token of the vault */
1468
+ token: {
1469
+ /** @description Name of the asset */
1470
+ name: string
1471
+ /** @description Address of the asset */
1472
+ assetAddress: string
1473
+ assetCaip: string
1474
+ /** @description Symbol of the asset */
1475
+ symbol: string
1476
+ /** @description Decimals of the asset */
1477
+ decimals: number
1478
+ }
1479
+ /** @description Object describing the base APY of the vault given different APY windows */
1480
+ apy: {
1481
+ /** @description Object describing the base APY of the vault given different APY windows */
1482
+ base: {
1483
+ /** @description APY in BIPS with 1 day window */
1484
+ '1day': number
1485
+ /** @description APY in BIPS with 7 day window */
1486
+ '7day': number
1487
+ /** @description APY in BIPS with 30 day window */
1488
+ '30day': number
1489
+ }
1490
+ /** @description Object describing the base APY of the vault given different APY windows */
1491
+ rewards?: {
1492
+ /** @description APY in BIPS with 1 day window */
1493
+ '1day': number
1494
+ /** @description APY in BIPS with 7 day window */
1495
+ '7day': number
1496
+ /** @description APY in BIPS with 30 day window */
1497
+ '30day': number
1498
+ }
1499
+ /** @description Object describing the base APY of the vault given different APY windows */
1500
+ total: {
1501
+ /** @description APY in BIPS with 1 day window */
1502
+ '1day': number
1503
+ /** @description APY in BIPS with 7 day window */
1504
+ '7day': number
1505
+ /** @description APY in BIPS with 30 day window */
1506
+ '30day': number
1507
+ }
1508
+ }
1509
+ /** @description Description of the vault */
1510
+ description: string | null
1511
+ /** @description Additional incentives of the vault */
1512
+ additionalIncentives: string | null
1513
+ /** @description Array of rewards present on vault */
1514
+ rewards: {
1515
+ /** @description Object describing the APY of the reward given different APY windows */
1516
+ apy: {
1517
+ /** @description APY in BIPS with 1 day window */
1518
+ '1day': number
1519
+ /** @description APY in BIPS with 7 day window */
1520
+ '7day': number
1521
+ /** @description APY in BIPS with 30 day window */
1522
+ '30day': number
1523
+ }
1524
+ /** @description Price of the asset in USD 1e8 precision */
1525
+ assetPriceInUsd: number
1526
+ /** @description Object describing the reward asset */
1527
+ asset: {
1528
+ /** @description Name of the asset */
1529
+ name: string
1530
+ /** @description Address of the asset */
1531
+ assetAddress: string
1532
+ assetCaip: string
1533
+ /** @description Symbol of the asset */
1534
+ symbol: string
1535
+ /** @description Decimals of the asset */
1536
+ decimals: number
1537
+ }
1538
+ }[]
1539
+ /** @description Boolean indicating if the vault is transactional */
1540
+ isTransactional: boolean
1541
+ score: {
1542
+ /** @description Score of the vault */
1543
+ vaultScore: number
1544
+ /** @description Score of the vault TVL */
1545
+ vaultTvlScore: number
1546
+ /** @description Score of the protocol TVL */
1547
+ protocolTvlScore: number
1548
+ /** @description Score of the vault holders */
1549
+ holderScore: number
1550
+ /** @description Score of the network */
1551
+ networkScore: number
1552
+ /** @description Score of the asset */
1553
+ assetScore: number
1554
+ }
1555
+ /** @description Array of derivative vaults */
1556
+ children?: string[]
1557
+ /** @description Price of the underlying vault asset in USD with 1e8 precision */
1558
+ assetPriceInUsd: number
1559
+ /** @description Top holders of vault LP tokens */
1560
+ topHolders: {
1561
+ address: string
1562
+ balance: string
1563
+ }[]
1564
+ /** @description Total balance of all holders of vault LP tokens */
1565
+ holdersTotalBalance: string
1566
+ }
1567
+ }
1568
+ }
1569
+ }
1570
+ }
1571
+ put?: never
1572
+ post?: never
1573
+ delete?: never
1574
+ options?: never
1575
+ head?: never
1576
+ patch?: never
1577
+ trace?: never
1578
+ }
1579
+ '/v1/vaults/{network}/{vaultAddress}/apy': {
1580
+ parameters: {
1581
+ query?: never
1582
+ header?: never
1583
+ path?: never
1584
+ cookie?: never
1585
+ }
1586
+ /** @description Get APY data for a vault for given interval */
1587
+ get: {
1588
+ parameters: {
1589
+ query: {
1590
+ /** @description Resolution of the APY data */
1591
+ interval: '1day' | '7day' | '30day'
1592
+ }
1593
+ header?: never
1594
+ path: {
1595
+ /** @description Address of a vault */
1596
+ vaultAddress: string
1597
+ /** @description Network name or caip */
1598
+ network:
1599
+ | 'mainnet'
1600
+ | 'optimism'
1601
+ | 'arbitrum'
1602
+ | 'polygon'
1603
+ | 'gnosis'
1604
+ | 'base'
1605
+ | 'unichain'
1606
+ | 'swellchain'
1607
+ | 'celo'
1608
+ | 'eip155:1'
1609
+ | 'eip155:10'
1610
+ | 'eip155:42161'
1611
+ | 'eip155:137'
1612
+ | 'eip155:100'
1613
+ | 'eip155:8453'
1614
+ | 'eip155:130'
1615
+ | 'eip155:1923'
1616
+ | 'eip155:42220'
1617
+ }
1618
+ cookie?: never
1619
+ }
1620
+ requestBody?: never
1621
+ responses: {
1622
+ /** @description Object describing the APY of the vault in current time */
1623
+ 200: {
1624
+ headers: {
1625
+ [name: string]: unknown
1626
+ }
1627
+ content: {
1628
+ 'application/json': {
1629
+ /** @description APY of the vault in BIPS */
1630
+ base: number
1631
+ /** @description APY of the vault rewards in BIPS */
1632
+ rewards?: number
1633
+ /** @description Sum of base APY of the vault and rewards in BIPS */
1634
+ total: number
1635
+ }
1636
+ }
1637
+ }
1638
+ }
1639
+ }
1640
+ put?: never
1641
+ post?: never
1642
+ delete?: never
1643
+ options?: never
1644
+ head?: never
1645
+ patch?: never
1646
+ trace?: never
1647
+ }
1648
+ '/v1/vaults/{network}/{vaultAddress}/historical-tvl/{timestamp}': {
1649
+ parameters: {
1650
+ query?: never
1651
+ header?: never
1652
+ path?: never
1653
+ cookie?: never
1654
+ }
1655
+ /** @description Get historical TVL data for a vault for block with closest timestamp to the given one */
1656
+ get: {
1657
+ parameters: {
1658
+ query?: never
1659
+ header?: never
1660
+ path: {
1661
+ /** @description Address of a vault */
1662
+ vaultAddress: string
1663
+ /** @description Network name or caip */
1664
+ network:
1665
+ | 'mainnet'
1666
+ | 'optimism'
1667
+ | 'arbitrum'
1668
+ | 'polygon'
1669
+ | 'gnosis'
1670
+ | 'base'
1671
+ | 'unichain'
1672
+ | 'swellchain'
1673
+ | 'celo'
1674
+ | 'eip155:1'
1675
+ | 'eip155:10'
1676
+ | 'eip155:42161'
1677
+ | 'eip155:137'
1678
+ | 'eip155:100'
1679
+ | 'eip155:8453'
1680
+ | 'eip155:130'
1681
+ | 'eip155:1923'
1682
+ | 'eip155:42220'
1683
+ /** @description Timestamp of the historical data */
1684
+ timestamp: number
1685
+ }
1686
+ cookie?: never
1687
+ }
1688
+ requestBody?: never
1689
+ responses: {
1690
+ /** @description Object describing the TVL of the vault in given time */
1691
+ 200: {
1692
+ headers: {
1693
+ [name: string]: unknown
1694
+ }
1695
+ content: {
1696
+ 'application/json': {
1697
+ /** @description Timestamp of the block for given data */
1698
+ timestamp: number
1699
+ /** @description Block number for given data */
1700
+ blockNumber: number
1701
+ /** @description Object containing a breakdown of TVL for a vault both in native token and USD */
1702
+ tvlDetails: {
1703
+ /** @description Total value locked in Vault token */
1704
+ tvlNative: string
1705
+ /** @description Total value locked in USD */
1706
+ tvlUsd: string
1707
+ /** @description Locked amount in Vault token */
1708
+ lockedNative: string
1709
+ /** @description Locked amount in USD */
1710
+ lockedUsd: string
1711
+ /** @description Liquid amount in Vault token */
1712
+ liquidNative: string
1713
+ /** @description Liquid amount in USD */
1714
+ liquidUsd: string
1715
+ }
1716
+ }
1717
+ }
1718
+ }
1719
+ }
1720
+ }
1721
+ put?: never
1722
+ post?: never
1723
+ delete?: never
1724
+ options?: never
1725
+ head?: never
1726
+ patch?: never
1727
+ trace?: never
1728
+ }
1729
+ '/v1/vaults/{network}/{vaultAddress}/historical-apy/{timestamp}': {
1730
+ parameters: {
1731
+ query?: never
1732
+ header?: never
1733
+ path?: never
1734
+ cookie?: never
1735
+ }
1736
+ /** @description Get historical APY data for a vault for block with closest timestamp to the given one */
1737
+ get: {
1738
+ parameters: {
1739
+ query: {
1740
+ /** @description Resolution of the APY data */
1741
+ interval: '1day' | '7day' | '30day'
1742
+ }
1743
+ header?: never
1744
+ path: {
1745
+ /** @description Address of a vault */
1746
+ vaultAddress: string
1747
+ /** @description Network name or caip */
1748
+ network:
1749
+ | 'mainnet'
1750
+ | 'optimism'
1751
+ | 'arbitrum'
1752
+ | 'polygon'
1753
+ | 'gnosis'
1754
+ | 'base'
1755
+ | 'unichain'
1756
+ | 'swellchain'
1757
+ | 'celo'
1758
+ | 'eip155:1'
1759
+ | 'eip155:10'
1760
+ | 'eip155:42161'
1761
+ | 'eip155:137'
1762
+ | 'eip155:100'
1763
+ | 'eip155:8453'
1764
+ | 'eip155:130'
1765
+ | 'eip155:1923'
1766
+ | 'eip155:42220'
1767
+ /** @description Timestamp of the historical data */
1768
+ timestamp: number
1769
+ }
1770
+ cookie?: never
1771
+ }
1772
+ requestBody?: never
1773
+ responses: {
1774
+ /** @description Object describing the APY of the vault in given time */
1775
+ 200: {
1776
+ headers: {
1777
+ [name: string]: unknown
1778
+ }
1779
+ content: {
1780
+ 'application/json': {
1781
+ /** @description Timestamp of the block for given data */
1782
+ timestamp: number
1783
+ /** @description Block number for given data */
1784
+ blockNumber: number
1785
+ /** @description APY broken down into components */
1786
+ apy: {
1787
+ /** @description APY of the vault in BIPS */
1788
+ base: number
1789
+ /** @description APY of the vault rewards in BIPS */
1790
+ rewards?: number
1791
+ /** @description Sum of base APY of the vault and rewards in BIPS */
1792
+ total: number
1793
+ }
1794
+ }
1795
+ }
1796
+ }
1797
+ }
1798
+ }
1799
+ put?: never
1800
+ post?: never
1801
+ delete?: never
1802
+ options?: never
1803
+ head?: never
1804
+ patch?: never
1805
+ trace?: never
1806
+ }
1807
+ '/v1/vaults/{network}/{vaultAddress}/historical-apy': {
1808
+ parameters: {
1809
+ query?: never
1810
+ header?: never
1811
+ path?: never
1812
+ cookie?: never
1813
+ }
1814
+ /** @description Get historical APY data for a vault for blocks in given timestamp range */
1815
+ get: {
1816
+ parameters: {
1817
+ query: {
1818
+ /** @description Resolution of the APY data */
1819
+ interval: '1day' | '7day' | '30day'
1820
+ /** @description Timestamp of the beginning of the range */
1821
+ from_timestamp: number
1822
+ /** @description Timestamp of the end of the range */
1823
+ to_timestamp: number
1824
+ /** @description Page number */
1825
+ page?: number
1826
+ /** @description Number of items per page */
1827
+ per_page?: number
1828
+ /** @description Time difference between returned data points */
1829
+ granularity: number
1830
+ }
1831
+ header?: never
1832
+ path: {
1833
+ /** @description Address of a vault */
1834
+ vaultAddress: string
1835
+ /** @description Network name or caip */
1836
+ network:
1837
+ | 'mainnet'
1838
+ | 'optimism'
1839
+ | 'arbitrum'
1840
+ | 'polygon'
1841
+ | 'gnosis'
1842
+ | 'base'
1843
+ | 'unichain'
1844
+ | 'swellchain'
1845
+ | 'celo'
1846
+ | 'eip155:1'
1847
+ | 'eip155:10'
1848
+ | 'eip155:42161'
1849
+ | 'eip155:137'
1850
+ | 'eip155:100'
1851
+ | 'eip155:8453'
1852
+ | 'eip155:130'
1853
+ | 'eip155:1923'
1854
+ | 'eip155:42220'
1855
+ }
1856
+ cookie?: never
1857
+ }
1858
+ requestBody?: never
1859
+ responses: {
1860
+ /** @description Default Response */
1861
+ 200: {
1862
+ headers: {
1863
+ [name: string]: unknown
1864
+ }
1865
+ content: {
1866
+ 'application/json': {
1867
+ /** @description Next page number */
1868
+ next_page?: number
1869
+ /** @description Array of historical APY data for the vault */
1870
+ data: {
1871
+ /** @description Timestamp of the block for given data */
1872
+ timestamp: number
1873
+ /** @description Block number for given data */
1874
+ blockNumber: number
1875
+ /** @description APY broken down into components */
1876
+ apy: {
1877
+ /** @description APY of the vault in BIPS */
1878
+ base: number
1879
+ /** @description APY of the vault rewards in BIPS */
1880
+ rewards?: number
1881
+ /** @description Sum of base APY of the vault and rewards in BIPS */
1882
+ total: number
1883
+ }
1884
+ }[]
1885
+ }
1886
+ }
1887
+ }
1888
+ }
1889
+ }
1890
+ put?: never
1891
+ post?: never
1892
+ delete?: never
1893
+ options?: never
1894
+ head?: never
1895
+ patch?: never
1896
+ trace?: never
1897
+ }
1898
+ '/v1/vaults/{network}/{vaultAddress}/historical-data': {
1899
+ parameters: {
1900
+ query?: never
1901
+ header?: never
1902
+ path?: never
1903
+ cookie?: never
1904
+ }
1905
+ /** @description Get historical APY data for a vault for blocks in given timestamp range */
1906
+ get: {
1907
+ parameters: {
1908
+ query?: {
1909
+ /** @description Page number */
1910
+ page?: number
1911
+ /** @description Number of items per page */
1912
+ per_page?: number
1913
+ /** @description Resolution of the APY data */
1914
+ interval?: '1day' | '7day' | '30day'
1915
+ /** @description Timestamp of the beginning of the range in epoch seconds */
1916
+ from_timestamp?: number
1917
+ /** @description Timestamp of the end of the range in epoch seconds */
1918
+ to_timestamp?: number
1919
+ /** @description Time difference between returned data points */
1920
+ granularity?: number
1921
+ }
1922
+ header?: never
1923
+ path: {
1924
+ /** @description Address of a vault */
1925
+ vaultAddress: string
1926
+ /** @description Network name or caip */
1927
+ network:
1928
+ | 'mainnet'
1929
+ | 'optimism'
1930
+ | 'arbitrum'
1931
+ | 'polygon'
1932
+ | 'gnosis'
1933
+ | 'base'
1934
+ | 'unichain'
1935
+ | 'swellchain'
1936
+ | 'celo'
1937
+ | 'eip155:1'
1938
+ | 'eip155:10'
1939
+ | 'eip155:42161'
1940
+ | 'eip155:137'
1941
+ | 'eip155:100'
1942
+ | 'eip155:8453'
1943
+ | 'eip155:130'
1944
+ | 'eip155:1923'
1945
+ | 'eip155:42220'
1946
+ }
1947
+ cookie?: never
1948
+ }
1949
+ requestBody?: never
1950
+ responses: {
1951
+ /** @description Default Response */
1952
+ 200: {
1953
+ headers: {
1954
+ [name: string]: unknown
1955
+ }
1956
+ content: {
1957
+ 'application/json': {
1958
+ /** @description Next page number */
1959
+ next_page?: number
1960
+ /** @description Array of historical APY data for the vault */
1961
+ data: {
1962
+ /** @description Timestamp of the block for given data */
1963
+ timestamp: number
1964
+ /** @description Block number for given data */
1965
+ blockNumber: number
1966
+ /** @description APY broken down into components */
1967
+ apy: {
1968
+ /** @description APY of the vault in BIPS */
1969
+ base: number
1970
+ /** @description APY of the vault rewards in BIPS */
1971
+ rewards?: number
1972
+ /** @description Sum of base APY of the vault and rewards in BIPS */
1973
+ total: number
1974
+ }
1975
+ /** @description Object containing a breakdown of TVL for a vault both in native token and USD */
1976
+ tvlDetails: {
1977
+ /** @description Total value locked in Vault token */
1978
+ tvlNative: string
1979
+ /** @description Total value locked in USD */
1980
+ tvlUsd: string
1981
+ /** @description Locked amount in Vault token */
1982
+ lockedNative: string
1983
+ /** @description Locked amount in USD */
1984
+ lockedUsd: string
1985
+ /** @description Liquid amount in Vault token */
1986
+ liquidNative: string
1987
+ /** @description Liquid amount in USD */
1988
+ liquidUsd: string
1989
+ }
1990
+ }[]
1991
+ }
1992
+ }
1993
+ }
1994
+ }
1995
+ }
1996
+ put?: never
1997
+ post?: never
1998
+ delete?: never
1999
+ options?: never
2000
+ head?: never
2001
+ patch?: never
2002
+ trace?: never
2003
+ }
2004
+ '/v1/vaults/{network}/{vaultAddress}/holder-events/{holder}': {
2005
+ parameters: {
2006
+ query?: never
2007
+ header?: never
2008
+ path?: never
2009
+ cookie?: never
2010
+ }
2011
+ /** @description Get a list of holder events on a vault */
2012
+ get: {
2013
+ parameters: {
2014
+ query?: never
2015
+ header?: never
2016
+ path: {
2017
+ /** @description Address of a vault */
2018
+ vaultAddress: string
2019
+ /** @description Network name or caip */
2020
+ network:
2021
+ | 'mainnet'
2022
+ | 'optimism'
2023
+ | 'arbitrum'
2024
+ | 'polygon'
2025
+ | 'gnosis'
2026
+ | 'base'
2027
+ | 'unichain'
2028
+ | 'swellchain'
2029
+ | 'celo'
2030
+ | 'eip155:1'
2031
+ | 'eip155:10'
2032
+ | 'eip155:42161'
2033
+ | 'eip155:137'
2034
+ | 'eip155:100'
2035
+ | 'eip155:8453'
2036
+ | 'eip155:130'
2037
+ | 'eip155:1923'
2038
+ | 'eip155:42220'
2039
+ /** @description Address of a holder */
2040
+ holder: string
2041
+ }
2042
+ cookie?: never
2043
+ }
2044
+ requestBody?: never
2045
+ responses: {
2046
+ /** @description Default Response */
2047
+ 200: {
2048
+ headers: {
2049
+ [name: string]: unknown
2050
+ }
2051
+ content: {
2052
+ 'application/json': {
2053
+ events: {
2054
+ /** @enum {string} */
2055
+ activity: 'Transfer' | 'Deposit' | 'Withdrawal'
2056
+ timestamp: number
2057
+ amount: {
2058
+ usd: number
2059
+ native: string
2060
+ }
2061
+ positionValue: {
2062
+ usd: number
2063
+ native: string
2064
+ }
2065
+ }[]
2066
+ }
2067
+ }
2068
+ }
2069
+ }
2070
+ }
2071
+ put?: never
2072
+ post?: never
2073
+ delete?: never
2074
+ options?: never
2075
+ head?: never
2076
+ patch?: never
2077
+ trace?: never
2078
+ }
2079
+ '/v1/vaults/{network}/{vaultAddress}/holder-total-returns/{holder}': {
2080
+ parameters: {
2081
+ query?: never
2082
+ header?: never
2083
+ path?: never
2084
+ cookie?: never
2085
+ }
2086
+ /** @description Get a holder total returns on a vault */
2087
+ get: {
2088
+ parameters: {
2089
+ query?: never
2090
+ header?: never
2091
+ path: {
2092
+ /** @description Address of a vault */
2093
+ vaultAddress: string
2094
+ /** @description Network name or caip */
2095
+ network:
2096
+ | 'mainnet'
2097
+ | 'optimism'
2098
+ | 'arbitrum'
2099
+ | 'polygon'
2100
+ | 'gnosis'
2101
+ | 'base'
2102
+ | 'unichain'
2103
+ | 'swellchain'
2104
+ | 'celo'
2105
+ | 'eip155:1'
2106
+ | 'eip155:10'
2107
+ | 'eip155:42161'
2108
+ | 'eip155:137'
2109
+ | 'eip155:100'
2110
+ | 'eip155:8453'
2111
+ | 'eip155:130'
2112
+ | 'eip155:1923'
2113
+ | 'eip155:42220'
2114
+ /** @description Address of a holder */
2115
+ holder: string
2116
+ }
2117
+ cookie?: never
2118
+ }
2119
+ requestBody?: never
2120
+ responses: {
2121
+ /** @description Default Response */
2122
+ 200: {
2123
+ headers: {
2124
+ [name: string]: unknown
2125
+ }
2126
+ content: {
2127
+ 'application/json': {
2128
+ usd: number
2129
+ native: number
2130
+ }
2131
+ }
2132
+ }
2133
+ }
2134
+ }
2135
+ put?: never
2136
+ post?: never
2137
+ delete?: never
2138
+ options?: never
2139
+ head?: never
2140
+ patch?: never
2141
+ trace?: never
2142
+ }
2143
+ '/v1/portfolio/best-deposit-options/{userAddress}': {
2144
+ parameters: {
2145
+ query?: never
2146
+ header?: never
2147
+ path?: never
2148
+ cookie?: never
2149
+ }
2150
+ get?: never
2151
+ put?: never
2152
+ post: {
2153
+ parameters: {
2154
+ query?: never
2155
+ header?: never
2156
+ path: {
2157
+ userAddress: string
2158
+ }
2159
+ cookie?: never
2160
+ }
2161
+ requestBody?: {
2162
+ content: {
2163
+ 'application/json': {
2164
+ /**
2165
+ * @description Resolution of the APY data
2166
+ * @default 7day
2167
+ * @enum {string}
2168
+ */
2169
+ apyInterval?: '1day' | '7day' | '30day'
2170
+ /**
2171
+ * @description Networks to be included (name or CAIP)
2172
+ * @default [
2173
+ * "base",
2174
+ * "mainnet",
2175
+ * "arbitrum",
2176
+ * "polygon"
2177
+ * ]
2178
+ */
2179
+ allowedNetworks?: (
2180
+ | 'mainnet'
2181
+ | 'optimism'
2182
+ | 'arbitrum'
2183
+ | 'polygon'
2184
+ | 'gnosis'
2185
+ | 'base'
2186
+ | 'unichain'
2187
+ | 'swellchain'
2188
+ | 'celo'
2189
+ | 'eip155:1'
2190
+ | 'eip155:10'
2191
+ | 'eip155:42161'
2192
+ | 'eip155:137'
2193
+ | 'eip155:100'
2194
+ | 'eip155:8453'
2195
+ | 'eip155:130'
2196
+ | 'eip155:1923'
2197
+ | 'eip155:42220'
2198
+ )[]
2199
+ /** @description Networks to be excluded (name or CAIP) */
2200
+ disallowedNetworks?: (
2201
+ | 'mainnet'
2202
+ | 'optimism'
2203
+ | 'arbitrum'
2204
+ | 'polygon'
2205
+ | 'gnosis'
2206
+ | 'base'
2207
+ | 'unichain'
2208
+ | 'swellchain'
2209
+ | 'celo'
2210
+ | 'eip155:1'
2211
+ | 'eip155:10'
2212
+ | 'eip155:42161'
2213
+ | 'eip155:137'
2214
+ | 'eip155:100'
2215
+ | 'eip155:8453'
2216
+ | 'eip155:130'
2217
+ | 'eip155:1923'
2218
+ | 'eip155:42220'
2219
+ )[]
2220
+ /** @description Assets to be included (by symbol/ticker) */
2221
+ allowedAssets?: string[]
2222
+ /** @description Assets to be excluded (by symbol/ticker) */
2223
+ disallowedAssets?: string[]
2224
+ /** @description Protocols to be included (by name) */
2225
+ allowedProtocols?: string[]
2226
+ /** @description Protocols to be excluded (by name) */
2227
+ disallowedProtocols?: string[]
2228
+ /**
2229
+ * @description Minimum balance in USD of the assets to be included
2230
+ * @default 1
2231
+ */
2232
+ minimumBalanceThreshold?: number
2233
+ /**
2234
+ * @description Minimum TVL in USD of the vaults to be included
2235
+ * @default 100000
2236
+ */
2237
+ minimumVaultTvl?: number
2238
+ /** @description Boolean indicating if only transactional vaults should be included */
2239
+ transactionalOnly?: boolean
2240
+ /** @description Boolean indicating if only transactional vaults featured in app.vaults.fyi should be included */
2241
+ transactionalFeaturedOnly?: boolean
2242
+ /**
2243
+ * @description Maximum number of vaults per asset
2244
+ * @default 3
2245
+ */
2246
+ maxVaultsPerAsset?: number
2247
+ /** @description Minimum APY(in BPS) of the vaults to be included */
2248
+ minApy?: number
2249
+ /**
2250
+ * @description Symbols/tickers of assets to always return, regardless of balance
2251
+ * @default []
2252
+ */
2253
+ alwaysReturnAssets?: string[]
2254
+ /** @description Return only one vault per protocol for each asset */
2255
+ distinctProtocols?: boolean
2256
+ }
2257
+ }
2258
+ }
2259
+ responses: {
2260
+ /** @description Default Response */
2261
+ 200: {
2262
+ headers: {
2263
+ [name: string]: unknown
2264
+ }
2265
+ content: {
2266
+ 'application/json': {
2267
+ requestedAddress: string
2268
+ userBalances: {
2269
+ asset: {
2270
+ /** @description Name of the asset */
2271
+ name: string
2272
+ /** @description Address of the asset */
2273
+ assetAddress: string
2274
+ assetCaip: string
2275
+ /** @description Symbol of the asset */
2276
+ symbol: string
2277
+ /** @description Decimals of the asset */
2278
+ decimals: number
2279
+ /** @enum {string} */
2280
+ networkName:
2281
+ | 'mainnet'
2282
+ | 'optimism'
2283
+ | 'arbitrum'
2284
+ | 'polygon'
2285
+ | 'gnosis'
2286
+ | 'base'
2287
+ | 'unichain'
2288
+ | 'swellchain'
2289
+ | 'celo'
2290
+ networkCaip: string
2291
+ balanceNative: string
2292
+ balanceUsd: number
2293
+ }
2294
+ depositOptions: {
2295
+ name: string
2296
+ protocol: {
2297
+ name: string
2298
+ product?: string
2299
+ version?: string
2300
+ /** Format: uri */
2301
+ protocolLogo: string
2302
+ /** Format: uri */
2303
+ protocolUrl?: string
2304
+ description?: string
2305
+ }
2306
+ vaultAddress: string
2307
+ /** Format: uri */
2308
+ vaultUrl?: string
2309
+ /** @enum {string} */
2310
+ networkName:
2311
+ | 'mainnet'
2312
+ | 'optimism'
2313
+ | 'arbitrum'
2314
+ | 'polygon'
2315
+ | 'gnosis'
2316
+ | 'base'
2317
+ | 'unichain'
2318
+ | 'swellchain'
2319
+ | 'celo'
2320
+ networkCaip: string
2321
+ tvlInUsd: number
2322
+ apy: {
2323
+ /** @description APY of the vault in BIPS */
2324
+ base: number
2325
+ /** @description APY of the vault rewards in BIPS */
2326
+ rewards?: number
2327
+ /** @description Sum of base APY of the vault and rewards in BIPS */
2328
+ total: number
2329
+ }
2330
+ projectedAnnualEarnings: number
2331
+ tags?: string[]
2332
+ isTransactional: boolean
2333
+ }[]
2334
+ }[]
2335
+ errors?: {
2336
+ unsupportedNetworks?: string[]
2337
+ unsupportedAssets?: string[]
2338
+ unsupportedProtocols?: string[]
2339
+ }
2340
+ }
2341
+ }
2342
+ }
2343
+ }
2344
+ }
2345
+ delete?: never
2346
+ options?: never
2347
+ head?: never
2348
+ patch?: never
2349
+ trace?: never
2350
+ }
2351
+ '/v1/portfolio/best-vault/{userAddress}': {
2352
+ parameters: {
2353
+ query?: never
2354
+ header?: never
2355
+ path?: never
2356
+ cookie?: never
2357
+ }
2358
+ get?: never
2359
+ put?: never
2360
+ post: {
2361
+ parameters: {
2362
+ query?: never
2363
+ header?: never
2364
+ path: {
2365
+ userAddress: string
2366
+ }
2367
+ cookie?: never
2368
+ }
2369
+ requestBody?: {
2370
+ content: {
2371
+ 'application/json': {
2372
+ /**
2373
+ * @description Resolution of the APY data
2374
+ * @default 7day
2375
+ * @enum {string}
2376
+ */
2377
+ apyInterval?: '1day' | '7day' | '30day'
2378
+ /**
2379
+ * @description Networks to be included (name or CAIP)
2380
+ * @default [
2381
+ * "base",
2382
+ * "mainnet",
2383
+ * "arbitrum",
2384
+ * "polygon"
2385
+ * ]
2386
+ */
2387
+ allowedNetworks?: (
2388
+ | 'mainnet'
2389
+ | 'optimism'
2390
+ | 'arbitrum'
2391
+ | 'polygon'
2392
+ | 'gnosis'
2393
+ | 'base'
2394
+ | 'unichain'
2395
+ | 'swellchain'
2396
+ | 'celo'
2397
+ | 'eip155:1'
2398
+ | 'eip155:10'
2399
+ | 'eip155:42161'
2400
+ | 'eip155:137'
2401
+ | 'eip155:100'
2402
+ | 'eip155:8453'
2403
+ | 'eip155:130'
2404
+ | 'eip155:1923'
2405
+ | 'eip155:42220'
2406
+ )[]
2407
+ /** @description Networks to be excluded (name or CAIP) */
2408
+ disallowedNetworks?: (
2409
+ | 'mainnet'
2410
+ | 'optimism'
2411
+ | 'arbitrum'
2412
+ | 'polygon'
2413
+ | 'gnosis'
2414
+ | 'base'
2415
+ | 'unichain'
2416
+ | 'swellchain'
2417
+ | 'celo'
2418
+ | 'eip155:1'
2419
+ | 'eip155:10'
2420
+ | 'eip155:42161'
2421
+ | 'eip155:137'
2422
+ | 'eip155:100'
2423
+ | 'eip155:8453'
2424
+ | 'eip155:130'
2425
+ | 'eip155:1923'
2426
+ | 'eip155:42220'
2427
+ )[]
2428
+ /** @description Assets to be included (by symbol/ticker) */
2429
+ allowedAssets?: string[]
2430
+ /** @description Assets to be excluded (by symbol/ticker) */
2431
+ disallowedAssets?: string[]
2432
+ /** @description Protocols to be included (by name) */
2433
+ allowedProtocols?: string[]
2434
+ /** @description Protocols to be excluded (by name) */
2435
+ disallowedProtocols?: string[]
2436
+ /**
2437
+ * @description Minimum balance in USD of the assets to be included
2438
+ * @default 1
2439
+ */
2440
+ minimumBalanceThreshold?: number
2441
+ /**
2442
+ * @description Minimum TVL in USD of the vaults to be included
2443
+ * @default 100000
2444
+ */
2445
+ minimumVaultTvl?: number
2446
+ /** @description Boolean indicating if only transactional vaults should be included */
2447
+ transactionalOnly?: boolean
2448
+ /** @description Boolean indicating if only transactional vaults featured in app.vaults.fyi should be included */
2449
+ transactionalFeaturedOnly?: boolean
2450
+ }
2451
+ }
2452
+ }
2453
+ responses: {
2454
+ /** @description Default Response */
2455
+ 200: {
2456
+ headers: {
2457
+ [name: string]: unknown
2458
+ }
2459
+ content: {
2460
+ 'application/json': {
2461
+ requestedAddress: string
2462
+ asset?: {
2463
+ /** @description Name of the asset */
2464
+ name: string
2465
+ /** @description Address of the asset */
2466
+ assetAddress: string
2467
+ assetCaip: string
2468
+ /** @description Symbol of the asset */
2469
+ symbol: string
2470
+ /** @description Decimals of the asset */
2471
+ decimals: number
2472
+ /** @enum {string} */
2473
+ networkName:
2474
+ | 'mainnet'
2475
+ | 'optimism'
2476
+ | 'arbitrum'
2477
+ | 'polygon'
2478
+ | 'gnosis'
2479
+ | 'base'
2480
+ | 'unichain'
2481
+ | 'swellchain'
2482
+ | 'celo'
2483
+ networkCaip: string
2484
+ balanceNative: string
2485
+ balanceUsd: number
2486
+ }
2487
+ vault?: {
2488
+ name: string
2489
+ protocol: {
2490
+ name: string
2491
+ product?: string
2492
+ version?: string
2493
+ /** Format: uri */
2494
+ protocolLogo: string
2495
+ /** Format: uri */
2496
+ protocolUrl?: string
2497
+ description?: string
2498
+ }
2499
+ vaultAddress: string
2500
+ /** Format: uri */
2501
+ vaultUrl?: string
2502
+ /** @enum {string} */
2503
+ networkName:
2504
+ | 'mainnet'
2505
+ | 'optimism'
2506
+ | 'arbitrum'
2507
+ | 'polygon'
2508
+ | 'gnosis'
2509
+ | 'base'
2510
+ | 'unichain'
2511
+ | 'swellchain'
2512
+ | 'celo'
2513
+ networkCaip: string
2514
+ tvlInUsd: number
2515
+ apy: {
2516
+ /** @description APY of the vault in BIPS */
2517
+ base: number
2518
+ /** @description APY of the vault rewards in BIPS */
2519
+ rewards?: number
2520
+ /** @description Sum of base APY of the vault and rewards in BIPS */
2521
+ total: number
2522
+ }
2523
+ projectedAnnualEarnings: number
2524
+ tags?: string[]
2525
+ isTransactional: boolean
2526
+ }
2527
+ errors?: {
2528
+ unsupportedNetworks?: string[]
2529
+ unsupportedAssets?: string[]
2530
+ unsupportedProtocols?: string[]
2531
+ }
2532
+ }
2533
+ }
2534
+ }
2535
+ }
2536
+ }
2537
+ delete?: never
2538
+ options?: never
2539
+ head?: never
2540
+ patch?: never
2541
+ trace?: never
2542
+ }
2543
+ '/v1/portfolio/wallet-balances': {
2544
+ parameters: {
2545
+ query?: never
2546
+ header?: never
2547
+ path?: never
2548
+ cookie?: never
2549
+ }
2550
+ get: {
2551
+ parameters: {
2552
+ query: {
2553
+ account: string
2554
+ }
2555
+ header?: never
2556
+ path?: never
2557
+ cookie?: never
2558
+ }
2559
+ requestBody?: never
2560
+ responses: {
2561
+ /** @description Default Response */
2562
+ 200: {
2563
+ headers: {
2564
+ [name: string]: unknown
2565
+ }
2566
+ content: {
2567
+ 'application/json': {
2568
+ mainnet: {
2569
+ address: string
2570
+ name: string
2571
+ symbol: string
2572
+ decimals: number
2573
+ /** @enum {string} */
2574
+ network:
2575
+ | 'mainnet'
2576
+ | 'optimism'
2577
+ | 'arbitrum'
2578
+ | 'polygon'
2579
+ | 'gnosis'
2580
+ | 'base'
2581
+ | 'unichain'
2582
+ | 'swellchain'
2583
+ | 'celo'
2584
+ balance: string
2585
+ balanceNative: string
2586
+ balanceUsd?: string
2587
+ /** @enum {string} */
2588
+ type: 'asset' | 'vault'
2589
+ }[]
2590
+ optimism: {
2591
+ address: string
2592
+ name: string
2593
+ symbol: string
2594
+ decimals: number
2595
+ /** @enum {string} */
2596
+ network:
2597
+ | 'mainnet'
2598
+ | 'optimism'
2599
+ | 'arbitrum'
2600
+ | 'polygon'
2601
+ | 'gnosis'
2602
+ | 'base'
2603
+ | 'unichain'
2604
+ | 'swellchain'
2605
+ | 'celo'
2606
+ balance: string
2607
+ balanceNative: string
2608
+ balanceUsd?: string
2609
+ /** @enum {string} */
2610
+ type: 'asset' | 'vault'
2611
+ }[]
2612
+ arbitrum: {
2613
+ address: string
2614
+ name: string
2615
+ symbol: string
2616
+ decimals: number
2617
+ /** @enum {string} */
2618
+ network:
2619
+ | 'mainnet'
2620
+ | 'optimism'
2621
+ | 'arbitrum'
2622
+ | 'polygon'
2623
+ | 'gnosis'
2624
+ | 'base'
2625
+ | 'unichain'
2626
+ | 'swellchain'
2627
+ | 'celo'
2628
+ balance: string
2629
+ balanceNative: string
2630
+ balanceUsd?: string
2631
+ /** @enum {string} */
2632
+ type: 'asset' | 'vault'
2633
+ }[]
2634
+ polygon: {
2635
+ address: string
2636
+ name: string
2637
+ symbol: string
2638
+ decimals: number
2639
+ /** @enum {string} */
2640
+ network:
2641
+ | 'mainnet'
2642
+ | 'optimism'
2643
+ | 'arbitrum'
2644
+ | 'polygon'
2645
+ | 'gnosis'
2646
+ | 'base'
2647
+ | 'unichain'
2648
+ | 'swellchain'
2649
+ | 'celo'
2650
+ balance: string
2651
+ balanceNative: string
2652
+ balanceUsd?: string
2653
+ /** @enum {string} */
2654
+ type: 'asset' | 'vault'
2655
+ }[]
2656
+ gnosis: {
2657
+ address: string
2658
+ name: string
2659
+ symbol: string
2660
+ decimals: number
2661
+ /** @enum {string} */
2662
+ network:
2663
+ | 'mainnet'
2664
+ | 'optimism'
2665
+ | 'arbitrum'
2666
+ | 'polygon'
2667
+ | 'gnosis'
2668
+ | 'base'
2669
+ | 'unichain'
2670
+ | 'swellchain'
2671
+ | 'celo'
2672
+ balance: string
2673
+ balanceNative: string
2674
+ balanceUsd?: string
2675
+ /** @enum {string} */
2676
+ type: 'asset' | 'vault'
2677
+ }[]
2678
+ base: {
2679
+ address: string
2680
+ name: string
2681
+ symbol: string
2682
+ decimals: number
2683
+ /** @enum {string} */
2684
+ network:
2685
+ | 'mainnet'
2686
+ | 'optimism'
2687
+ | 'arbitrum'
2688
+ | 'polygon'
2689
+ | 'gnosis'
2690
+ | 'base'
2691
+ | 'unichain'
2692
+ | 'swellchain'
2693
+ | 'celo'
2694
+ balance: string
2695
+ balanceNative: string
2696
+ balanceUsd?: string
2697
+ /** @enum {string} */
2698
+ type: 'asset' | 'vault'
2699
+ }[]
2700
+ unichain: {
2701
+ address: string
2702
+ name: string
2703
+ symbol: string
2704
+ decimals: number
2705
+ /** @enum {string} */
2706
+ network:
2707
+ | 'mainnet'
2708
+ | 'optimism'
2709
+ | 'arbitrum'
2710
+ | 'polygon'
2711
+ | 'gnosis'
2712
+ | 'base'
2713
+ | 'unichain'
2714
+ | 'swellchain'
2715
+ | 'celo'
2716
+ balance: string
2717
+ balanceNative: string
2718
+ balanceUsd?: string
2719
+ /** @enum {string} */
2720
+ type: 'asset' | 'vault'
2721
+ }[]
2722
+ swellchain: {
2723
+ address: string
2724
+ name: string
2725
+ symbol: string
2726
+ decimals: number
2727
+ /** @enum {string} */
2728
+ network:
2729
+ | 'mainnet'
2730
+ | 'optimism'
2731
+ | 'arbitrum'
2732
+ | 'polygon'
2733
+ | 'gnosis'
2734
+ | 'base'
2735
+ | 'unichain'
2736
+ | 'swellchain'
2737
+ | 'celo'
2738
+ balance: string
2739
+ balanceNative: string
2740
+ balanceUsd?: string
2741
+ /** @enum {string} */
2742
+ type: 'asset' | 'vault'
2743
+ }[]
2744
+ celo: {
2745
+ address: string
2746
+ name: string
2747
+ symbol: string
2748
+ decimals: number
2749
+ /** @enum {string} */
2750
+ network:
2751
+ | 'mainnet'
2752
+ | 'optimism'
2753
+ | 'arbitrum'
2754
+ | 'polygon'
2755
+ | 'gnosis'
2756
+ | 'base'
2757
+ | 'unichain'
2758
+ | 'swellchain'
2759
+ | 'celo'
2760
+ balance: string
2761
+ balanceNative: string
2762
+ balanceUsd?: string
2763
+ /** @enum {string} */
2764
+ type: 'asset' | 'vault'
2765
+ }[]
2766
+ }
2767
+ }
2768
+ }
2769
+ }
2770
+ }
2771
+ put?: never
2772
+ post?: never
2773
+ delete?: never
2774
+ options?: never
2775
+ head?: never
2776
+ patch?: never
2777
+ trace?: never
2778
+ }
2779
+ '/v1/portfolio/positions/{userAddress}': {
2780
+ parameters: {
2781
+ query?: never
2782
+ header?: never
2783
+ path?: never
2784
+ cookie?: never
2785
+ }
2786
+ get: {
2787
+ parameters: {
2788
+ query?: {
2789
+ apyInterval?: '1day' | '7day' | '30day'
2790
+ }
2791
+ header?: never
2792
+ path: {
2793
+ userAddress: string
2794
+ }
2795
+ cookie?: never
2796
+ }
2797
+ requestBody?: never
2798
+ responses: {
2799
+ /** @description Default Response */
2800
+ 200: {
2801
+ headers: {
2802
+ [name: string]: unknown
2803
+ }
2804
+ content: {
2805
+ 'application/json': {
2806
+ mainnet: {
2807
+ vaultAddress: string
2808
+ protocolName: string
2809
+ /** Format: uri */
2810
+ protocolLogo: string
2811
+ vaultName: string
2812
+ balanceUsd: string
2813
+ balanceNative: string
2814
+ balanceLp: string
2815
+ unclaimedUsd: string
2816
+ unclaimedNative: string
2817
+ apy: {
2818
+ /** @description APY of the vault in BIPS */
2819
+ base: number
2820
+ /** @description APY of the vault rewards in BIPS */
2821
+ rewards?: number
2822
+ /** @description Sum of base APY of the vault and rewards in BIPS */
2823
+ total: number
2824
+ }
2825
+ asset: {
2826
+ /** @description Name of the asset */
2827
+ name: string
2828
+ /** @description Address of the asset */
2829
+ assetAddress: string
2830
+ assetCaip: string
2831
+ /** @description Symbol of the asset */
2832
+ symbol: string
2833
+ /** @description Decimals of the asset */
2834
+ decimals: number
2835
+ }
2836
+ children: {
2837
+ vaultAddress: string
2838
+ protocolName: string
2839
+ /** Format: uri */
2840
+ protocolLogo: string
2841
+ vaultName: string
2842
+ balanceUsd: string
2843
+ balanceNative: string
2844
+ balanceLp: string
2845
+ unclaimedUsd: string
2846
+ unclaimedNative: string
2847
+ apy: {
2848
+ /** @description APY of the vault in BIPS */
2849
+ base: number
2850
+ /** @description APY of the vault rewards in BIPS */
2851
+ rewards?: number
2852
+ /** @description Sum of base APY of the vault and rewards in BIPS */
2853
+ total: number
2854
+ }
2855
+ asset: {
2856
+ /** @description Name of the asset */
2857
+ name: string
2858
+ /** @description Address of the asset */
2859
+ assetAddress: string
2860
+ assetCaip: string
2861
+ /** @description Symbol of the asset */
2862
+ symbol: string
2863
+ /** @description Decimals of the asset */
2864
+ decimals: number
2865
+ }
2866
+ }[]
2867
+ }[]
2868
+ optimism: {
2869
+ vaultAddress: string
2870
+ protocolName: string
2871
+ /** Format: uri */
2872
+ protocolLogo: string
2873
+ vaultName: string
2874
+ balanceUsd: string
2875
+ balanceNative: string
2876
+ balanceLp: string
2877
+ unclaimedUsd: string
2878
+ unclaimedNative: string
2879
+ apy: {
2880
+ /** @description APY of the vault in BIPS */
2881
+ base: number
2882
+ /** @description APY of the vault rewards in BIPS */
2883
+ rewards?: number
2884
+ /** @description Sum of base APY of the vault and rewards in BIPS */
2885
+ total: number
2886
+ }
2887
+ asset: {
2888
+ /** @description Name of the asset */
2889
+ name: string
2890
+ /** @description Address of the asset */
2891
+ assetAddress: string
2892
+ assetCaip: string
2893
+ /** @description Symbol of the asset */
2894
+ symbol: string
2895
+ /** @description Decimals of the asset */
2896
+ decimals: number
2897
+ }
2898
+ children: {
2899
+ vaultAddress: string
2900
+ protocolName: string
2901
+ /** Format: uri */
2902
+ protocolLogo: string
2903
+ vaultName: string
2904
+ balanceUsd: string
2905
+ balanceNative: string
2906
+ balanceLp: string
2907
+ unclaimedUsd: string
2908
+ unclaimedNative: string
2909
+ apy: {
2910
+ /** @description APY of the vault in BIPS */
2911
+ base: number
2912
+ /** @description APY of the vault rewards in BIPS */
2913
+ rewards?: number
2914
+ /** @description Sum of base APY of the vault and rewards in BIPS */
2915
+ total: number
2916
+ }
2917
+ asset: {
2918
+ /** @description Name of the asset */
2919
+ name: string
2920
+ /** @description Address of the asset */
2921
+ assetAddress: string
2922
+ assetCaip: string
2923
+ /** @description Symbol of the asset */
2924
+ symbol: string
2925
+ /** @description Decimals of the asset */
2926
+ decimals: number
2927
+ }
2928
+ }[]
2929
+ }[]
2930
+ arbitrum: {
2931
+ vaultAddress: string
2932
+ protocolName: string
2933
+ /** Format: uri */
2934
+ protocolLogo: string
2935
+ vaultName: string
2936
+ balanceUsd: string
2937
+ balanceNative: string
2938
+ balanceLp: string
2939
+ unclaimedUsd: string
2940
+ unclaimedNative: string
2941
+ apy: {
2942
+ /** @description APY of the vault in BIPS */
2943
+ base: number
2944
+ /** @description APY of the vault rewards in BIPS */
2945
+ rewards?: number
2946
+ /** @description Sum of base APY of the vault and rewards in BIPS */
2947
+ total: number
2948
+ }
2949
+ asset: {
2950
+ /** @description Name of the asset */
2951
+ name: string
2952
+ /** @description Address of the asset */
2953
+ assetAddress: string
2954
+ assetCaip: string
2955
+ /** @description Symbol of the asset */
2956
+ symbol: string
2957
+ /** @description Decimals of the asset */
2958
+ decimals: number
2959
+ }
2960
+ children: {
2961
+ vaultAddress: string
2962
+ protocolName: string
2963
+ /** Format: uri */
2964
+ protocolLogo: string
2965
+ vaultName: string
2966
+ balanceUsd: string
2967
+ balanceNative: string
2968
+ balanceLp: string
2969
+ unclaimedUsd: string
2970
+ unclaimedNative: string
2971
+ apy: {
2972
+ /** @description APY of the vault in BIPS */
2973
+ base: number
2974
+ /** @description APY of the vault rewards in BIPS */
2975
+ rewards?: number
2976
+ /** @description Sum of base APY of the vault and rewards in BIPS */
2977
+ total: number
2978
+ }
2979
+ asset: {
2980
+ /** @description Name of the asset */
2981
+ name: string
2982
+ /** @description Address of the asset */
2983
+ assetAddress: string
2984
+ assetCaip: string
2985
+ /** @description Symbol of the asset */
2986
+ symbol: string
2987
+ /** @description Decimals of the asset */
2988
+ decimals: number
2989
+ }
2990
+ }[]
2991
+ }[]
2992
+ polygon: {
2993
+ vaultAddress: string
2994
+ protocolName: string
2995
+ /** Format: uri */
2996
+ protocolLogo: string
2997
+ vaultName: string
2998
+ balanceUsd: string
2999
+ balanceNative: string
3000
+ balanceLp: string
3001
+ unclaimedUsd: string
3002
+ unclaimedNative: string
3003
+ apy: {
3004
+ /** @description APY of the vault in BIPS */
3005
+ base: number
3006
+ /** @description APY of the vault rewards in BIPS */
3007
+ rewards?: number
3008
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3009
+ total: number
3010
+ }
3011
+ asset: {
3012
+ /** @description Name of the asset */
3013
+ name: string
3014
+ /** @description Address of the asset */
3015
+ assetAddress: string
3016
+ assetCaip: string
3017
+ /** @description Symbol of the asset */
3018
+ symbol: string
3019
+ /** @description Decimals of the asset */
3020
+ decimals: number
3021
+ }
3022
+ children: {
3023
+ vaultAddress: string
3024
+ protocolName: string
3025
+ /** Format: uri */
3026
+ protocolLogo: string
3027
+ vaultName: string
3028
+ balanceUsd: string
3029
+ balanceNative: string
3030
+ balanceLp: string
3031
+ unclaimedUsd: string
3032
+ unclaimedNative: string
3033
+ apy: {
3034
+ /** @description APY of the vault in BIPS */
3035
+ base: number
3036
+ /** @description APY of the vault rewards in BIPS */
3037
+ rewards?: number
3038
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3039
+ total: number
3040
+ }
3041
+ asset: {
3042
+ /** @description Name of the asset */
3043
+ name: string
3044
+ /** @description Address of the asset */
3045
+ assetAddress: string
3046
+ assetCaip: string
3047
+ /** @description Symbol of the asset */
3048
+ symbol: string
3049
+ /** @description Decimals of the asset */
3050
+ decimals: number
3051
+ }
3052
+ }[]
3053
+ }[]
3054
+ gnosis: {
3055
+ vaultAddress: string
3056
+ protocolName: string
3057
+ /** Format: uri */
3058
+ protocolLogo: string
3059
+ vaultName: string
3060
+ balanceUsd: string
3061
+ balanceNative: string
3062
+ balanceLp: string
3063
+ unclaimedUsd: string
3064
+ unclaimedNative: string
3065
+ apy: {
3066
+ /** @description APY of the vault in BIPS */
3067
+ base: number
3068
+ /** @description APY of the vault rewards in BIPS */
3069
+ rewards?: number
3070
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3071
+ total: number
3072
+ }
3073
+ asset: {
3074
+ /** @description Name of the asset */
3075
+ name: string
3076
+ /** @description Address of the asset */
3077
+ assetAddress: string
3078
+ assetCaip: string
3079
+ /** @description Symbol of the asset */
3080
+ symbol: string
3081
+ /** @description Decimals of the asset */
3082
+ decimals: number
3083
+ }
3084
+ children: {
3085
+ vaultAddress: string
3086
+ protocolName: string
3087
+ /** Format: uri */
3088
+ protocolLogo: string
3089
+ vaultName: string
3090
+ balanceUsd: string
3091
+ balanceNative: string
3092
+ balanceLp: string
3093
+ unclaimedUsd: string
3094
+ unclaimedNative: string
3095
+ apy: {
3096
+ /** @description APY of the vault in BIPS */
3097
+ base: number
3098
+ /** @description APY of the vault rewards in BIPS */
3099
+ rewards?: number
3100
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3101
+ total: number
3102
+ }
3103
+ asset: {
3104
+ /** @description Name of the asset */
3105
+ name: string
3106
+ /** @description Address of the asset */
3107
+ assetAddress: string
3108
+ assetCaip: string
3109
+ /** @description Symbol of the asset */
3110
+ symbol: string
3111
+ /** @description Decimals of the asset */
3112
+ decimals: number
3113
+ }
3114
+ }[]
3115
+ }[]
3116
+ base: {
3117
+ vaultAddress: string
3118
+ protocolName: string
3119
+ /** Format: uri */
3120
+ protocolLogo: string
3121
+ vaultName: string
3122
+ balanceUsd: string
3123
+ balanceNative: string
3124
+ balanceLp: string
3125
+ unclaimedUsd: string
3126
+ unclaimedNative: string
3127
+ apy: {
3128
+ /** @description APY of the vault in BIPS */
3129
+ base: number
3130
+ /** @description APY of the vault rewards in BIPS */
3131
+ rewards?: number
3132
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3133
+ total: number
3134
+ }
3135
+ asset: {
3136
+ /** @description Name of the asset */
3137
+ name: string
3138
+ /** @description Address of the asset */
3139
+ assetAddress: string
3140
+ assetCaip: string
3141
+ /** @description Symbol of the asset */
3142
+ symbol: string
3143
+ /** @description Decimals of the asset */
3144
+ decimals: number
3145
+ }
3146
+ children: {
3147
+ vaultAddress: string
3148
+ protocolName: string
3149
+ /** Format: uri */
3150
+ protocolLogo: string
3151
+ vaultName: string
3152
+ balanceUsd: string
3153
+ balanceNative: string
3154
+ balanceLp: string
3155
+ unclaimedUsd: string
3156
+ unclaimedNative: string
3157
+ apy: {
3158
+ /** @description APY of the vault in BIPS */
3159
+ base: number
3160
+ /** @description APY of the vault rewards in BIPS */
3161
+ rewards?: number
3162
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3163
+ total: number
3164
+ }
3165
+ asset: {
3166
+ /** @description Name of the asset */
3167
+ name: string
3168
+ /** @description Address of the asset */
3169
+ assetAddress: string
3170
+ assetCaip: string
3171
+ /** @description Symbol of the asset */
3172
+ symbol: string
3173
+ /** @description Decimals of the asset */
3174
+ decimals: number
3175
+ }
3176
+ }[]
3177
+ }[]
3178
+ unichain: {
3179
+ vaultAddress: string
3180
+ protocolName: string
3181
+ /** Format: uri */
3182
+ protocolLogo: string
3183
+ vaultName: string
3184
+ balanceUsd: string
3185
+ balanceNative: string
3186
+ balanceLp: string
3187
+ unclaimedUsd: string
3188
+ unclaimedNative: string
3189
+ apy: {
3190
+ /** @description APY of the vault in BIPS */
3191
+ base: number
3192
+ /** @description APY of the vault rewards in BIPS */
3193
+ rewards?: number
3194
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3195
+ total: number
3196
+ }
3197
+ asset: {
3198
+ /** @description Name of the asset */
3199
+ name: string
3200
+ /** @description Address of the asset */
3201
+ assetAddress: string
3202
+ assetCaip: string
3203
+ /** @description Symbol of the asset */
3204
+ symbol: string
3205
+ /** @description Decimals of the asset */
3206
+ decimals: number
3207
+ }
3208
+ children: {
3209
+ vaultAddress: string
3210
+ protocolName: string
3211
+ /** Format: uri */
3212
+ protocolLogo: string
3213
+ vaultName: string
3214
+ balanceUsd: string
3215
+ balanceNative: string
3216
+ balanceLp: string
3217
+ unclaimedUsd: string
3218
+ unclaimedNative: string
3219
+ apy: {
3220
+ /** @description APY of the vault in BIPS */
3221
+ base: number
3222
+ /** @description APY of the vault rewards in BIPS */
3223
+ rewards?: number
3224
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3225
+ total: number
3226
+ }
3227
+ asset: {
3228
+ /** @description Name of the asset */
3229
+ name: string
3230
+ /** @description Address of the asset */
3231
+ assetAddress: string
3232
+ assetCaip: string
3233
+ /** @description Symbol of the asset */
3234
+ symbol: string
3235
+ /** @description Decimals of the asset */
3236
+ decimals: number
3237
+ }
3238
+ }[]
3239
+ }[]
3240
+ swellchain: {
3241
+ vaultAddress: string
3242
+ protocolName: string
3243
+ /** Format: uri */
3244
+ protocolLogo: string
3245
+ vaultName: string
3246
+ balanceUsd: string
3247
+ balanceNative: string
3248
+ balanceLp: string
3249
+ unclaimedUsd: string
3250
+ unclaimedNative: string
3251
+ apy: {
3252
+ /** @description APY of the vault in BIPS */
3253
+ base: number
3254
+ /** @description APY of the vault rewards in BIPS */
3255
+ rewards?: number
3256
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3257
+ total: number
3258
+ }
3259
+ asset: {
3260
+ /** @description Name of the asset */
3261
+ name: string
3262
+ /** @description Address of the asset */
3263
+ assetAddress: string
3264
+ assetCaip: string
3265
+ /** @description Symbol of the asset */
3266
+ symbol: string
3267
+ /** @description Decimals of the asset */
3268
+ decimals: number
3269
+ }
3270
+ children: {
3271
+ vaultAddress: string
3272
+ protocolName: string
3273
+ /** Format: uri */
3274
+ protocolLogo: string
3275
+ vaultName: string
3276
+ balanceUsd: string
3277
+ balanceNative: string
3278
+ balanceLp: string
3279
+ unclaimedUsd: string
3280
+ unclaimedNative: string
3281
+ apy: {
3282
+ /** @description APY of the vault in BIPS */
3283
+ base: number
3284
+ /** @description APY of the vault rewards in BIPS */
3285
+ rewards?: number
3286
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3287
+ total: number
3288
+ }
3289
+ asset: {
3290
+ /** @description Name of the asset */
3291
+ name: string
3292
+ /** @description Address of the asset */
3293
+ assetAddress: string
3294
+ assetCaip: string
3295
+ /** @description Symbol of the asset */
3296
+ symbol: string
3297
+ /** @description Decimals of the asset */
3298
+ decimals: number
3299
+ }
3300
+ }[]
3301
+ }[]
3302
+ celo: {
3303
+ vaultAddress: string
3304
+ protocolName: string
3305
+ /** Format: uri */
3306
+ protocolLogo: string
3307
+ vaultName: string
3308
+ balanceUsd: string
3309
+ balanceNative: string
3310
+ balanceLp: string
3311
+ unclaimedUsd: string
3312
+ unclaimedNative: string
3313
+ apy: {
3314
+ /** @description APY of the vault in BIPS */
3315
+ base: number
3316
+ /** @description APY of the vault rewards in BIPS */
3317
+ rewards?: number
3318
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3319
+ total: number
3320
+ }
3321
+ asset: {
3322
+ /** @description Name of the asset */
3323
+ name: string
3324
+ /** @description Address of the asset */
3325
+ assetAddress: string
3326
+ assetCaip: string
3327
+ /** @description Symbol of the asset */
3328
+ symbol: string
3329
+ /** @description Decimals of the asset */
3330
+ decimals: number
3331
+ }
3332
+ children: {
3333
+ vaultAddress: string
3334
+ protocolName: string
3335
+ /** Format: uri */
3336
+ protocolLogo: string
3337
+ vaultName: string
3338
+ balanceUsd: string
3339
+ balanceNative: string
3340
+ balanceLp: string
3341
+ unclaimedUsd: string
3342
+ unclaimedNative: string
3343
+ apy: {
3344
+ /** @description APY of the vault in BIPS */
3345
+ base: number
3346
+ /** @description APY of the vault rewards in BIPS */
3347
+ rewards?: number
3348
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3349
+ total: number
3350
+ }
3351
+ asset: {
3352
+ /** @description Name of the asset */
3353
+ name: string
3354
+ /** @description Address of the asset */
3355
+ assetAddress: string
3356
+ assetCaip: string
3357
+ /** @description Symbol of the asset */
3358
+ symbol: string
3359
+ /** @description Decimals of the asset */
3360
+ decimals: number
3361
+ }
3362
+ }[]
3363
+ }[]
3364
+ }
3365
+ }
3366
+ }
3367
+ /** @description Default Response */
3368
+ 301: {
3369
+ headers: {
3370
+ [name: string]: unknown
3371
+ }
3372
+ content: {
3373
+ 'application/json': {
3374
+ mainnet: {
3375
+ vaultAddress: string
3376
+ protocolName: string
3377
+ /** Format: uri */
3378
+ protocolLogo: string
3379
+ vaultName: string
3380
+ balanceUsd: string
3381
+ balanceNative: string
3382
+ balanceLp: string
3383
+ unclaimedUsd: string
3384
+ unclaimedNative: string
3385
+ apy: {
3386
+ /** @description APY of the vault in BIPS */
3387
+ base: number
3388
+ /** @description APY of the vault rewards in BIPS */
3389
+ rewards?: number
3390
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3391
+ total: number
3392
+ }
3393
+ asset: {
3394
+ /** @description Name of the asset */
3395
+ name: string
3396
+ /** @description Address of the asset */
3397
+ assetAddress: string
3398
+ assetCaip: string
3399
+ /** @description Symbol of the asset */
3400
+ symbol: string
3401
+ /** @description Decimals of the asset */
3402
+ decimals: number
3403
+ }
3404
+ children: {
3405
+ vaultAddress: string
3406
+ protocolName: string
3407
+ /** Format: uri */
3408
+ protocolLogo: string
3409
+ vaultName: string
3410
+ balanceUsd: string
3411
+ balanceNative: string
3412
+ balanceLp: string
3413
+ unclaimedUsd: string
3414
+ unclaimedNative: string
3415
+ apy: {
3416
+ /** @description APY of the vault in BIPS */
3417
+ base: number
3418
+ /** @description APY of the vault rewards in BIPS */
3419
+ rewards?: number
3420
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3421
+ total: number
3422
+ }
3423
+ asset: {
3424
+ /** @description Name of the asset */
3425
+ name: string
3426
+ /** @description Address of the asset */
3427
+ assetAddress: string
3428
+ assetCaip: string
3429
+ /** @description Symbol of the asset */
3430
+ symbol: string
3431
+ /** @description Decimals of the asset */
3432
+ decimals: number
3433
+ }
3434
+ }[]
3435
+ }[]
3436
+ optimism: {
3437
+ vaultAddress: string
3438
+ protocolName: string
3439
+ /** Format: uri */
3440
+ protocolLogo: string
3441
+ vaultName: string
3442
+ balanceUsd: string
3443
+ balanceNative: string
3444
+ balanceLp: string
3445
+ unclaimedUsd: string
3446
+ unclaimedNative: string
3447
+ apy: {
3448
+ /** @description APY of the vault in BIPS */
3449
+ base: number
3450
+ /** @description APY of the vault rewards in BIPS */
3451
+ rewards?: number
3452
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3453
+ total: number
3454
+ }
3455
+ asset: {
3456
+ /** @description Name of the asset */
3457
+ name: string
3458
+ /** @description Address of the asset */
3459
+ assetAddress: string
3460
+ assetCaip: string
3461
+ /** @description Symbol of the asset */
3462
+ symbol: string
3463
+ /** @description Decimals of the asset */
3464
+ decimals: number
3465
+ }
3466
+ children: {
3467
+ vaultAddress: string
3468
+ protocolName: string
3469
+ /** Format: uri */
3470
+ protocolLogo: string
3471
+ vaultName: string
3472
+ balanceUsd: string
3473
+ balanceNative: string
3474
+ balanceLp: string
3475
+ unclaimedUsd: string
3476
+ unclaimedNative: string
3477
+ apy: {
3478
+ /** @description APY of the vault in BIPS */
3479
+ base: number
3480
+ /** @description APY of the vault rewards in BIPS */
3481
+ rewards?: number
3482
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3483
+ total: number
3484
+ }
3485
+ asset: {
3486
+ /** @description Name of the asset */
3487
+ name: string
3488
+ /** @description Address of the asset */
3489
+ assetAddress: string
3490
+ assetCaip: string
3491
+ /** @description Symbol of the asset */
3492
+ symbol: string
3493
+ /** @description Decimals of the asset */
3494
+ decimals: number
3495
+ }
3496
+ }[]
3497
+ }[]
3498
+ arbitrum: {
3499
+ vaultAddress: string
3500
+ protocolName: string
3501
+ /** Format: uri */
3502
+ protocolLogo: string
3503
+ vaultName: string
3504
+ balanceUsd: string
3505
+ balanceNative: string
3506
+ balanceLp: string
3507
+ unclaimedUsd: string
3508
+ unclaimedNative: string
3509
+ apy: {
3510
+ /** @description APY of the vault in BIPS */
3511
+ base: number
3512
+ /** @description APY of the vault rewards in BIPS */
3513
+ rewards?: number
3514
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3515
+ total: number
3516
+ }
3517
+ asset: {
3518
+ /** @description Name of the asset */
3519
+ name: string
3520
+ /** @description Address of the asset */
3521
+ assetAddress: string
3522
+ assetCaip: string
3523
+ /** @description Symbol of the asset */
3524
+ symbol: string
3525
+ /** @description Decimals of the asset */
3526
+ decimals: number
3527
+ }
3528
+ children: {
3529
+ vaultAddress: string
3530
+ protocolName: string
3531
+ /** Format: uri */
3532
+ protocolLogo: string
3533
+ vaultName: string
3534
+ balanceUsd: string
3535
+ balanceNative: string
3536
+ balanceLp: string
3537
+ unclaimedUsd: string
3538
+ unclaimedNative: string
3539
+ apy: {
3540
+ /** @description APY of the vault in BIPS */
3541
+ base: number
3542
+ /** @description APY of the vault rewards in BIPS */
3543
+ rewards?: number
3544
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3545
+ total: number
3546
+ }
3547
+ asset: {
3548
+ /** @description Name of the asset */
3549
+ name: string
3550
+ /** @description Address of the asset */
3551
+ assetAddress: string
3552
+ assetCaip: string
3553
+ /** @description Symbol of the asset */
3554
+ symbol: string
3555
+ /** @description Decimals of the asset */
3556
+ decimals: number
3557
+ }
3558
+ }[]
3559
+ }[]
3560
+ polygon: {
3561
+ vaultAddress: string
3562
+ protocolName: string
3563
+ /** Format: uri */
3564
+ protocolLogo: string
3565
+ vaultName: string
3566
+ balanceUsd: string
3567
+ balanceNative: string
3568
+ balanceLp: string
3569
+ unclaimedUsd: string
3570
+ unclaimedNative: string
3571
+ apy: {
3572
+ /** @description APY of the vault in BIPS */
3573
+ base: number
3574
+ /** @description APY of the vault rewards in BIPS */
3575
+ rewards?: number
3576
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3577
+ total: number
3578
+ }
3579
+ asset: {
3580
+ /** @description Name of the asset */
3581
+ name: string
3582
+ /** @description Address of the asset */
3583
+ assetAddress: string
3584
+ assetCaip: string
3585
+ /** @description Symbol of the asset */
3586
+ symbol: string
3587
+ /** @description Decimals of the asset */
3588
+ decimals: number
3589
+ }
3590
+ children: {
3591
+ vaultAddress: string
3592
+ protocolName: string
3593
+ /** Format: uri */
3594
+ protocolLogo: string
3595
+ vaultName: string
3596
+ balanceUsd: string
3597
+ balanceNative: string
3598
+ balanceLp: string
3599
+ unclaimedUsd: string
3600
+ unclaimedNative: string
3601
+ apy: {
3602
+ /** @description APY of the vault in BIPS */
3603
+ base: number
3604
+ /** @description APY of the vault rewards in BIPS */
3605
+ rewards?: number
3606
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3607
+ total: number
3608
+ }
3609
+ asset: {
3610
+ /** @description Name of the asset */
3611
+ name: string
3612
+ /** @description Address of the asset */
3613
+ assetAddress: string
3614
+ assetCaip: string
3615
+ /** @description Symbol of the asset */
3616
+ symbol: string
3617
+ /** @description Decimals of the asset */
3618
+ decimals: number
3619
+ }
3620
+ }[]
3621
+ }[]
3622
+ gnosis: {
3623
+ vaultAddress: string
3624
+ protocolName: string
3625
+ /** Format: uri */
3626
+ protocolLogo: string
3627
+ vaultName: string
3628
+ balanceUsd: string
3629
+ balanceNative: string
3630
+ balanceLp: string
3631
+ unclaimedUsd: string
3632
+ unclaimedNative: string
3633
+ apy: {
3634
+ /** @description APY of the vault in BIPS */
3635
+ base: number
3636
+ /** @description APY of the vault rewards in BIPS */
3637
+ rewards?: number
3638
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3639
+ total: number
3640
+ }
3641
+ asset: {
3642
+ /** @description Name of the asset */
3643
+ name: string
3644
+ /** @description Address of the asset */
3645
+ assetAddress: string
3646
+ assetCaip: string
3647
+ /** @description Symbol of the asset */
3648
+ symbol: string
3649
+ /** @description Decimals of the asset */
3650
+ decimals: number
3651
+ }
3652
+ children: {
3653
+ vaultAddress: string
3654
+ protocolName: string
3655
+ /** Format: uri */
3656
+ protocolLogo: string
3657
+ vaultName: string
3658
+ balanceUsd: string
3659
+ balanceNative: string
3660
+ balanceLp: string
3661
+ unclaimedUsd: string
3662
+ unclaimedNative: string
3663
+ apy: {
3664
+ /** @description APY of the vault in BIPS */
3665
+ base: number
3666
+ /** @description APY of the vault rewards in BIPS */
3667
+ rewards?: number
3668
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3669
+ total: number
3670
+ }
3671
+ asset: {
3672
+ /** @description Name of the asset */
3673
+ name: string
3674
+ /** @description Address of the asset */
3675
+ assetAddress: string
3676
+ assetCaip: string
3677
+ /** @description Symbol of the asset */
3678
+ symbol: string
3679
+ /** @description Decimals of the asset */
3680
+ decimals: number
3681
+ }
3682
+ }[]
3683
+ }[]
3684
+ base: {
3685
+ vaultAddress: string
3686
+ protocolName: string
3687
+ /** Format: uri */
3688
+ protocolLogo: string
3689
+ vaultName: string
3690
+ balanceUsd: string
3691
+ balanceNative: string
3692
+ balanceLp: string
3693
+ unclaimedUsd: string
3694
+ unclaimedNative: string
3695
+ apy: {
3696
+ /** @description APY of the vault in BIPS */
3697
+ base: number
3698
+ /** @description APY of the vault rewards in BIPS */
3699
+ rewards?: number
3700
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3701
+ total: number
3702
+ }
3703
+ asset: {
3704
+ /** @description Name of the asset */
3705
+ name: string
3706
+ /** @description Address of the asset */
3707
+ assetAddress: string
3708
+ assetCaip: string
3709
+ /** @description Symbol of the asset */
3710
+ symbol: string
3711
+ /** @description Decimals of the asset */
3712
+ decimals: number
3713
+ }
3714
+ children: {
3715
+ vaultAddress: string
3716
+ protocolName: string
3717
+ /** Format: uri */
3718
+ protocolLogo: string
3719
+ vaultName: string
3720
+ balanceUsd: string
3721
+ balanceNative: string
3722
+ balanceLp: string
3723
+ unclaimedUsd: string
3724
+ unclaimedNative: string
3725
+ apy: {
3726
+ /** @description APY of the vault in BIPS */
3727
+ base: number
3728
+ /** @description APY of the vault rewards in BIPS */
3729
+ rewards?: number
3730
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3731
+ total: number
3732
+ }
3733
+ asset: {
3734
+ /** @description Name of the asset */
3735
+ name: string
3736
+ /** @description Address of the asset */
3737
+ assetAddress: string
3738
+ assetCaip: string
3739
+ /** @description Symbol of the asset */
3740
+ symbol: string
3741
+ /** @description Decimals of the asset */
3742
+ decimals: number
3743
+ }
3744
+ }[]
3745
+ }[]
3746
+ unichain: {
3747
+ vaultAddress: string
3748
+ protocolName: string
3749
+ /** Format: uri */
3750
+ protocolLogo: string
3751
+ vaultName: string
3752
+ balanceUsd: string
3753
+ balanceNative: string
3754
+ balanceLp: string
3755
+ unclaimedUsd: string
3756
+ unclaimedNative: string
3757
+ apy: {
3758
+ /** @description APY of the vault in BIPS */
3759
+ base: number
3760
+ /** @description APY of the vault rewards in BIPS */
3761
+ rewards?: number
3762
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3763
+ total: number
3764
+ }
3765
+ asset: {
3766
+ /** @description Name of the asset */
3767
+ name: string
3768
+ /** @description Address of the asset */
3769
+ assetAddress: string
3770
+ assetCaip: string
3771
+ /** @description Symbol of the asset */
3772
+ symbol: string
3773
+ /** @description Decimals of the asset */
3774
+ decimals: number
3775
+ }
3776
+ children: {
3777
+ vaultAddress: string
3778
+ protocolName: string
3779
+ /** Format: uri */
3780
+ protocolLogo: string
3781
+ vaultName: string
3782
+ balanceUsd: string
3783
+ balanceNative: string
3784
+ balanceLp: string
3785
+ unclaimedUsd: string
3786
+ unclaimedNative: string
3787
+ apy: {
3788
+ /** @description APY of the vault in BIPS */
3789
+ base: number
3790
+ /** @description APY of the vault rewards in BIPS */
3791
+ rewards?: number
3792
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3793
+ total: number
3794
+ }
3795
+ asset: {
3796
+ /** @description Name of the asset */
3797
+ name: string
3798
+ /** @description Address of the asset */
3799
+ assetAddress: string
3800
+ assetCaip: string
3801
+ /** @description Symbol of the asset */
3802
+ symbol: string
3803
+ /** @description Decimals of the asset */
3804
+ decimals: number
3805
+ }
3806
+ }[]
3807
+ }[]
3808
+ swellchain: {
3809
+ vaultAddress: string
3810
+ protocolName: string
3811
+ /** Format: uri */
3812
+ protocolLogo: string
3813
+ vaultName: string
3814
+ balanceUsd: string
3815
+ balanceNative: string
3816
+ balanceLp: string
3817
+ unclaimedUsd: string
3818
+ unclaimedNative: string
3819
+ apy: {
3820
+ /** @description APY of the vault in BIPS */
3821
+ base: number
3822
+ /** @description APY of the vault rewards in BIPS */
3823
+ rewards?: number
3824
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3825
+ total: number
3826
+ }
3827
+ asset: {
3828
+ /** @description Name of the asset */
3829
+ name: string
3830
+ /** @description Address of the asset */
3831
+ assetAddress: string
3832
+ assetCaip: string
3833
+ /** @description Symbol of the asset */
3834
+ symbol: string
3835
+ /** @description Decimals of the asset */
3836
+ decimals: number
3837
+ }
3838
+ children: {
3839
+ vaultAddress: string
3840
+ protocolName: string
3841
+ /** Format: uri */
3842
+ protocolLogo: string
3843
+ vaultName: string
3844
+ balanceUsd: string
3845
+ balanceNative: string
3846
+ balanceLp: string
3847
+ unclaimedUsd: string
3848
+ unclaimedNative: string
3849
+ apy: {
3850
+ /** @description APY of the vault in BIPS */
3851
+ base: number
3852
+ /** @description APY of the vault rewards in BIPS */
3853
+ rewards?: number
3854
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3855
+ total: number
3856
+ }
3857
+ asset: {
3858
+ /** @description Name of the asset */
3859
+ name: string
3860
+ /** @description Address of the asset */
3861
+ assetAddress: string
3862
+ assetCaip: string
3863
+ /** @description Symbol of the asset */
3864
+ symbol: string
3865
+ /** @description Decimals of the asset */
3866
+ decimals: number
3867
+ }
3868
+ }[]
3869
+ }[]
3870
+ celo: {
3871
+ vaultAddress: string
3872
+ protocolName: string
3873
+ /** Format: uri */
3874
+ protocolLogo: string
3875
+ vaultName: string
3876
+ balanceUsd: string
3877
+ balanceNative: string
3878
+ balanceLp: string
3879
+ unclaimedUsd: string
3880
+ unclaimedNative: string
3881
+ apy: {
3882
+ /** @description APY of the vault in BIPS */
3883
+ base: number
3884
+ /** @description APY of the vault rewards in BIPS */
3885
+ rewards?: number
3886
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3887
+ total: number
3888
+ }
3889
+ asset: {
3890
+ /** @description Name of the asset */
3891
+ name: string
3892
+ /** @description Address of the asset */
3893
+ assetAddress: string
3894
+ assetCaip: string
3895
+ /** @description Symbol of the asset */
3896
+ symbol: string
3897
+ /** @description Decimals of the asset */
3898
+ decimals: number
3899
+ }
3900
+ children: {
3901
+ vaultAddress: string
3902
+ protocolName: string
3903
+ /** Format: uri */
3904
+ protocolLogo: string
3905
+ vaultName: string
3906
+ balanceUsd: string
3907
+ balanceNative: string
3908
+ balanceLp: string
3909
+ unclaimedUsd: string
3910
+ unclaimedNative: string
3911
+ apy: {
3912
+ /** @description APY of the vault in BIPS */
3913
+ base: number
3914
+ /** @description APY of the vault rewards in BIPS */
3915
+ rewards?: number
3916
+ /** @description Sum of base APY of the vault and rewards in BIPS */
3917
+ total: number
3918
+ }
3919
+ asset: {
3920
+ /** @description Name of the asset */
3921
+ name: string
3922
+ /** @description Address of the asset */
3923
+ assetAddress: string
3924
+ assetCaip: string
3925
+ /** @description Symbol of the asset */
3926
+ symbol: string
3927
+ /** @description Decimals of the asset */
3928
+ decimals: number
3929
+ }
3930
+ }[]
3931
+ }[]
3932
+ }
3933
+ }
3934
+ }
3935
+ }
3936
+ }
3937
+ put?: never
3938
+ post?: never
3939
+ delete?: never
3940
+ options?: never
3941
+ head?: never
3942
+ patch?: never
3943
+ trace?: never
3944
+ }
3945
+ }
3946
+ export type webhooks = Record<string, never>
3947
+ export interface components {
3948
+ schemas: never
3949
+ responses: never
3950
+ parameters: never
3951
+ requestBodies: never
3952
+ headers: never
3953
+ pathItems: never
3954
+ }
3955
+ export type $defs = Record<string, never>
3956
+ export type operations = Record<string, never>