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
entryPrice
number
required

Entry Price per Unit

Required range: 1e-8 <= x <= 100000000
margin
number
required

Margin (Collateral)

Required range: 0.01 <= x <= 1000000000
direction
enum<string>

Position Direction

Available options:
long,
short
leverage
number

Leverage

Required range: 1 <= x <= 125
maintenanceMarginRate
number

Maintenance Margin Rate (%)

Required range: 0 <= x <= 50
exitPrice
number

Exit Price (optional)

Required range: 1e-8 <= x <= 100000000
currency
enum<string>

Currency

Available options:
USD,
EUR,
GBP,
AUD,
JPY,
CAD

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.