@compass-labs/api-sdk 2.2.33 → 2.2.34-rc.1

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.
Files changed (312) hide show
  1. package/README.md +20 -1
  2. package/codeSamples_typescript.yaml +48 -0
  3. package/dist/commonjs/funcs/tradFiTradfiCancelOrder.d.ts +21 -0
  4. package/dist/commonjs/funcs/tradFiTradfiCancelOrder.d.ts.map +1 -0
  5. package/dist/commonjs/funcs/tradFiTradfiCancelOrder.js +121 -0
  6. package/dist/commonjs/funcs/tradFiTradfiCancelOrder.js.map +1 -0
  7. package/dist/commonjs/funcs/tradFiTradfiCreateAccount.d.ts +24 -0
  8. package/dist/commonjs/funcs/tradFiTradfiCreateAccount.d.ts.map +1 -0
  9. package/dist/commonjs/funcs/tradFiTradfiCreateAccount.js +124 -0
  10. package/dist/commonjs/funcs/tradFiTradfiCreateAccount.js.map +1 -0
  11. package/dist/commonjs/funcs/tradFiTradfiDeposit.d.ts +23 -0
  12. package/dist/commonjs/funcs/tradFiTradfiDeposit.d.ts.map +1 -0
  13. package/dist/commonjs/funcs/tradFiTradfiDeposit.js +123 -0
  14. package/dist/commonjs/funcs/tradFiTradfiDeposit.js.map +1 -0
  15. package/dist/commonjs/funcs/tradFiTradfiLimitOrder.d.ts +24 -0
  16. package/dist/commonjs/funcs/tradFiTradfiLimitOrder.d.ts.map +1 -0
  17. package/dist/commonjs/funcs/tradFiTradfiLimitOrder.js +124 -0
  18. package/dist/commonjs/funcs/tradFiTradfiLimitOrder.js.map +1 -0
  19. package/dist/commonjs/funcs/tradFiTradfiMarketOrder.d.ts +25 -0
  20. package/dist/commonjs/funcs/tradFiTradfiMarketOrder.d.ts.map +1 -0
  21. package/dist/commonjs/funcs/tradFiTradfiMarketOrder.js +125 -0
  22. package/dist/commonjs/funcs/tradFiTradfiMarketOrder.js.map +1 -0
  23. package/dist/commonjs/funcs/tradFiTradfiOpportunities.d.ts +25 -0
  24. package/dist/commonjs/funcs/tradFiTradfiOpportunities.d.ts.map +1 -0
  25. package/dist/commonjs/funcs/tradFiTradfiOpportunities.js +132 -0
  26. package/dist/commonjs/funcs/tradFiTradfiOpportunities.js.map +1 -0
  27. package/dist/commonjs/funcs/tradFiTradfiPositions.d.ts +25 -0
  28. package/dist/commonjs/funcs/tradFiTradfiPositions.d.ts.map +1 -0
  29. package/dist/commonjs/funcs/tradFiTradfiPositions.js +129 -0
  30. package/dist/commonjs/funcs/tradFiTradfiPositions.js.map +1 -0
  31. package/dist/commonjs/funcs/tradFiTradfiWithdraw.d.ts +23 -0
  32. package/dist/commonjs/funcs/tradFiTradfiWithdraw.d.ts.map +1 -0
  33. package/dist/commonjs/funcs/tradFiTradfiWithdraw.js +123 -0
  34. package/dist/commonjs/funcs/tradFiTradfiWithdraw.js.map +1 -0
  35. package/dist/commonjs/lib/config.d.ts +2 -2
  36. package/dist/commonjs/lib/config.js +2 -2
  37. package/dist/commonjs/lib/config.js.map +1 -1
  38. package/dist/commonjs/lib/security.d.ts +1 -1
  39. package/dist/commonjs/lib/security.d.ts.map +1 -1
  40. package/dist/commonjs/lib/security.js +19 -8
  41. package/dist/commonjs/lib/security.js.map +1 -1
  42. package/dist/commonjs/models/components/chain.d.ts +1 -0
  43. package/dist/commonjs/models/components/chain.d.ts.map +1 -1
  44. package/dist/commonjs/models/components/chain.js +1 -0
  45. package/dist/commonjs/models/components/chain.js.map +1 -1
  46. package/dist/commonjs/models/components/createtradfiaccountrequest.d.ts +37 -0
  47. package/dist/commonjs/models/components/createtradfiaccountrequest.d.ts.map +1 -0
  48. package/dist/commonjs/models/components/createtradfiaccountrequest.js +62 -0
  49. package/dist/commonjs/models/components/createtradfiaccountrequest.js.map +1 -0
  50. package/dist/commonjs/models/components/createtradfiaccountresponse.d.ts +21 -0
  51. package/dist/commonjs/models/components/createtradfiaccountresponse.d.ts.map +1 -0
  52. package/dist/commonjs/models/components/createtradfiaccountresponse.js +57 -0
  53. package/dist/commonjs/models/components/createtradfiaccountresponse.js.map +1 -0
  54. package/dist/commonjs/models/components/index.d.ts +15 -0
  55. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  56. package/dist/commonjs/models/components/index.js +15 -0
  57. package/dist/commonjs/models/components/index.js.map +1 -1
  58. package/dist/commonjs/models/components/tradficancelorderrequest.d.ts +33 -0
  59. package/dist/commonjs/models/components/tradficancelorderrequest.d.ts.map +1 -0
  60. package/dist/commonjs/models/components/tradficancelorderrequest.js +58 -0
  61. package/dist/commonjs/models/components/tradficancelorderrequest.js.map +1 -0
  62. package/dist/commonjs/models/components/tradficategory.d.ts +11 -0
  63. package/dist/commonjs/models/components/tradficategory.d.ts.map +1 -0
  64. package/dist/commonjs/models/components/tradficategory.js +48 -0
  65. package/dist/commonjs/models/components/tradficategory.js.map +1 -0
  66. package/dist/commonjs/models/components/tradfidepositrequest.d.ts +23 -0
  67. package/dist/commonjs/models/components/tradfidepositrequest.d.ts.map +1 -0
  68. package/dist/commonjs/models/components/tradfidepositrequest.js +50 -0
  69. package/dist/commonjs/models/components/tradfidepositrequest.js.map +1 -0
  70. package/dist/commonjs/models/components/tradfidepositresponse.d.ts +17 -0
  71. package/dist/commonjs/models/components/tradfidepositresponse.d.ts.map +1 -0
  72. package/dist/commonjs/models/components/tradfidepositresponse.js +51 -0
  73. package/dist/commonjs/models/components/tradfidepositresponse.js.map +1 -0
  74. package/dist/commonjs/models/components/tradfilimitorderrequest.d.ts +53 -0
  75. package/dist/commonjs/models/components/tradfilimitorderrequest.d.ts.map +1 -0
  76. package/dist/commonjs/models/components/tradfilimitorderrequest.js +63 -0
  77. package/dist/commonjs/models/components/tradfilimitorderrequest.js.map +1 -0
  78. package/dist/commonjs/models/components/tradfimarketorderrequest.d.ts +43 -0
  79. package/dist/commonjs/models/components/tradfimarketorderrequest.d.ts.map +1 -0
  80. package/dist/commonjs/models/components/tradfimarketorderrequest.js +60 -0
  81. package/dist/commonjs/models/components/tradfimarketorderrequest.js.map +1 -0
  82. package/dist/commonjs/models/components/tradfiopportunitiesresponse.d.ts +17 -0
  83. package/dist/commonjs/models/components/tradfiopportunitiesresponse.d.ts.map +1 -0
  84. package/dist/commonjs/models/components/tradfiopportunitiesresponse.js +51 -0
  85. package/dist/commonjs/models/components/tradfiopportunitiesresponse.js.map +1 -0
  86. package/dist/commonjs/models/components/tradfiopportunity.d.ts +52 -0
  87. package/dist/commonjs/models/components/tradfiopportunity.d.ts.map +1 -0
  88. package/dist/commonjs/models/components/tradfiopportunity.js +71 -0
  89. package/dist/commonjs/models/components/tradfiopportunity.js.map +1 -0
  90. package/dist/commonjs/models/components/tradfiorderresponse.d.ts +14 -0
  91. package/dist/commonjs/models/components/tradfiorderresponse.d.ts.map +1 -0
  92. package/dist/commonjs/models/components/tradfiorderresponse.js +51 -0
  93. package/dist/commonjs/models/components/tradfiorderresponse.js.map +1 -0
  94. package/dist/commonjs/models/components/tradfiposition.d.ts +70 -0
  95. package/dist/commonjs/models/components/tradfiposition.d.ts.map +1 -0
  96. package/dist/commonjs/models/components/tradfiposition.js +80 -0
  97. package/dist/commonjs/models/components/tradfiposition.js.map +1 -0
  98. package/dist/commonjs/models/components/tradfipositionsresponse.d.ts +17 -0
  99. package/dist/commonjs/models/components/tradfipositionsresponse.d.ts.map +1 -0
  100. package/dist/commonjs/models/components/tradfipositionsresponse.js +51 -0
  101. package/dist/commonjs/models/components/tradfipositionsresponse.js.map +1 -0
  102. package/dist/commonjs/models/components/tradfiwithdrawrequest.d.ts +28 -0
  103. package/dist/commonjs/models/components/tradfiwithdrawrequest.d.ts.map +1 -0
  104. package/dist/commonjs/models/components/tradfiwithdrawrequest.js +51 -0
  105. package/dist/commonjs/models/components/tradfiwithdrawrequest.js.map +1 -0
  106. package/dist/commonjs/models/components/tradfiwithdrawresponse.d.ts +17 -0
  107. package/dist/commonjs/models/components/tradfiwithdrawresponse.d.ts.map +1 -0
  108. package/dist/commonjs/models/components/tradfiwithdrawresponse.js +51 -0
  109. package/dist/commonjs/models/components/tradfiwithdrawresponse.js.map +1 -0
  110. package/dist/commonjs/models/operations/index.d.ts +2 -0
  111. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  112. package/dist/commonjs/models/operations/index.js +2 -0
  113. package/dist/commonjs/models/operations/index.js.map +1 -1
  114. package/dist/commonjs/models/operations/v2tradfiopportunities.d.ts +64 -0
  115. package/dist/commonjs/models/operations/v2tradfiopportunities.d.ts.map +1 -0
  116. package/dist/commonjs/models/operations/v2tradfiopportunities.js +81 -0
  117. package/dist/commonjs/models/operations/v2tradfiopportunities.js.map +1 -0
  118. package/dist/commonjs/models/operations/v2tradfipositions.d.ts +20 -0
  119. package/dist/commonjs/models/operations/v2tradfipositions.d.ts.map +1 -0
  120. package/dist/commonjs/models/operations/v2tradfipositions.js +50 -0
  121. package/dist/commonjs/models/operations/v2tradfipositions.js.map +1 -0
  122. package/dist/commonjs/sdk/sdk.d.ts +3 -0
  123. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  124. package/dist/commonjs/sdk/sdk.js +4 -0
  125. package/dist/commonjs/sdk/sdk.js.map +1 -1
  126. package/dist/commonjs/sdk/tradfi.d.ts +106 -0
  127. package/dist/commonjs/sdk/tradfi.d.ts.map +1 -0
  128. package/dist/commonjs/sdk/tradfi.js +136 -0
  129. package/dist/commonjs/sdk/tradfi.js.map +1 -0
  130. package/dist/esm/funcs/tradFiTradfiCancelOrder.d.ts +21 -0
  131. package/dist/esm/funcs/tradFiTradfiCancelOrder.d.ts.map +1 -0
  132. package/dist/esm/funcs/tradFiTradfiCancelOrder.js +85 -0
  133. package/dist/esm/funcs/tradFiTradfiCancelOrder.js.map +1 -0
  134. package/dist/esm/funcs/tradFiTradfiCreateAccount.d.ts +24 -0
  135. package/dist/esm/funcs/tradFiTradfiCreateAccount.d.ts.map +1 -0
  136. package/dist/esm/funcs/tradFiTradfiCreateAccount.js +88 -0
  137. package/dist/esm/funcs/tradFiTradfiCreateAccount.js.map +1 -0
  138. package/dist/esm/funcs/tradFiTradfiDeposit.d.ts +23 -0
  139. package/dist/esm/funcs/tradFiTradfiDeposit.d.ts.map +1 -0
  140. package/dist/esm/funcs/tradFiTradfiDeposit.js +87 -0
  141. package/dist/esm/funcs/tradFiTradfiDeposit.js.map +1 -0
  142. package/dist/esm/funcs/tradFiTradfiLimitOrder.d.ts +24 -0
  143. package/dist/esm/funcs/tradFiTradfiLimitOrder.d.ts.map +1 -0
  144. package/dist/esm/funcs/tradFiTradfiLimitOrder.js +88 -0
  145. package/dist/esm/funcs/tradFiTradfiLimitOrder.js.map +1 -0
  146. package/dist/esm/funcs/tradFiTradfiMarketOrder.d.ts +25 -0
  147. package/dist/esm/funcs/tradFiTradfiMarketOrder.d.ts.map +1 -0
  148. package/dist/esm/funcs/tradFiTradfiMarketOrder.js +89 -0
  149. package/dist/esm/funcs/tradFiTradfiMarketOrder.js.map +1 -0
  150. package/dist/esm/funcs/tradFiTradfiOpportunities.d.ts +25 -0
  151. package/dist/esm/funcs/tradFiTradfiOpportunities.d.ts.map +1 -0
  152. package/dist/esm/funcs/tradFiTradfiOpportunities.js +96 -0
  153. package/dist/esm/funcs/tradFiTradfiOpportunities.js.map +1 -0
  154. package/dist/esm/funcs/tradFiTradfiPositions.d.ts +25 -0
  155. package/dist/esm/funcs/tradFiTradfiPositions.d.ts.map +1 -0
  156. package/dist/esm/funcs/tradFiTradfiPositions.js +93 -0
  157. package/dist/esm/funcs/tradFiTradfiPositions.js.map +1 -0
  158. package/dist/esm/funcs/tradFiTradfiWithdraw.d.ts +23 -0
  159. package/dist/esm/funcs/tradFiTradfiWithdraw.d.ts.map +1 -0
  160. package/dist/esm/funcs/tradFiTradfiWithdraw.js +87 -0
  161. package/dist/esm/funcs/tradFiTradfiWithdraw.js.map +1 -0
  162. package/dist/esm/lib/config.d.ts +2 -2
  163. package/dist/esm/lib/config.js +2 -2
  164. package/dist/esm/lib/config.js.map +1 -1
  165. package/dist/esm/lib/security.d.ts +1 -1
  166. package/dist/esm/lib/security.d.ts.map +1 -1
  167. package/dist/esm/lib/security.js +19 -8
  168. package/dist/esm/lib/security.js.map +1 -1
  169. package/dist/esm/models/components/chain.d.ts +1 -0
  170. package/dist/esm/models/components/chain.d.ts.map +1 -1
  171. package/dist/esm/models/components/chain.js +1 -0
  172. package/dist/esm/models/components/chain.js.map +1 -1
  173. package/dist/esm/models/components/createtradfiaccountrequest.d.ts +37 -0
  174. package/dist/esm/models/components/createtradfiaccountrequest.d.ts.map +1 -0
  175. package/dist/esm/models/components/createtradfiaccountrequest.js +25 -0
  176. package/dist/esm/models/components/createtradfiaccountrequest.js.map +1 -0
  177. package/dist/esm/models/components/createtradfiaccountresponse.d.ts +21 -0
  178. package/dist/esm/models/components/createtradfiaccountresponse.d.ts.map +1 -0
  179. package/dist/esm/models/components/createtradfiaccountresponse.js +20 -0
  180. package/dist/esm/models/components/createtradfiaccountresponse.js.map +1 -0
  181. package/dist/esm/models/components/index.d.ts +15 -0
  182. package/dist/esm/models/components/index.d.ts.map +1 -1
  183. package/dist/esm/models/components/index.js +15 -0
  184. package/dist/esm/models/components/index.js.map +1 -1
  185. package/dist/esm/models/components/tradficancelorderrequest.d.ts +33 -0
  186. package/dist/esm/models/components/tradficancelorderrequest.d.ts.map +1 -0
  187. package/dist/esm/models/components/tradficancelorderrequest.js +21 -0
  188. package/dist/esm/models/components/tradficancelorderrequest.js.map +1 -0
  189. package/dist/esm/models/components/tradficategory.d.ts +11 -0
  190. package/dist/esm/models/components/tradficategory.d.ts.map +1 -0
  191. package/dist/esm/models/components/tradficategory.js +12 -0
  192. package/dist/esm/models/components/tradficategory.js.map +1 -0
  193. package/dist/esm/models/components/tradfidepositrequest.d.ts +23 -0
  194. package/dist/esm/models/components/tradfidepositrequest.d.ts.map +1 -0
  195. package/dist/esm/models/components/tradfidepositrequest.js +13 -0
  196. package/dist/esm/models/components/tradfidepositrequest.js.map +1 -0
  197. package/dist/esm/models/components/tradfidepositresponse.d.ts +17 -0
  198. package/dist/esm/models/components/tradfidepositresponse.d.ts.map +1 -0
  199. package/dist/esm/models/components/tradfidepositresponse.js +14 -0
  200. package/dist/esm/models/components/tradfidepositresponse.js.map +1 -0
  201. package/dist/esm/models/components/tradfilimitorderrequest.d.ts +53 -0
  202. package/dist/esm/models/components/tradfilimitorderrequest.d.ts.map +1 -0
  203. package/dist/esm/models/components/tradfilimitorderrequest.js +26 -0
  204. package/dist/esm/models/components/tradfilimitorderrequest.js.map +1 -0
  205. package/dist/esm/models/components/tradfimarketorderrequest.d.ts +43 -0
  206. package/dist/esm/models/components/tradfimarketorderrequest.d.ts.map +1 -0
  207. package/dist/esm/models/components/tradfimarketorderrequest.js +23 -0
  208. package/dist/esm/models/components/tradfimarketorderrequest.js.map +1 -0
  209. package/dist/esm/models/components/tradfiopportunitiesresponse.d.ts +17 -0
  210. package/dist/esm/models/components/tradfiopportunitiesresponse.d.ts.map +1 -0
  211. package/dist/esm/models/components/tradfiopportunitiesresponse.js +14 -0
  212. package/dist/esm/models/components/tradfiopportunitiesresponse.js.map +1 -0
  213. package/dist/esm/models/components/tradfiopportunity.d.ts +52 -0
  214. package/dist/esm/models/components/tradfiopportunity.d.ts.map +1 -0
  215. package/dist/esm/models/components/tradfiopportunity.js +34 -0
  216. package/dist/esm/models/components/tradfiopportunity.js.map +1 -0
  217. package/dist/esm/models/components/tradfiorderresponse.d.ts +14 -0
  218. package/dist/esm/models/components/tradfiorderresponse.d.ts.map +1 -0
  219. package/dist/esm/models/components/tradfiorderresponse.js +14 -0
  220. package/dist/esm/models/components/tradfiorderresponse.js.map +1 -0
  221. package/dist/esm/models/components/tradfiposition.d.ts +70 -0
  222. package/dist/esm/models/components/tradfiposition.d.ts.map +1 -0
  223. package/dist/esm/models/components/tradfiposition.js +43 -0
  224. package/dist/esm/models/components/tradfiposition.js.map +1 -0
  225. package/dist/esm/models/components/tradfipositionsresponse.d.ts +17 -0
  226. package/dist/esm/models/components/tradfipositionsresponse.d.ts.map +1 -0
  227. package/dist/esm/models/components/tradfipositionsresponse.js +14 -0
  228. package/dist/esm/models/components/tradfipositionsresponse.js.map +1 -0
  229. package/dist/esm/models/components/tradfiwithdrawrequest.d.ts +28 -0
  230. package/dist/esm/models/components/tradfiwithdrawrequest.d.ts.map +1 -0
  231. package/dist/esm/models/components/tradfiwithdrawrequest.js +14 -0
  232. package/dist/esm/models/components/tradfiwithdrawrequest.js.map +1 -0
  233. package/dist/esm/models/components/tradfiwithdrawresponse.d.ts +17 -0
  234. package/dist/esm/models/components/tradfiwithdrawresponse.d.ts.map +1 -0
  235. package/dist/esm/models/components/tradfiwithdrawresponse.js +14 -0
  236. package/dist/esm/models/components/tradfiwithdrawresponse.js.map +1 -0
  237. package/dist/esm/models/operations/index.d.ts +2 -0
  238. package/dist/esm/models/operations/index.d.ts.map +1 -1
  239. package/dist/esm/models/operations/index.js +2 -0
  240. package/dist/esm/models/operations/index.js.map +1 -1
  241. package/dist/esm/models/operations/v2tradfiopportunities.d.ts +64 -0
  242. package/dist/esm/models/operations/v2tradfiopportunities.d.ts.map +1 -0
  243. package/dist/esm/models/operations/v2tradfiopportunities.js +44 -0
  244. package/dist/esm/models/operations/v2tradfiopportunities.js.map +1 -0
  245. package/dist/esm/models/operations/v2tradfipositions.d.ts +20 -0
  246. package/dist/esm/models/operations/v2tradfipositions.d.ts.map +1 -0
  247. package/dist/esm/models/operations/v2tradfipositions.js +13 -0
  248. package/dist/esm/models/operations/v2tradfipositions.js.map +1 -0
  249. package/dist/esm/sdk/sdk.d.ts +3 -0
  250. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  251. package/dist/esm/sdk/sdk.js +4 -0
  252. package/dist/esm/sdk/sdk.js.map +1 -1
  253. package/dist/esm/sdk/tradfi.d.ts +106 -0
  254. package/dist/esm/sdk/tradfi.d.ts.map +1 -0
  255. package/dist/esm/sdk/tradfi.js +132 -0
  256. package/dist/esm/sdk/tradfi.js.map +1 -0
  257. package/docs/models/components/chain.md +2 -2
  258. package/docs/models/components/createtradfiaccountrequest.md +24 -0
  259. package/docs/models/components/createtradfiaccountrequestchain.md +15 -0
  260. package/docs/models/components/createtradfiaccountresponse.md +21 -0
  261. package/docs/models/components/side.md +17 -0
  262. package/docs/models/components/tradficancelorderrequest.md +24 -0
  263. package/docs/models/components/tradficategory.md +15 -0
  264. package/docs/models/components/tradfidepositrequest.md +21 -0
  265. package/docs/models/components/tradfidepositresponse.md +19 -0
  266. package/docs/models/components/tradfilimitorderrequest.md +32 -0
  267. package/docs/models/components/tradfimarketorderrequest.md +29 -0
  268. package/docs/models/components/tradfiopportunitiesresponse.md +19 -0
  269. package/docs/models/components/tradfiopportunity.md +37 -0
  270. package/docs/models/components/tradfiorderresponse.md +29 -0
  271. package/docs/models/components/tradfiposition.md +38 -0
  272. package/docs/models/components/tradfipositionsresponse.md +19 -0
  273. package/docs/models/components/tradfiwithdrawrequest.md +22 -0
  274. package/docs/models/components/tradfiwithdrawresponse.md +19 -0
  275. package/docs/models/operations/tradfisortby.md +17 -0
  276. package/docs/models/operations/tradfisortorder.md +17 -0
  277. package/docs/models/operations/v2tradfiopportunitiesrequest.md +22 -0
  278. package/docs/models/operations/v2tradfipositionsrequest.md +18 -0
  279. package/docs/sdks/tradfi/README.md +686 -0
  280. package/package.json +1 -1
  281. package/src/funcs/tradFiTradfiCancelOrder.ts +172 -0
  282. package/src/funcs/tradFiTradfiCreateAccount.ts +176 -0
  283. package/src/funcs/tradFiTradfiDeposit.ts +174 -0
  284. package/src/funcs/tradFiTradfiLimitOrder.ts +175 -0
  285. package/src/funcs/tradFiTradfiMarketOrder.ts +176 -0
  286. package/src/funcs/tradFiTradfiOpportunities.ts +185 -0
  287. package/src/funcs/tradFiTradfiPositions.ts +181 -0
  288. package/src/funcs/tradFiTradfiWithdraw.ts +174 -0
  289. package/src/lib/config.ts +2 -2
  290. package/src/lib/security.ts +14 -2
  291. package/src/models/components/chain.ts +1 -0
  292. package/src/models/components/createtradfiaccountrequest.ts +70 -0
  293. package/src/models/components/createtradfiaccountresponse.ts +51 -0
  294. package/src/models/components/index.ts +15 -0
  295. package/src/models/components/tradficancelorderrequest.ts +61 -0
  296. package/src/models/components/tradficategory.ts +18 -0
  297. package/src/models/components/tradfidepositrequest.ts +43 -0
  298. package/src/models/components/tradfidepositresponse.ts +41 -0
  299. package/src/models/components/tradfilimitorderrequest.ts +86 -0
  300. package/src/models/components/tradfimarketorderrequest.ts +73 -0
  301. package/src/models/components/tradfiopportunitiesresponse.ts +41 -0
  302. package/src/models/components/tradfiopportunity.ts +94 -0
  303. package/src/models/components/tradfiorderresponse.ts +38 -0
  304. package/src/models/components/tradfiposition.ts +116 -0
  305. package/src/models/components/tradfipositionsresponse.ts +41 -0
  306. package/src/models/components/tradfiwithdrawrequest.ts +49 -0
  307. package/src/models/components/tradfiwithdrawresponse.ts +41 -0
  308. package/src/models/operations/index.ts +2 -0
  309. package/src/models/operations/v2tradfiopportunities.ts +104 -0
  310. package/src/models/operations/v2tradfipositions.ts +40 -0
  311. package/src/sdk/sdk.ts +6 -0
  312. package/src/sdk/tradfi.ts +198 -0
@@ -0,0 +1,106 @@
1
+ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
2
+ import * as components from "../models/components/index.js";
3
+ import * as operations from "../models/operations/index.js";
4
+ export declare class TradFi extends ClientSDK {
5
+ /**
6
+ * List TradFi perp markets
7
+ *
8
+ * @remarks
9
+ * List available TradFi perpetual futures markets with key metrics.
10
+ *
11
+ * Returns tradfi perp markets (stocks, commodities, forex) with open interest,
12
+ * 24h volume, funding rate, and max leverage. Supports filtering by category,
13
+ * minimum OI/volume, and sorting.
14
+ *
15
+ * Only tradfi assets are returned — crypto perps are excluded.
16
+ */
17
+ tradfiOpportunities(request: operations.V2TradfiOpportunitiesRequest, options?: RequestOptions): Promise<components.TradFiOpportunitiesResponse>;
18
+ /**
19
+ * List TradFi positions
20
+ *
21
+ * @remarks
22
+ * List open perpetual futures positions for a user's TradFi account.
23
+ *
24
+ * Returns position data including size, entry price, mark price, PnL, liquidation price,
25
+ * leverage, and cumulative funding. Optionally filter by asset ticker.
26
+ *
27
+ * Returns 404 if the user has no TradFi product account.
28
+ * Returns an empty list if no positions are open.
29
+ */
30
+ tradfiPositions(request: operations.V2TradfiPositionsRequest, options?: RequestOptions): Promise<components.TradFiPositionsResponse>;
31
+ /**
32
+ * Create TradFi account
33
+ *
34
+ * @remarks
35
+ * Create a TradFi product account on HyperEVM.
36
+ *
37
+ * Before trading perpetual futures or depositing USDC, the owner must create a TradFi
38
+ * product account. Each wallet address has one TradFi account.
39
+ *
40
+ * Returns an unsigned transaction to create the account. The `sender` signs and broadcasts
41
+ * this transaction on HyperEVM (gas paid in HYPE).
42
+ */
43
+ tradfiCreateAccount(request: components.CreateTradFiAccountRequest, options?: RequestOptions): Promise<components.CreateTradFiAccountResponse>;
44
+ /**
45
+ * Deposit USDC to TradFi account
46
+ *
47
+ * @remarks
48
+ * Bridge USDC from Arbitrum to the TradFi account on HyperEVM.
49
+ *
50
+ * Returns unsigned Arbitrum transactions: USDC approval (if current allowance is insufficient)
51
+ * followed by a bridge deposit to the Hyperliquid Arbitrum bridge contract.
52
+ *
53
+ * After the bridge deposit confirms, USDC lands on HyperCore and can be used for trading.
54
+ */
55
+ tradfiDeposit(request: components.TradFiDepositRequest, options?: RequestOptions): Promise<components.TradFiDepositResponse>;
56
+ /**
57
+ * Withdraw USDC from TradFi account
58
+ *
59
+ * @remarks
60
+ * Withdraw USDC from HyperEVM Safe back to Arbitrum.
61
+ *
62
+ * Returns unsigned HyperEVM transactions to transfer USDC from the Safe to HyperCore,
63
+ * then initiate a withdrawal to the destination address on Arbitrum.
64
+ *
65
+ * Withdrawal processing takes minutes to hours depending on bridge conditions.
66
+ */
67
+ tradfiWithdraw(request: components.TradFiWithdrawRequest, options?: RequestOptions): Promise<components.TradFiWithdrawResponse>;
68
+ /**
69
+ * Place market order
70
+ *
71
+ * @remarks
72
+ * Place a market order on a TradFi perpetual futures market.
73
+ *
74
+ * Executes as an IOC (Immediate or Cancel) order at the current mark price with
75
+ * slippage protection. The transaction is a Safe execTransaction wrapping a
76
+ * CoreWriter call on HyperEVM.
77
+ *
78
+ * Orders are asynchronous — execution confirms a few seconds after the transaction,
79
+ * not atomically.
80
+ */
81
+ tradfiMarketOrder(request: components.TradFiMarketOrderRequest, options?: RequestOptions): Promise<components.TradFiOrderResponse>;
82
+ /**
83
+ * Place limit order
84
+ *
85
+ * @remarks
86
+ * Place a limit order on a TradFi perpetual futures market.
87
+ *
88
+ * Supports GTC (Good Til Cancel) and ALO (Add Liquidity Only) time-in-force types.
89
+ * The transaction is a Safe execTransaction wrapping a CoreWriter call on HyperEVM.
90
+ *
91
+ * Orders are asynchronous — execution confirms a few seconds after the transaction,
92
+ * not atomically.
93
+ */
94
+ tradfiLimitOrder(request: components.TradFiLimitOrderRequest, options?: RequestOptions): Promise<components.TradFiOrderResponse>;
95
+ /**
96
+ * Cancel order
97
+ *
98
+ * @remarks
99
+ * Cancel an open order on a TradFi perpetual futures market.
100
+ *
101
+ * Cancel by either Hyperliquid order ID or client order ID. The transaction is a
102
+ * Safe execTransaction wrapping a CoreWriter call on HyperEVM.
103
+ */
104
+ tradfiCancelOrder(request: components.TradFiCancelOrderRequest, options?: RequestOptions): Promise<components.TradFiOrderResponse>;
105
+ }
106
+ //# sourceMappingURL=tradfi.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tradfi.d.ts","sourceRoot":"","sources":["../../../src/sdk/tradfi.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;OAWG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAQlD;;;;;;;;;;;OAWG;IACG,eAAe,CACnB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAQ9C;;;;;;;;;;;OAWG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAQlD;;;;;;;;;;OAUG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAQ5C;;;;;;;;;;OAUG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAQ7C;;;;;;;;;;;;OAYG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;;;;;OAWG;IACG,gBAAgB,CACpB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;;OAQG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAO3C"}
@@ -0,0 +1,132 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import { tradFiTradfiCancelOrder } from "../funcs/tradFiTradfiCancelOrder.js";
5
+ import { tradFiTradfiCreateAccount } from "../funcs/tradFiTradfiCreateAccount.js";
6
+ import { tradFiTradfiDeposit } from "../funcs/tradFiTradfiDeposit.js";
7
+ import { tradFiTradfiLimitOrder } from "../funcs/tradFiTradfiLimitOrder.js";
8
+ import { tradFiTradfiMarketOrder } from "../funcs/tradFiTradfiMarketOrder.js";
9
+ import { tradFiTradfiOpportunities } from "../funcs/tradFiTradfiOpportunities.js";
10
+ import { tradFiTradfiPositions } from "../funcs/tradFiTradfiPositions.js";
11
+ import { tradFiTradfiWithdraw } from "../funcs/tradFiTradfiWithdraw.js";
12
+ import { ClientSDK } from "../lib/sdks.js";
13
+ import { unwrapAsync } from "../types/fp.js";
14
+ export class TradFi extends ClientSDK {
15
+ /**
16
+ * List TradFi perp markets
17
+ *
18
+ * @remarks
19
+ * List available TradFi perpetual futures markets with key metrics.
20
+ *
21
+ * Returns tradfi perp markets (stocks, commodities, forex) with open interest,
22
+ * 24h volume, funding rate, and max leverage. Supports filtering by category,
23
+ * minimum OI/volume, and sorting.
24
+ *
25
+ * Only tradfi assets are returned — crypto perps are excluded.
26
+ */
27
+ async tradfiOpportunities(request, options) {
28
+ return unwrapAsync(tradFiTradfiOpportunities(this, request, options));
29
+ }
30
+ /**
31
+ * List TradFi positions
32
+ *
33
+ * @remarks
34
+ * List open perpetual futures positions for a user's TradFi account.
35
+ *
36
+ * Returns position data including size, entry price, mark price, PnL, liquidation price,
37
+ * leverage, and cumulative funding. Optionally filter by asset ticker.
38
+ *
39
+ * Returns 404 if the user has no TradFi product account.
40
+ * Returns an empty list if no positions are open.
41
+ */
42
+ async tradfiPositions(request, options) {
43
+ return unwrapAsync(tradFiTradfiPositions(this, request, options));
44
+ }
45
+ /**
46
+ * Create TradFi account
47
+ *
48
+ * @remarks
49
+ * Create a TradFi product account on HyperEVM.
50
+ *
51
+ * Before trading perpetual futures or depositing USDC, the owner must create a TradFi
52
+ * product account. Each wallet address has one TradFi account.
53
+ *
54
+ * Returns an unsigned transaction to create the account. The `sender` signs and broadcasts
55
+ * this transaction on HyperEVM (gas paid in HYPE).
56
+ */
57
+ async tradfiCreateAccount(request, options) {
58
+ return unwrapAsync(tradFiTradfiCreateAccount(this, request, options));
59
+ }
60
+ /**
61
+ * Deposit USDC to TradFi account
62
+ *
63
+ * @remarks
64
+ * Bridge USDC from Arbitrum to the TradFi account on HyperEVM.
65
+ *
66
+ * Returns unsigned Arbitrum transactions: USDC approval (if current allowance is insufficient)
67
+ * followed by a bridge deposit to the Hyperliquid Arbitrum bridge contract.
68
+ *
69
+ * After the bridge deposit confirms, USDC lands on HyperCore and can be used for trading.
70
+ */
71
+ async tradfiDeposit(request, options) {
72
+ return unwrapAsync(tradFiTradfiDeposit(this, request, options));
73
+ }
74
+ /**
75
+ * Withdraw USDC from TradFi account
76
+ *
77
+ * @remarks
78
+ * Withdraw USDC from HyperEVM Safe back to Arbitrum.
79
+ *
80
+ * Returns unsigned HyperEVM transactions to transfer USDC from the Safe to HyperCore,
81
+ * then initiate a withdrawal to the destination address on Arbitrum.
82
+ *
83
+ * Withdrawal processing takes minutes to hours depending on bridge conditions.
84
+ */
85
+ async tradfiWithdraw(request, options) {
86
+ return unwrapAsync(tradFiTradfiWithdraw(this, request, options));
87
+ }
88
+ /**
89
+ * Place market order
90
+ *
91
+ * @remarks
92
+ * Place a market order on a TradFi perpetual futures market.
93
+ *
94
+ * Executes as an IOC (Immediate or Cancel) order at the current mark price with
95
+ * slippage protection. The transaction is a Safe execTransaction wrapping a
96
+ * CoreWriter call on HyperEVM.
97
+ *
98
+ * Orders are asynchronous — execution confirms a few seconds after the transaction,
99
+ * not atomically.
100
+ */
101
+ async tradfiMarketOrder(request, options) {
102
+ return unwrapAsync(tradFiTradfiMarketOrder(this, request, options));
103
+ }
104
+ /**
105
+ * Place limit order
106
+ *
107
+ * @remarks
108
+ * Place a limit order on a TradFi perpetual futures market.
109
+ *
110
+ * Supports GTC (Good Til Cancel) and ALO (Add Liquidity Only) time-in-force types.
111
+ * The transaction is a Safe execTransaction wrapping a CoreWriter call on HyperEVM.
112
+ *
113
+ * Orders are asynchronous — execution confirms a few seconds after the transaction,
114
+ * not atomically.
115
+ */
116
+ async tradfiLimitOrder(request, options) {
117
+ return unwrapAsync(tradFiTradfiLimitOrder(this, request, options));
118
+ }
119
+ /**
120
+ * Cancel order
121
+ *
122
+ * @remarks
123
+ * Cancel an open order on a TradFi perpetual futures market.
124
+ *
125
+ * Cancel by either Hyperliquid order ID or client order ID. The transaction is a
126
+ * Safe execTransaction wrapping a CoreWriter call on HyperEVM.
127
+ */
128
+ async tradfiCancelOrder(request, options) {
129
+ return unwrapAsync(tradFiTradfiCancelOrder(this, request, options));
130
+ }
131
+ }
132
+ //# sourceMappingURL=tradfi.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tradfi.js","sourceRoot":"","sources":["../../../src/sdk/tradfi.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAgD,EAChD,OAAwB;QAExB,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,eAAe,CACnB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,cAAc,CAClB,OAAyC,EACzC,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,sBAAsB,CACvC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -7,11 +7,11 @@ The chain to use.
7
7
  ```typescript
8
8
  import { Chain } from "@compass-labs/api-sdk/models/components";
9
9
 
10
- let value: Chain = "base";
10
+ let value: Chain = "ethereum";
11
11
  ```
12
12
 
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "base" | "ethereum" | "arbitrum"
16
+ "base" | "ethereum" | "arbitrum" | "hyperevm"
17
17
  ```
@@ -0,0 +1,24 @@
1
+ # CreateTradFiAccountRequest
2
+
3
+ Request to create a TradFi product account on HyperEVM.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { CreateTradFiAccountRequest } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: CreateTradFiAccountRequest = {
11
+ chain: "hyperevm",
12
+ sender: "0x01E62835dd7F52173546A325294762143eE4a882",
13
+ owner: "0x01E62835dd7F52173546A325294762143eE4a882",
14
+ };
15
+ ```
16
+
17
+ ## Fields
18
+
19
+ | Field | Type | Required | Description | Example |
20
+ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
21
+ | `chain` | [components.CreateTradFiAccountRequestChain](../../models/components/createtradfiaccountrequestchain.md) | :heavy_check_mark: | N/A | hyperevm |
22
+ | `sender` | *string* | :heavy_check_mark: | The address of the transaction sender. | 0x01E62835dd7F52173546A325294762143eE4a882 |
23
+ | `estimateGas` | *boolean* | :heavy_minus_sign: | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true |
24
+ | `owner` | *string* | :heavy_check_mark: | The address that will own and control the product account | 0x01E62835dd7F52173546A325294762143eE4a882 |
@@ -0,0 +1,15 @@
1
+ # CreateTradFiAccountRequestChain
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CreateTradFiAccountRequestChain } from "@compass-labs/api-sdk/models/components";
7
+
8
+ let value: CreateTradFiAccountRequestChain = "hyperevm";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "hyperevm"
15
+ ```
@@ -0,0 +1,21 @@
1
+ # CreateTradFiAccountResponse
2
+
3
+ Response containing unsigned transaction to create a TradFi product account.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { CreateTradFiAccountResponse } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: CreateTradFiAccountResponse = {
11
+ transaction: null,
12
+ tradfiAccountAddress: "<value>",
13
+ };
14
+ ```
15
+
16
+ ## Fields
17
+
18
+ | Field | Type | Required | Description |
19
+ | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
20
+ | `transaction` | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md) | :heavy_check_mark: | Transaction to create the product account (None if already deployed) |
21
+ | `tradfiAccountAddress` | *string* | :heavy_check_mark: | Predicted address of the product account that will be deployed on HyperEVM |
@@ -0,0 +1,17 @@
1
+ # Side
2
+
3
+ Position side: 'long' or 'short'
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { Side } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: Side = "short";
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "long" | "short"
17
+ ```
@@ -0,0 +1,24 @@
1
+ # TradFiCancelOrderRequest
2
+
3
+ Request to cancel an open order on a TradFi perp market.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { TradFiCancelOrderRequest } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: TradFiCancelOrderRequest = {
11
+ owner: "0x01E62835dd7F52173546A325294762143eE4a882",
12
+ asset: "AAPL",
13
+ orderId: 12345,
14
+ };
15
+ ```
16
+
17
+ ## Fields
18
+
19
+ | Field | Type | Required | Description | Example |
20
+ | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
21
+ | `owner` | *string* | :heavy_check_mark: | Owner of the TradFi product account | 0x01E62835dd7F52173546A325294762143eE4a882 |
22
+ | `asset` | *string* | :heavy_check_mark: | Asset ticker symbol (e.g. AAPL, GOLD, EUR) | AAPL |
23
+ | `orderId` | *number* | :heavy_minus_sign: | Hyperliquid order ID to cancel | 12345 |
24
+ | `clientOrderId` | *number* | :heavy_minus_sign: | Client order ID to cancel (alternative to order_id) | |
@@ -0,0 +1,15 @@
1
+ # TradFiCategory
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { TradFiCategory } from "@compass-labs/api-sdk/models/components";
7
+
8
+ let value: TradFiCategory = "commodity";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "stock" | "commodity" | "forex"
15
+ ```
@@ -0,0 +1,21 @@
1
+ # TradFiDepositRequest
2
+
3
+ Request to deposit USDC from Arbitrum into the user's TradFi account.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { TradFiDepositRequest } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: TradFiDepositRequest = {
11
+ owner: "0x01E62835dd7F52173546A325294762143eE4a882",
12
+ amount: "100.0",
13
+ };
14
+ ```
15
+
16
+ ## Fields
17
+
18
+ | Field | Type | Required | Description | Example |
19
+ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
20
+ | `owner` | *string* | :heavy_check_mark: | The user's EOA address on Arbitrum | 0x01E62835dd7F52173546A325294762143eE4a882 |
21
+ | `amount` | *string* | :heavy_check_mark: | USDC amount to deposit (human-readable, e.g. '1000.0') | 100.0 |
@@ -0,0 +1,19 @@
1
+ # TradFiDepositResponse
2
+
3
+ Response containing unsigned Arbitrum transactions for USDC deposit.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { TradFiDepositResponse } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: TradFiDepositResponse = {
11
+ transactions: [],
12
+ };
13
+ ```
14
+
15
+ ## Fields
16
+
17
+ | Field | Type | Required | Description |
18
+ | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
19
+ | `transactions` | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)[] | :heavy_check_mark: | Unsigned Arbitrum transactions: USDC approval (if needed) + bridge deposit |
@@ -0,0 +1,32 @@
1
+ # TradFiLimitOrderRequest
2
+
3
+ Request to place a limit order on a TradFi perp market.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { TradFiLimitOrderRequest } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: TradFiLimitOrderRequest = {
11
+ owner: "0x01E62835dd7F52173546A325294762143eE4a882",
12
+ asset: "AAPL",
13
+ side: "buy",
14
+ size: "10.0",
15
+ price: "190.00",
16
+ timeInForce: "gtc",
17
+ reduceOnly: false,
18
+ };
19
+ ```
20
+
21
+ ## Fields
22
+
23
+ | Field | Type | Required | Description | Example |
24
+ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
25
+ | `owner` | *string* | :heavy_check_mark: | Owner of the TradFi product account | 0x01E62835dd7F52173546A325294762143eE4a882 |
26
+ | `asset` | *string* | :heavy_check_mark: | Asset ticker symbol (e.g. AAPL, GOLD, EUR) | AAPL |
27
+ | `side` | *string* | :heavy_check_mark: | Order side: 'buy' or 'sell' | buy |
28
+ | `size` | *string* | :heavy_check_mark: | Number of contracts (human-readable) | 10.0 |
29
+ | `price` | *string* | :heavy_check_mark: | Limit price (human-readable) | 190.00 |
30
+ | `timeInForce` | *string* | :heavy_minus_sign: | Time-in-force: 'gtc' (good til cancel) or 'alo' (add liquidity only) | gtc |
31
+ | `reduceOnly` | *boolean* | :heavy_minus_sign: | If true, order can only reduce an existing position | false |
32
+ | `clientOrderId` | *number* | :heavy_minus_sign: | Optional client order ID for idempotency (uint128) | |
@@ -0,0 +1,29 @@
1
+ # TradFiMarketOrderRequest
2
+
3
+ Request to place a market order on a TradFi perp market.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { TradFiMarketOrderRequest } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: TradFiMarketOrderRequest = {
11
+ owner: "0x01E62835dd7F52173546A325294762143eE4a882",
12
+ asset: "AAPL",
13
+ side: "buy",
14
+ size: "10.0",
15
+ slippagePercent: 1,
16
+ reduceOnly: false,
17
+ };
18
+ ```
19
+
20
+ ## Fields
21
+
22
+ | Field | Type | Required | Description | Example |
23
+ | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
24
+ | `owner` | *string* | :heavy_check_mark: | Owner of the TradFi product account | 0x01E62835dd7F52173546A325294762143eE4a882 |
25
+ | `asset` | *string* | :heavy_check_mark: | Asset ticker symbol (e.g. AAPL, GOLD, EUR) | AAPL |
26
+ | `side` | *string* | :heavy_check_mark: | Order side: 'buy' or 'sell' | buy |
27
+ | `size` | *string* | :heavy_check_mark: | Number of contracts (human-readable) | 10.0 |
28
+ | `slippagePercent` | *number* | :heavy_minus_sign: | Max slippage percentage for price protection | 1 |
29
+ | `reduceOnly` | *boolean* | :heavy_minus_sign: | If true, order can only reduce an existing position | false |
@@ -0,0 +1,19 @@
1
+ # TradFiOpportunitiesResponse
2
+
3
+ List of available TradFi perpetual futures markets.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { TradFiOpportunitiesResponse } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: TradFiOpportunitiesResponse = {
11
+ opportunities: [],
12
+ };
13
+ ```
14
+
15
+ ## Fields
16
+
17
+ | Field | Type | Required | Description |
18
+ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
19
+ | `opportunities` | [components.TradFiOpportunity](../../models/components/tradfiopportunity.md)[] | :heavy_check_mark: | Available tradfi perp markets |
@@ -0,0 +1,37 @@
1
+ # TradFiOpportunity
2
+
3
+ A single TradFi perpetual futures market.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { TradFiOpportunity } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: TradFiOpportunity = {
11
+ asset: "<value>",
12
+ assetId: 533779,
13
+ category: "<value>",
14
+ markPrice: "<value>",
15
+ oraclePrice: "<value>",
16
+ openInterest: "<value>",
17
+ volume24h: "<value>",
18
+ fundingRate: "<value>",
19
+ maxLeverage: 455095,
20
+ szDecimals: 608263,
21
+ };
22
+ ```
23
+
24
+ ## Fields
25
+
26
+ | Field | Type | Required | Description |
27
+ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
28
+ | `asset` | *string* | :heavy_check_mark: | Asset ticker symbol (e.g. AAPL, GOLD, EUR) |
29
+ | `assetId` | *number* | :heavy_check_mark: | Hyperliquid asset index |
30
+ | `category` | *string* | :heavy_check_mark: | Asset category: stock, commodity, forex |
31
+ | `markPrice` | *string* | :heavy_check_mark: | Current mark price |
32
+ | `oraclePrice` | *string* | :heavy_check_mark: | Oracle reference price |
33
+ | `openInterest` | *string* | :heavy_check_mark: | Open interest in USD |
34
+ | `volume24h` | *string* | :heavy_check_mark: | 24-hour trading volume in USD |
35
+ | `fundingRate` | *string* | :heavy_check_mark: | Current hourly funding rate |
36
+ | `maxLeverage` | *number* | :heavy_check_mark: | Maximum allowed leverage |
37
+ | `szDecimals` | *number* | :heavy_check_mark: | Size decimal places for order quantities |
@@ -0,0 +1,29 @@
1
+ # TradFiOrderResponse
2
+
3
+ Response containing an unsigned HyperEVM transaction for an order operation.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { TradFiOrderResponse } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: TradFiOrderResponse = {
11
+ transaction: {
12
+ chainId: "<id>",
13
+ data: "<value>",
14
+ from: "<value>",
15
+ gas: "<value>",
16
+ to: "<value>",
17
+ value: "<value>",
18
+ nonce: "<value>",
19
+ maxFeePerGas: "<value>",
20
+ maxPriorityFeePerGas: "<value>",
21
+ },
22
+ };
23
+ ```
24
+
25
+ ## Fields
26
+
27
+ | Field | Type | Required | Description |
28
+ | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
29
+ | `transaction` | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md) | :heavy_check_mark: | N/A |
@@ -0,0 +1,38 @@
1
+ # TradFiPosition
2
+
3
+ A single open perpetual futures position.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { TradFiPosition } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: TradFiPosition = {
11
+ asset: "<value>",
12
+ assetId: 655196,
13
+ side: "long",
14
+ size: "<value>",
15
+ entryPrice: "<value>",
16
+ markPrice: "<value>",
17
+ unrealizedPnl: "<value>",
18
+ leverage: "<value>",
19
+ marginUsed: "<value>",
20
+ fundingAccrued: "<value>",
21
+ };
22
+ ```
23
+
24
+ ## Fields
25
+
26
+ | Field | Type | Required | Description |
27
+ | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
28
+ | `asset` | *string* | :heavy_check_mark: | Asset ticker symbol |
29
+ | `assetId` | *number* | :heavy_check_mark: | Hyperliquid asset index |
30
+ | `side` | [components.Side](../../models/components/side.md) | :heavy_check_mark: | Position side: 'long' or 'short' |
31
+ | `size` | *string* | :heavy_check_mark: | Position size in contracts |
32
+ | `entryPrice` | *string* | :heavy_check_mark: | Average entry price |
33
+ | `markPrice` | *string* | :heavy_check_mark: | Current mark price |
34
+ | `liquidationPrice` | *string* | :heavy_minus_sign: | Estimated liquidation price |
35
+ | `unrealizedPnl` | *string* | :heavy_check_mark: | Unrealized PnL in USD |
36
+ | `leverage` | *string* | :heavy_check_mark: | Current leverage |
37
+ | `marginUsed` | *string* | :heavy_check_mark: | Margin used for this position in USD |
38
+ | `fundingAccrued` | *string* | :heavy_check_mark: | Cumulative funding payments (negative = paid) |