add begin and end params

.gitignore

@@ -1,6 +1,9 @@
 build/
 dist/
 python_okx.egg-info/
+*.DS_Store
+**/__pycache__
+**/**/__pycache__
 
 ### STS ###
 .apt_generated
@@ -29,4 +32,4 @@ build/
 
 ### VS Code ###
 .vscode/
-setup.py
+id_rsa*

README.md

@@ -1,143 +1,64 @@
-[TOC]
+### Overview
+This is an unofficial Python wrapper for the [OKX exchange v5 API](https://www.okx.com/okx-api)
 
-### 如何使用？
+If you came here looking to purchase cryptocurrencies from the OKX exchange, please go [here](https://www.okx.com/).
 
-`python版本：>=3.9
+#### Source code
+https://github.com/okxapi/python-okx
+#### API trading tutorials
+- Spot trading: https://www.okx.com/help/how-can-i-do-spot-trading-with-the-jupyter-notebook
+- Derivative trading: https://www.okx.com/help/how-can-i-do-derivatives-trading-with-the-jupyter-notebook
 
-`WebSocketAPI：autobahn.twisted>=22.10.0`
+Make sure you update often and check the [Changelog](https://www.okx.com/docs-v5/log_en/) for new features and bug fixes.
 
-#### 第一步：下载SDK，安装相关所需库
+### Features
+- Implementation of all Rest API endpoints.
+- Private and Public Websocket implementation
+- Testnet support 
+- Websocket handling with reconnection and multiplexed connections
 
-1.1 下载`python SDK`
-
-* 将SDK目录`Clone`或者`Download`到本地，选择使用`okx-python-sdk-api-v5`即可
-
-1.2 安装所需库
-
-```python
-pip install requests
-pip install autobahn\[twisted\]
-pip install pyOpenSSL
-```
-
-#### 第二步：配置个人信息
-
-2.1 如果还未有API，可[点击](https://www.okx.com/account/users/myApi)前往官网进行申请
-
-```python
-api_key = ""
-secret_key = ""
-passphrase = ""
-```
-
-#### 第三步：调用接口
-
-* RestAPI
-
-  * 运行`example.py`
-
-  * 解开相应方法的注释传参调用各接口即可
-
-* WebSocketAPI
-  * 参考Test文件夹下`WsPrivate`和`WsPublic`文件示例；
-  * 根据`公共频道`/`私有频道`选择对应`url`(如果是私有频道需要设置登陆信息)，传入相应参数即可。
-
-  ```python
-  # WebSocket公共频道
-  url = "wss://ws.okx.com:8443/ws/v5/public"
-  # WebSocket私有频道
-  url = "wss://ws.okx.com:8443/ws/v5/private"
-  ```
-
-  ```python
-  # 公共频道 不需要登录（行情，持仓总量，K线，标记价格，深度，资金费率等）
-  参考 WsPublicTest.py
-
-  # 私有频道 需要登录（账户，持仓，订单等）
-  参考 WsPrivateTest.py
-  ```
-
-附言：
-
-* 如果对API尚不了解，建议参考`OKX`官方[API文档](https://www.okx.com/docs-v5/zh/)
-
-* 使用RestAPI的用户可以通过参考Test文件夹下的示例，设置正确的参数即可
-
-* 使用WebSocketAPI的用户可以通过参考Test文件夹下的`WsPublicTest.py`和`WsPrivateTest.py`，设置正确的参数即可
-
-* 若使用`WebSocketAPI`遇到问题建议参考相关链接
-
-  * `asyncio`、`websockets`文档/`github`：
-        https://docs.python.org/3/library/asyncio-dev.html
-        https://websockets.readthedocs.io/en/stable/intro.html
-        https://github.com/aaugustin/websockets
-
-  * 关于`code=1006`：
-        https://github.com/Rapptz/discord.py/issues/1996
-        https://github.com/aaugustin/websockets/issues/587
-
-
-
-### How to use ?
+### Quick start
+#### Prerequisites
 
 `python version：>=3.9`
 
-`WebSocketAPI： autobahn.twisted>=22.10.0`
-
-#### Step 1: Download the SDK and install the necessary libraries
-
-1.1 Download python SDK 
+`WebSocketAPI： websockets package advise version 6.0`
 
-- `Clone` or `Download` the SDK directory to your local directory,choose to use `okx-python-sdk-api-v5`
+#### 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
 
-1.2 Install the necessary libraries
+#### Step 2: install python-okx
 
 ```python
-pip install requests
-pip install autobahn\[twisted\]
-pip install pyOpenSSL
+pip install python-okx
 ```
 
-#### Step 2: Configure Personal Information
-
-2.1 If you have no API，[Click here](https://www.okx.com/account/users/myApi) to the official websit to apply for the API
-
-2.2 Fill out all necessary informatiuon in `example.py（RestAPI）`  and `websocket_example.py（WebSocketAPI）`
+#### Step 3: Run examples
 
+- Fill in API credentials in the corresponding examples
 ```python 
 api_key = ""
 secret_key = ""
 passphrase = ""
 ```
-
-#### Step 3: Call API 
-
 - RestAPI
-  - Run `example.py`
-  - Uncomment the corresponding method and then pass the arguments and call the interfaces
+  - For spot trading: run example/get_started_en.ipynb
+  - For derivative trading: run example/trade_derivatives_en.ipynb
+  - Tweak the value of the parameter `flag` (live trading: 0, demo trading: 1
+) to switch between live and demo trading environment
 - WebSocketAPI
-  - Open `websocket_example.py`
-  - According to the `public channel`/`private channel`, select the corresponding `url`, the corresponding start method, and pass in the corresponding parameters
-
-```python 
-# WebSocket public channel
-url = "wss://ws.okx.com:8443/ws/v5/public?brokerId=9999"
-
-# WebSocket private channel
-url = "wss://ws.okx.com:8443/ws/v5/private?brokerId=9999"
-```
+  - Run test/WsPrivateTest.py for private websocket channels
+  - Run test/WsPublicTest.py for public websocket channels
+  - Use different URLs for different environment
+      - Live trading URLs: https://www.okx.com/docs-v5/en/#overview-production-trading-services
+      - Demo trading URLs: https://www.okx.com/docs-v5/en/#overview-demo-trading-services
 
-P.S. 
+Note 
 
-- If  you know little about API, advise consulting the  offical [API document](https://www.okx.com/docs-v5/en/)
+- To learn more about OKX API, visit official [OKX API documentation](https://www.okx.com/docs-v5/en/)
 
-- User with RestAPI can configure parameter `flag` in `example.py` in  to choose to access to real trading or demo trading 
-
-- User with WebSocketAPI can ucomment the corresponding `url`  to choose to access to real trading or demo trading 
-
-- Rest API support request by http2, you can refer to http2_example  
-
-- If you face any questions when using `WebSocketAPI`,you can consult related link
+- If you face any questions when using `WebSocketAPI`,you can consult the following links
 
   - `asyncio`、`websockets` document/`github`：
 
@@ -153,6 +74,3 @@ P.S.
     https://github.com/Rapptz/discord.py/issues/1996
     https://github.com/aaugustin/websockets/issues/587
     ```
-
-
-