Profit Table (profit_table)¶
Retrieve a summary of account Profit Table, according to given search criteria
Auth Scope(s): read
, trading_information
-
profit_table
(contract_type: Optional[List] = None, date_from: Optional[str] = None, date_to: Optional[str] = None, description: Optional[int] = None, limit: Optional[Union[int, float, Decimal]] = None, offset: Optional[Union[int, float, Decimal]] = None, sort: Optional[str] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int¶ Parameters: - contract_type (Optional[List]) – Return only contracts of the specified types
- date_from (Optional[str]) – [Optional] Start date (epoch or YYYY-MM-DD)
- date_to (Optional[str]) – [Optional] End date (epoch or YYYY-MM-DD)
- description (Optional[int]) – [Optional] If set to 1, will return full contracts description.
- limit (Optional[Union[int, float, Decimal]]) – [Optional] Apply upper limit to count of transactions received.
- offset (Optional[Union[int, float, Decimal]]) – [Optional] Number of transactions to skip.
- sort (Optional[str]) – [Optional] Sort direction.
- passthrough (Optional[Any]) – [Optional] Used to pass data through the websocket, which may be retrieved via the echo_req output field.
- req_id (Optional[int]) – [Optional] Used to map request to response.
Returns: req_id
Return type: int