GetDeals

GetDeals

Filter inputs

Name

Type

Description

Mandatory

Available from version

Name

Type

Description

Mandatory

Available from version

BrickIds

Guid[]

Specific ids to search for. BrickId is the internal id of a deal.

false

2.11

CreatedDateFrom

DateTime?

Filter by a range of dates when the deal was created. This defines the first date of the search range. Note that the time of the day is relevant in this search and not just the date.

false

2.11

CreatedDateTo

DateTime?

Filter by a range of dates when the deal was created. This defines the last date of the search range. Note that the time of the day is relevant in this search and not just the date.

false

2.11

 Asset1

Guid?

Filter by Asset1 on the deal

false

2.11

 Asset2

Guid?

Filter by Asset2 on the deal

false

2.11

ExecutionInterfaces

string[]

Filter by the execution interface keys on the deals.
Possible values: MFEX, NFM, Manual, Internal, ExternalFund, Fax

false

2.11

BuyPartyAccounts

Guid[]

Filter by the internal id of the Account on the deal

false

2.11

SellPartyAccounts

Guid[]

Filter by the internal id of the Account on the deal

false

2.11

DealNos

string[]

Filter by the deal number

false

2.11

BuyOrders

Guid[]

Filter by the internal id of the buy orders connected to the deal

false

2.11

SellOrders

Guid[]

Filter by the internal id of the sell orders connected to the deal

false

2.11

BuyPartyNotes

string[]

Filter by the buy party note number of connected to the deal

false

2.11

SellPartyNotes

string[]

Filter by the sell party note number of connected to the deal

false

2.11

IsTRSReporting

bool?

Filter by whether the deal should be included in the TRS-reporting or not.

false

2.11

TradeTimeFrom

DateTime?

Filter by a range of timestamps of when the deal was executed. This defines the first date of the search range.

false

2.11

TradeTimeTo

DateTime?

Filter by a range of timestamps of when the deal was executed. This defines the last date of the search range.

false

2.11

TradeDateFrom

DateTime?

Filter by a range of dates of when the deal was executed. This defines the first date of the search range.

false

2.11

TradeDateTo

DateTime?

Filter by a range of dates of when the deal was executed. This defines the last date of the search range.

false

2.11

SettlementDateFrom

DateTime?

Filter by a range of dates of when the deal was settled. This defines the first date of the search range.

false

2.11

SettlementDateTo

DateTime?

Filter by a range of dates of when the deal was settled. This defines the last date of the search range.

false

2.11

StatusKeys

string[]

Filter by the Status of the deal. It is only possible to filter on StatusKey = "Cancelled".

false

2.12

TradingVenues

Guid[]

Filter by the Trading Venue of the deal

false

2.12

TradingVenueTransactionIds

string[]

Filter by the transaction id given by the Trading Venue when the deal was executed.

false

2.12

TradingVenueTimeStampDateFrom

DateTime?

Filter by the time stamp of the deal that defines when the deal was executed at the trading venue. This value will define the earliest time in the specified range.

false

2.12

TradingVenueTimeStampDateTo

DateTime?

Filter by the time stamp of the deal that defines when the deal was executed at the trading venue. This value will define the latest time in the specified range.

false

2.12

ExecutionWithinFirmType

string

Filter by the type of the entity that was responsible for the execution of the deal. Can be either "USER" or "ALGO".

false

2.12

ExecutionWithinFirm_USER

Guid[]

Filter by the BrickId of the person that was responsible for the execution of the deal.

false

2.12

ExecutionWithinFirm_ALGO

Guid[]

Filter by the BrickId of the algorithm that was responsible for the execution of the deal.

false

2.12

TradingCapacity

string

Filter by the Trading Capacity of the deal

false

2.12

CancellationDateFrom

DateTime?

Filter by the time stamp of when the deal was cancelled. This value will define the earliest time in the specified range.

false

2.12

CancellationDateTo

DateTime?

Filter by the time stamp of when the deal was cancelled. This value will define the latest time in the specified range.

false

2.12

INTC

bool?

Filter by whether the deal is an INTC deal in the TRS report or not.

false

2.17

Response rows (Array) inherits from EntityBase

Name

Type

Description

Available from version

Name

Type

Description

Available from version

BrickId

Guid

The BrickId (unique id) of the account type

2.11

CreatedDate

DateTime

The time when the deal was created

2.11

AmountAsset1

decimal

The amount of the first leg of the deal

2.11

AmountAsset2

decimal

The amount of the second leg of the deal

2.11

Asset1

Guid

The asset of the first leg of the deal

2.11

Asset2

Guid

The asset of the second leg of the deal

2.11

Price

double

The price of the deal

2.11

ExecutionInterface

string

The execution interface key

2.11

BuyPartyAccount

Guid

The internal id of the buy party account

2.11

SellPartyAccount

Guid

The internal id of the sell party account

2.11

DealNo

string

The deal number of the deal

2.11

BuyOrder

Guid

The buy order of the deal

2.11

SellOrder

Guid

The sell order of the deal

2.11

BuyPartyNote

string

The note number of the buy party note connected to the deal

2.11

SellPartyNote

string

The note number of the sell party note connected to the deal

2.11

IsTRSReporting

bool

Tells whether the deal should be included in the TRS-reporting or not

2.11

TradeTime

DateTime

The timestamp of the of the trade connected to the deal

2.11

TradeDate

DateTime

The trade date of the deal

2.11

SettlementDate

DateTime

The settlement date of the deal

2.11

StatusKey

string

Staus of the Deal

2.12

TradingVenue

Guid

The Trading Venue of the deal

2.12

TradingVenueTransactionId

string

The id of the transaction given by the Trading Venue when the deal was executed.

2.12

TradingVenueTimeStampDate

DateTime

The time stamp of the deal that defines when the deal was executed at the trading venue

2.12

ExecutionWithinFirmType

string

The type of the entity that was responsible for the execution of the deal. Can be either "USER" or "ALGO".

2.12

ExecutionWithinFirm_USER

Guid

The BrickId of the person that was responsible for the execution of the deal.

2.12

ExecutionWithinFirm_ALGO

Guid

The BrickId of the algorithm that was responsible for the execution of the deal.

2.12

TradingCapacity

string

The Trading Capacity of the deal

2.12

OTCPostTradeIndicator_BENC

bool

Indicator that is used in TRS2 reports

2.12

OTCPostTradeIndicator_ACTX

bool

Indicator that is used in TRS2 reports

2.12

OTCPostTradeIndicator_ILQD

bool

Indicator that is used in TRS2 reports

2.12

OTCPostTradeIndicator_SIZE

bool

Indicator that is used in TRS2 reports

2.12

OTCPostTradeIndicator_CANC

bool

Indicator that is used in TRS2 reports

2.12

OTCPostTradeIndicator_AMND

bool

Indicator that is used in TRS2 reports

2.12

OTCPostTradeIndicator_SDIV

bool

Indicator that is used in TRS2 reports

2.12

OTCPostTradeIndicator_RPRI