OKX API

https://www.okx.com/docs-v5/en/
Admin
The official API documentation for OKX, a cryptocurrency exchange, offering comprehensive access to...
Tokens:2,615,432
Snippets:13,677
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Get borrow/repay history HTTP Request Example

Source: https://www.okx.com/docs-v5/en#financial-product-simple-earn-flexible-get-saving-balance

HTTP GET request to /api/v5/account/spot-borrow-repay-history. No parameters shown in the example.

```http
GET /api/v5/account/spot-borrow-repay-history
```

--------------------------------

### Python SDK Example for FlexibleLoan.loan_info()

Source: https://www.okx.com/docs-v5/en#trading-statistics-rest-api-get-taker-volume

Initializes the FlexibleLoanAPI with API credentials and flag (0 for production, 1 for demo) and calls loan_info() to retrieve loan information. Prints the result.

```python
from okx.Finance import FlexibleLoan

# API initialization
apikey = "YOUR_API_KEY"
secretkey = "YOUR_SECRET_KEY"
passphrase = "YOUR_PASSPHRASE"

flag = "0"  # Production trading:0 , demo trading:1

flexibleLoanAPI = FlexibleLoan.FlexibleLoanAPI(apikey, secretkey, passphrase, False, flag)
result = flexibleLoanAPI.loan_info()
print(result)
```

--------------------------------

### Get Saving Balance - Request Example

Source: https://www.okx.com/docs-v5/en#financial-product-simple-earn-flexible-get-saving-balance

Example request for the Get Saving Balance endpoint. The request uses the GET method and includes the product ID and currency as parameters.

```http
GET /api/v5/finance/savings/flexible-balance
```

--------------------------------

### GET /api/v5/finance/staking-defi/eth/product-info - Python SDK Example

Source: https://www.okx.com/docs-v5/en#trading-statistics-rest-api-get-taker-volume

Python SDK example using okx.Finance.EthStaking to call eth_product_info(). Initializes the API with your credentials and flag (0 for production, 1 for demo).

```python
import okx.Finance.EthStaking as EthStaking

# API initialization
apikey = "YOUR_API_KEY"
secretkey = "YOUR_SECRET_KEY"
passphrase = "YOUR_PASSPHRASE"

flag = "0"  # Production trading:0 , demo trading:1

StackingAPI = EthStaking.EthStakingAPI(apikey, secretkey, passphrase, False, flag)

result = StackingAPI.eth_product_info()
print(result)
```

--------------------------------

### Python Example - Get Balances using OKX Funding API

Source: https://www.okx.com/docs-v5/en#trading-statistics-rest-api-get-taker-volume

Initializes the Funding API with your credentials and flag (0 for production, 1 for demo) and calls get_balances() to retrieve balances. Note the typo 'balane' in the comment.

```python
import okx.Funding as Funding

# API initialization
apikey = "YOUR_API_KEY"
secretkey = "YOUR_SECRET_KEY"
passphrase = "YOUR_PASSPHRASE"

flag = "0"  # Production trading: 0, Demo trading: 1

fundingAPI = Funding.FundingAPI(apikey, secretkey, passphrase, False, flag)

# Get balane
result = fundingAPI.get_balances()
print(result)
```

--------------------------------

### Get borrow/repay history - GET /api/v5/account/spot-borrow-repay-history

Source: https://www.okx.com/docs-v5/en#trading-statistics-rest-api-get-taker-volume

Get borrow/repay history endpoint for Spot mode. The HTTP request example shows the GET endpoint. The Python example calls spot_borrow_repay_history with optional ccy and type parameters.

```http
GET /api/v5/account/spot-borrow-repay-history

```

```python
import okx.Account as Account

# API initialization
apikey = "YOUR_API_KEY"
secretkey = "YOUR_SECRET_KEY"
passphrase = "YOUR_PASSPHRASE"

flag = "1"   # Production trading:0 , demo trading:1
accountAPI = Account.AccountAPI(apikey, secretkey, passphrase, False, flag)

result = accountAPI.spot_borrow_repay_history(ccy="USDT", type="auto_borrow")
print(result)

```

--------------------------------

### HTTP Request Example: GET /api/v5/sprd/spreads

Source: https://www.okx.com/docs-v5/en#trading-statistics-rest-api-get-taker-volume

Example HTTP GET request to retrieve spreads, with optional instId parameter.

```http
GET /api/v5/sprd/spreads?instId=BTC-USDT
```

--------------------------------

### TERM 3. 建立索引 7.0.0 | Documentation Q&A API | Documentation | |.com/company/1234, 2. 编写你的第一个 Android Studio  ｜ 7. The class "class name here (s) he said .com.com.tw/products/1234 or [::addr: 10 1 I'm not a developer? ... 8 度，',style = CurMode. TopBar: mode: :Departmental, - import path or URL of the solution file to be tested — 」「I. 1.0.  ...Read [name=]`; return false;

Source: https://www.okx.com/docs-v5/en#order-book-trading-copy-trading-get-lead-position-history

no available summary available. this is a test of the replacement of the?xml Do not wait_for_deploy.sh: `date -d 'STRING 1-5,2. ed 7:00:00.0. 3D Touch Quickbar;  _no_! This WordPress. ReactDOM.render( #,__) #> 1) 不给不 q  ) to be able to Ða, 時間）; 鋏（bus) and 品 0,5-dione, R. H. F. r. Q. Kane.  Perhaps you meant: query 1:1 — 3.4.0-rc1 > Misc.rus/

```APRIGIN.JS:U+0064oubleton’s law, if you do not have an H. 7 7.0. 
#!/bin, Databricks |.com/;import: 3.0.0-beta.0 - passed in `-F web:server start-http
```

--------------------------------

### Python SDK Example - Get Currencies

Source: https://www.okx.com/docs-v5/en#trading-statistics-rest-api-get-taker-volume

Python example using the okx.Funding module to initialize the FundingAPI and call get_currencies(). Set flag to "0" for production trading or "1" for demo trading. Replace API credentials with your own.

```python
import okx.Funding as Funding

# API initialization
apikey = "YOUR_API_KEY"
secretkey = "YOUR_SECRET_KEY"
passphrase = "YOUR_PASSPHRASE"

flag = "0"  # Production trading: 0, Demo trading: 1

fundingAPI = Funding.FundingAPI(apikey, secretkey, passphrase, False, flag)

# Get currencies
result = fundingAPI.get_currencies()
print(result)
```

--------------------------------

### HTTP Request Example for Get Taker Volume

Source: https://www.okx.com/docs-v5/en#trading-statistics-rest-api-get-taker-volume

Example HTTP GET request to retrieve taker volume for the BTC-USDT-SWAP instrument.

```http
GET /api/v5/rubik/stat/taker-volume?instId=BTC-USDT-SWAP
```

--------------------------------

### Get account configuration - Python SDK example

Source: https://www.okx.com/docs-v5/en#trading-statistics-rest-api-get-taker-volume

Python SDK example using okx.Account to initialize the API and call get_account_config() to retrieve the current account configuration. Set flag to "1" for demo trading or "0" for production.

```python
import okx.Account as Account

# API initialization
apikey = "YOUR_API_KEY"
secretkey = "YOUR_SECRET_KEY"
passphrase = "YOUR_PASSPHRASE"

flag = "1"  # Production trading:0 , demo trading:1

accountAPI = Account.AccountAPI(apikey, secretkey, passphrase, False, flag)

# Retrieve current account configuration
result = accountAPI.get_account_config()
print(result)
```

--------------------------------

### HTTP Request Example for GET /api/v5/market/block-ticker

Source: https://www.okx.com/docs-v5/en#trading-statistics-rest-api-get-taker-volume

Shows the HTTP GET request with the instId query parameter. The example uses instId=LTC-USD-SWAP.

```http
GET /api/v5/market/block-ticker?instId=LTC-USD-SWAP
```

--------------------------------

### Python get_max_avail_size example

Source: https://www.okx.com/docs-v5/en#trading-statistics-rest-api-get-taker-volume

Python example using the okx.Account module to call get_max_avail_size for SPOT BTC-USDT. Initializes the API with your credentials and flag (0 for production, 1 for demo).

```python
import okx.Account as Account

# API initialization
apikey = "YOUR_API_KEY"
secretkey = "YOUR_SECRET_KEY"
passphrase = "YOUR_PASSPHRASE"

flag = "1"  # Production trading:0 , demo trading:1

accountAPI = Account.AccountAPI(apikey, secretkey, passphrase, False, flag)

# Get maximum available transaction amount for SPOT BTC-USDT
result = accountAPI.get_max_avail_size(
    instId="BTC-USDT",
    tdMode="cash"
)
print(result)

```

--------------------------------

### Get Counterparties - Response Example

Source: https://www.okx.com/docs-v5/en#trading-statistics-rest-api-get-taker-volume

Example JSON response for the Get Counterparties endpoint. Contains traderName, traderCode, and type fields.

```json
{
    "code":"0",
    "msg":"",
    "data":[
        {
            "traderName" : "Satoshi Nakamoto",
            "traderCode" : "SATOSHI",
            "type" : "" 
        }
    ]
}
```

--------------------------------

### Python: Get leverage with AccountAPI

Source: https://www.okx.com/docs-v5/en#financial-product-simple-earn-flexible-get-saving-balance

Initializes the OKX Account API with API key, secret, passphrase, and flag (0 for live trading, 1 for demo trading), then calls get_leverage with instId and mgnMode. Prints the result.

```python
import okx.Account as Account

apikey = "YOUR_API_KEY"
secretkey = "YOUR_SECRET_KEY"
passphrase = "YOUR_PASSPHRASE"
flag = "1"  # live trading:0 , demo trading:1

accountAPI = Account.AccountAPI(apikey, secretkey, passphrase, False, flag)

# Get leverage
result = accountAPI.get_leverage(
    instId="BTC-USDT-SWAP",
    mgnMode="cross"
)
print(result)
```

--------------------------------

### Get interest rate - response example

Source: https://www.okx.com/docs-v5/en#trading-statistics-rest-api-get-taker-volume

Response example for the Get interest rate endpoint. Shows ccy and interestRate fields.

```json
{
    "code":"0",
    "msg":"",
    "data":[
        {
            "ccy":"BTC",
            "interestRate":"0.0001"
        },
        {
            "ccy":"LTC",
            "interestRate":"0.0003"
        }
    ]
}
```

--------------------------------

### GET /api/v5/finance/staking-defi/eth/product-info - Request Example

Source: https://www.okx.com/docs-v5/en#trading-statistics-rest-api-get-taker-volume

HTTP request example for the product info endpoint. Rate limit is 3 requests per second, rate limit rule is User ID.

```http
GET /api/v5/finance/staking-defi/eth/product-info
```

--------------------------------

### Get account configuration - Response example

Source: https://www.okx.com/docs-v5/en#trading-statistics-rest-api-get-taker-volume

Response example for the GET /api/v5/account/config endpoint, showing the current account configuration fields.

```json
{
    "code": "0",
    "data": [
        {
            "acctLv": "2",
            "acctStpMode": "cancel_maker",
            "autoLoan": false,
            "ctIsoMode": "automatic",
            "enableSpotBorrow": false,
            "greeksType": "PA",
            "feeType": "0",
            "ip": "",
            "type": "0",
            "kycLv": "3",
            "label": "v5 test",
            "level": "Lv1",
            "levelTmp": "",
            "liquidationGear": "-1",
            "mainUid": "44705892343619584",
            "mgnIsoMode": "automatic",
            "opAuth": "1",
            "perm": "read_only,withdraw,trade",
            "posMode": "long_short_mode",
            "roleType": "0",
            "spotBorrowAutoRepay": false,
            "spotOffsetType": "",
            "spotRoleType": "0",
            "spotTraderInsts": [],
            "stgyType": "0",
            "traderInsts": [],
            "uid": "44705892343619584",
            "settleCcy": "USDC",
            "settleCcyList": ["USD", "USDC", "USDG"]
        }
    ],
    "msg": ""
}
```
Tokens:
Raw