Change position margin

PATCH/positions/{positionId}/margin

Change position marginTrading

Moves quote balance in or out of the margin of an open position, which moves its leverage and liquidation price with it.

The position must still be open, and its account must belong to the caller and be active — an account locked by the managed capital limit is refused here.
The market must be open and not in close-only mode.
marginChange: "0" is accepted and returns the position untouched.
Adding more than the free balance covers fails with insufficient_balance; withdrawing more than the position can spare fails with non_positive_margin.

Base URL https://api.upscale.trade

Authorization

bearerhttp · bearerrequired

Personal API key, prefixed with usk_.

Parameters

Path

positionIdstring · uuidrequired

Position identifier. Its account must belong to the caller.

Example: 00000000-0000-4000-8000-000000000000

Request body · required

marginChangestring · int32required

Signed quote amount to move in or out of the position margin, fp9 raw. Positive adds margin and requires that much free balance, negative withdraws it and must keep the remaining margin positive. 0 is accepted and changes nothing.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

{
  "marginChange": "1000000000"
}

Examples

curl --request PATCH 'https://api.upscale.trade/positions/{positionId}/margin' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "marginChange": "1000000000"
}'

const response = await fetch("https://api.upscale.trade/positions/{positionId}/margin", {
  method: "PATCH",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: "{\n  \"marginChange\": \"1000000000\"\n}",
});
console.log(response.status, await response.text());

import requests
 
response = requests.request(
    "PATCH",
    "https://api.upscale.trade/positions/{positionId}/margin",
    headers={"Accept":"application/json","Authorization":"Bearer YOUR_API_KEY","Content-Type":"application/json"},
    data="{\n  \"marginChange\": \"1000000000\"\n}",
    timeout=30,
)
print(response.status_code, response.text)

Responses

401

Unauthorized

403

The account belongs to another user (account_access_denied), or the request is authenticated with an API key while api_trading is disabled on the account (api_trading_not_enabled). The account is not in an active status. The market is paused (market_paused) or accepts closing orders only (market_close_only).

404

No position with this identifier.

429

Rate limit of the API key exceeded (api_key_rate_limit_exceeded). Retry-After says when to come back; the body carries the bucket (read / write), the window that tripped, its limit and retryAt.

defaultResponseapplication/json

idxstring[]required

Position identifier. Same value as txId.

Array items · string

string

View example

[
  "string"
]

txIdstring[]required

Position identifier. Kept for backward compatibility, always equal to idx.

Array items · string

string

View example

[
  "string"
]

versionnumberrequired

Revision of the position: incremented by every event applied to it.

Example: 0

openedAtstring · date-timerequired

When the position was opened.

Example: 2026-05-01T12:30:00.000Z

lastUpdatedAtstring · date-timerequired

When the last event was applied to the position.

Example: 2026-05-01T12:30:00.000Z

closedAtstring · date-time · nullablerequired

When the position was closed; null while it is still open.

Example: 2026-05-01T12:30:00.000Z

typestring · enumrequired

Direction of the position. Same value as direction.

Allowed: "long" "short"

Example: long

statusstring · enumrequired

Whether the position is still open, closed by the trader, or liquidated.

Allowed: "opened" "closed" "liquidated"

Example: opened

marketstring · uuidrequired

Market the position is held on.

pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Example: 00000000-0000-4000-8000-000000000000

traderstring · uuidrequired

Trader account the position belongs to.

pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Example: 00000000-0000-4000-8000-000000000000

sizestring · int32required

Position size in base asset units, fp9 raw.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

notionalstring · int32required

Open notional of the position in quote currency, fp9 raw — size at entry price.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

fractionstring · int32required

Always 0. Kept for backward compatibility.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

marginstring · int32required

Margin currently backing the position, fp9 raw. Moves with pnl, funding and manual margin changes.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

pnlstring · int32 · nullablerequired

Realised pnl accumulated over every event of the position, fp9 raw.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

fundingstring · int32 · nullablerequired

Funding paid (negative) or received (positive) over the life of the position, fp9 raw.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

rolloverFeestring · int32required

Always 0. Kept for backward compatibility.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

settlementOraclePricestring · int32required

Always 1000000000 (1.0). Kept for backward compatibility.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

feestring · int32required

Trading fees charged over the life of the position, fp9 raw.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

feeRatestring · int32required

Fee rate applied to the position, fp9 raw fraction (1000000 = 0.1%).

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

exchangedQuotestring · int32required

Quote amount exchanged by the most recent event, fp9 raw.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

exchangedBasestring · int32required

Base amount exchanged by the most recent event, fp9 raw.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

directionstring · enumrequired

Direction of the position.

Allowed: "long" "short"

Example: long

eventNamestring · enumrequired

Type of the most recent event applied to the position.

Allowed: "addMargin" "removeMargin" "closePosition" "increasePosition" "liquidate" "forceClose" "payFunding"

Example: addMargin

pnlInEventstring · int32required

Realised pnl of the most recent event, fp9 raw.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

rawPnlInEventstring · int32required

Realised pnl of the most recent event before the 60-second adjustment, fp9 raw. Differs from pnlInEvent only when the adjustment fired.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

profitAdjustmentAppliedbooleanrequired

Whether the 60-second adjustment capped the profit of the most recent event — inside a minute of an open or increase the position pnl cannot grow above what it was at that moment.

Example: true

holdingTimeMsstring[]required

How long the position was held before the most recent close, in milliseconds, counted from the open or the last increase. Null on events that are not closes.

Array items · string

string

View example

[
  "string"
]

feeInEventstring · int32required

Fee charged by the most recent event, fp9 raw.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

fundingInEventstring · int32required

Funding settled by the most recent event, fp9 raw.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

rolloverFeeInEventstring · int32required

Always 0. Kept for backward compatibility.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

executionFeeRatestring · int32required

Always 0. Kept for backward compatibility.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

executionFeeInEventstring · int32required

Always 0. Kept for backward compatibility.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

executionFeestring · int32required

Always 0. Kept for backward compatibility.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

timestampstring · date-timerequired

Timestamp of the most recent event. Same value as lastUpdatedAt.

Example: 2026-05-01T12:30:00.000Z

isOnchainbooleanrequired

Always true. Kept for backward compatibility.

Example: true

roestring · int32required

Return on equity of the position — realised pnl over the margin put up, fp9 raw fraction.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

scalpingCoefficientstring · int32required

Dynamic spread multiplier the position was charged, fp9 raw (1000000000 = 1.0). Above 1 when the trade fell inside the market scalping window.

pattern: ^(?:-?[1-9][0-9]*|0)$

Example: 1000000000

closeReasonstring[]required

Why the platform closed the position (for example weekly_session_risk_close). Null for positions closed by the trader and for open ones.

Array items · string

string

View example

[
  "string"
]

{
  "idx": [
    "string"
  ],
  "txId": [
    "string"
  ],
  "version": 0,
  "openedAt": "2026-05-01T12:30:00.000Z",
  "lastUpdatedAt": "2026-05-01T12:30:00.000Z",
  "closedAt": "2026-05-01T12:30:00.000Z",
  "type": "long",
  "status": "opened",
  "market": "00000000-0000-4000-8000-000000000000",
  "trader": "00000000-0000-4000-8000-000000000000",
  "size": "1000000000",
  "notional": "1000000000",
  "fraction": "1000000000",
  "margin": "1000000000",
  "pnl": "1000000000",
  "funding": "1000000000",
  "rolloverFee": "1000000000",
  "settlementOraclePrice": "1000000000",
  "fee": "1000000000",
  "feeRate": "1000000000",
  "exchangedQuote": "1000000000",
  "exchangedBase": "1000000000",
  "direction": "long",
  "eventName": "addMargin",
  "pnlInEvent": "1000000000",
  "rawPnlInEvent": "1000000000",
  "profitAdjustmentApplied": true,
  "holdingTimeMs": [
    "string"
  ],
  "feeInEvent": "1000000000",
  "fundingInEvent": "1000000000",
  "rolloverFeeInEvent": "1000000000",
  "executionFeeRate": "1000000000",
  "executionFeeInEvent": "1000000000",
  "executionFee": "1000000000",
  "timestamp": "2026-05-01T12:30:00.000Z",
  "isOnchain": true,
  "roe": "1000000000",
  "scalpingCoefficient": "1000000000",
  "closeReason": [
    "string"
  ]
}