Skip to content

Commit 950a0df

Browse files
committed
docs: improved documentation of order object
1 parent 2a0dd4c commit 950a0df

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/trade-object.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,15 +134,17 @@ Most properties here can be None as they are dependent on the exchange response.
134134
|------------|-------------|-------------|
135135
| `trade` | Trade | Trade object this order is attached to |
136136
| `ft_pair` | string | Pair this order is for |
137-
| `ft_is_open` | boolean | is the order filled? |
137+
| `ft_is_open` | boolean | is the order still open? |
138138
| `order_type` | string | Order type as defined on the exchange - usually market, limit or stoploss |
139-
| `status` | string | Status as defined by ccxt. Usually open, closed, expired or canceled |
140-
| `side` | string | Buy or Sell |
139+
| `status` | string | Status as defined by [ccxt's order structure](https://docs.ccxt.com/#/README?id=order-structure). Usually open, closed, expired, canceled or rejected |
140+
| `side` | string | buy or sell |
141141
| `price` | float | Price the order was placed at |
142142
| `average` | float | Average price the order filled at |
143143
| `amount` | float | Amount in base currency |
144-
| `filled` | float | Filled amount (in base currency) |
145-
| `remaining` | float | Remaining amount |
144+
| `filled` | float | Filled amount (in base currency) (use `safe_filled` instead) |
145+
| `safe_filled` | float | Filled amount (in base currency) - guaranteed to not be None |
146+
| `remaining` | float | Remaining amount (use `safe_remaining` instead) |
147+
| `safe_remaining` | float | Remaining amount - either taken from the exchange or calculated. |
146148
| `cost` | float | Cost of the order - usually average * filled (*Exchange dependent on futures, may contain the cost with or without leverage and may be in contracts.*) |
147149
| `stake_amount` | float | Stake amount used for this order. *Added in 2023.7.* |
148150
| `stake_amount_filled` | float | Filled Stake amount used for this order. *Added in 2024.11.* |

0 commit comments

Comments
 (0)