positions

Returns next deal id, positions, orders and settlement orders snapshot

POST api/positions

Payload

{
    "filter": "all"
}

200 OK

[
    5,
    [
        [ 
            "BTC",        // Posititon Currency
            -10000000,    // Value
            2,            // Counterparty id
            0,            // Max reachable position, if the settlement order is committed
            -10000000     // Min reachable position
        ],
        [
            "USD",
            100000000000,
            2,
            100000000000,
            0,
        ]
    ],
    [
        [
            "BTC-USD",     // Order instrument
            0,             // Order type
            0,             // Side
            0,             // Cancel reason
            1234,          // Order id
            0,             // Client order id 
            999900000000,  // Price
            10000000,      // Size or volume
            8000000,       // Remaining size or volume
            1558051200000, // Created at
            0              // created by size or volume
        ]
    ],
    [
        [
            1229,          // Settlement order id
            "BTC",         // Currency 1
            "USD",         // Currency 2
            10000000,      // Size 1
            100000000000,  // Size 2
            1558050900000, // Created at
            2,             // Counterparty id
            "BTC",         // Network name 1
            ""             // Network name 2 (not specified)    
        ]
    ]
]

400 Bad request

{
    "error": 2
}

Request parameters

Field name	Type	Description
filter	string	Optional field for master accounts only (FM Liquidity Match). - absent or "all": returns positions for all counterparties - "subaccounts": returns positions for the sub-accounts - "external": returns positions for external counterparties

Response description

Fiels name	Type	Description
	Array[4]	Array or 4 elements
0	Efx::DealId	Next Deal or Settlement Id
1	Array of Positions	Asset Positions
2	Array of Orders	Active Orders (for makers only)
3	Array of SettlementOrders	Active Settlement Orders
Position	Array[3]
0	string	Currency name
1	Efx::Size	Value
2	Efx::ClientId	Counterparty Id
3	Efx::Size	Max reachable position
4	Efx::Size	Min reachable position
Order	Array[11]
0	string	Instrument name
1	unsigned int16	Order Type 0 - limit 1 - post only 2 - limit IOC 3 - limit FOK 4 - market IOC 5 - market FOK 6 - manual trade 7 - pending limit 9 - RFQ
2	Efx::Side	Side 0 - bid 1 - ask
3	unsigned int16	Cancel reason 0 - in place or filled 1 - by client 2 - as non-book order 3 - by self-trade prevention 4 - cancel-on-disconnect
4	Efx::OrderId	Order Id
5	Efx::ClientOrderId	Client Order Id
6	Efx::Price	Order price
7	Efx::Size	Order Initial Size Or Volume (Depending on Order was initially created by size or volume)
8	Efx::Size	Remaining Order Size Or Volume (Depending on Order was initially created by size or volume)
9	Efx::Timestamp	Created At
10	unsigned int16	If order was created by size or by volume 0 - by size 1 - by volume
SettlementOrder	Array[9]
0	Efx::OrderId	Settlement order id
1	string	Currency 1
2	string	Currency 2
3	Efx::Size	Size 1
4	Efx::Size	Size 2
5	Efx::Timestamp	Created At
6	Efx::ClientId	Counterparty id
7	string	Newtork 1 or empty
8	string	Network 2 or empty