Jupyter Notebook is a popular open-source web application widely utilized by data scientists and algorithmic traders. It allows you to create and share documents that contain live code, equations, visualizations, and narrative text.
With the official launch of the WOO X Pro OpenAPI, professional traders can now seamlessly integrate their Python environments and Jupyter Notebooks with our core matching engine to fetch market data, backtest trading strategies, and execute automated trades.
This guide outlines the high-level steps to securely configure your environment for WOO X Pro API integration.
Step 1: Generate Your WOO X Pro API Keys
Before interacting with the platform programmatically, you must generate your unique API Key and API Secret.
- Log in to your WOO X Pro account.
- Navigate to the API Management page in your account settings.
- Click Create API.
- Securely store your API Key and API Secret.
⚠️ Security Warning: Your API Secret will only be displayed once during creation. Do not share it with anyone, and never upload it to public repositories (such as GitHub).
For detailed instructions on API creation and permissions, please refer to our official guide: WOO X Pro API Application & Configuration.
Step 2: Set Up Your Jupyter Environment
If you have not yet set up your development environment, we recommend installing Anaconda, which comes pre-packaged with Python, Jupyter Notebook, and the most common data science libraries.
Alternatively, if you already have Python installed, you can install Jupyter via your terminal or command prompt using standard package managers (e.g., pip install jupyter), and launch the application by typing jupyter notebook.
Step 3: Connecting to WOO X Pro Endpoints
Once your notebook is running, you can begin constructing HTTP requests to the WOO X Pro REST API or connecting via WebSockets.
- Public Endpoints: You can query market data, order book depth, and recent trades without authentication.
- Private Endpoints: To execute trades or query your account balance, your requests must include a digital signature (HMAC SHA256) in the HTTP headers using your API keys.
Important: We do not provide static code snippets in the Help Center, as API endpoints and signature logic are subject to updates. For the most accurate, up-to-date integration instructions, base URLs, and authentication logic, please refer strictly to the WOO X Pro Official Developer Documentation.
Step 4: Security & Best Practices
As an institutional-grade platform, WOO X Pro strongly recommends adhering to the following security protocols when building automated strategies:
- IP Whitelisting: Always bind a static, trusted IP address to your production API Keys. Keys without IP restrictions may be subject to stricter security limitations and shorter validity periods.
- Environment Variables: Never hardcode your API Secret directly into your .ipynb notebook cells. Utilize environment variables (e.g., .env files) to load your credentials securely into your scripts.
- Read-Only Testing: During the development and backtesting phases of your algorithms, always generate an API Key with "Read-Only" permissions. Only enable "Trade" permissions once your code has been thoroughly tested.
If you encounter any technical issues or require clarification on rate limits and error codes, please reach out to our technical support team or consult the Developer Documentation.