okx-client 0.1.2

Async Rust client for the OKX exchange API v5
Documentation
use crate::error::OkxResult;
use crate::rest::RestClient;
use crate::types::request::finance::*;
use crate::types::response::finance::*;

impl RestClient {
    /// Get staking offers.
    /// GET /api/v5/finance/staking-defi/offers
    pub async fn get_staking_offers(
        &self,
        params: &serde_json::Value,
    ) -> OkxResult<Vec<serde_json::Value>> {
        self.get_signed("/api/v5/finance/staking-defi/offers", Some(params))
            .await
    }

    /// Stake / purchase.
    /// POST /api/v5/finance/staking-defi/purchase
    pub async fn stake_purchase(
        &self,
        params: &serde_json::Value,
    ) -> OkxResult<Vec<serde_json::Value>> {
        self.post_signed("/api/v5/finance/staking-defi/purchase", params)
            .await
    }

    /// Redeem staking.
    /// POST /api/v5/finance/staking-defi/redeem
    pub async fn stake_redeem(
        &self,
        params: &serde_json::Value,
    ) -> OkxResult<Vec<serde_json::Value>> {
        self.post_signed("/api/v5/finance/staking-defi/redeem", params)
            .await
    }

    /// Get staking orders.
    /// GET /api/v5/finance/staking-defi/orders-active
    pub async fn get_staking_orders_active(
        &self,
        params: &serde_json::Value,
    ) -> OkxResult<Vec<serde_json::Value>> {
        self.get_signed("/api/v5/finance/staking-defi/orders-active", Some(params))
            .await
    }

    /// Get staking order history.
    /// GET /api/v5/finance/staking-defi/orders-history
    pub async fn get_staking_order_history(
        &self,
        params: &serde_json::Value,
    ) -> OkxResult<Vec<serde_json::Value>> {
        self.get_signed("/api/v5/finance/staking-defi/orders-history", Some(params))
            .await
    }

    /// Get savings balance.
    /// GET /api/v5/finance/savings/balance
    pub async fn get_savings_balance(
        &self,
        params: &serde_json::Value,
    ) -> OkxResult<Vec<serde_json::Value>> {
        self.get_signed("/api/v5/finance/savings/balance", Some(params))
            .await
    }

    /// Savings purchase/redemption.
    /// POST /api/v5/finance/savings/purchase-redempt
    pub async fn savings_purchase_redempt(
        &self,
        params: &serde_json::Value,
    ) -> OkxResult<Vec<serde_json::Value>> {
        self.post_signed("/api/v5/finance/savings/purchase-redempt", params)
            .await
    }

    /// Get lending rate summary.
    /// GET /api/v5/finance/savings/lending-rate-summary
    pub async fn get_lending_rate_summary(&self) -> OkxResult<Vec<serde_json::Value>> {
        self.get::<serde_json::Value, ()>("/api/v5/finance/savings/lending-rate-summary", None)
            .await
    }

    /// Get lending rate history.
    /// GET /api/v5/finance/savings/lending-rate-history
    pub async fn get_lending_rate_history(
        &self,
        params: &serde_json::Value,
    ) -> OkxResult<Vec<serde_json::Value>> {
        self.get("/api/v5/finance/savings/lending-rate-history", Some(params))
            .await
    }

    /// Get current flexible-loan information.
    /// GET /api/v5/finance/flexible-loan/loan-info
    pub async fn get_flexible_loan_info(
        &self,
        params: &GetFlexibleLoanInfoRequest,
    ) -> OkxResult<Vec<FlexibleLoanInfo>> {
        self.get_signed("/api/v5/finance/flexible-loan/loan-info", Some(params))
            .await
    }

    /// Get supported dual investment currency pairs.
    /// GET /api/v5/finance/sfp/dcd/currency-pair
    pub async fn get_dcd_currency_pairs(&self) -> OkxResult<Vec<DcdCurrencyPair>> {
        self.get_signed::<DcdCurrencyPair, ()>("/api/v5/finance/sfp/dcd/currency-pair", None)
            .await
    }

    /// Get dual investment products.
    /// GET /api/v5/finance/sfp/dcd/products
    pub async fn get_dcd_products(
        &self,
        params: &GetDcdProductsRequest,
    ) -> OkxResult<Vec<DcdProduct>> {
        self.get_signed("/api/v5/finance/sfp/dcd/products", Some(params))
            .await
    }

    /// Request a dual investment quote.
    /// POST /api/v5/finance/sfp/dcd/quote
    pub async fn request_dcd_quote(
        &self,
        params: &RequestDcdQuoteRequest,
    ) -> OkxResult<Vec<DcdQuote>> {
        self.post_signed("/api/v5/finance/sfp/dcd/quote", params)
            .await
    }

    /// Submit a dual investment trade.
    /// POST /api/v5/finance/sfp/dcd/trade
    pub async fn submit_dcd_trade(
        &self,
        params: &SubmitDcdTradeRequest,
    ) -> OkxResult<Vec<DcdTradeResult>> {
        self.post_signed("/api/v5/finance/sfp/dcd/trade", params)
            .await
    }

    /// Request a dual investment redemption quote.
    /// POST /api/v5/finance/sfp/dcd/redeem-quote
    pub async fn request_dcd_redeem_quote(
        &self,
        params: &RequestDcdRedeemQuoteRequest,
    ) -> OkxResult<Vec<DcdRedeemQuote>> {
        self.post_signed("/api/v5/finance/sfp/dcd/redeem-quote", params)
            .await
    }

    /// Submit a dual investment redemption.
    /// POST /api/v5/finance/sfp/dcd/redeem
    pub async fn submit_dcd_redeem(
        &self,
        params: &SubmitDcdRedeemRequest,
    ) -> OkxResult<Vec<DcdRedeemResult>> {
        self.post_signed("/api/v5/finance/sfp/dcd/redeem", params)
            .await
    }

    /// Get a dual investment order status.
    /// GET /api/v5/finance/sfp/dcd/order-status
    pub async fn get_dcd_order_status(
        &self,
        params: &GetDcdOrderStatusRequest,
    ) -> OkxResult<Vec<DcdOrderStatus>> {
        self.get_signed("/api/v5/finance/sfp/dcd/order-status", Some(params))
            .await
    }

    /// Get dual investment order history.
    /// GET /api/v5/finance/sfp/dcd/order-history
    pub async fn get_dcd_order_history(
        &self,
        params: &GetDcdOrderHistoryRequest,
    ) -> OkxResult<Vec<DcdOrderHistoryItem>> {
        self.get_signed("/api/v5/finance/sfp/dcd/order-history", Some(params))
            .await
    }

    /// Get Stable Rewards product information.
    /// GET /api/v5/finance/stable-rewards/product-info
    pub async fn get_stable_rewards_product_info(
        &self,
        params: &GetStableRewardsProductInfoRequest,
    ) -> OkxResult<Vec<StableRewardsProductInfo>> {
        self.get_signed("/api/v5/finance/stable-rewards/product-info", Some(params))
            .await
    }

    /// Request a Stable Rewards quote.
    /// POST /api/v5/finance/stable-rewards/quote
    #[deprecated(note = "OKX decommissioned this endpoint on 2026-07-14")]
    pub async fn request_stable_rewards_quote(
        &self,
        params: &RequestStableRewardsQuoteRequest,
    ) -> OkxResult<Vec<StableRewardsQuote>> {
        self.post_signed("/api/v5/finance/stable-rewards/quote", params)
            .await
    }

    /// Submit a Stable Rewards trade.
    /// POST /api/v5/finance/stable-rewards/trade
    #[deprecated(note = "OKX decommissioned this endpoint on 2026-07-14")]
    pub async fn submit_stable_rewards_trade(
        &self,
        params: &SubmitStableRewardsTradeRequest,
    ) -> OkxResult<Vec<StableRewardsTradeResult>> {
        self.post_signed("/api/v5/finance/stable-rewards/trade", params)
            .await
    }

    /// Get Stable Rewards balance.
    /// GET /api/v5/finance/stable-rewards/balance
    pub async fn get_stable_rewards_balance(
        &self,
        params: &GetStableRewardsBalanceRequest,
    ) -> OkxResult<Vec<StableRewardsBalance>> {
        self.get_signed("/api/v5/finance/stable-rewards/balance", Some(params))
            .await
    }

    /// Get Stable Rewards APY history.
    /// GET /api/v5/finance/stable-rewards/apy-history
    pub async fn get_stable_rewards_apy_history(
        &self,
        params: &GetStableRewardsApyHistoryRequest,
    ) -> OkxResult<Vec<StableRewardsApyHistoryItem>> {
        self.get("/api/v5/finance/stable-rewards/apy-history", Some(params))
            .await
    }

    /// Get Stable Rewards subscription and redemption history.
    /// GET /api/v5/finance/stable-rewards/subscribe-redeem-history
    #[deprecated(note = "OKX decommissioned this endpoint on 2026-07-14")]
    pub async fn get_stable_rewards_subscribe_redeem_history(
        &self,
        params: &GetStableRewardsSubscribeRedeemHistoryRequest,
    ) -> OkxResult<Vec<StableRewardsSubscribeRedeemHistoryItem>> {
        self.get_signed(
            "/api/v5/finance/stable-rewards/subscribe-redeem-history",
            Some(params),
        )
        .await
    }

    /// Get OKUSD subscription and redemption limits.
    /// GET /api/v5/finance/okusd/limits
    pub async fn get_okusd_limits(&self) -> OkxResult<Vec<OkusdLimits>> {
        self.get_signed::<OkusdLimits, ()>("/api/v5/finance/okusd/limits", None)
            .await
    }

    /// Subscribe to OKUSD.
    /// POST /api/v5/finance/okusd/subscribe
    pub async fn subscribe_okusd(
        &self,
        params: &SubscribeOkusdRequest,
    ) -> OkxResult<Vec<OkusdSubscribeResult>> {
        self.post_signed("/api/v5/finance/okusd/subscribe", params)
            .await
    }

    /// Redeem OKUSD.
    /// POST /api/v5/finance/okusd/redeem
    pub async fn redeem_okusd(
        &self,
        params: &RedeemOkusdRequest,
    ) -> OkxResult<Vec<OkusdRedeemResult>> {
        self.post_signed("/api/v5/finance/okusd/redeem", params)
            .await
    }

    /// Get ETH staking product information.
    /// GET /api/v5/finance/staking-defi/eth/product-info
    pub async fn get_eth_staking_product_info(&self) -> OkxResult<Vec<EthStakingProductInfo>> {
        self.get::<EthStakingProductInfo, ()>("/api/v5/finance/staking-defi/eth/product-info", None)
            .await
    }

    /// Get SOL staking product information.
    /// GET /api/v5/finance/staking-defi/sol/product-info
    pub async fn get_sol_staking_product_info(&self) -> OkxResult<Vec<SolStakingProductInfo>> {
        self.get::<SolStakingProductInfo, ()>("/api/v5/finance/staking-defi/sol/product-info", None)
            .await
    }

    /// Cancel an ETH staking redemption.
    /// POST /api/v5/finance/staking-defi/eth/cancel-redeem
    pub async fn cancel_eth_staking_redeem(
        &self,
        params: &CancelEthStakingRedeemRequest,
    ) -> OkxResult<Vec<EthStakingCancelRedeemResult>> {
        self.post_signed("/api/v5/finance/staking-defi/eth/cancel-redeem", params)
            .await
    }

    /// Get current GLP performance.
    /// GET /api/v5/users/glp/today-performance
    pub async fn get_glp_today_performance(&self) -> OkxResult<Vec<GlpTodayPerformance>> {
        self.get_signed::<GlpTodayPerformance, ()>("/api/v5/users/glp/today-performance", None)
            .await
    }

    /// Get historical GLP performance.
    /// GET /api/v5/users/glp/historical-performance
    pub async fn get_glp_historical_performance(
        &self,
        params: &GetGlpHistoricalPerformanceRequest,
    ) -> OkxResult<Vec<GlpHistoricalPerformanceItem>> {
        self.get_signed("/api/v5/users/glp/historical-performance", Some(params))
            .await
    }
}