Skip to content

Latest commit

 

History

History
120 lines (81 loc) · 5.21 KB

3_Commands.md

File metadata and controls

120 lines (81 loc) · 5.21 KB
Raw

Available commands examples

Since the trade executor is decoupled from the requests you can't know if the trade has been successfully processed without checking the logs, I strongly recommand to check those during your alerts setup/testing phase.

  • Add main account under the stub main :

    curl -d '{"stub": "MAIN", "exchange":"ftx", "apiKey": "YOUR_API_KEY", "secret": "YOUR_SECRET_KEY" }' -X POST http://YOUR.STATIC.IP.ADDRESS/accounts -H 'Content-Type: application/json; charset=utf-8'

  • Add subaccount named testing under the stub sub :

    curl -d '{"stub": "sub", "subaccount":"testing", "exchange":"ftx", "apiKey": "YOUR_API_KEY", "secret": "YOUR_SECRET_KEY" }' -X POST http://YOUR.STATIC.IP.ADDRESS/accounts -H 'Content-Type: application/json; charset=utf-8'

  • Remove account under the stub sub :

    curl -X DELETE http://YOUR.STATIC.IP.ADDRESS/accounts/sub

  • Open a long position of 11$ on ETH-PERP using test account :

    curl -d '{"stub": "test", "symbol": "ETH-PERP", "size": "11", "direction": "long" }' -X POST http://YOUR.STATIC.IP.ADDRESS/trades -H 'Content-Type: application/json; charset=utf-8'

  • Open a short position a 11$ on ETH-PERP using test account :

    curl -d '{"stub": "test", "symbol": "ETH-PERP", "size": "11", "direction": "short" }' -X POST http://YOUR.STATIC.IP.ADDRESS/trades -H 'Content-Type: application/json; charset=utf-8'

  • Open a long position with 5% of available collateral (Futures) or available balance (Spot) on ETH-PERP using test account :

    curl -d '{"stub": "test", "symbol": "ETH-PERP", "size": "5%", "direction": "long" }' -X POST http://YOUR.STATIC.IP.ADDRESS/trades -H 'Content-Type: application/json; charset=utf-8'

  • Open a short position with 5% of available collateral (Futures) or available balance (Spot) on ETH-PERP using test account :

    curl -d '{"stub": "test", "symbol": "ETH-PERP", "size": "5%", "direction": "short" }' -X POST http://YOUR.STATIC.IP.ADDRESS/trades -H 'Content-Type: application/json; charset=utf-8'

  • Set a maximum budget and open a long position of 11$ on ETH-PERP using test account (order will not be processed if requested size + current opened size is greater than maximum size) :

    curl -d '{"stub": "test", "symbol": "ETH-PERP", "size": "11", "direction": "long", "max": "1000" }' -X POST http://YOUR.STATIC.IP.ADDRESS/trades -H 'Content-Type: application/json; charset=utf-8'

  • Close 100% of a position (short or long) on ETH-PERP using test account :

    curl -d '{"stub": "test", "symbol": "ETH-PERP", "direction": "close" }' -X POST http://YOUR.STATIC.IP.ADDRESS/trades -H 'Content-Type: application/json; charset=utf-8'

  • Close XX% of a position (short or long) on ETH-PERP using test account :

    curl -d '{"stub": "test", "symbol": "ETH-PERP", "direction": "close", "size": "33%" }' -X POST http://YOUR.STATIC.IP.ADDRESS/trades -H 'Content-Type: application/json; charset=utf-8'

  • List balances on sub account :

    curl -X GET http://YOUR.STATIC.IP.ADDRESS/balances/sub

  • List configured accounts :

    curl -X GET http://YOUR.STATIC.IP.ADDRESS/accounts

  • List balances on all configured accounts :

    curl -X GET http://YOUR.STATIC.IP.ADDRESS/balances

  • List available markets on a specific exchange :

    curl -X GET http://YOUR.STATIC.IP.ADDRESS/markets/ftx

  • Process multiple trades at once :

    curl -d '[{"stub": "test", "symbol": "ETH-PERP", "size": "11", "direction": "long" }, {"stub": "test", "symbol": "BTC-PERP", "size": "11", "direction": "long" }]' -X POST http://YOUR.STATIC.IP.ADDRESS/trades -H 'Content-Type: application/json; charset=utf-8'