CTYPTO/freqtrade
1
0
Fork 0
mirror of https://github.com/freqtrade/freqtrade.git synced 2026-01-25 16:30:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improved documentation of order object

Browse Source
This commit is contained in:
Matthias
2025-05-10 08:38:45 +02:00
parent 2a0dd4cf55
commit 950a0df8b1
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/trade-object.md
View File

@@ -134,15 +134,17 @@ Most properties here can be None as they are dependent on the exchange response.
|------------|-------------|-------------| |------------|-------------|-------------|
| `trade` | Trade | Trade object this order is attached to | | `trade` | Trade | Trade object this order is attached to |
| `ft_pair` | string | Pair this order is for | | `ft_pair` | string | Pair this order is for |
| `ft_is_open` | boolean | is the order filled? | | `ft_is_open` | boolean | is the order still open? |
| `order_type` | string | Order type as defined on the exchange - usually market, limit or stoploss | | `order_type` | string | Order type as defined on the exchange - usually market, limit or stoploss |
| `status` | string | Status as defined by ccxt. Usually open, closed, expired or canceled | | `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 |
| `side` | string | Buy or Sell | | `side` | string | buy or sell |
| `price` | float | Price the order was placed at | | `price` | float | Price the order was placed at |
| `average` | float | Average price the order filled at | | `average` | float | Average price the order filled at |
| `amount` | float | Amount in base currency | | `amount` | float | Amount in base currency |
| `filled` | float | Filled amount (in base currency) | | `filled` | float | Filled amount (in base currency) (use `safe_filled` instead) |
| `remaining` | float | Remaining amount | | `safe_filled` | float | Filled amount (in base currency) - guaranteed to not be None |
| `remaining` | float | Remaining amount (use `safe_remaining` instead) |
| `safe_remaining` | float | Remaining amount - either taken from the exchange or calculated. |
| `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.*) | | `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.*) |
| `stake_amount` | float | Stake amount used for this order. *Added in 2023.7.* | | `stake_amount` | float | Stake amount used for this order. *Added in 2023.7.* |
| `stake_amount_filled` | float | Filled Stake amount used for this order. *Added in 2024.11.* | | `stake_amount_filled` | float | Filled Stake amount used for this order. *Added in 2024.11.* |