Storm Trade
EN
EnglishРусскийNot available
Menu
On this page

Get a position

Try it out ↓
GET/api/positions/{id}
Get a positionPositions and order history
Base URL https://api.storm.tg

Parameters

Path
idstringrequired
Example: string

Examples

curl --request GET 'https://api.storm.tg/api/positions/{id}' \
  --header 'Accept: application/json'

Responses

200Responseapplication/json
idxstring · nullablerequired
Example: string
txIdstring · nullablerequired
Example: string
versionnumberrequired
Example: 0
openedAtstring · date-timerequired
Example: 2026-01-01T00:00:00Z
lastUpdatedAtstring · date-timerequired
Example: 2026-01-01T00:00:00Z
closedAtstring · date-time · nullablerequired
Example: 2026-01-01T00:00:00Z
typestring · enumrequired
Allowed: "long" "short"
Example: long
statusstring · enumrequired
Allowed: "pending_open" "pending_close" "pending_full_close" "pending_liquidate" "pending_max_pnl" "opened" "closed" "liquidated"
Example: pending_open
marketstringrequired
Example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660
traderstringrequired
Example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660
sizestring · int64required
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
notionalstring · int64required
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
fractionstring · int64required
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
marginstring · int64required
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
pnlstring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
fundingstring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
rolloverFeestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
settlementOraclePricestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
indexOraclePricestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
feestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
feeRatestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
exchangedQuotestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
exchangedBasestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
directionstring · enumrequired
Allowed: "long" "short"
Example: long
eventNamestring · nullablerequired
Example: string
pnlInEventstring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
feeInEventstring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
fundingInEventstring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
rolloverFeeInEventstring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
executionFeeRatestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
executionFeeInEventstring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
executionFeestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
timestampstring · date-timerequired
Example: 2026-01-01T00:00:00Z
isOnchainbooleanrequired
Example: true
roestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
orderobject · nullableoptional
Object · 21 fields
idstringrequired
Example: string
txIdstringrequired
Example: string
traderstringrequired
Example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660
masterTraderstringrequired
Example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660
marketstringrequired
Example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660
statusstring · enumrequired
Allowed: "seq_pending" "seq_executing" "active" "pending" "tx_sent" "executed" "canceled" "canceled_by_sequencer" "expired" "error"
Example: seq_pending
typestring · enumrequired
Allowed: "market" "stop" "take" "limit" "liquidation" "max_pnl" "add_margin" "remove_margin"
Example: market
directionstring · enumrequired
Allowed: "long" "short"
Example: long
stopPricestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
limitPricestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
stopTriggerPricestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
takeTriggerPricestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
leveragestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
indexnumber · nullablerequired
Example: 0
positionIdstring · nullablerequired
Example: string
expirationstring · date-time · nullablerequired
Example: 2026-01-01T00:00:00Z
amountstring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
indexPricestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
settlementOraclePricestring · int64 · nullablerequired
pattern
^(0|-?[1-9][0-9]*)$
Example: 0
createdAtstring · date-timerequired
Example: 2026-01-01T00:00:00Z
errorstring · nullablerequired
Example: string
View example
{
  "id": "string",
  "txId": "string",
  "trader": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660",
  "masterTrader": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660",
  "market": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660",
  "status": "seq_pending",
  "type": "market",
  "direction": "long",
  "stopPrice": "0",
  "limitPrice": "0",
  "stopTriggerPrice": "0",
  "takeTriggerPrice": "0",
  "leverage": "0",
  "index": 0,
  "positionId": "string",
  "expiration": "2026-01-01T00:00:00Z",
  "amount": "0",
  "indexPrice": "0",
  "settlementOraclePrice": "0",
  "createdAt": "2026-01-01T00:00:00Z",
  "error": "string"
}