Skip to main content
GET
Preview allocation withdraw payout

Authorizations

Authorization
string
header
required

User JWT access token issued by POST /api/auth/verify or POST /api/auth/social/verify. Routes that accept both auth modes declare api-key and bearer-jwt security schemes.

Headers

x-signature
string
required

Required for API-key authenticated requests. HMAC-SHA256(secretKey, timestamp + METHOD + path + body) as lowercase hex. Omit only for JWT/OAuth session tokens or public routes.

x-timestamp
string
required

Required with x-signature. Epoch milliseconds; rejected if drift exceeds 5 minutes. Omit only for JWT/OAuth session tokens or public routes.

Path Parameters

agentId
string
required

Query Parameters

amountUsd
number
required

USD amount to preview. Gross − pending fees − slippage − dust − success fee = you receive.

Required range: x >= 0.01
closeAllTrades
boolean

When true, preview the close-all sheet (no staying-in-open-trades; full-exit fee). Default keep-open.

fullExit
boolean

When true, preview the unsubscribe sheet: full idle equity (not amountUsd) and the entire outstanding success fee.

Response

200 - application/json

Payout preview.

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload