Add support to Kucoin's "Get an Account" (spot)

Author: backslash-f

Sources/SwiftTrader/Model/Error/SwiftTraderError+Details.swift

@@ -25,7 +25,8 @@ public extension SwiftTraderError {
                 isSuccess: ftxError.isSuccess,
                 errorMessage: ftxError.errorMessage
             )
-        case .kucoinAccounts,
+        case .kucoinSpotListAccounts,
+                .kucoinSpotGetAccount,
                 .kucoinFuturesAccountOverview,
                 .kucoinFuturesCancelStopOrders,
                 .kucoinFuturesOrderList,

Sources/SwiftTrader/Model/Error/SwiftTraderError.swift

@@ -80,8 +80,11 @@ public enum SwiftTraderError: Error {
 
     // MARK: Accounts
 
-    /// And error ocurred while executing the function `SwiftTrader.kucoinAccounts(currencySymbol:)`.
-    case kucoinAccounts(error: Error)
+    /// And error ocurred while executing the function `SwiftTrader.kucoinListAccounts(currencySymbol:)`.
+    case kucoinSpotListAccounts(error: Error)
+    
+    /// And error ocurred while executing the function `SwiftTrader.kucoinGetAccount(accountID:)`.
+    case kucoinSpotGetAccount(error: Error)
 
     // MARK: Account Overview
 

Sources/SwiftTrader/Model/Kucoin/Responses/KucoinAccount.swift

@@ -0,0 +1,44 @@
+//
+//  KucoinAccounts.swift
+//  
+//
+//  Created by Fernando Fernandes on 16.07.22.
+//
+
+import Foundation
+
+/// Kucoin "List Acounts" REST API response.
+///
+/// https://docs.kucoin.com/#list-accounts
+public struct KucoinSpotListAccounts: Codable {
+    let code: String
+    let data: [KucoinFuturesAccount]
+}
+
+/// Encapsulates Kucoin futures account data.
+public struct KucoinFuturesAccount: Codable {
+    let id, currency, balance: String
+    let type: KucoinAccountType
+    let available, holds: String
+}
+
+/// Kucoin "Get Acount" REST API response.
+///
+/// https://docs.kucoin.com/#get-an-account
+public struct KucoinSpotGetAccount: Codable {
+    let code: String
+    let data: KucoinSpotAccount
+}
+
+/// Encapsulates Kucoin spot account data.
+public struct KucoinSpotAccount: Codable {
+    let currency, balance: String
+    let available, holds: String
+}
+
+/// There are three types of accounts: 1) main account 2) trade account 3) margin account.
+public enum KucoinAccountType: String, Codable {
+    case main
+    case trade
+    case margin
+}

Sources/SwiftTrader/Model/Kucoin/Responses/KucoinSpotAccounts.swift

@@ -21,7 +21,8 @@ public enum SwiftTraderOperation {
 
     // MARK: Spot
 
-    case kucoinAccounts
+    case kucoinSpotListAccounts
+    case kucoinSpotGetAccount
 
     // MARK: Futures
 

Sources/SwiftTrader/Model/SwiftTraderOperation.swift

@@ -12,7 +12,22 @@ public extension KucoinAPI {
     struct Spot {
 
         public struct Path {
-            static let accounts  = "/api/v1/accounts"
+            
+            /// Returns the path for getting accounts within Kucoin spot.
+            ///
+            /// `pathComponent` required as `URL.appendingPathComponent(_:)` will be deprecated and
+            /// `URL.appending(path:directoryHint:)` is only available in macOS 13 and later (so not in Linux / Heroku).
+            ///
+            /// - Parameter pathComponent: use this parameter to append extra info to the returned
+            /// `String`, e.g.: "/api/v1/accounts/5bd6e9286d99522a52e458de"
+            /// - Returns: `/api/v1/accounts` or `/api/v1/accounts/pathComponent`
+            static func accounts(pathComponent: String? = nil) -> String {
+                if let path = pathComponent {
+                    return "/api/v1/accounts" + "/" + path
+                } else {
+                    return "/api/v1/accounts"
+                }
+            }
         }
 
         /// Returns the base `URL` based on an Xcode environment variable.

Sources/SwiftTrader/Network/Kucoin/API/Kucoin/KucoinAPI+Spot.swift

@@ -18,6 +18,7 @@ public struct KucoinAPI {
     }
 
     public struct QueryParam {
+        public static let accountId    = "accountId"
         public static let currency     = "currency"
         public static let orderStatus  = "status"
         public static let symbol       = "symbol"

Sources/SwiftTrader/Network/Kucoin/API/Kucoin/KucoinAPI.swift

@@ -0,0 +1,75 @@
+//
+//  KucoinGetAccountRequest.swift
+//
+//
+//  Created by Fernando Fernandes on 30.07.22.
+//
+
+import Foundation
+
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
+import Logging
+
+/// A **request** for getting a Kucoin account.
+///
+/// https://docs.kucoin.com/#get-an-account
+public struct KucoinGetAccountRequest: NetworkRequest {
+    
+    // MARK: - Properties
+    
+    public typealias DecodableModel = KucoinSpotGetAccount
+    
+    public var logger: Logger {
+        NetworkRequestLogger().default
+    }
+    
+    public var session: URLSession
+    
+    public var request: URLRequest {
+        get throws {
+            let accountResource = KucoinGetAccountResource(accountID: accountID)
+            var urlRequest = URLRequest(url: try accountResource.url)
+            urlRequest.httpMethod = HTTPMethod.GET.rawValue
+            try KucoinAPI.setRequestHeaderFields(request: &urlRequest, kucoinAuth: kucoinAuth.spot)
+            return urlRequest
+        }
+    }
+    
+    public var settings: NetworkRequestSettings
+    
+    // MARK: Private
+    
+    private let accountID: String
+    
+    private let kucoinAuth: KucoinAuth
+    
+    // MARK: - Lifecycle
+    
+    /// Creates a new `KucoinListAccountsRequest` instance.
+    ///
+    /// - Parameters:
+    ///   - accountID: `String`, the ID of the account.
+    ///   - kucoinAuth: Kucoin authentication data.
+    ///   - session: `URLSession`, default is `.shared`.
+    ///   - settings: `NetworkRequestSettings`.
+    public init(accountID: String,
+                kucoinAuth: KucoinAuth,
+                session: URLSession = .shared,
+                settings: NetworkRequestSettings) {
+        self.accountID = accountID
+        self.kucoinAuth = kucoinAuth
+        self.session = session
+        self.settings = settings
+    }
+}
+
+// MARK: - Network Request Protocol
+
+public extension KucoinGetAccountRequest {
+    
+    func decode(_ data: Data) throws -> DecodableModel {
+        try JSONDecoder().decode(KucoinSpotGetAccount.self, from: data)
+    }
+}

Sources/SwiftTrader/Network/Kucoin/Accounts/KucoinGetAccountRequest.swift

@@ -0,0 +1,43 @@
+//
+//  KucoinGetAccountResource.swift
+//
+//
+//  Created by Fernando Fernandes on 16.07.22.
+//
+
+import Foundation
+
+/// The **resource** for getting a Kucoin account.
+///
+/// https://docs.kucoin.com/#get-an-account
+public struct KucoinGetAccountResource: NetworkResource {
+    
+    // MARK: - Properties
+    
+    public var url: URL {
+        get throws {
+            let baseURLString = try KucoinAPI.Spot.baseURL()
+            guard var urlComponents = URLComponents(string: baseURLString) else {
+                throw NetworkRequestError.invalidURLString(urlString: baseURLString)
+            }
+            urlComponents.path = KucoinAPI.Spot.Path.accounts(pathComponent: accountID)
+            guard let url = urlComponents.url else {
+                throw NetworkRequestError.invalidURLString(urlString: baseURLString)
+            }
+            return url
+        }
+    }
+    
+    // MARK: Private
+    
+    private let accountID: String
+    
+    // MARK: - Lifecycle
+    
+    /// Creates a new `KucoinGetAccountResource` instance.
+    ///
+    /// - Parameter accountID: `String`.
+    init(accountID: String) {
+        self.accountID = accountID
+    }
+}

Sources/SwiftTrader/Network/Kucoin/Accounts/KucoinGetAccountResource.swift

@@ -1,5 +1,5 @@
 //
-//  KucoinAccountsRequest.swift
+//  KucoinListAccountsRequest.swift
 //  
 //
 //  Created by Fernando Fernandes on 16.07.22.
@@ -15,11 +15,11 @@ import Logging
 /// A **request** for listing Kucoin accounts.
 ///
 /// https://docs.kucoin.com/#list-accounts
-public struct KucoinAccountsRequest: NetworkRequest {
+public struct KucoinListAccountsRequest: NetworkRequest {
 
     // MARK: - Properties
 
-    public typealias DecodableModel = KucoinAccounts
+    public typealias DecodableModel = KucoinSpotListAccounts
 
     public var logger: Logger {
         NetworkRequestLogger().default
@@ -29,7 +29,7 @@ public struct KucoinAccountsRequest: NetworkRequest {
 
     public var request: URLRequest {
         get throws {
-            let accountsResource = KucoinAccountsResource(currencySymbol: currencySymbol)
+            let accountsResource = KucoinListAccountsResource(currencySymbol: currencySymbol)
             var urlRequest = URLRequest(url: try accountsResource.url)
             urlRequest.httpMethod = HTTPMethod.GET.rawValue
             try KucoinAPI.setRequestHeaderFields(request: &urlRequest, kucoinAuth: kucoinAuth.spot)
@@ -47,7 +47,7 @@ public struct KucoinAccountsRequest: NetworkRequest {
 
     // MARK: - Lifecycle
 
-    /// Creates a new `KucoinAccountsRequest` instance.
+    /// Creates a new `KucoinListAccountsRequest` instance.
     ///
     /// - Parameters:
     ///   - currencySymbol: `CurrencySymbol`, default is `.USDT`.
@@ -67,9 +67,9 @@ public struct KucoinAccountsRequest: NetworkRequest {
 
 // MARK: - Network Request Protocol
 
-public extension KucoinAccountsRequest {
+public extension KucoinListAccountsRequest {
 
     func decode(_ data: Data) throws -> DecodableModel {
-        try JSONDecoder().decode(KucoinAccounts.self, from: data)
+        try JSONDecoder().decode(KucoinSpotListAccounts.self, from: data)
     }
 }