Release/version 0.4.1

.env.example

@@ -0,0 +1,10 @@
+# OKX API Credentials
+# Copy this file to .env and fill in your actual credentials
+# NEVER commit .env to version control!
+
+OKX_API_KEY=your_api_key_here
+OKX_API_SECRET=your_api_secret_here
+OKX_PASSPHRASE=your_passphrase_here
+
+# Optional: Set to '0' for live trading, '1' for demo trading
+OKX_FLAG=1

.github/workflows/ci.yml

@@ -0,0 +1,173 @@
+# GitHub Actions CI/CD Configuration for python-okx
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+      - 'release/*'
+      - 'releases/*'
+  pull_request:
+    branches:
+      - master
+      - 'release/*'
+      - 'releases/*'
+
+jobs:
+  # ============================================
+  # DEPENDENCY CHECK JOB
+  # Ensures all imports are satisfied by requirements.txt
+  # ============================================
+  dependency-check:
+    name: Dependency Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install only from requirements.txt (clean environment)
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Verify all production imports work
+        run: |
+          # This catches missing dependencies in requirements.txt
+          python -c "
+          import okx
+          from okx import Account, Trade, Funding, MarketData, PublicData
+          from okx import SubAccount, Convert, BlockTrading, CopyTrading
+          from okx import SpreadTrading, Grid, TradingData, Status
+          from okx.websocket import WsPublicAsync, WsPrivateAsync
+          print('✅ All imports successful')
+          print(f'   okx version: {okx.__version__}')
+          "
+
+      - name: Verify test imports
+        run: |
+          pip install pytest
+          python -c "
+          import pytest
+          import unittest
+          print('✅ Test imports successful')
+          "
+
+  # ============================================
+  # LINT JOB
+  # ============================================
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install linting tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+
+      - name: Run ruff
+        run: |
+          ruff check okx/ --ignore=E501
+        continue-on-error: true  # Set to false once codebase is cleaned up
+
+  # ============================================
+  # TEST JOB
+  # ============================================
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    needs: [dependency-check]  # Only run tests if dependencies are valid
+    strategy:
+      fail-fast: true
+      max-parallel: 1
+      matrix:
+        python-version: ["3.9", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Cache pip dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-${{ matrix.python-version }}-
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -e .
+
+      - name: Run tests
+        run: |
+          python -m pytest test/unit/ -v --cov=okx --cov-report=term-missing --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false
+
+  # ============================================
+  # BUILD JOB
+  # ============================================
+  build:
+    name: Build Package
+    runs-on: ubuntu-latest
+    needs: [test]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Build package
+        run: python -m build --no-isolation
+
+      - name: Check package
+        run: twine check dist/*
+
+      - name: Test install from wheel (clean environment)
+        run: |
+          # Create a fresh venv and install the built wheel
+          python -m venv /tmp/test-install
+          /tmp/test-install/bin/pip install dist/*.whl
+          /tmp/test-install/bin/python -c "
+          import okx
+          from okx import Account, Trade, Funding
+          print(f'✅ Package installs correctly: okx {okx.__version__}')
+          "
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          retention-days: 7

.gitignore

@@ -32,4 +32,9 @@ build/
 
 ### VS Code ###
 .vscode/
-id_rsa*
+id_rsa*
+
+# Environment files
+.env
+.env.local
+.env.*.local

MANIFEST.in

@@ -0,0 +1,3 @@
+include requirements.txt
+include README.md
+

README.md

@@ -20,20 +20,80 @@ Make sure you update often and check the [Changelog](https://www.okx.com/docs-v5
 ### Quick start
 #### Prerequisites
 
-`python version：>=3.9`
+`python version：>=3.7`
 
-`WebSocketAPI： websockets package advise version 6.0`
-
-#### Step 1: register an account on OKX and apply for an API key
+#### Step 1: Register an account on OKX and apply for an API key
 - Register for an account: https://www.okx.com/account/register
 - Apply for an API key: https://www.okx.com/account/users/myApi
 
-#### Step 2: install python-okx
+#### Step 2: Install python-okx
 
-```python
+```bash
 pip install python-okx
 ```
 
+### API Credentials
+
+#### Option 1: Hardcoded credentials
+
+```python
+from okx import Account
+
+account = Account.AccountAPI(
+    api_key="your-api-key-here",
+    api_secret_key="your-api-secret-here",
+    passphrase="your-passphrase-here",
+    flag="1",  # 0 = live trading, 1 = demo trading
+    debug=False
+)
+```
+
+#### Option 2: Using `.env` file (recommended)
+
+Create a `.env` file in your project root:
+
+```bash
+OKX_API_KEY=your-api-key-here
+OKX_API_SECRET=your-api-secret-here
+OKX_PASSPHRASE=your-passphrase-here
+OKX_FLAG=1
+```
+
+Then load it in your code:
+
+```python
+import os
+from dotenv import load_dotenv
+from okx import Account
+
+load_dotenv()
+
+account = Account.AccountAPI(
+    api_key=os.getenv('OKX_API_KEY'),
+    api_secret_key=os.getenv('OKX_API_SECRET'),
+    passphrase=os.getenv('OKX_PASSPHRASE'),
+    flag=os.getenv('OKX_FLAG', '1'),
+    debug=False
+)
+```
+
+### Development Setup
+
+For contributors or local development:
+
+```bash
+# Clone the repository
+git clone https://github.com/okxapi/python-okx.git
+cd python-okx
+
+# Install dependencies
+pip install -r requirements.txt
+pip install -e .
+
+# Run tests
+pytest test/unit/ -v
+```
+
 #### Step 3: Run examples
 
 - Fill in API credentials in the corresponding examples

okx/Account.py

@@ -27,21 +27,23 @@ def get_positions(self, instType='', instId='', posId=''):
         params = {'instType': instType, 'instId': instId, 'posId': posId}
         return self._request_with_params(GET, POSITION_INFO, params)
 
-    def position_builder(self, acctLv=None,inclRealPosAndEq=False, lever=None, greeksType=None, simPos=None,
-                         simAsset=None):
+    def position_builder(self, acctLv=None, inclRealPosAndEq=None, lever=None, greeksType=None, simPos=None,
+                         simAsset=None, idxVol=None):
         params = {}
         if acctLv is not None:
             params['acctLv'] = acctLv
         if inclRealPosAndEq is not None:
             params['inclRealPosAndEq'] = inclRealPosAndEq
         if lever is not None:
-            params['spotOffsetType'] = lever
+            params['lever'] = lever
         if greeksType is not None:
-            params['greksType'] = greeksType
+            params['greeksType'] = greeksType
         if simPos is not None:
             params['simPos'] = simPos
         if simAsset is not None:
             params['simAsset'] = simAsset
+        if idxVol is not None:
+            params['idxVol'] = idxVol
         return self._request_with_params(POST, POSITION_BUILDER, params)
 
     # Get Bills Details (recent 7 days)
@@ -74,14 +76,18 @@ def set_leverage(self, lever, mgnMode, instId='', ccy='', posSide=''):
         return self._request_with_params(POST, SET_LEVERAGE, params)
 
     # Get Maximum Tradable Size For Instrument
-    def get_max_order_size(self, instId, tdMode, ccy='', px=''):
+    def get_max_order_size(self, instId, tdMode, ccy='', px='', tradeQuoteCcy=None):
         params = {'instId': instId, 'tdMode': tdMode, 'ccy': ccy, 'px': px}
+        if tradeQuoteCcy is not None:
+            params['tradeQuoteCcy'] = tradeQuoteCcy
         return self._request_with_params(GET, MAX_TRADE_SIZE, params)
 
     # Get Maximum Available Tradable Amount
-    def get_max_avail_size(self, instId, tdMode, ccy='', reduceOnly='', unSpotOffset='', quickMgnType=''):
+    def get_max_avail_size(self, instId, tdMode, ccy='', reduceOnly='', unSpotOffset='', quickMgnType='', tradeQuoteCcy=None):
         params = {'instId': instId, 'tdMode': tdMode, 'ccy': ccy, 'reduceOnly': reduceOnly,
                   'unSpotOffset': unSpotOffset, 'quickMgnType': quickMgnType}
+        if tradeQuoteCcy is not None:
+            params['tradeQuoteCcy'] = tradeQuoteCcy
         return self._request_with_params(GET, MAX_AVAIL_SIZE, params)
 
     # Increase / Decrease margin
@@ -100,8 +106,10 @@ def get_instruments(self, instType='', ugly='', instFamily='', instId=''):
         return self._request_with_params(GET, GET_INSTRUMENTS, params)
 
     # Get the maximum loan of isolated MARGIN
-    def get_max_loan(self, instId, mgnMode, mgnCcy=''):
+    def get_max_loan(self, instId, mgnMode, mgnCcy='', tradeQuoteCcy=None):
         params = {'instId': instId, 'mgnMode': mgnMode, 'mgnCcy': mgnCcy}
+        if tradeQuoteCcy is not None:
+            params['tradeQuoteCcy'] = tradeQuoteCcy
         return self._request_with_params(GET, MAX_LOAN, params)
 
     # Get Fee Rates
@@ -323,3 +331,9 @@ def set_auto_repay(self, autoRepay=False):
     def spot_borrow_repay_history(self, ccy='', type='', after='', before='', limit=''):
         params = {'ccy': ccy, 'type': type, 'after': after, 'before': before, 'limit': limit}
         return self._request_with_params(GET, GET_BORROW_REPAY_HISTORY, params)
+
+    def set_auto_earn(self, ccy, action, earnType=None):
+        params = {'ccy': ccy, 'action': action}
+        if earnType is not None:
+            params['earnType'] = earnType
+        return self._request_with_params(POST, SET_AUTO_EARN, params)

okx/Funding.py

@@ -35,9 +35,11 @@ def funds_transfer(self, ccy, amt, from_, to, type='0', subAcct='', instId='', t
         return self._request_with_params(POST, FUNDS_TRANSFER, params)
 
     # Withdrawal
-    def withdrawal(self, ccy, amt, dest, toAddr, chain='', areaCode='', clientId=''):
+    def withdrawal(self, ccy, amt, dest, toAddr, chain='', areaCode='', clientId='', toAddrType=None):
         params = {'ccy': ccy, 'amt': amt, 'dest': dest, 'toAddr': toAddr, 'chain': chain,
                   'areaCode': areaCode, 'clientId': clientId}
+        if toAddrType is not None:
+            params['toAddrType'] = toAddrType
         return self._request_with_params(POST, WITHDRAWAL_COIN, params)
 
     # Get Deposit History
@@ -46,10 +48,7 @@ def get_deposit_history(self, ccy='', type='', state='', after='', before='', li
                   'depId': depId, 'fromWdId': fromWdId}
         return self._request_with_params(GET, DEPOSIT_HISTORY, params)
 
-    # Get Withdrawal History
-    def get_withdrawal_history(self, ccy='', wdId='', state='', after='', before='', limit='',txId=''):
-        params = {'ccy': ccy, 'wdId': wdId, 'state': state, 'after': after, 'before': before, 'limit': limit,'txId':txId}
-        return self._request_with_params(GET, WITHDRAWAL_HISTORY, params)
+
 
     # Get Currencies
     def get_currencies(self, ccy=''):
@@ -113,7 +112,9 @@ def get_deposit_withdraw_status(self, wdId='', txId='', ccy='', to='', chain='')
         return self._request_with_params(GET, GET_DEPOSIT_WITHDrAW_STATUS, params)
 
     #Get withdrawal history
-    def get_withdrawal_history(self, ccy='', wdId='', clientId='', txId='', type='', state='', after='', before	='', limit=''):
+    def get_withdrawal_history(self, ccy='', wdId='', clientId='', txId='', type='', state='', after='', before='', limit='', toAddrType=None):
         params = {'ccy': ccy, 'wdId': wdId, 'clientId': clientId, 'txId': txId, 'type': type, 'state': state, 'after': after, 'before': before, 'limit': limit}
+        if toAddrType is not None:
+            params['toAddrType'] = toAddrType
         return self._request_with_params(GET, GET_WITHDRAWAL_HISTORY, params)