Install OctoBot on Python index package (pip)
After installation, OctoBot starts in node mode and opens its node interface. From there you can:
- Run automations configured and monitored from the new OctoBot interface or the mobile app (recommended for most users).
- Launch manual OctoBots with their own interface, deeper configuration and the backtesting engine (for expert users).
See the getting started guide for setup steps, or the connect guide if you have connection issues.
Requirements
- Python 3.10 (download)
- Add python to your PATH (tutorial windows)
Installation
In a command line (with python in your PATH) type the following command:
python3.10 -m pip install OctoBotYou can change python3.10 to the name of the python binary you added to your PATH (for example on linux you may use python3 or even python if the python —version commands outputs a python 3.10 version)
Usage
OctoBotAfter install: Initialize your OctoBot and start your first automated strategy with a risk-free virtual account.
Update
Executing the following command will update your Python OctoBot using the latest version, as well as installing the latest requirements.
python3.10 -m pip install -U OctoBotThe next restart will automatically update your OctoBot tentacles.
Start multiple nodes
To run a second node on the same computer, use a separate working directory and change the node listen port in configuration before starting again. Manual OctoBots started from each node use their own ports in the 5001+ range. See having multiple OctoBots.
Initialize your OctoBot
After OctoBot starts, open http://localhost:8000/ and follow node onboarding.
After installation: Starting your OctoBot
- Open the node setupOpen
http://localhost:8000on the PC where OctoBot is running. The node setup screen opens in your browser. - Set up your node walletOn the node, create or import your node wallet to secure your node and its data. This wallet is not a cryptocurrency wallet, do not use a crypto wallet private key and never share your private key with anyone.
- Connect your Node to your OctoBot interfaceFrom the Connect your Node to your OctoBot interface step (or Settings → Connect → Web tab), open new.mobile.octobot.cloud. I already have a wallet → I already have a private key. Paste Copy your private key from this node. Then new automation → any type → Add a node → Existing install. Hostname: the hostname or IP the node shows. Port: 8000 (or what the node shows). Click Save when the checks turn green. Still Unreachable? Check our connection troubleshoot.
- Launch your first OctoBotOn new.mobile.octobot.cloud, leave demo mode on (default for risk-free simulated trading). Add an exchange account with 1000 USDC (or the crypto of your choice). Start a new automation (for example a Grid on BTC/USDC, if you added USDC to the demo account) and follow your automation from your OctoBot interface.
- Your node is now executing your strategyWhen you start an automation, the node runs it on its computer. You do not need to keep the browser tab or app open. Just leave the OctoBot program running so that it keeps trading. You can run as many automations as you want, on most crypto exchanges, with demo and real accounts. When needed, feel free to stop and restart your node, it will resume trading when you turn it back on.
Use new.mobile.octobot.cloud or the iOS or Android app on a regular basis to follow your investments and turn automations on and off. Go back to the node interface at http://localhost:8000 only for configuration, administration, or to connect to a new phone or computer.
Connection problems? Read the Node Connect Guide. If your node shows Unreachable, see connection common issues.
