API

Bots

Get a single bot or a list of all bots Auth Required: Read Bots
GET
Request
Path Params
number
optional
String
Unique identifier to retrieve a single bot. If omitted, all bots will be returned
Query Parameters
statuses
optional
Array
Filter bots to a given status or statuses. Valid values are "Enabled", "Disabled", and "Disable on Close". Query string should look like this: "?statuses[]=Enabled&statuses[]=Disable on Close"
include_details
optional
Boolean
Set to "true" to include all bot settings, including entry, exit, adjustments, notifications, and variables. If omitted, only high level information about the bot(s) will be returned
Header Parameters
API Token
required
String
Token from your Whispertrades account
Curl
Node.js
JS
Python
Responses
200

Enable a bot that is currently disabled or disable on close Auth Required: Write Bots
PUT
Request
Path Params
number
required
String
Bot number to enable
Header Parameters
API Token
required
String
Token from your Whispertrades account
Curl
Node.js
JS
Python
Responses
200

Disable a bot that is currently enabled. If the bot has open positions, the bot will move to Disable on Close. If there are no open positions, the bot will move to Disabled. Auth Required: Write Bots
PUT
Request
Path Params
number
required
String
Bot number to disable
Header Parameters
API Token
required
String
Token from your Whispertrades account
Curl
Node.js
JS
Python
Responses
200

Open a new position for the bot. This is only valid during market hours, while the bot is enabled, and while the bot has no more than one position currently open. This API request will ignore any entry filters configured for the bot and will immediately enter a new position when submitted. Auth Required: Write Positions
POST
Request
Path Params
number
required
String
Bot number for the new position
Header Parameters
API Token
required
String
Token from your Whispertrades account
Curl
Node.js
JS
Python
Responses
200

Close open position(s) for the bot. This is only valid during market hours and while the bot is set to Enabled or Disable on Close. Auth Required: Write Positions
PUT
Request
Path Params
number
required
String
Bot number for the position(s) to close
Header Parameters
API Token
required
String
Token from your Whispertrades account
Curl
Node.js
JS
Python
Responses
200




Updated 08 May 2024
Did this page help you?