Skip to content

Commit ca76ccb

Browse files
committed
docs: improve some documentation wording
1 parent bb6e33c commit ca76ccb

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

docs/trade-object.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ The following attributes / properties are available for each individual trade -
2323
| `open_trade_value` | float | Value of the open trade including fees. |
2424
| `close_rate` | float | Close rate - only set when is_open = False. |
2525
| `close_rate_requested` | float | The close rate that was requested. |
26-
| `safe_close_rate` | float | Close rate or close_rate_requested or 0.0 if neither is available. |
26+
| `safe_close_rate` | float | Close rate or `close_rate_requested` or 0.0 if neither is available. Only makes sense once the trade is closed. |
2727
| `stake_amount` | float | Amount in Stake (or Quote) currency. |
28-
| `max_stake_amount` | float | Maximum stake amount that was used in this trade (including DCA orders). |
28+
| `max_stake_amount` | float | Maximum stake amount that was used in this trade (sum of all filled Entry orders). |
2929
| `amount` | float | Amount in Asset / Base currency that is currently owned. Will be 0.0 until the initial order fills. |
30-
| `amount_requested` | float | Amount that was originally requested for this trade in the first entry order. |
30+
| `amount_requested` | float | Amount that was originally requested for this trade as part of the first entry order. |
3131
| `open_date` | datetime | Timestamp when trade was opened **use `open_date_utc` instead** |
3232
| `open_date_utc` | datetime | Timestamp when trade was opened - in UTC. |
3333
| `close_date` | datetime | Timestamp when trade was closed **use `close_date_utc` instead** |
@@ -68,8 +68,7 @@ The following attributes / properties are available for each individual trade -
6868
| `stop_loss_pct` | float | Relative value of the stop loss. |
6969
| `initial_stop_loss` | float | Absolute value of the initial stop loss. |
7070
| `initial_stop_loss_pct` | float | Relative value of the initial stop loss. |
71-
| `is_stop_loss_trailing` | boolean | True if the stop loss is trailing. |
72-
| `stoploss_last_update_utc` | datetime | Timestamp of the last stoploss update. |
71+
| `stoploss_last_update_utc` | datetime | Timestamp of the last stoploss on exchange order update. |
7372
| `stoploss_or_liquidation` | float | Returns the more restrictive of stoploss or liquidation price and corresponds to the price a stoploss would trigger at. |
7473

7574
### Futures/Margin trading attributes

0 commit comments

Comments
 (0)