Skip to main content
POST
Preview copying a lead trader's open positions

Authorizations

X-Monaco-Signature
string
header
required

Ed25519 session-key request signing. Every authenticated request carries three headers: X-Monaco-PublicKey (64-char lowercase-hex session public key), X-Monaco-Timestamp (Unix milliseconds, within 30s of server time), and X-Monaco-Signature (hex ed25519 signature). The signature is over METHOD\npath?query\ntimestamp_ms\nSHA256_hex(body), where the body hash is the SHA-256 of the empty byte string when there is no body. Obtain the session keypair from POST /api/v1/auth/challenge followed by POST /api/v1/auth/verify.

Body

application/json
leader
string | null

The leader's custom TraderCode handle

Example:

"alpha_trader"

marginModePolicy
string | null

FOLLOW (default), CROSS or ISOLATED

Example:

"FOLLOW"

sizingMode
string | null

PROPORTIONAL (default) or FIXED_MARGIN

Example:

"PROPORTIONAL"

sizingParam
string | null

Margin per leader order in quote units; required for FIXED_MARGIN, omitted otherwise

leverageMode
string | null

FOLLOW (default) or FIXED

Example:

"FOLLOW"

fixedLeverage
string | null

Leverage for every copy; required for FIXED, omitted otherwise

allocation
string | null

Collateral the copy account would start with, in quote units

Example:

"1000"

markets
object | null

Markets to copy; omit to copy every market the leader trades.

Response

OK

What following with copyExisting would open, as totals only. The caller of a preview is never a follower of the leader (copyExisting applies only on a create), so the response names no pair, side, size, mark or skip reason, and a leader whose positions cannot be copied at all gives copiedPositions = 0 with no reason. The totals are rounded UP to cents (the settlement currency's display precision). A residual aggregate signal remains: the counts and the rounded totals across varied allocations bound the size of the leader's book, never its markets or direction.

estimatedMargin
string | null

Estimated collateral the copied positions would reserve at placement, in quote units, rounded up to cents

Example:

"125.40"

estimatedFee
string | null

Estimated taker fees of the copies, in quote units, rounded up to cents

Example:

"0.35"

copiedPositions
integer<uint32> | null

The leader's positions (in the copied markets) that would be copied

Example:

2

skippedPositions
integer<uint32> | null

The leader's positions (in the copied markets) that would not be copied

Example:

1

truncated
boolean | null

True when the leader holds more positions in the copied markets than one preview sizes (64); the totals and counts cover the first ones only