Create KucoinOrderParameters

 - Create an order via API is WORKING! 🎉

Author: Fernando Fernandes

Sources/SwiftTrader/Model/Kucoin/KucoinError.swift

@@ -14,7 +14,7 @@ public struct KucoinSystemError: Codable {
     public let code: String
     public let message: String
 
-    public enum CodingKeys: String, CodingKey {
+    enum CodingKeys: String, CodingKey {
         case code
         case message = "msg"
     }

Sources/SwiftTrader/Model/Kucoin/KucoinFuturesPositionList.swift

@@ -19,32 +19,33 @@ public struct KucoinFuturesPosition: Codable {
 
     // MARK: - Properties
 
-    let id: String
+    public let id: String
 
     /// E.g.: XBTUSDTM
-    let symbol: String
-    let autoDeposit: Bool
-    let realLeverage: Double
-    let crossMode: Bool
-    let delevPercentage: Double
+    public let symbol: String
+    public let autoDeposit: Bool
+    public let realLeverage: Double
+    public let crossMode: Bool
+    public let delevPercentage: Double
 
     /// Opening date in milliseconds.
-    let openingTimestamp: Int64
+    public let openingTimestamp: Int64
     /// Opening date as string (E.g.: "Saturday, 5. February 2022 at 22:32:16").
-    let openingTimestampString: String
+    public let openingTimestampString: String
 
     /// Current date in milliseconds.
-    let currentTimestamp: Int64
+    public let currentTimestamp: Int64
     /// Current date as string (E.g.: "Saturday, 5. February 2022 at 22:32:16").
-    let currentTimestampString: String
+    public let currentTimestampString: String
 
-    let posInit: Double
-    let currentQty: Int
-    let isOpen: Bool
-    let realisedPnl: Double
-    let unrealisedPnl: Double
-    let avgEntryPrice: Double
-    let liquidationPrice: Double
+    public let posInit: Double
+    public let currentQty: Int
+    public let isOpen: Bool
+    public let markPrice: Double
+    public let realisedPnl: Double
+    public let unrealisedPnl: Double
+    public let avgEntryPrice: Double
+    public let liquidationPrice: Double
 
     enum CodingKeys: String, CodingKey {
         case id
@@ -60,6 +61,7 @@ public struct KucoinFuturesPosition: Codable {
         case posInit
         case currentQty
         case isOpen
+        case markPrice
         case realisedPnl
         case unrealisedPnl
         case avgEntryPrice
@@ -86,6 +88,7 @@ public struct KucoinFuturesPosition: Codable {
         self.posInit = try container.decode(Double.self, forKey: .posInit)
         self.currentQty = try container.decode(Int.self, forKey: .currentQty)
         self.isOpen = try container.decode(Bool.self, forKey: .isOpen)
+        self.markPrice = try container.decode(Double.self, forKey: .markPrice)
         self.realisedPnl = try container.decode(Double.self, forKey: .realisedPnl)
         self.unrealisedPnl = try container.decode(Double.self, forKey: .unrealisedPnl)
         self.avgEntryPrice = try container.decode(Double.self, forKey: .avgEntryPrice)

Sources/SwiftTrader/Model/Kucoin/Order/KucoinFuturesOrderList.swift

@@ -17,65 +17,65 @@ public struct KucoinFuturesOrderList: Codable {
 
 /// Encapsulates an array of `KucoinFuturesOrder` plus pagination information.
 public struct KucoinFuturesOrderData: Codable {
-    let currentPage: Int
-    let pageSize: Int
-    let totalNum: Int
-    let totalPage: Int
-    let items: [KucoinFuturesOrder]
+    public let currentPage: Int
+    public let pageSize: Int
+    public let totalNum: Int
+    public let totalPage: Int
+    public let items: [KucoinFuturesOrder]
 }
 
 public struct KucoinFuturesOrder: Codable {
 
     // MARK: - Properties
 
-    let id: String
+    public let id: String
 
     /// E.g.: BTCUSDT
-    let symbol: String
+    public let symbol: String
 
-    let type: KucoinOrderType
-    let side: KucoinOrderSide
+    public let type: KucoinOrderType
+    public let side: KucoinOrderSide
 
     /// The price of one asset's unit.
-    let price: String
+    public let price: String
 
     /// How much assets were bought.
-    let size: Int
+    public let size: Int
 
     /// The total value of the order.
-    let value: String
-    let filledValue: String
-    let filledSize: Int
-    let stp: KucoinOrderSTP?
+    public let value: String
+    public let filledValue: String
+    public let filledSize: Int
+    public let stp: KucoinOrderSTP?
 
     /// Stop order type (limit or market).
-    let stop: KucoinOrderType?
+    public let stop: KucoinOrderType?
 
     /// Whether the stop order is triggered.
-    let stopTriggered: Bool
+    public let stopTriggered: Bool
 
     /// Whether the stop order is triggered.
-    let stopPrice: String?
-    let leverage: String
-    let reduceOnly: Bool
+    public let stopPrice: String?
+    public let leverage: String
+    public let reduceOnly: Bool
 
     /// Unique order id created by users to identify their orders.
-    let clientOid: String?
-    let isActive: Bool
+    public let clientOid: String?
+    public let isActive: Bool
 
     /// Mark of the canceled orders.
-    let cancelExist: Bool
-    let status: KucoinOrderStatus
+    public let cancelExist: Bool
+    public let status: KucoinOrderStatus
 
     /// Creation date in milliseconds.
-    let createdAt: Int64
+    public let createdAt: Int64
     /// Creation date as string (E.g.: "Saturday, 5. February 2022 at 22:32:16").
-    let createdAtString: String
+    public let createdAtString: String
 
     /// Last update time in milliseconds.
-    let updatedAt: Int64
+    public let updatedAt: Int64
     /// Last update time as string (E.g.: "Saturday, 5. February 2022 at 22:32:16")
-    let updatedAtString: String
+    public let updatedAtString: String
 
     enum CodingKeys: String, CodingKey {
         case id

Sources/SwiftTrader/Model/Kucoin/Order/KucoinFuturesPlaceOrder.swift

@@ -13,5 +13,13 @@ import Foundation
 public struct KucoinFuturesPlaceOrder: Codable {
     public let code: String
     public let msg: String?
-    public let orderId: String?
+    public let data: OrderPlaced?
+}
+
+public struct OrderPlaced: Codable {
+    public let orderID: String
+
+    enum CodingKeys: String, CodingKey {
+        case orderID = "orderId"
+    }
 }

Sources/SwiftTrader/Model/Kucoin/Order/KucoinOrderParameters.swift

@@ -0,0 +1,63 @@
+//
+//  KucoinOrderParameters.swift
+//  
+//
+//  Created by Fernando Fernandes on 10.02.22.
+//
+
+import Foundation
+
+/// Encapsulates parameters do place an order, for example via `KucoinFuturesPlaceOrdersRequest`.
+///
+/// https://docs.kucoin.com/futures/#place-an-order
+public struct KucoinOrderParameters {
+    
+    // MARK: - Properties
+    
+    public let clientOid = UUID().uuidString
+    public let side: KucoinOrderSide
+    public let symbol: String
+    public let type: KucoinOrderType
+    public let stop: KucoinOrderStop
+    public let stopPriceType: KucoinOrderStopPriceType
+    public let stopPrice: String
+    public let reduceOnly: Bool
+    public let closeOrder: Bool
+    public let price: String
+    
+    // MARK: - Lifecycle
+    
+    public init(side: KucoinOrderSide,
+                symbol: String,
+                type: KucoinOrderType,
+                stop: KucoinOrderStop,
+                stopPriceType: KucoinOrderStopPriceType,
+                stopPrice: String,
+                reduceOnly: Bool,
+                closeOrder: Bool,
+                price: String) {
+        self.side = side
+        self.symbol = symbol
+        self.type = type
+        self.stop = stop
+        self.stopPriceType = stopPriceType
+        self.stopPrice = stopPrice
+        self.reduceOnly = reduceOnly
+        self.closeOrder = closeOrder
+        self.price = price
+    }
+}
+
+/// Holds the keys of the parameters for placing a Kucoin order.
+public enum KucoinOrderParameterKey: String {
+    case clientOid
+    case side
+    case symbol
+    case type
+    case stop
+    case stopPriceType
+    case stopPrice
+    case reduceOnly
+    case closeOrder
+    case price
+}

Sources/SwiftTrader/Model/Kucoin/Order/KucoinOrderStop.swift

@@ -0,0 +1,18 @@
+//
+//  KucoinOrderStop.swift
+//  
+//
+//  Created by Fernando Fernandes on 10.02.22.
+//
+
+import Foundation
+
+/// Either down or up.
+public enum KucoinOrderStop: String {
+    
+    /// Triggers when the price reaches or goes below a stop price.
+    case down
+
+    /// Triggers when the price reaches or goes above the a stop price.
+    case up
+}

Sources/SwiftTrader/Model/Kucoin/Order/KucoinOrderStopPriceType.swift

@@ -0,0 +1,23 @@
+//
+//  KucoinOrderStopPriceType.swift
+//  
+//
+//  Created by Fernando Fernandes on 10.02.22.
+//
+
+import Foundation
+
+/// Either `TP`, `IP` or `MP`.
+///
+/// Need to be defined if `KucoinOrderStop` is specified.
+public enum KucoinOrderStopPriceType: String {
+    
+    /// Trade price.
+    case TP
+    
+    /// Index price
+    case IP
+    
+    /// Mark price.
+    case MP
+}

Sources/SwiftTrader/Network/Kucoin/AccountOverview/KucoinFuturesAccountOverviewRequest.swift

@@ -49,17 +49,17 @@ public struct KucoinFuturesAccountOverviewRequest: NetworkRequest {
     /// Creates a new `KucoinFuturesAccountOverviewRequest` instance.
     ///
     /// - Parameters:
-    ///   - session: `URLSession`, default is `.shared`.
     ///   - currencySymbol: `CurrencySymbol`, default is `.USDT`.
     ///   - kucoinAuth: Kucoin authentication data.
+    ///   - session: `URLSession`, default is `.shared`.
     ///   - settings: `NetworkRequestSettings`.
-    public init(session: URLSession = .shared,
-                currencySymbol: CurrencySymbol = .USDT,
+    public init(currencySymbol: CurrencySymbol = .USDT,
                 kucoinAuth: KucoinAuth,
+                session: URLSession = .shared,
                 settings: NetworkRequestSettings) {
-        self.session = session
         self.currencySymbol = currencySymbol
         self.kucoinAuth = kucoinAuth
+        self.session = session
         self.settings = settings
     }
 }

Sources/SwiftTrader/Network/Kucoin/Orders/KucoinFuturesOrdersListRequest.swift

@@ -49,17 +49,17 @@ public struct KucoinFuturesOrdersListRequest: NetworkRequest {
     /// Creates a new `KucoinFuturesOrdersListRequest` instance.
     ///
     /// - Parameters:
-    ///   - session: `URLSession`, default is `.shared`.
     ///   - orderStatus: `KucoinFuturesOrderStatus`, default is `.active`.
     ///   - kucoinAuth: Kucoin authentication data.
+    ///   - session: `URLSession`, default is `.shared`.
     ///   - settings: `NetworkRequestSettings`.
-    public init(session: URLSession = .shared,
-                orderStatus: KucoinOrderStatus = .active,
+    public init(orderStatus: KucoinOrderStatus = .active,
                 kucoinAuth: KucoinAuth,
+                session: URLSession = .shared,
                 settings: NetworkRequestSettings) {
-        self.session = session
         self.orderStatus = orderStatus
         self.kucoinAuth = kucoinAuth
+        self.session = session
         self.settings = settings
     }
 }

Sources/SwiftTrader/Network/Kucoin/Orders/KucoinFuturesPlaceOrderRequest.swift

@@ -28,16 +28,22 @@ public struct KucoinFuturesPlaceOrdersRequest: NetworkRequest {
 
     public var request: URLRequest {
         get throws {
-            let futuresPlaceOrderResource = KucoinFuturesPlaceOrderResource(orderStatus: .active)
+            let futuresPlaceOrderResource = KucoinFuturesPlaceOrderResource()
             var urlRequest = URLRequest(url: try futuresPlaceOrderResource.url)
             urlRequest.httpMethod = HTTPMethod.POST.rawValue
 
             #warning("TODO: This has to be parameterized")
             var json = [String:Any]()
             json["clientOid"] = UUID().uuidString
+            json["side"] = "sell"
             json["symbol"] = "XBTUSDTM"
-            json["price"] = "42000"
+            json["type"] = "limit"
+            json["stop"] = "down"
+            json["stopPriceType"] = "TP"
+            json["stopPrice"] = "44970"
+            json["reduceOnly"] = true
             json["closeOrder"] = true
+            json["price"] = "44970"
 
             do {
                 let data = try JSONSerialization.data(withJSONObject: json, options: [])
@@ -57,8 +63,7 @@ public struct KucoinFuturesPlaceOrdersRequest: NetworkRequest {
 
     // MARK: Private
 
-    #warning("TODO: change from orderStatus to whatever needs sending")
-    private let orderStatus: KucoinOrderStatus
+    private let parameters: KucoinOrderParameters
 
     private let kucoinAuth: KucoinAuth
 
@@ -67,17 +72,17 @@ public struct KucoinFuturesPlaceOrdersRequest: NetworkRequest {
     /// Creates a new `KucoinFuturesPlaceOrdersRequest` instance.
     ///
     /// - Parameters:
-    ///   - session: `URLSession`, default is `.shared`.
-    ///   - orderStatus: `KucoinFuturesOrderStatus`, default is `.active`.
+    ///   - parameters: `KucoinOrderParameters` that defines an order.
     ///   - kucoinAuth: Kucoin authentication data.
+    ///   - session: `URLSession`, default is `.shared`.
     ///   - settings: `NetworkRequestSettings`.
-    public init(session: URLSession = .shared,
-                orderStatus: KucoinOrderStatus = .active,
+    public init(parameters: KucoinOrderParameters,
                 kucoinAuth: KucoinAuth,
+                session: URLSession = .shared,
                 settings: NetworkRequestSettings) {
-        self.session = session
-        self.orderStatus = orderStatus
+        self.parameters = parameters
         self.kucoinAuth = kucoinAuth
+        self.session = session
         self.settings = settings
     }
 }