> This page is for API Reference.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://okx-demo.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://okx-demo.ferndocs.com/_mcp/server.

# Get order history

GET https://www.okx.com/api/v5/finance/staking-defi/orders-history

Retrieve the history of completed (redeemed) staking and DeFi earn orders, with pagination support.

Reference: https://okx-demo.ferndocs.com/api/api-reference/on-chain-earn/get-orders-history

## 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.
- `after` (string, optional) — Pagination of data to return records earlier than the requested purchasedTime, Unix timestamp in milliseconds.
- `before` (string, optional) — Pagination of data to return records newer than the requested purchasedTime, Unix timestamp in milliseconds.
- `limit` (string, optional) — Number of results per request. The maximum is 100 and the default is 100.

## 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 ApiV5FinanceStakingDefiOrdersHistoryGetResponsesContentApplicationJsonSchemaDataItems, optional)

## Types

### ApiV5FinanceStakingDefiOrdersHistoryGetResponsesContentApplicationJsonSchemaDataItems

- `ordId` (string, optional) — Order ID.
- `ccy` (string, optional) — Currency, e.g. BTC.
- `productId` (string, optional) — Product ID.
- `state` (string, optional) — Order state. 3: Completed (redeemed), 7: Cancelled.
- `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 ApiV5FinanceStakingDefiOrdersHistoryGetResponsesContentApplicationJsonSchemaDataItemsInvestDataItems, optional) — Investment data.
- `earningData` (list of ApiV5FinanceStakingDefiOrdersHistoryGetResponsesContentApplicationJsonSchemaDataItemsEarningDataItems, optional) — Earning data.
- `purchasedTime` (string, optional) — Order purchase time, Unix timestamp in milliseconds.
- `redeemedTime` (string, optional) — Order redemption time, Unix timestamp in milliseconds.
- `tag` (string, optional) — Order tag.

### ApiV5FinanceStakingDefiOrdersHistoryGetResponsesContentApplicationJsonSchemaDataItemsInvestDataItems

- `ccy` (string, optional) — Investment currency, e.g. BTC.
- `amt` (string, optional) — Invested amount.

### ApiV5FinanceStakingDefiOrdersHistoryGetResponsesContentApplicationJsonSchemaDataItemsEarningDataItems

- `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": "1579252",
      "ccy": "DOT",
      "productId": "101",
      "state": "3",
      "protocol": "Polkadot",
      "protocolType": "defi",
      "term": "0",
      "apy": "0.1704",
      "investData": [
        {
          "ccy": "DOT",
          "amt": "2"
        }
      ],
      "earningData": [
        {
          "ccy": "DOT",
          "earningType": "0",
          "realizedEarnings": "0"
        }
      ],
      "purchasedTime": "1712908001000",
      "redeemedTime": "1712914294000",
      "tag": ""
    }
  ]
}
```

**SDK Code**

```python onChainEarn_getOrdersHistory_example
import requests

url = "https://www.okx.com/api/v5/finance/staking-defi/orders-history"

headers = {"OK-ACCESS-KEY": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript onChainEarn_getOrdersHistory_example
const url = 'https://www.okx.com/api/v5/finance/staking-defi/orders-history';
const options = {method: 'GET', headers: {'OK-ACCESS-KEY': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go onChainEarn_getOrdersHistory_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.okx.com/api/v5/finance/staking-defi/orders-history"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("OK-ACCESS-KEY", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby onChainEarn_getOrdersHistory_example
require 'uri'
require 'net/http'

url = URI("https://www.okx.com/api/v5/finance/staking-defi/orders-history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["OK-ACCESS-KEY"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java onChainEarn_getOrdersHistory_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://www.okx.com/api/v5/finance/staking-defi/orders-history")
  .header("OK-ACCESS-KEY", "<apiKey>")
  .asString();
```

```php onChainEarn_getOrdersHistory_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://www.okx.com/api/v5/finance/staking-defi/orders-history', [
  'headers' => [
    'OK-ACCESS-KEY' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp onChainEarn_getOrdersHistory_example
using RestSharp;

var client = new RestClient("https://www.okx.com/api/v5/finance/staking-defi/orders-history");
var request = new RestRequest(Method.GET);
request.AddHeader("OK-ACCESS-KEY", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift onChainEarn_getOrdersHistory_example
import Foundation

let headers = ["OK-ACCESS-KEY": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://www.okx.com/api/v5/finance/staking-defi/orders-history")! 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()
```