cShortSalesBan

Returns a list of short sales bans for counterparties

POST api/cShortSalesBan

Payload

{}

200 OK

[
    [
        1,            // Counterparty id
        "BTC",        // Asset name
        1,            // banned by me
    ],
    [
        1,            // Counterparty id
        "USD",        // Asset name
        2,            // banned by the CP
    ],
    [
        2,            // Counterparty id
        "BTC",        // Asset name
        3,            // banned both by me and the CP
    ]
]

400 Bad request

{
    "error": 2
}

Request parameters

Field name	Type	Description
counterpartyId	Efx::ClientId	Optional. Returns a list of short sales bans for specified counterparty. Returns a list of short sales bans for all counterparties otherwise.
filter	string	Optional field for master accounts only (FM Liquidity Match). - absent or "all": returns full deals history - "subaccounts": returns deals history with subaccounts - "external": returns deals history with external counterparties

Response description

Field name	Type	Description
	Array of shortSalesBan	Array of counterparties and assets for which short sales ban is set
shortSalesBan	Array[3]
0	Efx::ClientId	Counterparty Id
1	string	Asset name
2	int32	Short sales ban flags: flag & 1 = banned by client flag & 2 = banned by counterparty