Skip to main content
POST
Follow a lead trader or edit a follow

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
followId
string<uuid> | null

Omit to create a follow; set to edit one of your follows

leader
string | null

The leader's custom TraderCode handle; required on a create, optional on an edit (a consistency check when it resolves)

Example:

"alpha_trader"

marginModePolicy
string | null

FOLLOW (default: the leader's risk bucket mode per market), CROSS or ISOLATED

Example:

"FOLLOW"

sizingMode
string | null

PROPORTIONAL (default: scaled by copy account equity over the leader's equity) 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: the leader's leverage) or FIXED

Example:

"FOLLOW"

fixedLeverage
string | null

Leverage for every copy; required for FIXED, omitted otherwise

allocation
string | null

Collateral for the copy account, in quote units, at or above the minimum

Example:

"1000"

slPct
string | null

Copy stop-loss as a fraction of the allocation in (0, 1]; omitted means none

Example:

"0.25"

copyExisting
boolean | null

On a create, also copy the leader's currently open positions into the new copy account, sized like any mirrored fill (PreviewFollow shows the cost). Default false. Refused on an edit

markets
object | null

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

Response

OK

followId
string<uuid> | null

The follow's id

copyRiskBucketId
string<uuid> | null

The copy account: the cross risk bucket in your margin account that holds this follow's collateral and positions

created
boolean | null

True when this call created the follow, false when it edited one