1. Set up TWS(IB Trader WorkStation) and login your TWS in the same machine where you going to run xerolite.
2. After login, open configuration page. Go to top menu bar, Edit-> Global Configuration.
3. In API Settings
   • Check Enable ActiveX and Socket Clients
   • Set Socket port to 7497
   • Refer the settings as following screenshots
4. In API -> Precautions,
   • Bypass all the precautions as following screenshot.
   • 

• Download xerolite from the above link (Download section at the top on this page)
• Copy the xerolite-xxxx.zip that you have downloaded to any drive on your computer.
• Unzip the file to extract its contents.

• Open the config/login-credentials.properties file.
• Change the username and password to your desired values.

1. Open Command Prompt: Press Win + R, type cmd, and hit Enter.
2. Navigate to Folder:  cd C:\path\to\xerolite
3. Run Program: win-run.bat

1. Open Terminal: Press Ctrl + Alt + T.
2. Navigate to Folder: cd /path/to/xerolite
3. Run Program: ./linux-run.sh

1. Open Terminal: Press Command + Space, type Terminal, and hit Enter.
2. Navigate to Folder: cd /path/to/xerolite
3. Run Program: ./mac-run.sh

• After starting successfully, open your web browser and type localhost in the address bar.
• You should see the Xerolite Login Page. Log in using the username and password you set in the previous step

Important: Ensure Port 80 is Open

• Cloud Firewalls (if you’re using a cloud service)
• Operating System Firewalls (like Windows Firewall)

Testing if Port 80 is Accessible

1. Using Another Device: Open a web browser on any other computer or mobile device (not the server where Xerolite is installed).
2. Check Access: Type the IP address of your server where you installed Xerolite in the browser’s address bar.
   • If everything is set up correctly, you should see the Xerolite Login Page, which means port 80 is open and accessible.

Note:

• Do Not Test on the Server: Make sure you do not test this from the server where you installed Xerolite, as it will not provide an accurate test of accessibility from the outside.

1. After logging in to Xerolite, locate the License Key field.
2. Paste your license key into the provided text box.
3. Click the Activate button to complete the activation.

1. Click on Update License Key in the menu.
2. Paste your new license key into the License Key text box.
3. Click the Activate button to update your license.

• Activation Limit: Only one machine can be activated at a time.
• Deactivation: The original machine will automatically deactivate if the license is used on another machine.
• Free Trial License: Your license is valid and have full access to all features for 15 Days
• Lifetime License : Your license is valid for life and will work for all XeroLite v0.3.x updates.

Step 1: Login to TradingView

• Sign in to your TradingView account.
• Click on the ‘+’ icon in the top right corner to create a new alert.

  

Step 2: Set Up Alert Rule

• Choose your desired conditions for the alert. Configure the alert rule according to your trading strategy.

Step 3: Enter the Alert Message

• In the Message field, enter your alert request.
• Make sure it strictly follows the format specified by Xerolite.
• Refer to the User Manual -> Alert Request Format tab for details.

Step 4: Enter the WebHook URL

• • Copy the WebHook URL provided by Xerolite and paste it into WebHook URL field in TradingView.
  • Refer to the User Manual -> WebHook URL tab for details

What is a WebHook URL?
The WebHook URL is the link you need to configure in TradingView for sending alerts.

1. 1. Format of the WebHook URL:
      The WebHook URL should be formatted to include your API key, like this:
      https://<your-ip-address>/api/order/place-order?x-api-key=dwLoMoXfMJq77_32fZYP8gQlvUzTzHPJ
   2. Purpose of the API Key:
      The API key adds an extra layer of security, helping to prevent unauthorized requests to your system.
   3. Regenerating Your API Key:
      If you suspect that your API key has been exposed, you can regenerate it. This is an important security measure.
   4. Regular Updates:
      It’s advisable to regenerate your API key occasionally, just like you would with a password, to maintain security.
   5. Updating TradingView:
      After regenerating your API key, remember to update the WebHook URL in TradingView with the new key. Ensure it looks like this:
      https://<your-ip-address>/api/order/place-order?x-api-key=<new-api-key>

To create an alert request that integrates with TradingView, follow the steps below. Ensure that the alert message you configure matches the required format exactly.

Alert Message Format Example:

Explanation of Fields:

• name: The alert name, which helps you differentiate between different alerts.
• sec_type: The type of security. Possible values:
  • STK: Stock
  • CASH: Forex
  • FUT: Futures
• con_id: The unique contract ID from Interactive Brokers (IB).
• exch: The name of the exchange (e.g., SMART).
• action: Specifies the action to take: either buy or sell.
• volume: The number of shares or contracts you want to trade.

Steps to Generate Your Alert Request:

1. Navigate to the “Create Your Alert Request” Tab.
2. Enter the following search criteria:
   • Symbol (e.g., AAPL for Apple)
   • Security Type (e.g., STK for stocks)
   • Currency (e.g., USD for U.S. dollars)

   Use these inputs to search for the corresponding contract from Interactive Brokers (IB).
   

3. Copy the Generated JSON:
   • After performing the search, you’ll see a JSON format for each returned contract.
   • Click on Copy to copy the JSON message.
4. Modify the JSON (If Necessary):
   • Do not modify: con_id, sec_type, or exch values.
   • You can modify the following fields:
     • action: Choose either “buy” or “sell”.
     • volume: Set the quantity for the order.
     • name: Update the alert name if needed.

By following these steps, you can generate an accurate alert request for TradingView and ensure your message is configured correctly for execution.

Why Whitelisting?
For security reasons, Xerolite Webhook URL only accepts requests from specific approved (whitelisted) IP addresses.
Currently, only your own server (localhost) and TradingView’s IP addresses are allowed by default.

Testing from Another Device
If you want to test the Webhook URL  from another device (like your phone or a different computer), you’ll need to add your device’s IP address to the whitelist.

Steps to Add Your Device’s IP:

1. Find Your IP Address
   Go to WhatIsMyIP.com to easily find your device’s IP address.
2. Update the Configuration
   Open the custom.yml file on Xerolite. Add your IP address inthe section labeled “whitelist” like this:

   

3. Indentation Matters
   When you add your IP address, make sure the spaces (indentation) are exactly as shown, otherwise it may not work properly.

4. Restart Xerolite
   The new IP address will be appear in the “WhiteList IP” section.

5. Unauthorized Request
   The alert request that sent from device without whitelisting the IP will be treated as Unauthorized and will not be processed
   

How to Validate and Test Your Alert Request

If you want to make sure your alert request is valid and can place an order successfully via the webhook URL(without waiting for TradingView to trigger it), you can use our testing tool. Here’s how you can easily validate and test your alert message:

Steps to Validate and Test Your Alert Request:

1. Why Validate?
   It’s helpful to test your alert request to ensure it works properly before waiting for it to be triggered in TradingView. This helps you avoid delays or errors.

2. Use Our Testing Tool
   We provide a simple tool to help you test and validate your alert message.

3. Follow These Steps:

   • Click on the “Place Your Order” tab.
   • Copy your alert request JSON (the one you generated earlier).
   • Paste the JSON into the provided text box.

4. Validate the Alert Request:

   • Click the “Validate Message” button to check if the format of your JSON is correct.
     
   •  
   • 

5. Submit the Order (Optional):
   If you want to test sending an actual order to Interactive Brokers, click the “Submit” button.

6. Testing from a Different Device:
   If you want to use this feature from a device other than from VPS where you install the xerolite (e.g., testing from your phone/ home laptop), you will need to whitelist your phone’s IP address to ensure it is allowed to access the tool.

By following these steps, you’ll be able to validate and test your alert requests in a safe environment before executing them through TradingView or Interactive Brokers.