Skip to main content

Module finance

Module finance 

Source
Expand description

Authenticated trading-account endpoints (/api/v5/finance/*).

Structsยง

CancelRedeem
Cancel redeem ETH
EthStaking
Accessor for ETH staking endpoints.
Finance
Accessor for OKX finance endpoint groups.
FinanceHistoryRequest
Common currency and cursor pagination query used by finance history endpoints.
FlexibleLoan
Accessor for Flexible Loan endpoints.
FlexibleLoanAdjustCollateralRequest
Request body for POST /api/v5/finance/flexible-loan/adjust-collateral.
FlexibleLoanCollateralAsset
Flexible-loan collateral asset row.
FlexibleLoanCollateralAssetsRequest
Query parameters for GET /api/v5/finance/flexible-loan/collateral-assets.
FlexibleLoanCurrency
Flexible-loan currency row.
FlexibleLoanHistory
Flexible-loan history row.
FlexibleLoanHistoryRequest
Query parameters for GET /api/v5/finance/flexible-loan/loan-history.
FlexibleLoanInfo
Flexible-loan account information.
FlexibleLoanInfoRequest
Query parameters for GET /api/v5/finance/flexible-loan/loan-info.
FlexibleLoanInterest
Flexible-loan interest row.
FlexibleLoanInterestAccruedRequest
Query parameters for GET /api/v5/finance/flexible-loan/interest-accrued.
FlexibleLoanMaxLoan
Flexible-loan maximum-loan row.
FlexibleLoanMaxLoanRequest
Request body for POST /api/v5/finance/flexible-loan/max-loan.
FlexibleLoanMaxRedeem
Flexible-loan maximum-redeem row.
FlexibleLoanMaxRedeemRequest
Query parameters for GET /api/v5/finance/flexible-loan/max-collateral-redeem-amount.
FlexibleLoanOrder
Flexible-loan order row.
LendingHistory
Lending history row.
PublicBorrowHistory
Public borrow-history row.
PublicBorrowInfo
Public borrow-info row.
SavingBalance
Savings balance row.
Savings
Accessor for Savings endpoints.
SavingsPurchaseRedemptionRequest
Request body for POST /api/v5/finance/savings/purchase-redempt.
SavingsPurchaseRedemptionResult
Savings purchase/redemption result.
SetLendingRateResult
Set-lending-rate result.
SolStaking
Accessor for SOL staking endpoints.
StakingApyHistory
Staking APY-history row.
StakingBalance
Staking balance row.
StakingDefi
Accessor for Staking/DeFi endpoints.
StakingDefiActiveOrdersRequest
Query parameters for GET /api/v5/finance/staking-defi/orders-active.
StakingDefiCancelRequest
Request body for POST /api/v5/finance/staking-defi/cancel.
StakingDefiInvestData
Currency-level investment data returned by Staking/DeFi endpoints.
StakingDefiInvestment
Currency and amount invested into one On-chain Earn product.
StakingDefiOffer
Staking/DeFi offer row.
StakingDefiOffersRequest
Query parameters for GET /api/v5/finance/staking-defi/offers.
StakingDefiOrder
Staking/DeFi order row.
StakingDefiOrderHistoryRequest
Query parameters for GET /api/v5/finance/staking-defi/orders-history.
StakingDefiPurchaseRequest
Request body for POST /api/v5/finance/staking-defi/purchase.
StakingDefiRedeemRequest
Request body for POST /api/v5/finance/staking-defi/redeem.
StakingHistory
Staking history row.
StakingOrder
Staking order row.
StakingProductInfo
Staking product-info row.