Skip to main content
POST
Stock & Forex Position Size Calculator

Authorizations

Authorization
string
header
required

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

Body

application/json
ioMode
enum<string>

Instrument

Available options:
stocks,
forex,
crypto
ioAccountBalance
number

Account balance

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

Currency

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

Risk sizing

Available options:
percent,
fixed
ioRiskPercent
number

Risk %

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

Risk amount

Required range: x >= 0
ioPipSize
number

Pip size

Required range: x >= 0
ioPipValue
number

Pip value / std lot

Required range: x >= 0
ioEntryPrice
number

Entry price

Required range: x >= 0
ioStopPrice
number

Stop-loss price

Required range: x >= 0
ioTargetPrice
number

Take-profit (optional)

Required range: x >= 0

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

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

request_id
string
credits_remaining
integer | null

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