Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
konst-toporov authored Sep 2, 2019
1 parent 9d62c21 commit 0c676b0
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,127 +37,127 @@ There are options to run the image in public clouds:
POST: /indicator/add

##### Example:
curl -X POST -F "src=@data/ATR_pips_Indicator.lua" $BACKTESTUTILS_SERVER_URL/indicator/add
curl -X POST -F "src=@data/ATR_pips_Indicator.lua" $BACKTEST_DOCKER_ADDRESS/indicator/add

#### Delete a custom indicator
DELETE: /indicator/delete

##### Example:
curl -X DELETE -H "Content-type: application/json" -d '{"name":"ATR_pips_Indicator.lua"}' $BACKTESTUTILS_SERVER_URL/indicator/delete
curl -X DELETE -H "Content-type: application/json" -d '{"name":"ATR_pips_Indicator.lua"}' $BACKTEST_DOCKER_ADDRESS/indicator/delete

#### List custom indicators
GET: /indicator/list

##### Example:
curl -X GET $BACKTESTUTILS_SERVER_URL/indicator/list
curl -X GET $BACKTEST_DOCKER_ADDRESS/indicator/list

### Strategies

#### Add a custom strategy
/strategy/add

##### Example:
curl -X POST -F "src=@data/MA_Crossover_Strategy.lua" $BACKTESTUTILS_SERVER_URL/strategy/add
curl -X POST -F "src=@data/MA_Crossover_Strategy.lua" $BACKTEST_DOCKER_ADDRESS/strategy/add

#### Delete a custom strategy
/strategy/delete

##### Example:
curl -X DELETE -H "Content-type: application/json" -d '{"name":"MA_Crossover_Strategy.lua"}' $BACKTESTUTILS_SERVER_URL/strategy/delete
curl -X DELETE -H "Content-type: application/json" -d '{"name":"MA_Crossover_Strategy.lua"}' $BACKTEST_DOCKER_ADDRESS/strategy/delete

#### List custom strategy
/strategy/list

##### Example:
curl -X GET $BACKTESTUTILS_SERVER_URL/strategy/list
curl -X GET $BACKTEST_DOCKER_ADDRESS/strategy/list

### Data files

#### Add a custom file
/data/add

##### Example:
curl -X POST -F "src=@data/test_data.csv" $BACKTESTUTILS_SERVER_URL/data/add
curl -X POST -F "src=@data/test_data.csv" $BACKTEST_DOCKER_ADDRESS/data/add

#### Delete a custom file
/data/delete

##### Example:
curl -X DELETE -H "Content-type: application/json" -d '{"name":"test_data.csv"}' $BACKTESTUTILS_SERVER_URL/data/delete
curl -X DELETE -H "Content-type: application/json" -d '{"name":"test_data.csv"}' $BACKTEST_DOCKER_ADDRESS/data/delete

#### List custom files
/data/list

##### Example:
curl -X GET $BACKTESTUTILS_SERVER_URL/data/list
curl -X GET $BACKTEST_DOCKER_ADDRESS/data/list

### Backtester

#### Run backtesting
/bt/run

##### Example:
curl -F "name=bt001" -F "src=@data/bt_ma.bpj" $BACKTESTUTILS_SERVER_URL/bt/run
curl -F "name=bt001" -F "src=@data/bt_ma.bpj" $BACKTEST_DOCKER_ADDRESS/bt/run

#### Delete backtesting and all related data
/bt/<bt_id>/delete

##### Example:
curl -X DELETE $BACKTESTUTILS_SERVER_URL/bt/bt001/delete
curl -X DELETE $BACKTEST_DOCKER_ADDRESS/bt/bt001/delete

#### Get backtesting project file
/bt/<bt_id>/input

##### Example:
curl -X GET $BACKTESTUTILS_SERVER_URL/bt/bt001/input/
curl -X GET $BACKTEST_DOCKER_ADDRESS/bt/bt001/input/

#### Get backtesting output
/bt/<bt_id>/output

##### Example:
curl -X GET $BACKTESTUTILS_SERVER_URL/bt/bt001/output/
curl -X GET $BACKTEST_DOCKER_ADDRESS/bt/bt001/output/

#### Get backtesting final statistics
/bt/<bt_id>/stat

##### Example:
curl -X GET $BACKTESTUTILS_SERVER_URL/bt/bt001/stat/
curl -X GET $BACKTEST_DOCKER_ADDRESS/bt/bt001/stat/

#### Get backtesting log
/bt/<bt_id>/log

##### Example:
curl -X GET $BACKTESTUTILS_SERVER_URL/bt/bt001/log/
curl -X GET $BACKTEST_DOCKER_ADDRESS/bt/bt001/log/

### Optimizer

#### Run optimizer
/opt/run

##### Example:
curl -F "name=opt001" -F "src=@data/opt_ma.opj" $BACKTESTUTILS_SERVER_URL/opt/run
curl -F "name=opt001" -F "src=@data/opt_ma.opj" $BACKTEST_DOCKER_ADDRESS/opt/run

#### Delete optimizer run and all related data
/opt/<opt_id>/delete

##### Example:
curl -X DELETE $BACKTESTUTILS_SERVER_URL/opt/opt001/delete
curl -X DELETE $BACKTEST_DOCKER_ADDRESS/opt/opt001/delete

#### Get optimizer project file
/opt/<opt_id>/input

##### Example:
curl -X GET $BACKTESTUTILS_SERVER_URL/opt/opt001/input/
curl -X GET $BACKTEST_DOCKER_ADDRESS/opt/opt001/input/

#### Get optimizer output
/opt/<opt_id>/output

##### Example:
curl -X GET $BACKTESTUTILS_SERVER_URL/opt/opt001/output/
curl -X GET $BACKTEST_DOCKER_ADDRESS/opt/opt001/output/

#### Get optimizer log
/opt/<opt_id>/log

##### Example:
curl -X GET $BACKTESTUTILS_SERVER_URL/opt/opt001/log/
curl -X GET $BACKTEST_DOCKER_ADDRESS/opt/opt001/log/

0 comments on commit 0c676b0

Please sign in to comment.