Skip to content

trading_agent.doctor.checks.dry_run_order_check

Checks that at least one desk order has gone all the way through UBI's dry run.

UBI refuses even dry-run orders when the market's instrument list is not loaded, such as at weekends, so this can only pass after a trading day.

Typical usage example:

result = DryRunOrderCheck(search).run()

DryRunOrderCheck 

DryRunOrderCheck(search)

Bases: DoctorCheck

Looks in the journals for a placed dry-run order.

Creates the check.

Parameters:

Name Type Description Default
search JournalSearch

Searches the desks' journals.

 required
Source code in src/trading_agent/doctor/checks/dry_run_order_check.py 
21
22
23
24
25
26
27
def __init__(self, search: journal_search_module.JournalSearch):
    """Creates the check.

    Args:
        search (journal_search_module.JournalSearch): Searches the desks' journals.
    """
    self._search = search

run 

run()

Finds the latest placed order.

Returns:

Type Description
CheckResult

OK naming the latest placed dry-run order; failed when no order has been placed yet.
Source code in src/trading_agent/doctor/checks/dry_run_order_check.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def run(self) -> doctor_check.CheckResult:
    """Finds the latest placed order.

    Returns:
        doctor_check.CheckResult: OK naming the latest placed dry-run order; failed when no order has been placed yet.
    """
    for event in self._search.events('order'):
        payload = event.get('payload', {})
        if payload.get('action') == _PLACED:
            mode = 'dry run' if payload.get('dry_run') else 'live'
            return doctor_check.CheckResult(
                doctor_check.CheckStatus.OK,
                f'{event.get("desk")} placed an order ({mode}) at {event.get("created_at", "")[:16]}.',
            )
    return doctor_check.CheckResult(
        doctor_check.CheckStatus.FAILED,
        'No order has gone through UBI yet. On a trading day, ask a desk in the chat to place one small dry-run order, such as buying 1 share of a cheap stock.',
    )