Application: Markup Details (app_markup_details)¶

Retrieve details of app_markup according to criteria specified.

Auth Scope(s): read

app_markup_details(date_from: str, date_to: str, app_id: Optional[int] = None, client_loginid: 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, sort_fields: Optional[List] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int¶

Parameters:	date_from (str) – Start date (epoch or YYYY-MM-DD HH:MM:SS). Results are inclusive of this time. date_to (str) – End date (epoch or YYYY-MM-DD HH::MM::SS). Results are inclusive of this time. app_id (Optional[int]) – [Optional] Specific application app_id to report on. client_loginid (Optional[str]) – [Optional] Specific client loginid to report on, like CR12345 description (Optional[int]) – [Optional] If set to 1, will return app_markup transaction details. 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 on transaction_time. Other fields sort order is ASC. sort_fields (Optional[List]) – [Optional] One or more of the specified fields to sort on. Default sort field is by transaction_time. 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.app_markup_details(
    description=1
    app_id=1234
    client_loginid='CR12345'
    date_from='2017-08-01 00:00:00'
    date_to='2017-08-31 23:59:59'
    limit=100
    offset=0
    sort='ASC'
    sort_fields=['app_id', 'client_loginid', 'transaction_time']
    passthrough={}
    req_id=3
)