Statement (statement)¶

Retrieve a summary of account transactions, according to given search criteria

Auth Scope(s): read, trading_information

statement(action_type: Optional[str] = None, date_from: Optional[int] = None, date_to: Optional[int] = None, description: Optional[int] = None, limit: Optional[Union[int, float, Decimal]] = None, offset: Optional[Union[int, float, Decimal]] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int¶

Parameters:	action_type (Optional[str]) – [Optional] To filter the statement according to the type of transaction. date_from (Optional[int]) – [Optional] Start date (epoch) date_to (Optional[int]) – [Optional] End date (epoch) description (Optional[int]) – [Optional] If set to 1, will return full contracts description. limit (Optional[Union[int, float, Decimal]]) – [Optional] Maximum number of transactions to receive. offset (Optional[Union[int, float, Decimal]]) – [Optional] Number of transactions to skip. 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

Example¶

binary.api.statement(
    description=1
    limit=100
    offset=25
)