CTYPTO/freqtrade
1
0
Fork 0
mirror of https://github.com/freqtrade/freqtrade.git synced 2025-12-01 01:23:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #11112 from froggleston/frog-docs-api-2

Browse Source 
Add params to REST API table description, fix first column width
This commit is contained in:
Matthias
2024-12-19 21:06:03 +01:00
committed by GitHub
parent 8cb69e4d5a 66380566c8
commit e1f759e70e
2 changed files with 51 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
docs/rest-api.md
View File

@@ -316,53 +316,53 @@ whitelist
If you wish to call the REST API manually via another route, e.g. directly via `curl`, the table below shows the relevant URL endpoints and parameters.
All endpoints in the below table need to be prefixed with the base URL of the API, e.g. `http://127.0.0.1:8080/api/v1/` - so the command becomes `http://127.0.0.1:8080/api/v1/<command>`.
| Endpoint | Params (type) | Method | Description |
|-----------|---------------|--------|-------------|
| `/ping` | | GET | Simple command testing the API Readiness - requires no authentication.
| `/start` | | POST | Starts the trader.
| `/stop` | | POST | Stops the trader.
| `/stopbuy` | | POST | Stops the trader from opening new trades. Gracefully closes open trades according to their rules.
| `/reload_config` | | POST | Reloads the configuration file.
| `/trades` | | GET | List last trades. Limited to 500 trades per call.
| `/trade/<tradeid>` | `tradeid` (`int`) | GET | Get specific trade.
| `/trades/<tradeid>` | `tradeid` (`int`) | DELETE | Remove trade from the database. Tries to close open orders. Requires manual handling of this trade on the exchange.
| `/trades/<tradeid>/open-order` | `tradeid` (`int`) | DELETE | Cancel open order for this trade.
| `/trades/<tradeid>/reload` | `tradeid` (`int`) | POST | Reload a trade from the Exchange. Only works in live, and can potentially help recover a trade that was manually sold on the exchange.
| `/show_config` | | GET | Shows part of the current configuration with relevant settings to operation.
| `/logs` | | GET | Shows last log messages.
| `/status` | | GET | Lists all open trades.
| `/count` | | GET | Displays number of trades used and available.
| `/entries` | `pair` (`str`) | GET | Shows profit statistics for each enter tags for given pair (or all pairs if pair isn't given). Pair is optional.
| `/exits` | `pair` (`str`) | GET | Shows profit statistics for each exit reasons for given pair (or all pairs if pair isn't given). Pair is optional.
| `/mix_tags` | `pair` (`str`) | GET | Shows profit statistics for each combinations of enter tag + exit reasons for given pair (or all pairs if pair isn't given). Pair is optional.
| `/locks` | | GET | Displays currently locked pairs.
| `/locks` | `<pair>` (`str`)<br/> `<until>` (`datetime`)<br/> `[side]` (`str`)<br/> `[reason]` (`str`) | POST | Locks a pair until "until". (Until will be rounded up to the nearest timeframe). Side is optional and is either `long` or `short` (default is `long`). Reason is optional.
| `/locks/<lockid>` | `lockid` (`int`) | DELETE | Deletes (disables) the lock by id.
| `/profit` | | GET | Display a summary of your profit/loss from close trades and some stats about your performance.
| `/forceexit` | `<tradeid>` (`int` or `str`)<br/> `<ordertype>` (`str`)<br/> `[amount]` (`float`) | POST | Instantly exits the given trade (ignoring `minimum_roi`), using the given order type ("market" or "limit", uses your config setting if not specified), and the chosen amount (full sell if not specified). If `all` is supplied as the `tradeid`, then all currently open trades will be forced to exit.
| `/forceenter` | `<pair>` (`str`)<br/> `<side>` (`str`)<br/> `[rate]` (`float`) | POST | Instantly enters the given pair. Side is optional and is either `long` or `short` (default is `long`). Rate is optional. (`force_entry_enable` must be set to True)
| `/performance` | | GET | Show performance of each finished trade grouped by pair.
| `/balance` | | GET | Show account balance per currency.
| `/daily` | `<n>` (`int`) | GET | Shows profit or loss per day, over the last n days (n defaults to 7).
| `/weekly` | `<n>` (`int`) | GET | Shows profit or loss per week, over the last n days (n defaults to 4).
| `/monthly` | `<n>` (`int`) | GET | Shows profit or loss per month, over the last n days (n defaults to 3).
| `/stats` | | GET | Display a summary of profit / loss reasons as well as average holding times.
| `/whitelist` | | GET | Show the current whitelist.
| `/blacklist` | | GET | Show the current blacklist.
| `/blacklist` | `pair` (`str`) | POST | Adds the specified pair to the blacklist.
| `/blacklist` | `[pair,pair]` (`list[str]`) | DELETE | Deletes the specified list of pairs from the blacklist.
| `/edge` | | GET | Show validated pairs by Edge if it is enabled.
| `/pair_candles` | | GET | Returns dataframe for a pair / timeframe combination while the bot is running. **Alpha**
| `/pair_candles` | `<column_list>` (`list[str]`) | POST | Returns dataframe for a pair / timeframe combination while the bot is running, filtered by a provided list of columns to return. **Alpha**
| `/pair_history` | | GET | Returns an analyzed dataframe for a given timerange, analyzed by a given strategy. **Alpha**
| `/pair_history` | `<column_list>` (`list[str]`) | POST | Returns an analyzed dataframe for a given timerange, analyzed by a given strategy, filtered by a provided list of columns to return. **Alpha**
| `/plot_config` | | GET | Get plot config from the strategy (or nothing if not configured). **Alpha**
| `/strategies` | | GET | List strategies in strategy directory. **Alpha**
| `/strategy/<strategy>` | `<strategy>` (`str`) | GET | Get specific Strategy content by strategy class name. **Alpha**
| `/available_pairs` | | GET | List available backtest data. **Alpha**
| `/version` | | GET | Show version.
| `/sysinfo` | | GET | Show information about the system load.
| `/health` | | GET | Show bot health (last bot loop).
| Endpoint | Method | Description / Parameters |
|-----------|--------|--------------------------|
| `/ping` | GET | Simple command testing the API Readiness - requires no authentication.
| `/start` | POST | Starts the trader.
| `/stop` | POST | Stops the trader.
| `/stopbuy` | POST | Stops the trader from opening new trades. Gracefully closes open trades according to their rules.
| `/reload_config` | POST | Reloads the configuration file.
| `/trades` | GET | List last trades. Limited to 500 trades per call.
| `/trade/<tradeid>` | GET | Get specific trade.<br/>*Params:*<br/>- `tradeid` (`int`)
| `/trades/<tradeid>` | DELETE | Remove trade from the database. Tries to close open orders. Requires manual handling of this trade on the exchange.<br/>*Params:*<br/>- `tradeid` (`int`)
| `/trades/<tradeid>/open-order` | DELETE | Cancel open order for this trade.<br/>*Params:*<br/>- `tradeid` (`int`)
| `/trades/<tradeid>/reload` | POST | Reload a trade from the Exchange. Only works in live, and can potentially help recover a trade that was manually sold on the exchange.<br/>*Params:*<br/>- `tradeid` (`int`)
| `/show_config` | GET | Shows part of the current configuration with relevant settings to operation.
| `/logs` | GET | Shows last log messages.
| `/status` | GET | Lists all open trades.
| `/count` | GET | Displays number of trades used and available.
| `/entries` | GET | Shows profit statistics for each enter tags for given pair (or all pairs if pair isn't given). Pair is optional.<br/>*Params:*<br/>- `pair` (`str`)
| `/exits` | GET | Shows profit statistics for each exit reasons for given pair (or all pairs if pair isn't given). Pair is optional.<br/>*Params:*<br/>- `pair` (`str`)
| `/mix_tags` | GET | Shows profit statistics for each combinations of enter tag + exit reasons for given pair (or all pairs if pair isn't given). Pair is optional.<br/>*Params:*<br/>- `pair` (`str`)
| `/locks` | GET | Displays currently locked pairs.
| `/locks` | POST | Locks a pair until "until". (Until will be rounded up to the nearest timeframe). Side is optional and is either `long` or `short` (default is `long`). Reason is optional.<br/>*Params:*<br/>- `<pair>` (`str`)<br/>- `<until>` (`datetime`)<br/>- `[side]` (`str`)<br/>- `[reason]` (`str`)
| `/locks/<lockid>` | DELETE | Deletes (disables) the lock by id.<br/>*Params:*<br/>- `lockid` (`int`)
| `/profit` | GET | Display a summary of your profit/loss from close trades and some stats about your performance.
| `/forceexit` | POST | Instantly exits the given trade (ignoring `minimum_roi`), using the given order type ("market" or "limit", uses your config setting if not specified), and the chosen amount (full sell if not specified). If `all` is supplied as the `tradeid`, then all currently open trades will be forced to exit.<br/>*Params:*<br/>- `<tradeid>` (`int` or `str`)<br/>- `<ordertype>` (`str`)<br/>- `[amount]` (`float`)
| `/forceenter` | POST | Instantly enters the given pair. Side is optional and is either `long` or `short` (default is `long`). Rate is optional. (`force_entry_enable` must be set to True)<br/>*Params:*<br/>- `<pair>` (`str`)<br/>- `<side>` (`str`)<br/>- `[rate]` (`float`)
| `/performance` | GET | Show performance of each finished trade grouped by pair.
| `/balance` | GET | Show account balance per currency.
| `/daily` | GET | Shows profit or loss per day, over the last n days (n defaults to 7).<br/>*Params:*<br/>- `<n>` (`int`)
| `/weekly` | GET | Shows profit or loss per week, over the last n days (n defaults to 4).<br/>*Params:*<br/>- `<n>` (`int`)
| `/monthly` | GET | Shows profit or loss per month, over the last n days (n defaults to 3).<br/>*Params:*<br/>- `<n>` (`int`)
| `/stats` | GET | Display a summary of profit / loss reasons as well as average holding times.
| `/whitelist` | GET | Show the current whitelist.
| `/blacklist` | GET | Show the current blacklist.
| `/blacklist` | POST | Adds the specified pair to the blacklist.<br/>*Params:*<br/>- `pair` (`str`)
| `/blacklist` | DELETE | Deletes the specified list of pairs from the blacklist.<br/>*Params:*<br/>- `[pair,pair]` (`list[str]`)
| `/edge` | GET | Show validated pairs by Edge if it is enabled.
| `/pair_candles` | GET | Returns dataframe for a pair / timeframe combination while the bot is running. **Alpha**
| `/pair_candles` | POST | Returns dataframe for a pair / timeframe combination while the bot is running, filtered by a provided list of columns to return. **Alpha**<br/>*Params:*<br/>- `<column_list>` (`list[str]`)
| `/pair_history` | GET | Returns an analyzed dataframe for a given timerange, analyzed by a given strategy. **Alpha**
| `/pair_history` | POST | Returns an analyzed dataframe for a given timerange, analyzed by a given strategy, filtered by a provided list of columns to return. **Alpha**<br/>*Params:*<br/>- `<column_list>` (`list[str]`)
| `/plot_config` | GET | Get plot config from the strategy (or nothing if not configured). **Alpha**
| `/strategies` | GET | List strategies in strategy directory. **Alpha**
| `/strategy/<strategy>` | GET | Get specific Strategy content by strategy class name. **Alpha**<br/>*Params:*<br/>- `<strategy>` (`str`)
| `/available_pairs` | GET | List available backtest data. **Alpha**
| `/version` | GET | Show version.
| `/sysinfo` | GET | Show information about the system load.
| `/health` | GET | Show bot health (last bot loop).
!!! Warning "Alpha status"
Endpoints labeled with *Alpha status* above may change at any time without notice.

4
docs/stylesheets/ft.extra.css
View File

@@ -15,3 +15,7 @@
.md-version__list {
font-weight: 500 !important;
}
#available-endpoints ~ .md-typeset__scrollwrap .md-typeset__table th:first-of-type {
width: 35% !important;
}