feat: add .env

okxapi · Dec 22, 2025 · Dec 16, 2025 · Dec 16, 2025 · Dec 19, 2025 · Dec 19, 2025
commit 75a20fc4eb115843420c116b708a8c56c4cdde61
diff --git a/.env.example b/.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
diff --git a/.gitignore b/.gitignore
@@ -32,4 +32,9 @@ build/
 
 ### VS Code ###
 .vscode/
-id_rsa*
+id_rsa*
+
+# Environment files
+.env
+.env.local
+.env.*.local
diff --git a/test/config.py b/test/config.py
@@ -0,0 +1,35 @@
+"""
+Test configuration module - loads API credentials from environment variables.
+
+Usage:
+    from test.config import get_api_credentials
+
+    api_key, api_secret, passphrase, flag = get_api_credentials()
+"""
+import os
+from pathlib import Path
+
+# Try to load from .env file if python-dotenv is available
+try:
+    from dotenv import load_dotenv
+    # Load .env from project root
+    env_path = Path(__file__).parent.parent / '.env'
+    load_dotenv(env_path)
+except ImportError:
+    pass  # python-dotenv not installed, rely on system environment variables
+
+
+def get_api_credentials():
+    """
+    Get API credentials from environment variables.
+
+    Returns:
+        tuple: (api_key, api_secret, passphrase, flag)
+    """
+    api_key = os.getenv('OKX_API_KEY', '')
+    api_secret = os.getenv('OKX_API_SECRET', '')
+    passphrase = os.getenv('OKX_PASSPHRASE', '')
+    flag = os.getenv('OKX_FLAG', '1')  # Default to demo trading
+
+    return api_key, api_secret, passphrase, flag
+
diff --git a/test/AccountTest.py → test/test_account.py b/test/AccountTest.py → test/test_account.py
@@ -3,14 +3,13 @@
 from loguru import logger
 
 from okx import Account
+from test.config import get_api_credentials
 
 
 class AccountTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
-        self.AccountAPI = Account.AccountAPI(api_key, api_secret_key, passphrase, flag='1')
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
+        self.AccountAPI = Account.AccountAPI(api_key, api_secret_key, passphrase, flag=flag)
 
     # '''
     # POSITIONS_HISTORY = '/api/v5/account/positions-history' #need add

diff --git a/test/BlockTradingTest.py → test/test_block_trading.py b/test/BlockTradingTest.py → test/test_block_trading.py
@@ -1,12 +1,13 @@
 
 import unittest
 from okx import BlockTrading
+from test.config import get_api_credentials
+
+
 class BlockTradingTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
-        self.BlockTradingAPI = BlockTrading.BlockTradingAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag='1')
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
+        self.BlockTradingAPI = BlockTrading.BlockTradingAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag=flag)
 
     """
     def test_get_counter_parties(self):

diff --git a/test/ConvertTest.py → test/test_convert.py b/test/ConvertTest.py → test/test_convert.py
@@ -1,11 +1,12 @@
 import unittest
-from ..okx import Convert
+from okx import Convert
+from test.config import get_api_credentials
+
+
 class ConvertTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
-        self.ConvertAPI = Convert.ConvertAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag='1')
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
+        self.ConvertAPI = Convert.ConvertAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag=flag)
     '''
 
     def test_get_currencies(self):

diff --git a/test/CopyTradingTest.py → test/test_copy_trading.py b/test/CopyTradingTest.py → test/test_copy_trading.py
@@ -1,13 +1,13 @@
 import unittest
 from okx import CopyTrading
+from test.config import get_api_credentials
+
 
 class CopyTradingTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
         self.StackingAPI = CopyTrading.CopyTradingAPI(api_key, api_secret_key, passphrase, use_server_time=False,
-                                                      flag='0')
+                                                      flag=flag)
 
     # def test_get_existing_leading_positions(self):
     #     print(self.StackingAPI.get_existing_leading_positions(instId='DOGE-USDT-SWAP'))

diff --git a/test/EthStakingTest.py → test/test_eth_staking.py b/test/EthStakingTest.py → test/test_eth_staking.py
@@ -1,12 +1,12 @@
 import unittest
 from okx.Finance import EthStaking
+from test.config import get_api_credentials
+
 
 class EthStakingTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
-        self.StackingAPI = EthStaking.EthStakingAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag='1')
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
+        self.StackingAPI = EthStaking.EthStakingAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag=flag)
 
     def test_eth_product_info(self):
         print(self.StackingAPI.eth_product_info())

diff --git a/test/FlexibleLoanTest.py → test/test_flexible_loan.py b/test/FlexibleLoanTest.py → test/test_flexible_loan.py
@@ -1,12 +1,12 @@
 import unittest
 from okx.Finance import FlexibleLoan
+from test.config import get_api_credentials
+
 
 class FlexibleLoanTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
-        self.FlexibleLoanAPI = FlexibleLoan.FlexibleLoanAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag='1')
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
+        self.FlexibleLoanAPI = FlexibleLoan.FlexibleLoanAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag=flag)
 
     def test_borrow_currencies(self):
         print(self.FlexibleLoanAPI.borrow_currencies())

diff --git a/test/FundingTest.py → test/test_funding.py b/test/FundingTest.py → test/test_funding.py
@@ -1,13 +1,13 @@
 
 import unittest
 from okx import Funding
+from test.config import get_api_credentials
+
 
 class FundingTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
-        self.FundingAPI = Funding.FundingAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag='0')
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
+        self.FundingAPI = Funding.FundingAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag=flag)
     """
     CANCEL_WITHDRAWAL = '/api/v5/asset/cancel-withdrawal' #need add
     CONVERT_DUST_ASSETS = '/api/v5/asset/convert-dust-assets' #need add

diff --git a/test/GridTest.py → test/test_grid.py b/test/GridTest.py → test/test_grid.py
@@ -1,13 +1,13 @@
 
 import unittest
 from okx import Grid
+from test.config import get_api_credentials
+
 
 class GridTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
-        self.GridAPI = Grid.GridAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag='1', debug=False)
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
+        self.GridAPI = Grid.GridAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag=flag, debug=False)
     """
     GRID_COMPUTE_MARIGIN_BALANCE = '/api/v5/tradingBot/grid/compute-margin-balance'
     GRID_MARGIN_BALANCE = '/api/v5/tradingBot/grid/margin-balance'

diff --git a/test/MarketTest.py → test/test_market.py b/test/MarketTest.py → test/test_market.py
@@ -12,12 +12,13 @@
 BLOCK_TRADES = '/api/v5/market/block-trades'#need to add
 '''
 
+from test.config import get_api_credentials
+
+
 class MarketAPITest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
-        self.MarketApi = MarketData.MarketAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag='1')
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
+        self.MarketApi = MarketData.MarketAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag=flag)
     '''
 
     def test_index_component(self):

diff --git a/test/PublicDataTest.py → test/test_public_data.py b/test/PublicDataTest.py → test/test_public_data.py
@@ -1,11 +1,12 @@
 import unittest
 from okx import PublicData
+from test.config import get_api_credentials
+
+
 class publicDataTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
-        self.publicDataApi = PublicData.PublicAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag='1')
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
+        self.publicDataApi = PublicData.PublicAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag=flag)
     '''
     TestCase For:
     INTEREST_LOAN = '/api/v5/public/interest-rate-loan-quota' #need to add

diff --git a/test/SavingsTest.py → test/test_savings.py b/test/SavingsTest.py → test/test_savings.py
@@ -1,12 +1,12 @@
 import unittest
 from okx.Finance import Savings
+from test.config import get_api_credentials
+
 
 class SavingsTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
-        self.StackingAPI = Savings.SavingsAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag='1')
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
+        self.StackingAPI = Savings.SavingsAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag=flag)
 
 
     def test_get_saving_balance(self):

diff --git a/test/SolStakingTest.py → test/test_sol_staking.py b/test/SolStakingTest.py → test/test_sol_staking.py
@@ -1,12 +1,12 @@
 import unittest
 from okx.Finance import SolStaking
+from test.config import get_api_credentials
+
 
 class SolStakingTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
-        self.StackingAPI = SolStaking.SolStakingAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag='1')
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
+        self.StackingAPI = SolStaking.SolStakingAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag=flag)
 
     def test_sol_purchase(self):
         print(self.StackingAPI.sol_purchase(amt="1"))

diff --git a/test/SpreadTest.py → test/test_spread.py b/test/SpreadTest.py → test/test_spread.py
@@ -1,11 +1,12 @@
 import unittest
 from okx import SpreadTrading
+from test.config import get_api_credentials
+
+
 class TradeTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
-        self.tradeApi = SpreadTrading.SpreadTradingAPI(api_key, api_secret_key, passphrase, False, '1')
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
+        self.tradeApi = SpreadTrading.SpreadTradingAPI(api_key, api_secret_key, passphrase, False, flag)
 
     # def test_place_order(self):
     #     print(self.tradeApi.place_order(sprdId='BTC-USDT_BTC-USDT-SWAP',clOrdId='b15',side='buy',ordType='limit',

diff --git a/test/StakingDefiTest.py → test/test_staking_defi.py b/test/StakingDefiTest.py → test/test_staking_defi.py
@@ -1,14 +1,13 @@
 import unittest
 from okx.Finance import StakingDefi
+from test.config import get_api_credentials
 
 
 class StakingDefiTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
         self.StackingAPI = StakingDefi.StakingDefiAPI(api_key, api_secret_key, passphrase, use_server_time=False,
-                                                      flag='1')
+                                                      flag=flag)
 
     def test_get_offers(self):
         print(self.StackingAPI.get_offers(ccy="USDT"))

diff --git a/test/SubAccountTest.py → test/test_sub_account.py b/test/SubAccountTest.py → test/test_sub_account.py
@@ -1,12 +1,12 @@
 import unittest
 from okx import SubAccount
+from test.config import get_api_credentials
+
 
 class SubAccountTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
-        self.SubAccountApi = SubAccount.SubAccountAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag='1')
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
+        self.SubAccountApi = SubAccount.SubAccountAPI(api_key, api_secret_key, passphrase, use_server_time=False, flag=flag)
     '''
     ENTRUST_SUBACCOUNT_LIST = '/api/v5/users/entrust-subaccount-list' #need to add
     SET_TRSNSFER_OUT = '/api/v5/users/subaccount/set-transfer-out' #need to add

diff --git a/test/TradeTest.py → test/test_trade.py b/test/TradeTest.py → test/test_trade.py
@@ -1,14 +1,13 @@
 import unittest
 
 from okx import Trade
+from test.config import get_api_credentials
 
 
 class TradeTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
-        self.tradeApi = Trade.TradeAPI(api_key, api_secret_key, passphrase, False, '1')
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
+        self.tradeApi = Trade.TradeAPI(api_key, api_secret_key, passphrase, False, flag)
 
     # # """
     # def test_place_order(self):

diff --git a/test/TradingDataTest.py → test/test_trading_data.py b/test/TradingDataTest.py → test/test_trading_data.py
@@ -1,14 +1,13 @@
 import unittest
-from ..okx import TradingData
+from okx import TradingData
+from test.config import get_api_credentials
 
 
 class TradingDataTest(unittest.TestCase):
     def setUp(self):
-        api_key = 'your_apiKey'
-        api_secret_key = 'your_secretKey'
-        passphrase = 'your_secretKey'
+        api_key, api_secret_key, passphrase, flag = get_api_credentials()
         self.TradingDataAPI = TradingData.TradingDataAPI(api_key, api_secret_key, passphrase, use_server_time=False,
-                                                         flag='1')
+                                                         flag=flag)
     """
       def test_get_support_coins(self):
         print(self.TradingDataAPI.get_support_coin())

diff --git a/test/WsPrivateAsyncTest.py → test/test_ws_private_async.py b/test/WsPrivateAsyncTest.py → test/test_ws_private_async.py
@@ -1,18 +1,20 @@
 import asyncio
 
 from okx.websocket.WsPrivateAsync import WsPrivateAsync
+from test.config import get_api_credentials
 
 
 def privateCallback(message):
     print("privateCallback", message)
 
 
 async def main():
+    api_key, api_secret_key, passphrase, _ = get_api_credentials()
     url = "wss://wspap.okx.com:8443/ws/v5/private?brokerId=9999"
     ws = WsPrivateAsync(
-        apiKey="your apiKey",
-        passphrase="your passphrase",
-        secretKey="your secretKey",
+        apiKey=api_key,
+        passphrase=passphrase,
+        secretKey=api_secret_key,
         url=url,
         useServerTime=False
     )

diff --git a/test/WsPublicAsyncTest.py → test/test_ws_public_async.py b/test/WsPublicAsyncTest.py → test/test_ws_public_async.py