moved lev docs to own file, updated config
This commit is contained in:
Sam Germain
parent
449710d662
commit
4a0a215c45
@ -90,8 +90,8 @@ Mandatory parameters are marked as **Required**, which means that they are requi
|
|||||||
| `trailing_stop_positive_offset` | Offset on when to apply `trailing_stop_positive`. Percentage value which should be positive. More details in the [stoploss documentation](stoploss.md#trailing-stop-loss-only-once-the-trade-has-reached-a-certain-offset). [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `0.0` (no offset).* <br> **Datatype:** Float
|
| `trailing_stop_positive_offset` | Offset on when to apply `trailing_stop_positive`. Percentage value which should be positive. More details in the [stoploss documentation](stoploss.md#trailing-stop-loss-only-once-the-trade-has-reached-a-certain-offset). [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `0.0` (no offset).* <br> **Datatype:** Float
|
||||||
| `trailing_only_offset_is_reached` | Only apply trailing stoploss when the offset is reached. [stoploss documentation](stoploss.md). [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `false`.* <br> **Datatype:** Boolean
|
| `trailing_only_offset_is_reached` | Only apply trailing stoploss when the offset is reached. [stoploss documentation](stoploss.md). [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `false`.* <br> **Datatype:** Boolean
|
||||||
| `fee` | Fee used during backtesting / dry-runs. Should normally not be configured, which has freqtrade fall back to the exchange default fee. Set as ratio (e.g. 0.001 = 0.1%). Fee is applied twice for each trade, once when buying, once when selling. <br> **Datatype:** Float (as ratio)
|
| `fee` | Fee used during backtesting / dry-runs. Should normally not be configured, which has freqtrade fall back to the exchange default fee. Set as ratio (e.g. 0.001 = 0.1%). Fee is applied twice for each trade, once when buying, once when selling. <br> **Datatype:** Float (as ratio)
|
||||||
| `trading_mode` | Specifies if you want to trade regularly, trade with leverage, or trade contracts whose prices are derived from matching cryptocurrency prices. spot, margin or futures
|
| `trading_mode` | Specifies if you want to trade regularly, trade with leverage, or trade contracts whose prices are derived from matching cryptocurrency prices. [leverage documentation](leverage.md). <br>*Defaults to `"spot"`.* <br> **Datatype:** String
|
||||||
| `collateral` | When trading with leverage, this determines if the collateral owned by the trader will be shared or isolated to each trading pair
|
| `collateral` | When trading with leverage, this determines if the collateral owned by the trader will be shared or isolated to each trading pair [leverage documentation](leverage.md). <br> **Datatype:** String
|
||||||
| `unfilledtimeout.buy` | **Required.** How long (in minutes or seconds) the bot will wait for an unfilled buy order to complete, after which the order will be cancelled and repeated at current (new) price, as long as there is a signal. [Strategy Override](#parameters-in-the-strategy).<br> **Datatype:** Integer
|
| `unfilledtimeout.buy` | **Required.** How long (in minutes or seconds) the bot will wait for an unfilled buy order to complete, after which the order will be cancelled and repeated at current (new) price, as long as there is a signal. [Strategy Override](#parameters-in-the-strategy).<br> **Datatype:** Integer
|
||||||
| `unfilledtimeout.sell` | **Required.** How long (in minutes or seconds) the bot will wait for an unfilled sell order to complete, after which the order will be cancelled and repeated at current (new) price, as long as there is a signal. [Strategy Override](#parameters-in-the-strategy).<br> **Datatype:** Integer
|
| `unfilledtimeout.sell` | **Required.** How long (in minutes or seconds) the bot will wait for an unfilled sell order to complete, after which the order will be cancelled and repeated at current (new) price, as long as there is a signal. [Strategy Override](#parameters-in-the-strategy).<br> **Datatype:** Integer
|
||||||
| `unfilledtimeout.unit` | Unit to use in unfilledtimeout setting. Note: If you set unfilledtimeout.unit to "seconds", "internals.process_throttle_secs" must be inferior or equal to timeout [Strategy Override](#parameters-in-the-strategy). <br> *Defaults to `minutes`.* <br> **Datatype:** String
|
| `unfilledtimeout.unit` | Unit to use in unfilledtimeout setting. Note: If you set unfilledtimeout.unit to "seconds", "internals.process_throttle_secs" must be inferior or equal to timeout [Strategy Override](#parameters-in-the-strategy). <br> *Defaults to `minutes`.* <br> **Datatype:** String
|
||||||
@ -449,65 +449,6 @@ The possible values are: `gtc` (default), `fok` or `ioc`.
|
|||||||
This is ongoing work. For now, it is supported only for binance and kucoin.
|
This is ongoing work. For now, it is supported only for binance and kucoin.
|
||||||
Please don't change the default value unless you know what you are doing and have researched the impact of using different values for your particular exchange.
|
Please don't change the default value unless you know what you are doing and have researched the impact of using different values for your particular exchange.
|
||||||
|
|
||||||
### Understand trading_mode
|
|
||||||
|
|
||||||
The possible values are: `spot` (default), `margin`(*coming soon*) or `futures`.
|
|
||||||
|
|
||||||
**SPOT**
|
|
||||||
Regular trading mode.
|
|
||||||
- Shorting is not available
|
|
||||||
- There is no liquidation price
|
|
||||||
- Profits gained/lost are equal to the change in value of the assets(minus trading fees)
|
|
||||||
|
|
||||||
#### Leverage trading modes
|
|
||||||
|
|
||||||
!!! Warning: Trading with leverage(`trading_mode="margin"` or `trading_mode="futures"`) is very risky.
|
|
||||||
!!! Do not trade with a leverage > 1 using a strategy that hasn't shown positive results in a live run using the spot market
|
|
||||||
!!! Check the stoploss of your strategy. With a leverage of 2, a stoploss of 0.5 would be too low, and these trades would be liquidated before reaching that amount
|
|
||||||
|
|
||||||
> I've only been using freqtrade for a couple weeks, but I feel like I'm pretty good and could use leverage
|
|
||||||
|
|
||||||
!!! No you're not. Do not use leverage yet.
|
|
||||||
|
|
||||||
# TODO: include a resource to help calculate stoplosses that are above the liquidation price
|
|
||||||
|
|
||||||
#TODO: Taken from investopedia, is that ok?
|
|
||||||
Leverage results from using borrowed capital as a funding source when investing to expand the firm's asset base and generate returns on risk capital. Leverage is an investment strategy of using borrowed money—specifically, the use of various financial instruments or borrowed capital—to increase the potential return of an investment.
|
|
||||||
|
|
||||||
|
|
||||||
**MARGIN**
|
|
||||||
*coming soon*
|
|
||||||
Trading occurs on the spot market, but the exchange lends currency to you in an amount equal to the chosen leverage. You pay the amount lent to you back to the exchange with interest, and your profits/losses are multiplied by the leverage specified
|
|
||||||
|
|
||||||
**FUTURES**
|
|
||||||
*Freqtrade can only trade **perpetual futures***
|
|
||||||
|
|
||||||
Perpetual futures contracts are traded at a price that mirrors the underlying asset they are based off of. You are not trading the actual asset but instead are trading a derivative contract. In contract to regular futures contracts, perpetual futures can last indefinately.
|
|
||||||
|
|
||||||
In addition to the gains/losses from the change in price of the futures contract, traders also exchange funding fees, which are gains/losses worth an amount that is derived from the difference in price between the futures contract and the underlying asset. The difference in price between a futures contract and the underlying asset varies between exchanges.
|
|
||||||
|
|
||||||
|
|
||||||
``` python
|
|
||||||
"trading_mode": "futures"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Collateral
|
|
||||||
|
|
||||||
The possible values are: `isolated`, or `cross`(*coming soon*)
|
|
||||||
|
|
||||||
# TODO: I took this definition from bitmex, is that fine? https://www.bitmex.com/app/isolatedMargin
|
|
||||||
**ISOLATED**
|
|
||||||
|
|
||||||
Margin assigned to a position is restricted to a certain amount. If the margin falls below the Maintenance Margin level, the position is liquidated.
|
|
||||||
|
|
||||||
**CROSS**
|
|
||||||
|
|
||||||
Margin is shared between open positions. When needed, a position will draw more margin from the total account balance to avoid liquidation.
|
|
||||||
|
|
||||||
``` python
|
|
||||||
"collateral": "isolated"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Exchange configuration
|
### Exchange configuration
|
||||||
|
|
||||||
Freqtrade is based on [CCXT library](https://github.com/ccxt/ccxt) that supports over 100 cryptocurrency
|
Freqtrade is based on [CCXT library](https://github.com/ccxt/ccxt) that supports over 100 cryptocurrency
|
||||||
|
|||||||
@ -1,21 +1,81 @@
|
|||||||
# Leverage
|
# Leverage
|
||||||
|
*You can't run 2 bots on the same account with leverage,*
|
||||||
|
|
||||||
|
!!! Warning: Trading with leverage(`trading_mode="margin"` or `trading_mode="futures"`) is very risky.
|
||||||
|
!!! Do not trade with a leverage > 1 using a strategy that hasn't shown positive results in a live run using the spot market
|
||||||
|
!!! Check the stoploss of your strategy. With a leverage of 2, a stoploss of 0.5 would be too low, and these trades would be liquidated before reaching that amount
|
||||||
|
|
||||||
|
> I've only been using freqtrade for a couple weeks, but I feel like I'm pretty good and could use leverage
|
||||||
|
|
||||||
|
!!! No you're not. Do not use leverage yet.
|
||||||
|
### Understand trading_mode
|
||||||
|
|
||||||
|
The possible values are: `spot` (default), `margin`(*coming soon*) or `futures`.
|
||||||
|
|
||||||
|
**SPOT**
|
||||||
|
Regular trading mode.
|
||||||
|
- Shorting is not available
|
||||||
|
- There is no liquidation price
|
||||||
|
- Profits gained/lost are equal to the change in value of the assets(minus trading fees)
|
||||||
|
|
||||||
|
#### Leverage trading modes
|
||||||
|
|
||||||
|
# TODO: include a resource to help calculate stoplosses that are above the liquidation price
|
||||||
|
|
||||||
|
#TODO: Taken from investopedia, is that ok?
|
||||||
|
Leverage results from using borrowed capital as a funding source when investing to expand the firm's asset base and generate returns on risk capital. Leverage is an investment strategy of using borrowed money—specifically, the use of various financial instruments or borrowed capital—to increase the potential return of an investment.
|
||||||
|
|
||||||
|
|
||||||
|
**MARGIN**
|
||||||
|
*coming soon*
|
||||||
|
Trading occurs on the spot market, but the exchange lends currency to you in an amount equal to the chosen leverage. You pay the amount lent to you back to the exchange with interest, and your profits/losses are multiplied by the leverage specified
|
||||||
|
|
||||||
|
**FUTURES**
|
||||||
|
*Freqtrade can only trade **perpetual futures***
|
||||||
|
|
||||||
|
Perpetual futures contracts are traded at a price that mirrors the underlying asset they are based off of. You are not trading the actual asset but instead are trading a derivative contract. In contract to regular futures contracts, perpetual futures can last indefinately.
|
||||||
|
|
||||||
|
In addition to the gains/losses from the change in price of the futures contract, traders also exchange funding fees, which are gains/losses worth an amount that is derived from the difference in price between the futures contract and the underlying asset. The difference in price between a futures contract and the underlying asset varies between exchanges.
|
||||||
|
|
||||||
|
|
||||||
|
``` python
|
||||||
|
"trading_mode": "futures"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Collateral
|
||||||
|
|
||||||
|
The possible values are: `isolated`, or `cross`(*coming soon*)
|
||||||
|
|
||||||
|
# TODO: I took this definition from bitmex, is that fine? https://www.bitmex.com/app/isolatedMargin
|
||||||
|
**ISOLATED**
|
||||||
|
|
||||||
|
Margin assigned to a position is restricted to a certain amount. If the margin falls below the Maintenance Margin level, the position is liquidated.
|
||||||
|
|
||||||
|
**CROSS**
|
||||||
|
|
||||||
|
Margin is shared between open positions. When needed, a position will draw more margin from the total account balance to avoid liquidation.
|
||||||
|
|
||||||
|
``` python
|
||||||
|
"collateral": "isolated"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Developer
|
||||||
|
|
||||||
For shorts, the currency which pays the interest fee for the `borrowed` currency is purchased at the same time of the closing trade (This means that the amount purchased in short closing trades is greater than the amount sold in short opening trades).
|
For shorts, the currency which pays the interest fee for the `borrowed` currency is purchased at the same time of the closing trade (This means that the amount purchased in short closing trades is greater than the amount sold in short opening trades).
|
||||||
|
|
||||||
For longs, the currency which pays the interest fee for the `borrowed` will already be owned by the user and does not need to be purchased. The interest is subtracted from the close_value of the trade.
|
For longs, the currency which pays the interest fee for the `borrowed` will already be owned by the user and does not need to be purchased. The interest is subtracted from the close_value of the trade.
|
||||||
|
|
||||||
## Binance margin trading interest formula
|
#### Binance margin trading interest formula
|
||||||
|
|
||||||
I (interest) = P (borrowed money) * R (daily_interest/24) * ceiling(T) (in hours)
|
I (interest) = P (borrowed money) * R (daily_interest/24) * ceiling(T) (in hours)
|
||||||
[source](https://www.binance.com/en/support/faq/360030157812)
|
[source](https://www.binance.com/en/support/faq/360030157812)
|
||||||
|
|
||||||
## Kraken margin trading interest formula
|
#### Kraken margin trading interest formula
|
||||||
|
|
||||||
Opening fee = P (borrowed money) * R (quat_hourly_interest)
|
Opening fee = P (borrowed money) * R (quat_hourly_interest)
|
||||||
Rollover fee = P (borrowed money) * R (quat_hourly_interest) * ceiling(T/4) (in hours)
|
Rollover fee = P (borrowed money) * R (quat_hourly_interest) * ceiling(T/4) (in hours)
|
||||||
I (interest) = Opening fee + Rollover fee
|
I (interest) = Opening fee + Rollover fee
|
||||||
[source](https://support.kraken.com/hc/en-us/articles/206161568-What-are-the-fees-for-margin-trading-)
|
[source](https://support.kraken.com/hc/en-us/articles/206161568-What-are-the-fees-for-margin-trading-)
|
||||||
|
|
||||||
# TODO-lev: Mention that says you can't run 2 bots on the same account with leverage,
|
|
||||||
|
|
||||||
#TODO-lev: Create a huge risk disclaimer
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user