> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://okx-demo.ferndocs.com/api/api-reference/on-chain-earn/get-active-orders/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://okx-demo.ferndocs.com/_mcp/server. # Get active orders GET https://www.okx.com/api/v5/finance/staking-defi/orders-active Retrieve your currently active staking and DeFi earn orders, including invested amounts, earnings, and order state. Reference: https://okx-demo.ferndocs.com/api/api-reference/on-chain-earn/get-active-orders ## Authentication - `OK-ACCESS-KEY` header (required) — Your API key. - `OK-ACCESS-SIGN` header (required) — Base64-encoded HMAC-SHA256 signature of the prehash string. - `OK-ACCESS-TIMESTAMP` header (required) — ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z. - `OK-ACCESS-PASSPHRASE` header (required) — The passphrase you set when creating the API key. ## Request ### Query parameters - `productId` (string, optional) — Product ID. - `protocolType` (enum, optional) — Protocol type. - Allowed values: `staking`, `defi` - `ccy` (string, optional) — Investment currency, e.g. BTC. - `state` (enum, optional) — Order state. 8: Pending, 13: Cancelling, 9: On-chain, 1: Earning, 2: Redeeming. - Allowed values: `8`, `13`, `9`, `1`, `2` ## Response ### 200 Successful response - `code` (string, optional) — Result code. `0` means success; any other value is an error code. - `msg` (string, optional) — Error message. Empty on success. - `data` (list of ApiV5FinanceStakingDefiOrdersActiveGetResponsesContentApplicationJsonSchemaDataItems, optional) ## Types ### ApiV5FinanceStakingDefiOrdersActiveGetResponsesContentApplicationJsonSchemaDataItems - `ordId` (string, optional) — Order ID. - `ccy` (string, optional) — Currency, e.g. BTC. - `productId` (string, optional) — Product ID. - `state` (string, optional) — Order state. 8: Pending, 13: Cancelling, 9: On-chain, 1: Earning, 2: Redeeming. - `protocol` (string, optional) — Protocol name, e.g. sushiswap. - `protocolType` (string, optional) — Protocol type. - `term` (string, optional) — Protocol term in days; empty for flexible terms. - `apy` (string, optional) — Estimated annualized yield, e.g. 0.03 for 3%. - `investData` (list of ApiV5FinanceStakingDefiOrdersActiveGetResponsesContentApplicationJsonSchemaDataItemsInvestDataItems, optional) — Investment data. - `earningData` (list of ApiV5FinanceStakingDefiOrdersActiveGetResponsesContentApplicationJsonSchemaDataItemsEarningDataItems, optional) — Earning data. - `purchasedTime` (string, optional) — Order purchase time, Unix timestamp in milliseconds. - `estSettlementTime` (string, optional) — Estimated redemption settlement time, Unix timestamp in milliseconds. - `cancelRedemptionDeadline` (string, optional) — Deadline for cancelling a redemption, Unix timestamp in milliseconds. - `tag` (string, optional) — Order tag. ### ApiV5FinanceStakingDefiOrdersActiveGetResponsesContentApplicationJsonSchemaDataItemsInvestDataItems - `ccy` (string, optional) — Investment currency, e.g. BTC. - `amt` (string, optional) — Invested amount. ### ApiV5FinanceStakingDefiOrdersActiveGetResponsesContentApplicationJsonSchemaDataItemsEarningDataItems - `ccy` (string, optional) — Earning currency, e.g. BTC. - `earningType` (string, optional) — Earning type. 0: Estimated earning, 1: Cumulative earning. - `earnings` (string, optional) — Earning amount. ## Examples **Response** ```json { "code": "0", "msg": "", "data": [ { "ordId": "2413499", "ccy": "DOT", "productId": "101", "state": "1", "protocol": "Polkadot", "protocolType": "defi", "term": "0", "apy": "0.1014", "investData": [ { "ccy": "DOT", "amt": "2" } ], "earningData": [ { "ccy": "DOT", "earningType": "0", "earnings": "0.10615025" } ], "purchasedTime": "1729839328000", "estSettlementTime": "", "cancelRedemptionDeadline": "", "tag": "", "fastRedemptionData": [] }, { "ordId": "2213257", "ccy": "USDT", "productId": "4005", "state": "1", "protocol": "On-Chain Defi", "protocolType": "defi", "term": "0", "apy": "0.0323", "investData": [ { "ccy": "USDT", "amt": "1" } ], "earningData": [ { "ccy": "USDT", "earningType": "0", "earnings": "0.02886582" }, { "ccy": "COMP", "earningType": "1", "earnings": "0.0000627" } ], "purchasedTime": "1725345790000", "estSettlementTime": "", "cancelRedemptionDeadline": "", "tag": "", "fastRedemptionData": [] }, { "ordId": "2210943", "ccy": "USDT", "productId": "4005", "state": "1", "protocol": "On-Chain Defi", "protocolType": "defi", "term": "0", "apy": "0.0323", "investData": [ { "ccy": "USDT", "amt": "1" } ], "earningData": [ { "ccy": "USDT", "earningType": "0", "earnings": "0.02891823" }, { "ccy": "COMP", "earningType": "1", "earnings": "0.0000632" } ], "purchasedTime": "1725280801000", "estSettlementTime": "", "cancelRedemptionDeadline": "", "tag": "", "fastRedemptionData": [] } ] } ``` **SDK Code** ```python onChainEarn_getActiveOrders_example import requests url = "https://www.okx.com/api/v5/finance/staking-defi/orders-active" headers = {"OK-ACCESS-KEY": ""} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript onChainEarn_getActiveOrders_example const url = 'https://www.okx.com/api/v5/finance/staking-defi/orders-active'; const options = {method: 'GET', headers: {'OK-ACCESS-KEY': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go onChainEarn_getActiveOrders_example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://www.okx.com/api/v5/finance/staking-defi/orders-active" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("OK-ACCESS-KEY", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby onChainEarn_getActiveOrders_example require 'uri' require 'net/http' url = URI("https://www.okx.com/api/v5/finance/staking-defi/orders-active") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["OK-ACCESS-KEY"] = '' response = http.request(request) puts response.read_body ``` ```java onChainEarn_getActiveOrders_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://www.okx.com/api/v5/finance/staking-defi/orders-active") .header("OK-ACCESS-KEY", "") .asString(); ``` ```php onChainEarn_getActiveOrders_example request('GET', 'https://www.okx.com/api/v5/finance/staking-defi/orders-active', [ 'headers' => [ 'OK-ACCESS-KEY' => '', ], ]); echo $response->getBody(); ``` ```csharp onChainEarn_getActiveOrders_example using RestSharp; var client = new RestClient("https://www.okx.com/api/v5/finance/staking-defi/orders-active"); var request = new RestRequest(Method.GET); request.AddHeader("OK-ACCESS-KEY", ""); IRestResponse response = client.Execute(request); ``` ```swift onChainEarn_getActiveOrders_example import Foundation let headers = ["OK-ACCESS-KEY": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://www.okx.com/api/v5/finance/staking-defi/orders-active")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```