Skip to content

Commit 2b4c678

Browse files
committed
Update README
1 parent f42fd35 commit 2b4c678

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,17 @@
66

77

88
# swift-trader
9-
A Swift package for connecting and trading on crypto exchanges such as Kucoin and FTX.
9+
A Swift package for connecting and trading on crypto exchanges such as Kucoin and Binance.
1010

1111
💰 It can calculate the stop and limit prices for a **trailing stop strategy** based on a set of given input parameters.
1212
Refer to [SwiftTrader+TrailingStop.swift](https://github.com/backslash-f/swift-trader/blob/main/Sources/SwiftTrader/SwiftTrader%2BTrailingStop.swift)
1313

1414
🤖 Supports being deployed to Heroku (Linux). Tested with [Vapor](https://github.com/vapor/vapor). This means [trading automation](https://youtu.be/gMRee2srpe8) by using webhooks and scripts such as the [Profit Percentage Tracker](https://www.tradingview.com/script/p6NBsV48-Profit-Percentage-Tracker/) (TradingView). #ka-ching!
1515

1616
📖 List of working APIs:
17+
18+
## Kucoin
19+
1720
[Kucoin Futures](https://github.com/backslash-f/swift-trader/blob/main/Sources/SwiftTrader/SwiftTrader%2BKucoinFutures.swift) | Explanation | API Documentation
1821
--- | --- | ---
1922
`SwiftTrader.kucoinFuturesAccountOverview` | Retrieves the overview of a Kucoin Futures account. | https://docs.kucoin.com/futures/#account
@@ -33,9 +36,19 @@ Refer to [SwiftTrader+TrailingStop.swift](https://github.com/backslash-f/swift-t
3336
`SwiftTrader.kucoinSpotStopOrderList` | Lists active Spot **stop** orders. | https://docs.kucoin.com/#list-stop-orders
3437
`SwiftTrader.kucoinSpotCancelStopOrders` | Cancels all untriggered stop orders of a given symbol (contract). | https://docs.kucoin.com/#cancel-orders
3538

36-
[FTX](https://github.com/backslash-f/swift-trader/blob/main/Sources/SwiftTrader/SwiftTrader%2BFTX.swift) | Explanation | API Documentation
39+
## Binance
40+
41+
[Binance Spot](https://github.com/backslash-f/swift-trader/blob/main/Sources/SwiftTrader/SwiftTrader%2BBinanceSpot.swift) | Explanation | API Documentation
42+
--- | --- | ---
43+
`SwiftTrader.binanceSpotNewOrder` | Send in a new order. Currently only `MARKET` orders are supported (but this can be easily changed). | https://binance-docs.github.io/apidocs/spot/en/#new-order-trade
44+
45+
## FTX
46+
47+
⚠️👮🏻 FTX won't work anymore, because its CEO is in jail. Great job! 👮🏻⚠️
48+
49+
[~~FTX~~](https://github.com/backslash-f/swift-trader/blob/main/Sources/SwiftTrader/SwiftTrader%2BFTX.swift) | Explanation | API Documentation
3750
--- | --- | ---
38-
`SwiftTrader.ftxTriggerOrdersList` | Retrieves the list of open trigger orders. | https://docs.ftx.com/?python#get-open-trigger-orders
39-
`SwiftTrader.ftxPositions` | Lists open positions. | https://docs.ftx.com/#get-positions
40-
`SwiftTrader.ftxPlaceStopLimitOrder` | Places a stop limit order within FTX. | https://docs.ftx.com/?python#place-trigger-order
41-
`SwiftTrader.cancelAllOrders` | Cancels all open orders. | https://docs.ftx.com/?python#cancel-all-orders
51+
~~`SwiftTrader.ftxTriggerOrdersList`~~ | ~~Retrieves the list of open trigger orders.~~ | ~~https://docs.ftx.com/?python#get-open-trigger-orders~~
52+
~~`SwiftTrader.ftxPositions`~~ | ~~Lists open positions.~~ | ~~https://docs.ftx.com/#get-positions~~
53+
~~`SwiftTrader.ftxPlaceStopLimitOrder`~~ | ~~Places a stop limit order within FTX.~~ | ~~https://docs.ftx.com/?python#place-trigger-order~~
54+
~~`SwiftTrader.cancelAllOrders`~~ | ~~Cancels all open orders.~~ | ~~https://docs.ftx.com/?python#cancel-all-orders~~

0 commit comments

Comments
 (0)