python-okx 0.4.2__tar.gz → 0.4.4__tar.gz

{python_okx-0.4.2 → python_okx-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-okx
-Version: 0.4.2
+Version: 0.4.4
 Summary: Python SDK for OKX
 Home-page: https://okx.com/docs-v5/
 Author: okxv5api
@@ -21,13 +21,6 @@ Requires-Dist: requests>=2.25.0
 Requires-Dist: websockets>=10.0
 Requires-Dist: certifi>=2021.0.0
 Requires-Dist: loguru>=0.7.0
-Requires-Dist: python-dotenv>=1.0.0
-Requires-Dist: pytest>=7.0.0
-Requires-Dist: pytest-asyncio>=0.21.0
-Requires-Dist: pytest-cov>=4.0.0
-Requires-Dist: ruff>=0.1.0
-Requires-Dist: build>=1.0.0
-Requires-Dist: twine>=4.0.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -58,7 +51,6 @@ Make sure you update often and check the [Changelog](https://www.okx.com/docs-v5
 - Websocket handling with reconnection and multiplexed connections
 
 ### Quick start
-
 #### Prerequisites
 
 `python version：>=3.7`
@@ -128,7 +120,7 @@ git clone https://github.com/okxapi/python-okx.git
 cd python-okx
 
 # Install dependencies
-pip install -r requirements.txt
+pip install -r dev_requirements.txt
 pip install -e .
 
 # Run tests

{python_okx-0.4.2 → python_okx-0.4.4}/README.md

@@ -18,7 +18,6 @@ Make sure you update often and check the [Changelog](https://www.okx.com/docs-v5
 - Websocket handling with reconnection and multiplexed connections
 
 ### Quick start
-
 #### Prerequisites
 
 `python version：>=3.7`
@@ -88,7 +87,7 @@ git clone https://github.com/okxapi/python-okx.git
 cd python-okx
 
 # Install dependencies
-pip install -r requirements.txt
+pip install -r dev_requirements.txt
 pip install -e .
 
 # Run tests

{python_okx-0.4.2 → python_okx-0.4.4}/okx/Account.py

@@ -229,7 +229,7 @@ class AccountAPI(OkxClient):
         }
         return self._request_with_params(POST, SET_AUTO_LOAN, params)
 
-    # - Set auto loan
+    # - Set account level
     def set_account_level(self, acctLv):
         params = {
             'acctLv': acctLv
@@ -366,3 +366,18 @@ class AccountAPI(OkxClient):
         if type != '':
             params['type'] = type
         return self._request_with_params(POST, BILLS_APPLY, params)
+
+    # Get GLP daily performance history for a program
+    def get_glp_historical_performance(self, program, begin='', end='', limit=''):
+        params = {'program': program}
+        if begin != '':
+            params['begin'] = begin
+        if end != '':
+            params['end'] = end
+        if limit != '':
+            params['limit'] = limit
+        return self._request_with_params(GET, GLP_HISTORICAL_PERFORMANCE, params)
+
+    # Get current-day + MTD GLP snapshot for all enrolled programs
+    def get_glp_today_performance(self):
+        return self._request_without_params(GET, GLP_TODAY_PERFORMANCE)

python_okx-0.4.4/okx/Affiliate.py

@@ -0,0 +1,84 @@
+from okx.okxclient import OkxClient
+from okx.consts import (
+    GET,
+    _NO_CREDENTIAL,
+    AFFILIATE_TVB_INVITEE_DETAIL,
+    AFFILIATE_TVB_INVITEE_LIST,
+    AFFILIATE_TVB_LINK_LIST,
+    AFFILIATE_TVB_PERFORMANCE_SUMMARY,
+    AFFILIATE_TVB_TIER_BREAKDOWN,
+)
+
+
+class AffiliateAPI(OkxClient):
+    def __init__(self, api_key=_NO_CREDENTIAL, api_secret_key=_NO_CREDENTIAL, passphrase=_NO_CREDENTIAL, use_server_time=None, flag='1',
+                 domain='https://www.okx.com', debug=False, proxy=None):
+        OkxClient.__init__(self, api_key, api_secret_key, passphrase, use_server_time, flag, domain, debug, proxy)
+
+    def get_tvb_invitee_detail(self, uid):
+        params = {'uid': uid}
+        return self._request_with_params(GET, AFFILIATE_TVB_INVITEE_DETAIL, params)
+
+    def get_tvb_invitee_list(self, periodType='', begin='', end='', feeTier=None, tradeType='',
+                             keyword='', orderBy='', orderDir='', page='', limit=''):
+        params = {}
+        if periodType != '':
+            params['periodType'] = periodType
+        if begin != '':
+            params['begin'] = begin
+        if end != '':
+            params['end'] = end
+        if feeTier is not None:
+            params['feeTier'] = feeTier
+        if tradeType != '':
+            params['tradeType'] = tradeType
+        if keyword != '':
+            params['keyword'] = keyword
+        if orderBy != '':
+            params['orderBy'] = orderBy
+        if orderDir != '':
+            params['orderDir'] = orderDir
+        if page != '':
+            params['page'] = page
+        if limit != '':
+            params['limit'] = limit
+        return self._request_with_params(GET, AFFILIATE_TVB_INVITEE_LIST, params)
+
+    def get_tvb_link_list(self, periodType='', begin='', end='', page='', limit='',
+                          linkType='', linkStatus=''):
+        params = {}
+        if periodType != '':
+            params['periodType'] = periodType
+        if begin != '':
+            params['begin'] = begin
+        if end != '':
+            params['end'] = end
+        if page != '':
+            params['page'] = page
+        if limit != '':
+            params['limit'] = limit
+        if linkType != '':
+            params['linkType'] = linkType
+        if linkStatus != '':
+            params['linkStatus'] = linkStatus
+        return self._request_with_params(GET, AFFILIATE_TVB_LINK_LIST, params)
+
+    def get_tvb_performance_summary(self, periodType='', begin='', end=''):
+        params = {}
+        if periodType != '':
+            params['periodType'] = periodType
+        if begin != '':
+            params['begin'] = begin
+        if end != '':
+            params['end'] = end
+        return self._request_with_params(GET, AFFILIATE_TVB_PERFORMANCE_SUMMARY, params)
+
+    def get_tvb_tier_breakdown(self, periodType='', begin='', end=''):
+        params = {}
+        if periodType != '':
+            params['periodType'] = periodType
+        if begin != '':
+            params['begin'] = begin
+        if end != '':
+            params['end'] = end
+        return self._request_with_params(GET, AFFILIATE_TVB_TIER_BREAKDOWN, params)

{python_okx-0.4.2 → python_okx-0.4.4}/okx/Finance/EthStaking.py

@@ -24,6 +24,13 @@ class EthStakingAPI(OkxClient):
         }
         return self._request_with_params(POST, STACK_ETH_REDEEM, params)
 
+    def eth_cancel_redeem(self, ordId=''):
+
+        params = {
+            'ordId': ordId,
+        }
+        return self._request_with_params(POST, STACK_ETH_CANCEL_REDEEM, params)
+
     def eth_balance(self):
 
         params = {}

{python_okx-0.4.2 → python_okx-0.4.4}/okx/Finance/FlexibleLoan.py

@@ -63,3 +63,28 @@ class FlexibleLoanAPI(OkxClient):
         if limit != '':
             params['limit'] = limit
         return self._request_with_params(GET, FINANCE_INTEREST_ACCRUED, params)
+
+    def borrow(self, loanData, clOrdId, ordId='', collateralData=None, eMode=''):
+        params = {
+            'loanData': loanData,
+            'clOrdId': clOrdId,
+        }
+        if ordId != '':
+            params['ordId'] = ordId
+        if collateralData is not None:
+            params['collateralData'] = collateralData
+        if eMode != '':
+            params['eMode'] = eMode
+        return self._request_with_params(POST, FINANCE_FLEXIBLE_LOAN_BORROW, params)
+
+    def repay(self, ordId, ccy, amt, clOrdId):
+        params = {
+            'ordId': ordId,
+            'ccy': ccy,
+            'amt': amt,
+            'clOrdId': clOrdId,
+        }
+        return self._request_with_params(POST, FINANCE_FLEXIBLE_LOAN_REPAY, params)
+
+    def emode_info(self):
+        return self._request_without_params(GET, FINANCE_FLEXIBLE_LOAN_EMODE_INFO)

python_okx-0.4.4/okx/Finance/Okusd.py

@@ -0,0 +1,61 @@
+from okx.okxclient import OkxClient
+from okx.consts import (
+    GET,
+    _NO_CREDENTIAL,
+    OKUSD_ACCOUNT,
+    OKUSD_RATE_HISTORY,
+    OKUSD_SUBSCRIBE_HISTORY,
+    OKUSD_REDEEM_HISTORY,
+    OKUSD_REWARDS_HISTORY,
+)
+
+
+class OkusdAPI(OkxClient):
+    def __init__(self, api_key=_NO_CREDENTIAL, api_secret_key=_NO_CREDENTIAL, passphrase=_NO_CREDENTIAL, use_server_time=None, flag='1',
+                 domain='https://www.okx.com', debug=False, proxy=None):
+        OkxClient.__init__(self, api_key, api_secret_key, passphrase, use_server_time, flag, domain, debug, proxy)
+
+    def get_account(self):
+        return self._request_without_params(GET, OKUSD_ACCOUNT)
+
+    def get_rate_history(self, limit='', begin='', end=''):
+        params = {}
+        if limit != '':
+            params['limit'] = limit
+        if begin != '':
+            params['begin'] = begin
+        if end != '':
+            params['end'] = end
+        return self._request_with_params(GET, OKUSD_RATE_HISTORY, params)
+
+    def get_subscribe_history(self, limit='', begin='', end=''):
+        params = {}
+        if limit != '':
+            params['limit'] = limit
+        if begin != '':
+            params['begin'] = begin
+        if end != '':
+            params['end'] = end
+        return self._request_with_params(GET, OKUSD_SUBSCRIBE_HISTORY, params)
+
+    def get_redeem_history(self, limit='', begin='', end='', type=''):
+        params = {}
+        if limit != '':
+            params['limit'] = limit
+        if begin != '':
+            params['begin'] = begin
+        if end != '':
+            params['end'] = end
+        if type != '':
+            params['type'] = type
+        return self._request_with_params(GET, OKUSD_REDEEM_HISTORY, params)
+
+    def get_rewards_history(self, limit='', begin='', end=''):
+        params = {}
+        if limit != '':
+            params['limit'] = limit
+        if begin != '':
+            params['begin'] = begin
+        if end != '':
+            params['end'] = end
+        return self._request_with_params(GET, OKUSD_REWARDS_HISTORY, params)

python_okx-0.4.4/okx/Finance/__init__.py

@@ -0,0 +1 @@
+from okx.Finance import Okusd  # noqa: F401

{python_okx-0.4.2 → python_okx-0.4.4}/okx/MarketData.py

@@ -31,6 +31,11 @@ class MarketAPI(OkxClient):
         params = {'instId': instId, 'sz': sz}
         return self._request_with_params(GET, ORDER_BOOKS, params)
 
+    # Get RPI Order Book
+    def get_rpi_orderbook(self, instId, sz=''):
+        params = {'instId': instId, 'sz': sz}
+        return self._request_with_params(GET, MARKET_BOOKS_RPI, params)
+
     # Get Candlesticks
     def get_candlesticks(self, instId, after='', before='', bar='', limit=''):
         params = {'instId': instId, 'after': after, 'before': before, 'bar': bar, 'limit': limit}

{python_okx-0.4.2 → python_okx-0.4.4}/okx/__init__.py

@@ -2,4 +2,4 @@
 Python SDK for the OKX API v5
 
 """
-__version__="0.4.2"
+__version__="0.4.4"

{python_okx-0.4.2 → python_okx-0.4.4}/okx/consts.py

@@ -16,6 +16,10 @@ APPLICATION_JSON = 'application/json'
 GET = "GET"
 POST = "POST"
 
+# Unset sentinel for credential args — lets public endpoints work without keys.
+# Never signed or transmitted as a real key/secret/passphrase.
+_NO_CREDENTIAL = '-1'
+
 SERVER_TIMESTAMP_URL = '/api/v5/public/time'
 
 # Account
@@ -112,6 +116,7 @@ BLOCK_TICKER = '/api/v5/market/block-ticker'
 BLOCK_TRADES = '/api/v5/market/block-trades'
 GET_ORDER_LITE_BOOK = '/api/v5/market/books-lite'
 GET_OPTION_TRADES = '/api/v5/market/option/instrument-family-trades'
+MARKET_BOOKS_RPI = '/api/v5/market/books-rpi'
 
 # Public Data
 INSTRUMENT_INFO = '/api/v5/public/instruments'
@@ -193,6 +198,10 @@ GET_ASSET_SUBACCOUNT_BALANCE = '/api/v5/asset/subaccount/balances'
 SET_SUB_ACCOUNTS_VIP_LOAN = '/api/v5/account/subaccount/set-loan-allocation'
 GET_SUB_ACCOUNT_BORROW_INTEREST_AND_LIMIT = '/api/v5/account/subaccount/interest-limits'
 
+# GLP performance
+GLP_HISTORICAL_PERFORMANCE = '/api/v5/users/glp/historicalperformance'
+GLP_TODAY_PERFORMANCE = '/api/v5/users/glp/todayperformance'
+
 # Convert
 GET_CURRENCIES = '/api/v5/asset/convert/currencies'
 GET_CURRENCY_PAIR = '/api/v5/asset/convert/currency-pair'
@@ -260,6 +269,7 @@ GET_PUBLIC_BORROW_HISTORY = '/api/v5/finance/savings/lending-rate-history'
 STACK_ETH_PRODUCT_INFO = '/api/v5/finance/staking-defi/eth/product-info'
 STACK_ETH_PURCHASE = '/api/v5/finance/staking-defi/eth/purchase'
 STACK_ETH_REDEEM = '/api/v5/finance/staking-defi/eth/redeem'
+STACK_ETH_CANCEL_REDEEM = '/api/v5/finance/staking-defi/eth/cancel-redeem'
 STACK_ETH_BALANCE = '/api/v5/finance/staking-defi/eth/balance'
 STACK_ETH_PURCHASE_REDEEM_HISTORY = '/api/v5/finance/staking-defi/eth/purchase-redeem-history'
 STACK_ETH_APY_HISTORY = '/api/v5/finance/staking-defi/eth/apy-history'
@@ -306,6 +316,9 @@ FINANCE_ADJUST_COLLATERAL = '/api/v5/finance/flexible-loan/adjust-collateral'
 FINANCE_LOAN_INFO = '/api/v5/finance/flexible-loan/loan-info'
 FINANCE_LOAN_HISTORY = '/api/v5/finance/flexible-loan/loan-history'
 FINANCE_INTEREST_ACCRUED = '/api/v5/finance/flexible-loan/interest-accrued'
+FINANCE_FLEXIBLE_LOAN_BORROW = '/api/v5/finance/flexible-loan/borrow'
+FINANCE_FLEXIBLE_LOAN_REPAY = '/api/v5/finance/flexible-loan/repay'
+FINANCE_FLEXIBLE_LOAN_EMODE_INFO = '/api/v5/finance/flexible-loan/emode-info'
 
 # Dual Investment (DCD) — under /api/v5/finance/sfp/dcd/
 DUAL_INVEST_CURRENCY_PAIRS       = '/api/v5/finance/sfp/dcd/currency-pair'
@@ -317,5 +330,16 @@ DUAL_INVEST_REDEEM               = '/api/v5/finance/sfp/dcd/redeem'
 DUAL_INVEST_ORDER_STATE          = '/api/v5/finance/sfp/dcd/order-status'
 DUAL_INVEST_ORDER_HISTORY        = '/api/v5/finance/sfp/dcd/order-history'
 
+# OKUSD
+OKUSD_ACCOUNT = '/api/v5/finance/okusd/account'
+OKUSD_RATE_HISTORY = '/api/v5/finance/okusd/rate/history'
+OKUSD_SUBSCRIBE_HISTORY = '/api/v5/finance/okusd/subscribe/history'
+OKUSD_REDEEM_HISTORY = '/api/v5/finance/okusd/redeem/history'
+OKUSD_REWARDS_HISTORY = '/api/v5/finance/okusd/rewards/history'
 
-
+# Affiliate TVB
+AFFILIATE_TVB_INVITEE_DETAIL = '/api/v5/affiliate/tvb/invitee/detail'
+AFFILIATE_TVB_INVITEE_LIST = '/api/v5/affiliate/tvb/invitee/list'
+AFFILIATE_TVB_LINK_LIST = '/api/v5/affiliate/tvb/link/list'
+AFFILIATE_TVB_PERFORMANCE_SUMMARY = '/api/v5/affiliate/tvb/performance/summary'
+AFFILIATE_TVB_TIER_BREAKDOWN = '/api/v5/affiliate/tvb/tier-breakdown'

{python_okx-0.4.2 → python_okx-0.4.4}/python_okx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-okx
-Version: 0.4.2
+Version: 0.4.4
 Summary: Python SDK for OKX
 Home-page: https://okx.com/docs-v5/
 Author: okxv5api
@@ -21,13 +21,6 @@ Requires-Dist: requests>=2.25.0
 Requires-Dist: websockets>=10.0
 Requires-Dist: certifi>=2021.0.0
 Requires-Dist: loguru>=0.7.0
-Requires-Dist: python-dotenv>=1.0.0
-Requires-Dist: pytest>=7.0.0
-Requires-Dist: pytest-asyncio>=0.21.0
-Requires-Dist: pytest-cov>=4.0.0
-Requires-Dist: ruff>=0.1.0
-Requires-Dist: build>=1.0.0
-Requires-Dist: twine>=4.0.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -58,7 +51,6 @@ Make sure you update often and check the [Changelog](https://www.okx.com/docs-v5
 - Websocket handling with reconnection and multiplexed connections
 
 ### Quick start
-
 #### Prerequisites
 
 `python version：>=3.7`
@@ -128,7 +120,7 @@ git clone https://github.com/okxapi/python-okx.git
 cd python-okx
 
 # Install dependencies
-pip install -r requirements.txt
+pip install -r dev_requirements.txt
 pip install -e .
 
 # Run tests

{python_okx-0.4.2 → python_okx-0.4.4}/python_okx.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 requirements.txt
 setup.py
 okx/Account.py
+okx/Affiliate.py
 okx/BlockTrading.py
 okx/Convert.py
 okx/CopyTrading.py
@@ -24,6 +25,7 @@ okx/okxclient.py
 okx/utils.py
 okx/Finance/EthStaking.py
 okx/Finance/FlexibleLoan.py
+okx/Finance/Okusd.py
 okx/Finance/Savings.py
 okx/Finance/SolStaking.py
 okx/Finance/StakingDefi.py

python_okx-0.4.4/python_okx.egg-info/requires.txt

@@ -0,0 +1,5 @@
+httpx[http2]>=0.24.0
+requests>=2.25.0
+websockets>=10.0
+certifi>=2021.0.0
+loguru>=0.7.0

python_okx-0.4.4/requirements.txt

@@ -0,0 +1,6 @@
+# Runtime dependencies for python-okx
+httpx[http2]>=0.24.0
+requests>=2.25.0
+websockets>=10.0
+certifi>=2021.0.0
+loguru>=0.7.0

{python_okx-0.4.2 → python_okx-0.4.4}/test/test_eth_staking.py

@@ -17,6 +17,9 @@ class EthStakingTest(unittest.TestCase):
     def test_eth_redeem(self):
         print(self.StackingAPI.eth_redeem(amt="1"))
 
+    def test_eth_cancel_redeem(self):
+        print(self.StackingAPI.eth_cancel_redeem(ordId="1234567890"))
+
     def test_eth_balance(self):
         print(self.StackingAPI.eth_balance())
 

python_okx-0.4.2/python_okx.egg-info/requires.txt

@@ -1,12 +0,0 @@
-httpx[http2]>=0.24.0
-requests>=2.25.0
-websockets>=10.0
-certifi>=2021.0.0
-loguru>=0.7.0
-python-dotenv>=1.0.0
-pytest>=7.0.0
-pytest-asyncio>=0.21.0
-pytest-cov>=4.0.0
-ruff>=0.1.0
-build>=1.0.0
-twine>=4.0.0

python_okx-0.4.2/requirements.txt

@@ -1,15 +0,0 @@
-# Dependencies for python-okx
-httpx[http2]>=0.24.0
-requests>=2.25.0
-websockets>=10.0
-certifi>=2021.0.0
-loguru>=0.7.0
-python-dotenv>=1.0.0
-
-# Development & Testing
-pytest>=7.0.0
-pytest-asyncio>=0.21.0
-pytest-cov>=4.0.0
-ruff>=0.1.0
-build>=1.0.0
-twine>=4.0.0