API

Bot Positions

Get a paginated list of bot positions. Because of the large amount of data that this can return, results are paginated to 100 positions per page, listed by position entry date descending. There is an optional page parameter that you can use to return a specific page. The paginated result set will also return a 'pages' array that contains information about the number of items and pages. Auth Required: Read Positions
GET
Request
Path Params
number
optional
String
Unique identifier to retrieve a single position. If omitted, all positions will be returned
Query Parameters
bot
optional
String
Bot number to only retrieve positions for a specific bot
status
optional
String
Filter the results by a certain position status. Expected values are OPEN or CLOSED
from_date
optional
String
Minimum date for position entry. Expected format is YYYY-MM-DD
to_date
optional
String
Maximum date for position entry. Expected format is YYYY-MM-DD
page
optional
String
Page number
Header Parameters
API Token
required
String
Token from your Whispertrades account
Curl
Node.js
JS
Python
Responses
200

Close a specific bot position. 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
Position number to close
Header Parameters
API Token
required
String
Token from your Whispertrades account
Curl
Node.js
JS
Python
Responses
200




Updated 09 May 2024
Did this page help you?