Skip to main content
GET
cURL

Query Parameters

currency
enum<string>
required

The currency symbol Currency, i.e "BTC", "ETH", "USDC"

Available options:
BTC,
ETH,
USDC,
USDT,
EURR
Example:

"BTC"

add_positions
boolean

If true, adds simulated positions to current positions, otherwise uses only simulated positions. By default true

simulated_positions
string

Object with positions in following form: {InstrumentName1: Position1, InstrumentName2: Position2...}, for example {"BTC-PERPETUAL": -1000.0} (or corresponding URI-encoding for GET). For futures in USD, for options in base currency. JSON string containing: object data

Response

200 - application/json

Success response

jsonrpc
enum<string>
required

The JSON-RPC version (2.0)

Available options:
2.0
result
object
required

Portfolio margin simulation result

id
integer

The id that was sent in the request