Skip to main content

Module finance

Module finance 

Source
Expand description

Authenticated finance endpoints (/api/v5/finance/*).

Structsยง

AmountRequest
Request for purchase/redeem operations on staking products.
ApyHistoryRequest
Request for apy_history on staking products.
CancelRedeem
Cancel redeem ETH
CancelRedeemRequest
Request for cancel_redeem on staking products.
CurrencyRequest
Request for get_saving_balance.
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.
SetLendingRateRequest
Request for set_lending_rate.
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.
StakingDefiEarningData
Earning data returned by the Staking/DeFi offers endpoint.
StakingDefiFastRedemptionData
Fast redemption data returned by the Staking/DeFi active-orders endpoint.
StakingDefiInvestData
Currency-level investment data returned by the Staking/DeFi offers endpoint.
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, returned by both the active-orders and order-history endpoints.
StakingDefiOrderEarningData
Earning data returned by the Staking/DeFi order endpoints.
StakingDefiOrderHistoryRequest
Query parameters for GET /api/v5/finance/staking-defi/orders-history.
StakingDefiOrderInvestData
Currency-level investment data returned by the Staking/DeFi order endpoints (active orders and order 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 purchase/redeem history row.
StakingOrder
Staking order row.
StakingProductInfo
Staking product-info row.