@compass-labs/api-sdk 2.2.34-rc.2 → 2.2.34-rc.4
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.
- package/README.md +21 -19
- package/codeSamples_typescript.yaml +22 -16
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingApproveBuilderFee.d.ts +22 -0
- package/dist/commonjs/funcs/{tradFiTradfiCreateAccount.d.ts.map → traditionalInvestingTraditionalInvestingApproveBuilderFee.d.ts.map} +1 -1
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingApproveBuilderFee.js +123 -0
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingApproveBuilderFee.js.map +1 -0
- package/dist/commonjs/funcs/{tradFiTradfiCancelOrder.d.ts → traditionalInvestingTraditionalInvestingCancelOrder.d.ts} +5 -5
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingCancelOrder.d.ts.map +1 -0
- package/dist/commonjs/funcs/{tradFiTradfiCancelOrder.js → traditionalInvestingTraditionalInvestingCancelOrder.js} +10 -10
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingCancelOrder.js.map +1 -0
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingDeposit.d.ts +22 -0
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingDeposit.d.ts.map +1 -0
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingDeposit.js +122 -0
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingDeposit.js.map +1 -0
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingExecute.d.ts +22 -0
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingExecute.d.ts.map +1 -0
- package/dist/commonjs/funcs/{tradFiTradfiCreateAccount.js → traditionalInvestingTraditionalInvestingExecute.js} +12 -14
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingExecute.js.map +1 -0
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingLimitOrder.d.ts +21 -0
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingLimitOrder.d.ts.map +1 -0
- package/dist/commonjs/funcs/{tradFiTradfiLimitOrder.js → traditionalInvestingTraditionalInvestingLimitOrder.js} +10 -13
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingLimitOrder.js.map +1 -0
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingMarketOrder.d.ts +22 -0
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingMarketOrder.d.ts.map +1 -0
- package/dist/commonjs/funcs/{tradFiTradfiMarketOrder.js → traditionalInvestingTraditionalInvestingMarketOrder.js} +11 -14
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingMarketOrder.js.map +1 -0
- package/dist/commonjs/funcs/{tradFiTradfiOpportunities.d.ts → traditionalInvestingTraditionalInvestingOpportunities.d.ts} +6 -6
- package/dist/commonjs/funcs/{tradFiTradfiPositions.d.ts.map → traditionalInvestingTraditionalInvestingOpportunities.d.ts.map} +1 -1
- package/dist/commonjs/funcs/{tradFiTradfiOpportunities.js → traditionalInvestingTraditionalInvestingOpportunities.js} +12 -11
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingOpportunities.js.map +1 -0
- package/dist/{esm/funcs/tradFiTradfiPositions.d.ts → commonjs/funcs/traditionalInvestingTraditionalInvestingPositions.d.ts} +4 -6
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingPositions.d.ts.map +1 -0
- package/dist/commonjs/funcs/{tradFiTradfiPositions.js → traditionalInvestingTraditionalInvestingPositions.js} +9 -11
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingPositions.js.map +1 -0
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingWithdraw.d.ts +22 -0
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingWithdraw.d.ts.map +1 -0
- package/dist/commonjs/funcs/{tradFiTradfiDeposit.js → traditionalInvestingTraditionalInvestingWithdraw.js} +12 -13
- package/dist/commonjs/funcs/traditionalInvestingTraditionalInvestingWithdraw.js.map +1 -0
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/models/components/index.d.ts +15 -15
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +15 -15
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/components/traditionalinvestingapprovebuilderfeerequest.d.ts +18 -0
- package/dist/commonjs/models/components/traditionalinvestingapprovebuilderfeerequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/traditionalinvestingapprovebuilderfeerequest.js +49 -0
- package/dist/commonjs/models/components/traditionalinvestingapprovebuilderfeerequest.js.map +1 -0
- package/dist/commonjs/models/components/traditionalinvestingcancelorderrequest.d.ts +33 -0
- package/dist/commonjs/models/components/traditionalinvestingcancelorderrequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/{tradficancelorderrequest.js → traditionalinvestingcancelorderrequest.js} +6 -6
- package/dist/commonjs/models/components/traditionalinvestingcancelorderrequest.js.map +1 -0
- package/dist/commonjs/models/components/traditionalinvestingcategory.d.ts +11 -0
- package/dist/commonjs/models/components/traditionalinvestingcategory.d.ts.map +1 -0
- package/dist/commonjs/models/components/{tradficategory.js → traditionalinvestingcategory.js} +4 -4
- package/dist/commonjs/models/components/traditionalinvestingcategory.js.map +1 -0
- package/dist/commonjs/models/components/traditionalinvestingdepositrequest.d.ts +23 -0
- package/dist/commonjs/models/components/traditionalinvestingdepositrequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/{tradfidepositrequest.js → traditionalinvestingdepositrequest.js} +6 -6
- package/dist/commonjs/models/components/traditionalinvestingdepositrequest.js.map +1 -0
- package/dist/commonjs/models/components/traditionalinvestingdepositresponse.d.ts +30 -0
- package/dist/commonjs/models/components/traditionalinvestingdepositresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/traditionalinvestingdepositresponse.js +58 -0
- package/dist/commonjs/models/components/traditionalinvestingdepositresponse.js.map +1 -0
- package/dist/commonjs/models/components/traditionalinvestingexecuterequest.d.ts +37 -0
- package/dist/commonjs/models/components/traditionalinvestingexecuterequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/traditionalinvestingexecuterequest.js +57 -0
- package/dist/commonjs/models/components/traditionalinvestingexecuterequest.js.map +1 -0
- package/dist/commonjs/models/components/traditionalinvestingexecuteresponse.d.ts +22 -0
- package/dist/commonjs/models/components/traditionalinvestingexecuteresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/{tradfiorderresponse.js → traditionalinvestingexecuteresponse.js} +8 -8
- package/dist/commonjs/models/components/traditionalinvestingexecuteresponse.js.map +1 -0
- package/dist/{esm/models/components/tradfilimitorderrequest.d.ts → commonjs/models/components/traditionalinvestinglimitorderrequest.d.ts} +7 -7
- package/dist/commonjs/models/components/traditionalinvestinglimitorderrequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/{tradfilimitorderrequest.js → traditionalinvestinglimitorderrequest.js} +6 -6
- package/dist/commonjs/models/components/traditionalinvestinglimitorderrequest.js.map +1 -0
- package/dist/commonjs/models/components/{tradfimarketorderrequest.d.ts → traditionalinvestingmarketorderrequest.d.ts} +7 -7
- package/dist/commonjs/models/components/traditionalinvestingmarketorderrequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/{tradfimarketorderrequest.js → traditionalinvestingmarketorderrequest.js} +6 -6
- package/dist/commonjs/models/components/traditionalinvestingmarketorderrequest.js.map +1 -0
- package/dist/commonjs/models/components/traditionalinvestingopportunitiesresponse.d.ts +17 -0
- package/dist/commonjs/models/components/traditionalinvestingopportunitiesresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/{tradfidepositresponse.js → traditionalinvestingopportunitiesresponse.js} +8 -8
- package/dist/commonjs/models/components/traditionalinvestingopportunitiesresponse.js.map +1 -0
- package/dist/{esm/models/components/tradfiopportunity.d.ts → commonjs/models/components/traditionalinvestingopportunity.d.ts} +5 -5
- package/dist/commonjs/models/components/traditionalinvestingopportunity.d.ts.map +1 -0
- package/dist/commonjs/models/components/{tradfiopportunity.js → traditionalinvestingopportunity.js} +6 -6
- package/dist/commonjs/models/components/traditionalinvestingopportunity.js.map +1 -0
- package/dist/{esm/models/components/tradfiposition.d.ts → commonjs/models/components/traditionalinvestingposition.d.ts} +4 -4
- package/dist/commonjs/models/components/traditionalinvestingposition.d.ts.map +1 -0
- package/dist/commonjs/models/components/{tradfiposition.js → traditionalinvestingposition.js} +6 -6
- package/dist/commonjs/models/components/traditionalinvestingposition.js.map +1 -0
- package/dist/commonjs/models/components/traditionalinvestingpositionsresponse.d.ts +25 -0
- package/dist/commonjs/models/components/traditionalinvestingpositionsresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/traditionalinvestingpositionsresponse.js +58 -0
- package/dist/commonjs/models/components/traditionalinvestingpositionsresponse.js.map +1 -0
- package/dist/commonjs/models/components/traditionalinvestingsignableactionresponse.d.ts +28 -0
- package/dist/commonjs/models/components/traditionalinvestingsignableactionresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/{createtradfiaccountresponse.js → traditionalinvestingsignableactionresponse.js} +10 -10
- package/dist/commonjs/models/components/traditionalinvestingsignableactionresponse.js.map +1 -0
- package/dist/commonjs/models/components/traditionalinvestingwithdrawrequest.d.ts +28 -0
- package/dist/commonjs/models/components/traditionalinvestingwithdrawrequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/{tradfiwithdrawrequest.js → traditionalinvestingwithdrawrequest.js} +6 -6
- package/dist/commonjs/models/components/traditionalinvestingwithdrawrequest.js.map +1 -0
- package/dist/commonjs/models/operations/index.d.ts +2 -2
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +2 -2
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/v2traditionalinvestingopportunities.d.ts +64 -0
- package/dist/commonjs/models/operations/v2traditionalinvestingopportunities.d.ts.map +1 -0
- package/dist/commonjs/models/operations/{v2tradfiopportunities.js → v2traditionalinvestingopportunities.js} +14 -13
- package/dist/commonjs/models/operations/v2traditionalinvestingopportunities.js.map +1 -0
- package/dist/commonjs/models/operations/v2traditionalinvestingpositions.d.ts +20 -0
- package/dist/commonjs/models/operations/v2traditionalinvestingpositions.d.ts.map +1 -0
- package/dist/commonjs/models/operations/{v2tradfipositions.js → v2traditionalinvestingpositions.js} +6 -6
- package/dist/commonjs/models/operations/v2traditionalinvestingpositions.js.map +1 -0
- package/dist/commonjs/sdk/sdk.d.ts +3 -3
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
- package/dist/commonjs/sdk/sdk.js +3 -3
- package/dist/commonjs/sdk/sdk.js.map +1 -1
- package/dist/commonjs/sdk/traditionalinvesting.d.ts +105 -0
- package/dist/commonjs/sdk/traditionalinvesting.d.ts.map +1 -0
- package/dist/commonjs/sdk/traditionalinvesting.js +138 -0
- package/dist/commonjs/sdk/traditionalinvesting.js.map +1 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingApproveBuilderFee.d.ts +22 -0
- package/dist/esm/funcs/{tradFiTradfiCreateAccount.d.ts.map → traditionalInvestingTraditionalInvestingApproveBuilderFee.d.ts.map} +1 -1
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingApproveBuilderFee.js +87 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingApproveBuilderFee.js.map +1 -0
- package/dist/esm/funcs/{tradFiTradfiCancelOrder.d.ts → traditionalInvestingTraditionalInvestingCancelOrder.d.ts} +5 -5
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingCancelOrder.d.ts.map +1 -0
- package/dist/esm/funcs/{tradFiTradfiCancelOrder.js → traditionalInvestingTraditionalInvestingCancelOrder.js} +9 -9
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingCancelOrder.js.map +1 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingDeposit.d.ts +22 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingDeposit.d.ts.map +1 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingDeposit.js +86 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingDeposit.js.map +1 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingExecute.d.ts +22 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingExecute.d.ts.map +1 -0
- package/dist/esm/funcs/{tradFiTradfiDeposit.js → traditionalInvestingTraditionalInvestingExecute.js} +11 -12
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingExecute.js.map +1 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingLimitOrder.d.ts +21 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingLimitOrder.d.ts.map +1 -0
- package/dist/esm/funcs/{tradFiTradfiLimitOrder.js → traditionalInvestingTraditionalInvestingLimitOrder.js} +9 -12
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingLimitOrder.js.map +1 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingMarketOrder.d.ts +22 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingMarketOrder.d.ts.map +1 -0
- package/dist/esm/funcs/{tradFiTradfiMarketOrder.js → traditionalInvestingTraditionalInvestingMarketOrder.js} +10 -13
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingMarketOrder.js.map +1 -0
- package/dist/esm/funcs/{tradFiTradfiOpportunities.d.ts → traditionalInvestingTraditionalInvestingOpportunities.d.ts} +6 -6
- package/dist/esm/funcs/{tradFiTradfiPositions.d.ts.map → traditionalInvestingTraditionalInvestingOpportunities.d.ts.map} +1 -1
- package/dist/esm/funcs/{tradFiTradfiOpportunities.js → traditionalInvestingTraditionalInvestingOpportunities.js} +11 -10
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingOpportunities.js.map +1 -0
- package/dist/{commonjs/funcs/tradFiTradfiPositions.d.ts → esm/funcs/traditionalInvestingTraditionalInvestingPositions.d.ts} +4 -6
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingPositions.d.ts.map +1 -0
- package/dist/esm/funcs/{tradFiTradfiPositions.js → traditionalInvestingTraditionalInvestingPositions.js} +8 -10
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingPositions.js.map +1 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingWithdraw.d.ts +22 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingWithdraw.d.ts.map +1 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingWithdraw.js +86 -0
- package/dist/esm/funcs/traditionalInvestingTraditionalInvestingWithdraw.js.map +1 -0
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/models/components/index.d.ts +15 -15
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +15 -15
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/components/traditionalinvestingapprovebuilderfeerequest.d.ts +18 -0
- package/dist/esm/models/components/traditionalinvestingapprovebuilderfeerequest.d.ts.map +1 -0
- package/dist/esm/models/components/traditionalinvestingapprovebuilderfeerequest.js +12 -0
- package/dist/esm/models/components/traditionalinvestingapprovebuilderfeerequest.js.map +1 -0
- package/dist/esm/models/components/traditionalinvestingcancelorderrequest.d.ts +33 -0
- package/dist/esm/models/components/traditionalinvestingcancelorderrequest.d.ts.map +1 -0
- package/dist/esm/models/components/{tradficancelorderrequest.js → traditionalinvestingcancelorderrequest.js} +4 -4
- package/dist/esm/models/components/traditionalinvestingcancelorderrequest.js.map +1 -0
- package/dist/esm/models/components/traditionalinvestingcategory.d.ts +11 -0
- package/dist/esm/models/components/traditionalinvestingcategory.d.ts.map +1 -0
- package/dist/esm/models/components/traditionalinvestingcategory.js +12 -0
- package/dist/esm/models/components/traditionalinvestingcategory.js.map +1 -0
- package/dist/esm/models/components/traditionalinvestingdepositrequest.d.ts +23 -0
- package/dist/esm/models/components/traditionalinvestingdepositrequest.d.ts.map +1 -0
- package/dist/esm/models/components/traditionalinvestingdepositrequest.js +13 -0
- package/dist/esm/models/components/traditionalinvestingdepositrequest.js.map +1 -0
- package/dist/esm/models/components/traditionalinvestingdepositresponse.d.ts +30 -0
- package/dist/esm/models/components/traditionalinvestingdepositresponse.d.ts.map +1 -0
- package/dist/esm/models/components/traditionalinvestingdepositresponse.js +21 -0
- package/dist/esm/models/components/traditionalinvestingdepositresponse.js.map +1 -0
- package/dist/esm/models/components/traditionalinvestingexecuterequest.d.ts +37 -0
- package/dist/esm/models/components/traditionalinvestingexecuterequest.d.ts.map +1 -0
- package/dist/esm/models/components/traditionalinvestingexecuterequest.js +20 -0
- package/dist/esm/models/components/traditionalinvestingexecuterequest.js.map +1 -0
- package/dist/esm/models/components/traditionalinvestingexecuteresponse.d.ts +22 -0
- package/dist/esm/models/components/traditionalinvestingexecuteresponse.d.ts.map +1 -0
- package/dist/esm/models/components/traditionalinvestingexecuteresponse.js +14 -0
- package/dist/esm/models/components/traditionalinvestingexecuteresponse.js.map +1 -0
- package/dist/{commonjs/models/components/tradfilimitorderrequest.d.ts → esm/models/components/traditionalinvestinglimitorderrequest.d.ts} +7 -7
- package/dist/esm/models/components/traditionalinvestinglimitorderrequest.d.ts.map +1 -0
- package/dist/esm/models/components/{tradfilimitorderrequest.js → traditionalinvestinglimitorderrequest.js} +4 -4
- package/dist/esm/models/components/traditionalinvestinglimitorderrequest.js.map +1 -0
- package/dist/esm/models/components/{tradfimarketorderrequest.d.ts → traditionalinvestingmarketorderrequest.d.ts} +7 -7
- package/dist/esm/models/components/traditionalinvestingmarketorderrequest.d.ts.map +1 -0
- package/dist/esm/models/components/{tradfimarketorderrequest.js → traditionalinvestingmarketorderrequest.js} +4 -4
- package/dist/esm/models/components/traditionalinvestingmarketorderrequest.js.map +1 -0
- package/dist/esm/models/components/traditionalinvestingopportunitiesresponse.d.ts +17 -0
- package/dist/esm/models/components/traditionalinvestingopportunitiesresponse.d.ts.map +1 -0
- package/dist/esm/models/components/traditionalinvestingopportunitiesresponse.js +14 -0
- package/dist/esm/models/components/traditionalinvestingopportunitiesresponse.js.map +1 -0
- package/dist/{commonjs/models/components/tradfiopportunity.d.ts → esm/models/components/traditionalinvestingopportunity.d.ts} +5 -5
- package/dist/esm/models/components/traditionalinvestingopportunity.d.ts.map +1 -0
- package/dist/esm/models/components/{tradfiopportunity.js → traditionalinvestingopportunity.js} +4 -4
- package/dist/esm/models/components/traditionalinvestingopportunity.js.map +1 -0
- package/dist/{commonjs/models/components/tradfiposition.d.ts → esm/models/components/traditionalinvestingposition.d.ts} +4 -4
- package/dist/esm/models/components/traditionalinvestingposition.d.ts.map +1 -0
- package/dist/esm/models/components/{tradfiposition.js → traditionalinvestingposition.js} +4 -4
- package/dist/esm/models/components/traditionalinvestingposition.js.map +1 -0
- package/dist/esm/models/components/traditionalinvestingpositionsresponse.d.ts +25 -0
- package/dist/esm/models/components/traditionalinvestingpositionsresponse.d.ts.map +1 -0
- package/dist/esm/models/components/traditionalinvestingpositionsresponse.js +21 -0
- package/dist/esm/models/components/traditionalinvestingpositionsresponse.js.map +1 -0
- package/dist/esm/models/components/traditionalinvestingsignableactionresponse.d.ts +28 -0
- package/dist/esm/models/components/traditionalinvestingsignableactionresponse.d.ts.map +1 -0
- package/dist/esm/models/components/traditionalinvestingsignableactionresponse.js +20 -0
- package/dist/esm/models/components/traditionalinvestingsignableactionresponse.js.map +1 -0
- package/dist/esm/models/components/traditionalinvestingwithdrawrequest.d.ts +28 -0
- package/dist/esm/models/components/traditionalinvestingwithdrawrequest.d.ts.map +1 -0
- package/dist/esm/models/components/traditionalinvestingwithdrawrequest.js +14 -0
- package/dist/esm/models/components/traditionalinvestingwithdrawrequest.js.map +1 -0
- package/dist/esm/models/operations/index.d.ts +2 -2
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +2 -2
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/v2traditionalinvestingopportunities.d.ts +64 -0
- package/dist/esm/models/operations/v2traditionalinvestingopportunities.d.ts.map +1 -0
- package/dist/esm/models/operations/v2traditionalinvestingopportunities.js +45 -0
- package/dist/esm/models/operations/v2traditionalinvestingopportunities.js.map +1 -0
- package/dist/esm/models/operations/v2traditionalinvestingpositions.d.ts +20 -0
- package/dist/esm/models/operations/v2traditionalinvestingpositions.d.ts.map +1 -0
- package/dist/esm/models/operations/v2traditionalinvestingpositions.js +13 -0
- package/dist/esm/models/operations/v2traditionalinvestingpositions.js.map +1 -0
- package/dist/esm/sdk/sdk.d.ts +3 -3
- package/dist/esm/sdk/sdk.d.ts.map +1 -1
- package/dist/esm/sdk/sdk.js +3 -3
- package/dist/esm/sdk/sdk.js.map +1 -1
- package/dist/esm/sdk/traditionalinvesting.d.ts +105 -0
- package/dist/esm/sdk/traditionalinvesting.d.ts.map +1 -0
- package/dist/esm/sdk/traditionalinvesting.js +134 -0
- package/dist/esm/sdk/traditionalinvesting.js.map +1 -0
- package/docs/models/components/traditionalinvestingapprovebuilderfeerequest.md +19 -0
- package/docs/models/components/{tradficancelorderrequest.md → traditionalinvestingcancelorderrequest.md} +5 -5
- package/docs/models/components/traditionalinvestingcategory.md +15 -0
- package/docs/models/components/{tradfidepositrequest.md → traditionalinvestingdepositrequest.md} +4 -4
- package/docs/models/components/traditionalinvestingdepositresponse.md +55 -0
- package/docs/models/components/traditionalinvestingexecuterequest.md +27 -0
- package/docs/models/components/traditionalinvestingexecuteresponse.md +20 -0
- package/docs/models/components/{tradfilimitorderrequest.md → traditionalinvestinglimitorderrequest.md} +5 -5
- package/docs/models/components/{tradfimarketorderrequest.md → traditionalinvestingmarketorderrequest.md} +5 -5
- package/docs/models/components/traditionalinvestingopportunitiesresponse.md +32 -0
- package/docs/models/components/{tradfiopportunity.md → traditionalinvestingopportunity.md} +7 -7
- package/docs/models/components/{tradfiposition.md → traditionalinvestingposition.md} +4 -4
- package/docs/models/components/traditionalinvestingpositionsresponse.md +23 -0
- package/docs/models/components/traditionalinvestingsignableactionresponse.md +26 -0
- package/docs/models/components/traditionalinvestingwithdrawrequest.md +22 -0
- package/docs/models/operations/traditionalinvestingsortby.md +17 -0
- package/docs/models/operations/traditionalinvestingsortorder.md +17 -0
- package/docs/models/operations/v2traditionalinvestingopportunitiesrequest.md +22 -0
- package/docs/models/operations/v2traditionalinvestingpositionsrequest.md +18 -0
- package/docs/sdks/{tradfi → traditionalinvesting}/README.md +210 -135
- package/package.json +1 -1
- package/src/funcs/traditionalInvestingTraditionalInvestingApproveBuilderFee.ts +178 -0
- package/src/funcs/{tradFiTradfiCancelOrder.ts → traditionalInvestingTraditionalInvestingCancelOrder.ts} +19 -13
- package/src/funcs/{tradFiTradfiCreateAccount.ts → traditionalInvestingTraditionalInvestingDeposit.ts} +15 -17
- package/src/funcs/{tradFiTradfiDeposit.ts → traditionalInvestingTraditionalInvestingExecute.ts} +16 -16
- package/src/funcs/{tradFiTradfiLimitOrder.ts → traditionalInvestingTraditionalInvestingLimitOrder.ts} +19 -16
- package/src/funcs/{tradFiTradfiMarketOrder.ts → traditionalInvestingTraditionalInvestingMarketOrder.ts} +20 -17
- package/src/funcs/{tradFiTradfiOpportunities.ts → traditionalInvestingTraditionalInvestingOpportunities.ts} +18 -14
- package/src/funcs/{tradFiTradfiPositions.ts → traditionalInvestingTraditionalInvestingPositions.ts} +15 -14
- package/src/funcs/traditionalInvestingTraditionalInvestingWithdraw.ts +179 -0
- package/src/lib/config.ts +2 -2
- package/src/models/components/index.ts +15 -15
- package/src/models/components/traditionalinvestingapprovebuilderfeerequest.ts +41 -0
- package/src/models/components/{tradficancelorderrequest.ts → traditionalinvestingcancelorderrequest.ts} +13 -10
- package/src/models/components/traditionalinvestingcategory.ts +20 -0
- package/src/models/components/traditionalinvestingdepositrequest.ts +45 -0
- package/src/models/components/traditionalinvestingdepositresponse.ts +62 -0
- package/src/models/components/traditionalinvestingexecuterequest.ts +62 -0
- package/src/models/components/traditionalinvestingexecuteresponse.ts +43 -0
- package/src/models/components/{tradfilimitorderrequest.ts → traditionalinvestinglimitorderrequest.ts} +12 -10
- package/src/models/components/{tradfimarketorderrequest.ts → traditionalinvestingmarketorderrequest.ts} +13 -10
- package/src/models/components/traditionalinvestingopportunitiesresponse.ts +47 -0
- package/src/models/components/{tradfiopportunity.ts → traditionalinvestingopportunity.ts} +8 -8
- package/src/models/components/{tradfiposition.ts → traditionalinvestingposition.ts} +7 -7
- package/src/models/components/traditionalinvestingpositionsresponse.ts +57 -0
- package/src/models/components/traditionalinvestingsignableactionresponse.ts +56 -0
- package/src/models/components/traditionalinvestingwithdrawrequest.ts +51 -0
- package/src/models/operations/index.ts +2 -2
- package/src/models/operations/v2traditionalinvestingopportunities.ts +112 -0
- package/src/models/operations/v2traditionalinvestingpositions.ts +43 -0
- package/src/sdk/sdk.ts +6 -4
- package/src/sdk/traditionalinvesting.ts +210 -0
- package/dist/commonjs/funcs/tradFiTradfiCancelOrder.d.ts.map +0 -1
- package/dist/commonjs/funcs/tradFiTradfiCancelOrder.js.map +0 -1
- package/dist/commonjs/funcs/tradFiTradfiCreateAccount.d.ts +0 -24
- package/dist/commonjs/funcs/tradFiTradfiCreateAccount.js.map +0 -1
- package/dist/commonjs/funcs/tradFiTradfiDeposit.d.ts +0 -23
- package/dist/commonjs/funcs/tradFiTradfiDeposit.d.ts.map +0 -1
- package/dist/commonjs/funcs/tradFiTradfiDeposit.js.map +0 -1
- package/dist/commonjs/funcs/tradFiTradfiLimitOrder.d.ts +0 -24
- package/dist/commonjs/funcs/tradFiTradfiLimitOrder.d.ts.map +0 -1
- package/dist/commonjs/funcs/tradFiTradfiLimitOrder.js.map +0 -1
- package/dist/commonjs/funcs/tradFiTradfiMarketOrder.d.ts +0 -25
- package/dist/commonjs/funcs/tradFiTradfiMarketOrder.d.ts.map +0 -1
- package/dist/commonjs/funcs/tradFiTradfiMarketOrder.js.map +0 -1
- package/dist/commonjs/funcs/tradFiTradfiOpportunities.d.ts.map +0 -1
- package/dist/commonjs/funcs/tradFiTradfiOpportunities.js.map +0 -1
- package/dist/commonjs/funcs/tradFiTradfiPositions.js.map +0 -1
- package/dist/commonjs/funcs/tradFiTradfiWithdraw.d.ts +0 -23
- package/dist/commonjs/funcs/tradFiTradfiWithdraw.d.ts.map +0 -1
- package/dist/commonjs/funcs/tradFiTradfiWithdraw.js +0 -123
- package/dist/commonjs/funcs/tradFiTradfiWithdraw.js.map +0 -1
- package/dist/commonjs/models/components/createtradfiaccountrequest.d.ts +0 -37
- package/dist/commonjs/models/components/createtradfiaccountrequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/createtradfiaccountrequest.js +0 -62
- package/dist/commonjs/models/components/createtradfiaccountrequest.js.map +0 -1
- package/dist/commonjs/models/components/createtradfiaccountresponse.d.ts +0 -21
- package/dist/commonjs/models/components/createtradfiaccountresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/createtradfiaccountresponse.js.map +0 -1
- package/dist/commonjs/models/components/tradficancelorderrequest.d.ts +0 -33
- package/dist/commonjs/models/components/tradficancelorderrequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/tradficancelorderrequest.js.map +0 -1
- package/dist/commonjs/models/components/tradficategory.d.ts +0 -11
- package/dist/commonjs/models/components/tradficategory.d.ts.map +0 -1
- package/dist/commonjs/models/components/tradficategory.js.map +0 -1
- package/dist/commonjs/models/components/tradfidepositrequest.d.ts +0 -23
- package/dist/commonjs/models/components/tradfidepositrequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/tradfidepositrequest.js.map +0 -1
- package/dist/commonjs/models/components/tradfidepositresponse.d.ts +0 -17
- package/dist/commonjs/models/components/tradfidepositresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/tradfidepositresponse.js.map +0 -1
- package/dist/commonjs/models/components/tradfilimitorderrequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/tradfilimitorderrequest.js.map +0 -1
- package/dist/commonjs/models/components/tradfimarketorderrequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/tradfimarketorderrequest.js.map +0 -1
- package/dist/commonjs/models/components/tradfiopportunitiesresponse.d.ts +0 -17
- package/dist/commonjs/models/components/tradfiopportunitiesresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/tradfiopportunitiesresponse.js +0 -51
- package/dist/commonjs/models/components/tradfiopportunitiesresponse.js.map +0 -1
- package/dist/commonjs/models/components/tradfiopportunity.d.ts.map +0 -1
- package/dist/commonjs/models/components/tradfiopportunity.js.map +0 -1
- package/dist/commonjs/models/components/tradfiorderresponse.d.ts +0 -14
- package/dist/commonjs/models/components/tradfiorderresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/tradfiorderresponse.js.map +0 -1
- package/dist/commonjs/models/components/tradfiposition.d.ts.map +0 -1
- package/dist/commonjs/models/components/tradfiposition.js.map +0 -1
- package/dist/commonjs/models/components/tradfipositionsresponse.d.ts +0 -17
- package/dist/commonjs/models/components/tradfipositionsresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/tradfipositionsresponse.js +0 -51
- package/dist/commonjs/models/components/tradfipositionsresponse.js.map +0 -1
- package/dist/commonjs/models/components/tradfiwithdrawrequest.d.ts +0 -28
- package/dist/commonjs/models/components/tradfiwithdrawrequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/tradfiwithdrawrequest.js.map +0 -1
- package/dist/commonjs/models/components/tradfiwithdrawresponse.d.ts +0 -17
- package/dist/commonjs/models/components/tradfiwithdrawresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/tradfiwithdrawresponse.js +0 -51
- package/dist/commonjs/models/components/tradfiwithdrawresponse.js.map +0 -1
- package/dist/commonjs/models/operations/v2tradfiopportunities.d.ts +0 -64
- package/dist/commonjs/models/operations/v2tradfiopportunities.d.ts.map +0 -1
- package/dist/commonjs/models/operations/v2tradfiopportunities.js.map +0 -1
- package/dist/commonjs/models/operations/v2tradfipositions.d.ts +0 -20
- package/dist/commonjs/models/operations/v2tradfipositions.d.ts.map +0 -1
- package/dist/commonjs/models/operations/v2tradfipositions.js.map +0 -1
- package/dist/commonjs/sdk/tradfi.d.ts +0 -106
- package/dist/commonjs/sdk/tradfi.d.ts.map +0 -1
- package/dist/commonjs/sdk/tradfi.js +0 -136
- package/dist/commonjs/sdk/tradfi.js.map +0 -1
- package/dist/esm/funcs/tradFiTradfiCancelOrder.d.ts.map +0 -1
- package/dist/esm/funcs/tradFiTradfiCancelOrder.js.map +0 -1
- package/dist/esm/funcs/tradFiTradfiCreateAccount.d.ts +0 -24
- package/dist/esm/funcs/tradFiTradfiCreateAccount.js +0 -88
- package/dist/esm/funcs/tradFiTradfiCreateAccount.js.map +0 -1
- package/dist/esm/funcs/tradFiTradfiDeposit.d.ts +0 -23
- package/dist/esm/funcs/tradFiTradfiDeposit.d.ts.map +0 -1
- package/dist/esm/funcs/tradFiTradfiDeposit.js.map +0 -1
- package/dist/esm/funcs/tradFiTradfiLimitOrder.d.ts +0 -24
- package/dist/esm/funcs/tradFiTradfiLimitOrder.d.ts.map +0 -1
- package/dist/esm/funcs/tradFiTradfiLimitOrder.js.map +0 -1
- package/dist/esm/funcs/tradFiTradfiMarketOrder.d.ts +0 -25
- package/dist/esm/funcs/tradFiTradfiMarketOrder.d.ts.map +0 -1
- package/dist/esm/funcs/tradFiTradfiMarketOrder.js.map +0 -1
- package/dist/esm/funcs/tradFiTradfiOpportunities.d.ts.map +0 -1
- package/dist/esm/funcs/tradFiTradfiOpportunities.js.map +0 -1
- package/dist/esm/funcs/tradFiTradfiPositions.js.map +0 -1
- package/dist/esm/funcs/tradFiTradfiWithdraw.d.ts +0 -23
- package/dist/esm/funcs/tradFiTradfiWithdraw.d.ts.map +0 -1
- package/dist/esm/funcs/tradFiTradfiWithdraw.js +0 -87
- package/dist/esm/funcs/tradFiTradfiWithdraw.js.map +0 -1
- package/dist/esm/models/components/createtradfiaccountrequest.d.ts +0 -37
- package/dist/esm/models/components/createtradfiaccountrequest.d.ts.map +0 -1
- package/dist/esm/models/components/createtradfiaccountrequest.js +0 -25
- package/dist/esm/models/components/createtradfiaccountrequest.js.map +0 -1
- package/dist/esm/models/components/createtradfiaccountresponse.d.ts +0 -21
- package/dist/esm/models/components/createtradfiaccountresponse.d.ts.map +0 -1
- package/dist/esm/models/components/createtradfiaccountresponse.js +0 -20
- package/dist/esm/models/components/createtradfiaccountresponse.js.map +0 -1
- package/dist/esm/models/components/tradficancelorderrequest.d.ts +0 -33
- package/dist/esm/models/components/tradficancelorderrequest.d.ts.map +0 -1
- package/dist/esm/models/components/tradficancelorderrequest.js.map +0 -1
- package/dist/esm/models/components/tradficategory.d.ts +0 -11
- package/dist/esm/models/components/tradficategory.d.ts.map +0 -1
- package/dist/esm/models/components/tradficategory.js +0 -12
- package/dist/esm/models/components/tradficategory.js.map +0 -1
- package/dist/esm/models/components/tradfidepositrequest.d.ts +0 -23
- package/dist/esm/models/components/tradfidepositrequest.d.ts.map +0 -1
- package/dist/esm/models/components/tradfidepositrequest.js +0 -13
- package/dist/esm/models/components/tradfidepositrequest.js.map +0 -1
- package/dist/esm/models/components/tradfidepositresponse.d.ts +0 -17
- package/dist/esm/models/components/tradfidepositresponse.d.ts.map +0 -1
- package/dist/esm/models/components/tradfidepositresponse.js +0 -14
- package/dist/esm/models/components/tradfidepositresponse.js.map +0 -1
- package/dist/esm/models/components/tradfilimitorderrequest.d.ts.map +0 -1
- package/dist/esm/models/components/tradfilimitorderrequest.js.map +0 -1
- package/dist/esm/models/components/tradfimarketorderrequest.d.ts.map +0 -1
- package/dist/esm/models/components/tradfimarketorderrequest.js.map +0 -1
- package/dist/esm/models/components/tradfiopportunitiesresponse.d.ts +0 -17
- package/dist/esm/models/components/tradfiopportunitiesresponse.d.ts.map +0 -1
- package/dist/esm/models/components/tradfiopportunitiesresponse.js +0 -14
- package/dist/esm/models/components/tradfiopportunitiesresponse.js.map +0 -1
- package/dist/esm/models/components/tradfiopportunity.d.ts.map +0 -1
- package/dist/esm/models/components/tradfiopportunity.js.map +0 -1
- package/dist/esm/models/components/tradfiorderresponse.d.ts +0 -14
- package/dist/esm/models/components/tradfiorderresponse.d.ts.map +0 -1
- package/dist/esm/models/components/tradfiorderresponse.js +0 -14
- package/dist/esm/models/components/tradfiorderresponse.js.map +0 -1
- package/dist/esm/models/components/tradfiposition.d.ts.map +0 -1
- package/dist/esm/models/components/tradfiposition.js.map +0 -1
- package/dist/esm/models/components/tradfipositionsresponse.d.ts +0 -17
- package/dist/esm/models/components/tradfipositionsresponse.d.ts.map +0 -1
- package/dist/esm/models/components/tradfipositionsresponse.js +0 -14
- package/dist/esm/models/components/tradfipositionsresponse.js.map +0 -1
- package/dist/esm/models/components/tradfiwithdrawrequest.d.ts +0 -28
- package/dist/esm/models/components/tradfiwithdrawrequest.d.ts.map +0 -1
- package/dist/esm/models/components/tradfiwithdrawrequest.js +0 -14
- package/dist/esm/models/components/tradfiwithdrawrequest.js.map +0 -1
- package/dist/esm/models/components/tradfiwithdrawresponse.d.ts +0 -17
- package/dist/esm/models/components/tradfiwithdrawresponse.d.ts.map +0 -1
- package/dist/esm/models/components/tradfiwithdrawresponse.js +0 -14
- package/dist/esm/models/components/tradfiwithdrawresponse.js.map +0 -1
- package/dist/esm/models/operations/v2tradfiopportunities.d.ts +0 -64
- package/dist/esm/models/operations/v2tradfiopportunities.d.ts.map +0 -1
- package/dist/esm/models/operations/v2tradfiopportunities.js +0 -44
- package/dist/esm/models/operations/v2tradfiopportunities.js.map +0 -1
- package/dist/esm/models/operations/v2tradfipositions.d.ts +0 -20
- package/dist/esm/models/operations/v2tradfipositions.d.ts.map +0 -1
- package/dist/esm/models/operations/v2tradfipositions.js +0 -13
- package/dist/esm/models/operations/v2tradfipositions.js.map +0 -1
- package/dist/esm/sdk/tradfi.d.ts +0 -106
- package/dist/esm/sdk/tradfi.d.ts.map +0 -1
- package/dist/esm/sdk/tradfi.js +0 -132
- package/dist/esm/sdk/tradfi.js.map +0 -1
- package/docs/models/components/createtradfiaccountrequest.md +0 -24
- package/docs/models/components/createtradfiaccountrequestchain.md +0 -15
- package/docs/models/components/createtradfiaccountresponse.md +0 -21
- package/docs/models/components/tradficategory.md +0 -15
- package/docs/models/components/tradfidepositresponse.md +0 -19
- package/docs/models/components/tradfiopportunitiesresponse.md +0 -19
- package/docs/models/components/tradfiorderresponse.md +0 -29
- package/docs/models/components/tradfipositionsresponse.md +0 -19
- package/docs/models/components/tradfiwithdrawrequest.md +0 -22
- package/docs/models/components/tradfiwithdrawresponse.md +0 -19
- package/docs/models/operations/tradfisortby.md +0 -17
- package/docs/models/operations/tradfisortorder.md +0 -17
- package/docs/models/operations/v2tradfiopportunitiesrequest.md +0 -22
- package/docs/models/operations/v2tradfipositionsrequest.md +0 -18
- package/src/funcs/tradFiTradfiWithdraw.ts +0 -174
- package/src/models/components/createtradfiaccountrequest.ts +0 -70
- package/src/models/components/createtradfiaccountresponse.ts +0 -51
- package/src/models/components/tradficategory.ts +0 -18
- package/src/models/components/tradfidepositrequest.ts +0 -43
- package/src/models/components/tradfidepositresponse.ts +0 -41
- package/src/models/components/tradfiopportunitiesresponse.ts +0 -41
- package/src/models/components/tradfiorderresponse.ts +0 -38
- package/src/models/components/tradfipositionsresponse.ts +0 -41
- package/src/models/components/tradfiwithdrawrequest.ts +0 -49
- package/src/models/components/tradfiwithdrawresponse.ts +0 -41
- package/src/models/operations/v2tradfiopportunities.ts +0 -104
- package/src/models/operations/v2tradfipositions.ts +0 -40
- package/src/sdk/tradfi.ts +0 -198
|
@@ -1,31 +1,32 @@
|
|
|
1
|
-
#
|
|
1
|
+
# TraditionalInvesting
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
4
|
|
|
5
5
|
### Available Operations
|
|
6
6
|
|
|
7
|
-
* [
|
|
8
|
-
* [
|
|
9
|
-
* [
|
|
10
|
-
* [
|
|
11
|
-
* [
|
|
12
|
-
* [
|
|
13
|
-
* [
|
|
14
|
-
* [
|
|
7
|
+
* [traditionalInvestingOpportunities](#traditionalinvestingopportunities) - List traditional investing perp markets
|
|
8
|
+
* [traditionalInvestingPositions](#traditionalinvestingpositions) - List traditional investing positions
|
|
9
|
+
* [traditionalInvestingDeposit](#traditionalinvestingdeposit) - Deposit USDC to traditional investments account
|
|
10
|
+
* [traditionalInvestingWithdraw](#traditionalinvestingwithdraw) - Withdraw USDC from traditional investments account
|
|
11
|
+
* [traditionalInvestingMarketOrder](#traditionalinvestingmarketorder) - Place market order
|
|
12
|
+
* [traditionalInvestingLimitOrder](#traditionalinvestinglimitorder) - Place limit order
|
|
13
|
+
* [traditionalInvestingCancelOrder](#traditionalinvestingcancelorder) - Cancel order
|
|
14
|
+
* [traditionalInvestingExecute](#traditionalinvestingexecute) - Execute signed action
|
|
15
|
+
* [traditionalInvestingApproveBuilderFee](#traditionalinvestingapprovebuilderfee) - Approve builder fee
|
|
15
16
|
|
|
16
|
-
##
|
|
17
|
+
## traditionalInvestingOpportunities
|
|
17
18
|
|
|
18
|
-
List available
|
|
19
|
+
List available traditional investing perpetual futures markets with key metrics.
|
|
19
20
|
|
|
20
|
-
Returns
|
|
21
|
+
Returns perp markets (stocks, commodities, forex) with open interest,
|
|
21
22
|
24h volume, funding rate, and max leverage. Supports filtering by category,
|
|
22
23
|
minimum OI/volume, and sorting.
|
|
23
24
|
|
|
24
|
-
Only
|
|
25
|
+
Only traditional investing assets are returned — crypto perps are excluded.
|
|
25
26
|
|
|
26
27
|
### Example Usage
|
|
27
28
|
|
|
28
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
29
|
+
<!-- UsageSnippet language="typescript" operationID="v2_traditional_investing_opportunities" method="get" path="/v2/traditional_investing/opportunities" -->
|
|
29
30
|
```typescript
|
|
30
31
|
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
31
32
|
|
|
@@ -34,7 +35,7 @@ const compassApiSDK = new CompassApiSDK({
|
|
|
34
35
|
});
|
|
35
36
|
|
|
36
37
|
async function run() {
|
|
37
|
-
const result = await compassApiSDK.
|
|
38
|
+
const result = await compassApiSDK.traditionalInvesting.traditionalInvestingOpportunities({
|
|
38
39
|
sortBy: "volume_24h",
|
|
39
40
|
sortOrder: "desc",
|
|
40
41
|
});
|
|
@@ -51,7 +52,7 @@ The standalone function version of this method:
|
|
|
51
52
|
|
|
52
53
|
```typescript
|
|
53
54
|
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
54
|
-
import {
|
|
55
|
+
import { traditionalInvestingTraditionalInvestingOpportunities } from "@compass-labs/api-sdk/funcs/traditionalInvestingTraditionalInvestingOpportunities.js";
|
|
55
56
|
|
|
56
57
|
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
57
58
|
// You can create one instance of it to use across an application.
|
|
@@ -60,7 +61,7 @@ const compassApiSDK = new CompassApiSDKCore({
|
|
|
60
61
|
});
|
|
61
62
|
|
|
62
63
|
async function run() {
|
|
63
|
-
const res = await
|
|
64
|
+
const res = await traditionalInvestingTraditionalInvestingOpportunities(compassApiSDK, {
|
|
64
65
|
sortBy: "volume_24h",
|
|
65
66
|
sortOrder: "desc",
|
|
66
67
|
});
|
|
@@ -68,7 +69,7 @@ async function run() {
|
|
|
68
69
|
const { value: result } = res;
|
|
69
70
|
console.log(result);
|
|
70
71
|
} else {
|
|
71
|
-
console.log("
|
|
72
|
+
console.log("traditionalInvestingTraditionalInvestingOpportunities failed:", res.error);
|
|
72
73
|
}
|
|
73
74
|
}
|
|
74
75
|
|
|
@@ -79,14 +80,14 @@ run();
|
|
|
79
80
|
|
|
80
81
|
| Parameter | Type | Required | Description |
|
|
81
82
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
82
|
-
| `request` | [operations.
|
|
83
|
+
| `request` | [operations.V2TraditionalInvestingOpportunitiesRequest](../../models/operations/v2traditionalinvestingopportunitiesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
83
84
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
84
85
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
85
86
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
86
87
|
|
|
87
88
|
### Response
|
|
88
89
|
|
|
89
|
-
**Promise\<[components.
|
|
90
|
+
**Promise\<[components.TraditionalInvestingOpportunitiesResponse](../../models/components/traditionalinvestingopportunitiesresponse.md)\>**
|
|
90
91
|
|
|
91
92
|
### Errors
|
|
92
93
|
|
|
@@ -95,19 +96,17 @@ run();
|
|
|
95
96
|
| errors.HTTPValidationError | 422 | application/json |
|
|
96
97
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
97
98
|
|
|
98
|
-
##
|
|
99
|
+
## traditionalInvestingPositions
|
|
99
100
|
|
|
100
|
-
List open perpetual futures positions for a user
|
|
101
|
+
List open perpetual futures positions for a user.
|
|
101
102
|
|
|
102
103
|
Returns position data including size, entry price, mark price, PnL, liquidation price,
|
|
103
104
|
leverage, and cumulative funding. Optionally filter by asset ticker.
|
|
104
|
-
|
|
105
|
-
Returns 404 if the user has no TradFi product account.
|
|
106
105
|
Returns an empty list if no positions are open.
|
|
107
106
|
|
|
108
107
|
### Example Usage
|
|
109
108
|
|
|
110
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
109
|
+
<!-- UsageSnippet language="typescript" operationID="v2_traditional_investing_positions" method="get" path="/v2/traditional_investing/positions" -->
|
|
111
110
|
```typescript
|
|
112
111
|
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
113
112
|
|
|
@@ -116,7 +115,7 @@ const compassApiSDK = new CompassApiSDK({
|
|
|
116
115
|
});
|
|
117
116
|
|
|
118
117
|
async function run() {
|
|
119
|
-
const result = await compassApiSDK.
|
|
118
|
+
const result = await compassApiSDK.traditionalInvesting.traditionalInvestingPositions({
|
|
120
119
|
owner: "0x01E62835dd7F52173546A325294762143eE4a882",
|
|
121
120
|
});
|
|
122
121
|
|
|
@@ -132,7 +131,7 @@ The standalone function version of this method:
|
|
|
132
131
|
|
|
133
132
|
```typescript
|
|
134
133
|
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
135
|
-
import {
|
|
134
|
+
import { traditionalInvestingTraditionalInvestingPositions } from "@compass-labs/api-sdk/funcs/traditionalInvestingTraditionalInvestingPositions.js";
|
|
136
135
|
|
|
137
136
|
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
138
137
|
// You can create one instance of it to use across an application.
|
|
@@ -141,14 +140,14 @@ const compassApiSDK = new CompassApiSDKCore({
|
|
|
141
140
|
});
|
|
142
141
|
|
|
143
142
|
async function run() {
|
|
144
|
-
const res = await
|
|
143
|
+
const res = await traditionalInvestingTraditionalInvestingPositions(compassApiSDK, {
|
|
145
144
|
owner: "0x01E62835dd7F52173546A325294762143eE4a882",
|
|
146
145
|
});
|
|
147
146
|
if (res.ok) {
|
|
148
147
|
const { value: result } = res;
|
|
149
148
|
console.log(result);
|
|
150
149
|
} else {
|
|
151
|
-
console.log("
|
|
150
|
+
console.log("traditionalInvestingTraditionalInvestingPositions failed:", res.error);
|
|
152
151
|
}
|
|
153
152
|
}
|
|
154
153
|
|
|
@@ -159,14 +158,14 @@ run();
|
|
|
159
158
|
|
|
160
159
|
| Parameter | Type | Required | Description |
|
|
161
160
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
162
|
-
| `request` | [operations.
|
|
161
|
+
| `request` | [operations.V2TraditionalInvestingPositionsRequest](../../models/operations/v2traditionalinvestingpositionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
163
162
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
164
163
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
165
164
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
166
165
|
|
|
167
166
|
### Response
|
|
168
167
|
|
|
169
|
-
**Promise\<[components.
|
|
168
|
+
**Promise\<[components.TraditionalInvestingPositionsResponse](../../models/components/traditionalinvestingpositionsresponse.md)\>**
|
|
170
169
|
|
|
171
170
|
### Errors
|
|
172
171
|
|
|
@@ -175,19 +174,17 @@ run();
|
|
|
175
174
|
| errors.HTTPValidationError | 422 | application/json |
|
|
176
175
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
177
176
|
|
|
178
|
-
##
|
|
179
|
-
|
|
180
|
-
Create a TradFi product account on HyperEVM.
|
|
177
|
+
## traditionalInvestingDeposit
|
|
181
178
|
|
|
182
|
-
|
|
183
|
-
product account. Each wallet address has one TradFi account.
|
|
179
|
+
Prepare a USDC deposit from Arbitrum via EIP-2612 Permit.
|
|
184
180
|
|
|
185
|
-
Returns
|
|
186
|
-
|
|
181
|
+
Returns EIP-712 typed data for the user to sign off-chain (no gas needed).
|
|
182
|
+
After signing, send the permit signature to the deposit/execute endpoint,
|
|
183
|
+
where a gas sponsor calls batchedDepositWithPermit on the HL Bridge2.
|
|
187
184
|
|
|
188
185
|
### Example Usage
|
|
189
186
|
|
|
190
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
187
|
+
<!-- UsageSnippet language="typescript" operationID="v2_traditional_investing_deposit" method="post" path="/v2/traditional_investing/deposit" -->
|
|
191
188
|
```typescript
|
|
192
189
|
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
193
190
|
|
|
@@ -196,10 +193,9 @@ const compassApiSDK = new CompassApiSDK({
|
|
|
196
193
|
});
|
|
197
194
|
|
|
198
195
|
async function run() {
|
|
199
|
-
const result = await compassApiSDK.
|
|
200
|
-
chain: "hyperevm",
|
|
201
|
-
sender: "0x01E62835dd7F52173546A325294762143eE4a882",
|
|
196
|
+
const result = await compassApiSDK.traditionalInvesting.traditionalInvestingDeposit({
|
|
202
197
|
owner: "0x01E62835dd7F52173546A325294762143eE4a882",
|
|
198
|
+
amount: "100.0",
|
|
203
199
|
});
|
|
204
200
|
|
|
205
201
|
console.log(result);
|
|
@@ -214,7 +210,7 @@ The standalone function version of this method:
|
|
|
214
210
|
|
|
215
211
|
```typescript
|
|
216
212
|
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
217
|
-
import {
|
|
213
|
+
import { traditionalInvestingTraditionalInvestingDeposit } from "@compass-labs/api-sdk/funcs/traditionalInvestingTraditionalInvestingDeposit.js";
|
|
218
214
|
|
|
219
215
|
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
220
216
|
// You can create one instance of it to use across an application.
|
|
@@ -223,16 +219,15 @@ const compassApiSDK = new CompassApiSDKCore({
|
|
|
223
219
|
});
|
|
224
220
|
|
|
225
221
|
async function run() {
|
|
226
|
-
const res = await
|
|
227
|
-
chain: "hyperevm",
|
|
228
|
-
sender: "0x01E62835dd7F52173546A325294762143eE4a882",
|
|
222
|
+
const res = await traditionalInvestingTraditionalInvestingDeposit(compassApiSDK, {
|
|
229
223
|
owner: "0x01E62835dd7F52173546A325294762143eE4a882",
|
|
224
|
+
amount: "100.0",
|
|
230
225
|
});
|
|
231
226
|
if (res.ok) {
|
|
232
227
|
const { value: result } = res;
|
|
233
228
|
console.log(result);
|
|
234
229
|
} else {
|
|
235
|
-
console.log("
|
|
230
|
+
console.log("traditionalInvestingTraditionalInvestingDeposit failed:", res.error);
|
|
236
231
|
}
|
|
237
232
|
}
|
|
238
233
|
|
|
@@ -243,14 +238,14 @@ run();
|
|
|
243
238
|
|
|
244
239
|
| Parameter | Type | Required | Description |
|
|
245
240
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
246
|
-
| `request` | [components.
|
|
241
|
+
| `request` | [components.TraditionalInvestingDepositRequest](../../models/components/traditionalinvestingdepositrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
247
242
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
248
243
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
249
244
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
250
245
|
|
|
251
246
|
### Response
|
|
252
247
|
|
|
253
|
-
**Promise\<[components.
|
|
248
|
+
**Promise\<[components.TraditionalInvestingDepositResponse](../../models/components/traditionalinvestingdepositresponse.md)\>**
|
|
254
249
|
|
|
255
250
|
### Errors
|
|
256
251
|
|
|
@@ -259,18 +254,17 @@ run();
|
|
|
259
254
|
| errors.HTTPValidationError | 422 | application/json |
|
|
260
255
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
261
256
|
|
|
262
|
-
##
|
|
257
|
+
## traditionalInvestingWithdraw
|
|
263
258
|
|
|
264
|
-
|
|
259
|
+
Prepare a USDC withdrawal from Hyperliquid to Arbitrum.
|
|
265
260
|
|
|
266
|
-
Returns
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
After the bridge deposit confirms, USDC lands on HyperCore and can be used for trading.
|
|
261
|
+
Returns EIP-712 typed data for the user to sign. After signing, submit
|
|
262
|
+
the signature via the /execute endpoint. Withdrawal processing takes
|
|
263
|
+
minutes to hours depending on bridge conditions.
|
|
270
264
|
|
|
271
265
|
### Example Usage
|
|
272
266
|
|
|
273
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
267
|
+
<!-- UsageSnippet language="typescript" operationID="v2_traditional_investing_withdraw" method="post" path="/v2/traditional_investing/withdraw" -->
|
|
274
268
|
```typescript
|
|
275
269
|
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
276
270
|
|
|
@@ -279,7 +273,7 @@ const compassApiSDK = new CompassApiSDK({
|
|
|
279
273
|
});
|
|
280
274
|
|
|
281
275
|
async function run() {
|
|
282
|
-
const result = await compassApiSDK.
|
|
276
|
+
const result = await compassApiSDK.traditionalInvesting.traditionalInvestingWithdraw({
|
|
283
277
|
owner: "0x01E62835dd7F52173546A325294762143eE4a882",
|
|
284
278
|
amount: "100.0",
|
|
285
279
|
});
|
|
@@ -296,7 +290,7 @@ The standalone function version of this method:
|
|
|
296
290
|
|
|
297
291
|
```typescript
|
|
298
292
|
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
299
|
-
import {
|
|
293
|
+
import { traditionalInvestingTraditionalInvestingWithdraw } from "@compass-labs/api-sdk/funcs/traditionalInvestingTraditionalInvestingWithdraw.js";
|
|
300
294
|
|
|
301
295
|
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
302
296
|
// You can create one instance of it to use across an application.
|
|
@@ -305,7 +299,7 @@ const compassApiSDK = new CompassApiSDKCore({
|
|
|
305
299
|
});
|
|
306
300
|
|
|
307
301
|
async function run() {
|
|
308
|
-
const res = await
|
|
302
|
+
const res = await traditionalInvestingTraditionalInvestingWithdraw(compassApiSDK, {
|
|
309
303
|
owner: "0x01E62835dd7F52173546A325294762143eE4a882",
|
|
310
304
|
amount: "100.0",
|
|
311
305
|
});
|
|
@@ -313,7 +307,7 @@ async function run() {
|
|
|
313
307
|
const { value: result } = res;
|
|
314
308
|
console.log(result);
|
|
315
309
|
} else {
|
|
316
|
-
console.log("
|
|
310
|
+
console.log("traditionalInvestingTraditionalInvestingWithdraw failed:", res.error);
|
|
317
311
|
}
|
|
318
312
|
}
|
|
319
313
|
|
|
@@ -324,14 +318,14 @@ run();
|
|
|
324
318
|
|
|
325
319
|
| Parameter | Type | Required | Description |
|
|
326
320
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
327
|
-
| `request` | [components.
|
|
321
|
+
| `request` | [components.TraditionalInvestingWithdrawRequest](../../models/components/traditionalinvestingwithdrawrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
328
322
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
329
323
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
330
324
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
331
325
|
|
|
332
326
|
### Response
|
|
333
327
|
|
|
334
|
-
**Promise\<[components.
|
|
328
|
+
**Promise\<[components.TraditionalInvestingSignableActionResponse](../../models/components/traditionalinvestingsignableactionresponse.md)\>**
|
|
335
329
|
|
|
336
330
|
### Errors
|
|
337
331
|
|
|
@@ -340,18 +334,17 @@ run();
|
|
|
340
334
|
| errors.HTTPValidationError | 422 | application/json |
|
|
341
335
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
342
336
|
|
|
343
|
-
##
|
|
344
|
-
|
|
345
|
-
Withdraw USDC from HyperEVM Safe back to Arbitrum.
|
|
337
|
+
## traditionalInvestingMarketOrder
|
|
346
338
|
|
|
347
|
-
|
|
348
|
-
then initiate a withdrawal to the destination address on Arbitrum.
|
|
339
|
+
Prepare a market order on a traditional investments perpetual futures market.
|
|
349
340
|
|
|
350
|
-
|
|
341
|
+
Returns EIP-712 typed data for the user to sign. After signing, submit
|
|
342
|
+
the signature via the /execute endpoint. Executes as an IOC order at the
|
|
343
|
+
current mark price with slippage protection.
|
|
351
344
|
|
|
352
345
|
### Example Usage
|
|
353
346
|
|
|
354
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
347
|
+
<!-- UsageSnippet language="typescript" operationID="v2_traditional_investing_market_order" method="post" path="/v2/traditional_investing/market_order" -->
|
|
355
348
|
```typescript
|
|
356
349
|
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
357
350
|
|
|
@@ -360,9 +353,13 @@ const compassApiSDK = new CompassApiSDK({
|
|
|
360
353
|
});
|
|
361
354
|
|
|
362
355
|
async function run() {
|
|
363
|
-
const result = await compassApiSDK.
|
|
356
|
+
const result = await compassApiSDK.traditionalInvesting.traditionalInvestingMarketOrder({
|
|
364
357
|
owner: "0x01E62835dd7F52173546A325294762143eE4a882",
|
|
365
|
-
|
|
358
|
+
asset: "AAPL",
|
|
359
|
+
side: "buy",
|
|
360
|
+
size: "10.0",
|
|
361
|
+
slippagePercent: 1,
|
|
362
|
+
reduceOnly: false,
|
|
366
363
|
});
|
|
367
364
|
|
|
368
365
|
console.log(result);
|
|
@@ -377,7 +374,7 @@ The standalone function version of this method:
|
|
|
377
374
|
|
|
378
375
|
```typescript
|
|
379
376
|
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
380
|
-
import {
|
|
377
|
+
import { traditionalInvestingTraditionalInvestingMarketOrder } from "@compass-labs/api-sdk/funcs/traditionalInvestingTraditionalInvestingMarketOrder.js";
|
|
381
378
|
|
|
382
379
|
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
383
380
|
// You can create one instance of it to use across an application.
|
|
@@ -386,15 +383,19 @@ const compassApiSDK = new CompassApiSDKCore({
|
|
|
386
383
|
});
|
|
387
384
|
|
|
388
385
|
async function run() {
|
|
389
|
-
const res = await
|
|
386
|
+
const res = await traditionalInvestingTraditionalInvestingMarketOrder(compassApiSDK, {
|
|
390
387
|
owner: "0x01E62835dd7F52173546A325294762143eE4a882",
|
|
391
|
-
|
|
388
|
+
asset: "AAPL",
|
|
389
|
+
side: "buy",
|
|
390
|
+
size: "10.0",
|
|
391
|
+
slippagePercent: 1,
|
|
392
|
+
reduceOnly: false,
|
|
392
393
|
});
|
|
393
394
|
if (res.ok) {
|
|
394
395
|
const { value: result } = res;
|
|
395
396
|
console.log(result);
|
|
396
397
|
} else {
|
|
397
|
-
console.log("
|
|
398
|
+
console.log("traditionalInvestingTraditionalInvestingMarketOrder failed:", res.error);
|
|
398
399
|
}
|
|
399
400
|
}
|
|
400
401
|
|
|
@@ -405,14 +406,14 @@ run();
|
|
|
405
406
|
|
|
406
407
|
| Parameter | Type | Required | Description |
|
|
407
408
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
408
|
-
| `request` | [components.
|
|
409
|
+
| `request` | [components.TraditionalInvestingMarketOrderRequest](../../models/components/traditionalinvestingmarketorderrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
409
410
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
410
411
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
411
412
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
412
413
|
|
|
413
414
|
### Response
|
|
414
415
|
|
|
415
|
-
**Promise\<[components.
|
|
416
|
+
**Promise\<[components.TraditionalInvestingSignableActionResponse](../../models/components/traditionalinvestingsignableactionresponse.md)\>**
|
|
416
417
|
|
|
417
418
|
### Errors
|
|
418
419
|
|
|
@@ -421,20 +422,16 @@ run();
|
|
|
421
422
|
| errors.HTTPValidationError | 422 | application/json |
|
|
422
423
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
423
424
|
|
|
424
|
-
##
|
|
425
|
+
## traditionalInvestingLimitOrder
|
|
425
426
|
|
|
426
|
-
|
|
427
|
+
Prepare a limit order on a traditional investments perpetual futures market.
|
|
427
428
|
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
CoreWriter call on HyperEVM.
|
|
431
|
-
|
|
432
|
-
Orders are asynchronous — execution confirms a few seconds after the transaction,
|
|
433
|
-
not atomically.
|
|
429
|
+
Returns EIP-712 typed data for the user to sign. After signing, submit
|
|
430
|
+
the signature via the /execute endpoint. Supports GTC and ALO time-in-force.
|
|
434
431
|
|
|
435
432
|
### Example Usage
|
|
436
433
|
|
|
437
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
434
|
+
<!-- UsageSnippet language="typescript" operationID="v2_traditional_investing_limit_order" method="post" path="/v2/traditional_investing/limit_order" -->
|
|
438
435
|
```typescript
|
|
439
436
|
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
440
437
|
|
|
@@ -443,12 +440,13 @@ const compassApiSDK = new CompassApiSDK({
|
|
|
443
440
|
});
|
|
444
441
|
|
|
445
442
|
async function run() {
|
|
446
|
-
const result = await compassApiSDK.
|
|
443
|
+
const result = await compassApiSDK.traditionalInvesting.traditionalInvestingLimitOrder({
|
|
447
444
|
owner: "0x01E62835dd7F52173546A325294762143eE4a882",
|
|
448
445
|
asset: "AAPL",
|
|
449
446
|
side: "buy",
|
|
450
447
|
size: "10.0",
|
|
451
|
-
|
|
448
|
+
price: "190.00",
|
|
449
|
+
timeInForce: "gtc",
|
|
452
450
|
reduceOnly: false,
|
|
453
451
|
});
|
|
454
452
|
|
|
@@ -464,7 +462,7 @@ The standalone function version of this method:
|
|
|
464
462
|
|
|
465
463
|
```typescript
|
|
466
464
|
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
467
|
-
import {
|
|
465
|
+
import { traditionalInvestingTraditionalInvestingLimitOrder } from "@compass-labs/api-sdk/funcs/traditionalInvestingTraditionalInvestingLimitOrder.js";
|
|
468
466
|
|
|
469
467
|
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
470
468
|
// You can create one instance of it to use across an application.
|
|
@@ -473,19 +471,20 @@ const compassApiSDK = new CompassApiSDKCore({
|
|
|
473
471
|
});
|
|
474
472
|
|
|
475
473
|
async function run() {
|
|
476
|
-
const res = await
|
|
474
|
+
const res = await traditionalInvestingTraditionalInvestingLimitOrder(compassApiSDK, {
|
|
477
475
|
owner: "0x01E62835dd7F52173546A325294762143eE4a882",
|
|
478
476
|
asset: "AAPL",
|
|
479
477
|
side: "buy",
|
|
480
478
|
size: "10.0",
|
|
481
|
-
|
|
479
|
+
price: "190.00",
|
|
480
|
+
timeInForce: "gtc",
|
|
482
481
|
reduceOnly: false,
|
|
483
482
|
});
|
|
484
483
|
if (res.ok) {
|
|
485
484
|
const { value: result } = res;
|
|
486
485
|
console.log(result);
|
|
487
486
|
} else {
|
|
488
|
-
console.log("
|
|
487
|
+
console.log("traditionalInvestingTraditionalInvestingLimitOrder failed:", res.error);
|
|
489
488
|
}
|
|
490
489
|
}
|
|
491
490
|
|
|
@@ -496,14 +495,14 @@ run();
|
|
|
496
495
|
|
|
497
496
|
| Parameter | Type | Required | Description |
|
|
498
497
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
499
|
-
| `request` | [components.
|
|
498
|
+
| `request` | [components.TraditionalInvestingLimitOrderRequest](../../models/components/traditionalinvestinglimitorderrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
500
499
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
501
500
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
502
501
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
503
502
|
|
|
504
503
|
### Response
|
|
505
504
|
|
|
506
|
-
**Promise\<[components.
|
|
505
|
+
**Promise\<[components.TraditionalInvestingSignableActionResponse](../../models/components/traditionalinvestingsignableactionresponse.md)\>**
|
|
507
506
|
|
|
508
507
|
### Errors
|
|
509
508
|
|
|
@@ -512,19 +511,16 @@ run();
|
|
|
512
511
|
| errors.HTTPValidationError | 422 | application/json |
|
|
513
512
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
514
513
|
|
|
515
|
-
##
|
|
516
|
-
|
|
517
|
-
Place a limit order on a TradFi perpetual futures market.
|
|
514
|
+
## traditionalInvestingCancelOrder
|
|
518
515
|
|
|
519
|
-
|
|
520
|
-
The transaction is a Safe execTransaction wrapping a CoreWriter call on HyperEVM.
|
|
516
|
+
Prepare an order cancellation.
|
|
521
517
|
|
|
522
|
-
|
|
523
|
-
|
|
518
|
+
Returns EIP-712 typed data for the user to sign. After signing, submit
|
|
519
|
+
the signature via the /execute endpoint.
|
|
524
520
|
|
|
525
521
|
### Example Usage
|
|
526
522
|
|
|
527
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
523
|
+
<!-- UsageSnippet language="typescript" operationID="v2_traditional_investing_cancel_order" method="post" path="/v2/traditional_investing/cancel_order" -->
|
|
528
524
|
```typescript
|
|
529
525
|
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
530
526
|
|
|
@@ -533,14 +529,10 @@ const compassApiSDK = new CompassApiSDK({
|
|
|
533
529
|
});
|
|
534
530
|
|
|
535
531
|
async function run() {
|
|
536
|
-
const result = await compassApiSDK.
|
|
532
|
+
const result = await compassApiSDK.traditionalInvesting.traditionalInvestingCancelOrder({
|
|
537
533
|
owner: "0x01E62835dd7F52173546A325294762143eE4a882",
|
|
538
534
|
asset: "AAPL",
|
|
539
|
-
|
|
540
|
-
size: "10.0",
|
|
541
|
-
price: "190.00",
|
|
542
|
-
timeInForce: "gtc",
|
|
543
|
-
reduceOnly: false,
|
|
535
|
+
orderId: 12345,
|
|
544
536
|
});
|
|
545
537
|
|
|
546
538
|
console.log(result);
|
|
@@ -555,7 +547,7 @@ The standalone function version of this method:
|
|
|
555
547
|
|
|
556
548
|
```typescript
|
|
557
549
|
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
558
|
-
import {
|
|
550
|
+
import { traditionalInvestingTraditionalInvestingCancelOrder } from "@compass-labs/api-sdk/funcs/traditionalInvestingTraditionalInvestingCancelOrder.js";
|
|
559
551
|
|
|
560
552
|
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
561
553
|
// You can create one instance of it to use across an application.
|
|
@@ -564,20 +556,16 @@ const compassApiSDK = new CompassApiSDKCore({
|
|
|
564
556
|
});
|
|
565
557
|
|
|
566
558
|
async function run() {
|
|
567
|
-
const res = await
|
|
559
|
+
const res = await traditionalInvestingTraditionalInvestingCancelOrder(compassApiSDK, {
|
|
568
560
|
owner: "0x01E62835dd7F52173546A325294762143eE4a882",
|
|
569
561
|
asset: "AAPL",
|
|
570
|
-
|
|
571
|
-
size: "10.0",
|
|
572
|
-
price: "190.00",
|
|
573
|
-
timeInForce: "gtc",
|
|
574
|
-
reduceOnly: false,
|
|
562
|
+
orderId: 12345,
|
|
575
563
|
});
|
|
576
564
|
if (res.ok) {
|
|
577
565
|
const { value: result } = res;
|
|
578
566
|
console.log(result);
|
|
579
567
|
} else {
|
|
580
|
-
console.log("
|
|
568
|
+
console.log("traditionalInvestingTraditionalInvestingCancelOrder failed:", res.error);
|
|
581
569
|
}
|
|
582
570
|
}
|
|
583
571
|
|
|
@@ -588,14 +576,14 @@ run();
|
|
|
588
576
|
|
|
589
577
|
| Parameter | Type | Required | Description |
|
|
590
578
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
591
|
-
| `request` | [components.
|
|
579
|
+
| `request` | [components.TraditionalInvestingCancelOrderRequest](../../models/components/traditionalinvestingcancelorderrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
592
580
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
593
581
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
594
582
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
595
583
|
|
|
596
584
|
### Response
|
|
597
585
|
|
|
598
|
-
**Promise\<[components.
|
|
586
|
+
**Promise\<[components.TraditionalInvestingSignableActionResponse](../../models/components/traditionalinvestingsignableactionresponse.md)\>**
|
|
599
587
|
|
|
600
588
|
### Errors
|
|
601
589
|
|
|
@@ -604,16 +592,17 @@ run();
|
|
|
604
592
|
| errors.HTTPValidationError | 422 | application/json |
|
|
605
593
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
606
594
|
|
|
607
|
-
##
|
|
595
|
+
## traditionalInvestingExecute
|
|
608
596
|
|
|
609
|
-
|
|
597
|
+
Submit a signed Hyperliquid action for execution.
|
|
610
598
|
|
|
611
|
-
|
|
612
|
-
|
|
599
|
+
Accepts the signature from any prepare endpoint (market_order, limit_order,
|
|
600
|
+
cancel_order, withdraw, approve_builder_fee) and POSTs it to the Hyperliquid
|
|
601
|
+
exchange API.
|
|
613
602
|
|
|
614
603
|
### Example Usage
|
|
615
604
|
|
|
616
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
605
|
+
<!-- UsageSnippet language="typescript" operationID="v2_traditional_investing_execute" method="post" path="/v2/traditional_investing/execute" -->
|
|
617
606
|
```typescript
|
|
618
607
|
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
619
608
|
|
|
@@ -622,10 +611,14 @@ const compassApiSDK = new CompassApiSDK({
|
|
|
622
611
|
});
|
|
623
612
|
|
|
624
613
|
async function run() {
|
|
625
|
-
const result = await compassApiSDK.
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
614
|
+
const result = await compassApiSDK.traditionalInvesting.traditionalInvestingExecute({
|
|
615
|
+
action: {
|
|
616
|
+
"key": "<value>",
|
|
617
|
+
"key1": "<value>",
|
|
618
|
+
"key2": "<value>",
|
|
619
|
+
},
|
|
620
|
+
nonce: 31516,
|
|
621
|
+
signature: "<value>",
|
|
629
622
|
});
|
|
630
623
|
|
|
631
624
|
console.log(result);
|
|
@@ -640,7 +633,7 @@ The standalone function version of this method:
|
|
|
640
633
|
|
|
641
634
|
```typescript
|
|
642
635
|
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
643
|
-
import {
|
|
636
|
+
import { traditionalInvestingTraditionalInvestingExecute } from "@compass-labs/api-sdk/funcs/traditionalInvestingTraditionalInvestingExecute.js";
|
|
644
637
|
|
|
645
638
|
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
646
639
|
// You can create one instance of it to use across an application.
|
|
@@ -649,16 +642,98 @@ const compassApiSDK = new CompassApiSDKCore({
|
|
|
649
642
|
});
|
|
650
643
|
|
|
651
644
|
async function run() {
|
|
652
|
-
const res = await
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
645
|
+
const res = await traditionalInvestingTraditionalInvestingExecute(compassApiSDK, {
|
|
646
|
+
action: {
|
|
647
|
+
"key": "<value>",
|
|
648
|
+
"key1": "<value>",
|
|
649
|
+
"key2": "<value>",
|
|
650
|
+
},
|
|
651
|
+
nonce: 31516,
|
|
652
|
+
signature: "<value>",
|
|
653
|
+
});
|
|
654
|
+
if (res.ok) {
|
|
655
|
+
const { value: result } = res;
|
|
656
|
+
console.log(result);
|
|
657
|
+
} else {
|
|
658
|
+
console.log("traditionalInvestingTraditionalInvestingExecute failed:", res.error);
|
|
659
|
+
}
|
|
660
|
+
}
|
|
661
|
+
|
|
662
|
+
run();
|
|
663
|
+
```
|
|
664
|
+
|
|
665
|
+
### Parameters
|
|
666
|
+
|
|
667
|
+
| Parameter | Type | Required | Description |
|
|
668
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
669
|
+
| `request` | [components.TraditionalInvestingExecuteRequest](../../models/components/traditionalinvestingexecuterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
670
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
671
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
672
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
673
|
+
|
|
674
|
+
### Response
|
|
675
|
+
|
|
676
|
+
**Promise\<[components.TraditionalInvestingExecuteResponse](../../models/components/traditionalinvestingexecuteresponse.md)\>**
|
|
677
|
+
|
|
678
|
+
### Errors
|
|
679
|
+
|
|
680
|
+
| Error Type | Status Code | Content Type |
|
|
681
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
682
|
+
| errors.HTTPValidationError | 422 | application/json |
|
|
683
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
684
|
+
|
|
685
|
+
## traditionalInvestingApproveBuilderFee
|
|
686
|
+
|
|
687
|
+
Prepare builder fee approval for the traditional investments DEX.
|
|
688
|
+
|
|
689
|
+
This is a one-time action required before placing the first trade.
|
|
690
|
+
Returns EIP-712 typed data for the user to sign. After signing, submit
|
|
691
|
+
the signature via the /execute endpoint.
|
|
692
|
+
|
|
693
|
+
### Example Usage
|
|
694
|
+
|
|
695
|
+
<!-- UsageSnippet language="typescript" operationID="v2_traditional_investing_approve_builder_fee" method="post" path="/v2/traditional_investing/approve_builder_fee" -->
|
|
696
|
+
```typescript
|
|
697
|
+
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
698
|
+
|
|
699
|
+
const compassApiSDK = new CompassApiSDK({
|
|
700
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
701
|
+
});
|
|
702
|
+
|
|
703
|
+
async function run() {
|
|
704
|
+
const result = await compassApiSDK.traditionalInvesting.traditionalInvestingApproveBuilderFee({
|
|
705
|
+
owner: "<value>",
|
|
706
|
+
});
|
|
707
|
+
|
|
708
|
+
console.log(result);
|
|
709
|
+
}
|
|
710
|
+
|
|
711
|
+
run();
|
|
712
|
+
```
|
|
713
|
+
|
|
714
|
+
### Standalone function
|
|
715
|
+
|
|
716
|
+
The standalone function version of this method:
|
|
717
|
+
|
|
718
|
+
```typescript
|
|
719
|
+
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
720
|
+
import { traditionalInvestingTraditionalInvestingApproveBuilderFee } from "@compass-labs/api-sdk/funcs/traditionalInvestingTraditionalInvestingApproveBuilderFee.js";
|
|
721
|
+
|
|
722
|
+
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
723
|
+
// You can create one instance of it to use across an application.
|
|
724
|
+
const compassApiSDK = new CompassApiSDKCore({
|
|
725
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
726
|
+
});
|
|
727
|
+
|
|
728
|
+
async function run() {
|
|
729
|
+
const res = await traditionalInvestingTraditionalInvestingApproveBuilderFee(compassApiSDK, {
|
|
730
|
+
owner: "<value>",
|
|
656
731
|
});
|
|
657
732
|
if (res.ok) {
|
|
658
733
|
const { value: result } = res;
|
|
659
734
|
console.log(result);
|
|
660
735
|
} else {
|
|
661
|
-
console.log("
|
|
736
|
+
console.log("traditionalInvestingTraditionalInvestingApproveBuilderFee failed:", res.error);
|
|
662
737
|
}
|
|
663
738
|
}
|
|
664
739
|
|
|
@@ -669,14 +744,14 @@ run();
|
|
|
669
744
|
|
|
670
745
|
| Parameter | Type | Required | Description |
|
|
671
746
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
672
|
-
| `request` | [components.
|
|
747
|
+
| `request` | [components.TraditionalInvestingApproveBuilderFeeRequest](../../models/components/traditionalinvestingapprovebuilderfeerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
673
748
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
674
749
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
675
750
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
676
751
|
|
|
677
752
|
### Response
|
|
678
753
|
|
|
679
|
-
**Promise\<[components.
|
|
754
|
+
**Promise\<[components.TraditionalInvestingSignableActionResponse](../../models/components/traditionalinvestingsignableactionresponse.md)\>**
|
|
680
755
|
|
|
681
756
|
### Errors
|
|
682
757
|
|