Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
mode
enum<string>

Instrument

Available options:
stocks,
forex,
crypto
accountBalance
number

Account balance

Required range: x >= 0
currency
enum<string>

Currency

Available options:
$,
,
£,
¥,
A$,
C$,
CHF
riskType
enum<string>

Risk sizing

Available options:
percent,
fixed
riskPercent
number

Risk %

Required range: 0.01 <= x <= 100
riskAmount
number

Risk amount

Required range: x >= 0
pipSize
number

Pip size

Required range: x >= 0
pipValue
number

Pip value / std lot

Required range: x >= 0
entryPrice
number

Entry price

Required range: x >= 0
stopPrice
number

Stop-loss price

Required range: x >= 0
targetPrice
number

Take-profit (optional)

Required range: x >= 0

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.