Alpaca Documentation Beta

Structure Alpaca​Client

public struct AlpacaClient: AlpacaClientProtocol
AlpacaClient AlpacaClient AlpacaClientProtocol AlpacaClientProtocol AlpacaClient->AlpacaClientProtocol

Conforms To

AlpacaClientProtocol

Initializers

init(_:​)

public init(_ environment: Environment)

Properties

environment

let environment: Environment

data

let data: AlpacaDataClient

Methods

account()

public func account() -> ResponsePublisher<Account>

account​Configurations()

public func accountConfigurations() -> ResponsePublisher<AccountConfigurations>

save​Account​Configurations(_:​)

public func saveAccountConfigurations(_ configurations: AccountConfigurations) -> ResponsePublisher<AccountConfigurations>

save​Account​Configurations(dtbp​Check:​no​Shorting:​suspend​Trade:​trade​Confirm​Email:​)

public func saveAccountConfigurations(dtbpCheck: AccountConfigurations.DayTradeBuyingPowerCheck? = nil, noShorting: Bool? = nil, suspendTrade: Bool? = nil, tradeConfirmEmail: AccountConfigurations.TradeConfirmEmail? = nil) -> ResponsePublisher<AccountConfigurations>

assets(status:​asset​Class:​)

public func assets(status: Asset.Status? = nil, assetClass: Asset.Class? = nil) -> ResponsePublisher<[Asset]>

asset(id:​)

public func asset(id: String) -> ResponsePublisher<Asset>

asset(id:​)

public func asset(id: UUID) -> ResponsePublisher<Asset>

asset(symbol:​)

public func asset(symbol: String) -> ResponsePublisher<Asset>

calendar(start:​end:​)

public func calendar(start: String? = nil, end: String? = nil) -> ResponsePublisher<[Calendar]>

calendar(start:​end:​)

public func calendar(start: Date? = nil, end: Date? = nil) -> ResponsePublisher<[Calendar]>

clock()

public func clock() -> ResponsePublisher<Clock>

orders(status:​limit:​after:​until:​direction:​nested:​)

public func orders(status: String? = nil, limit: Int? = nil, after: Date? = nil, until: Date? = nil, direction: SortDirection? = nil, nested: Bool? = nil) -> ResponsePublisher<[Order]>

order(id:​nested:​)

public func order(id: UUID, nested: Bool? = nil) -> ResponsePublisher<Order>

order(id:​nested:​)

public func order(id: String, nested: Bool? = nil) -> ResponsePublisher<Order>

create​Order(symbol:​qty:​side:​type:​time​InForce:​limit​Price:​stop​Price:​extended​Hours:​`class`:​take​Profit​Limit​Price:​stop​Loss:​)

public func createOrder(symbol: String, qty: Double, side: Order.Side, type: Order.OrderType, timeInForce: Order.TimeInForce, limitPrice: Double? = nil, stopPrice: Double? = nil, extendedHours: Bool = false, `class`: Order.Class? = nil, takeProfitLimitPrice: Double? = nil, stopLoss: (stopPrice: Double, limitPrice: Double?)? = nil) -> ResponsePublisher<Order>

cancel​Orders()

public func cancelOrders() -> ResponsePublisher<[MultiResponse<Order>]>

cancel​Order(id:​)

public func cancelOrder(id: String) -> ResponsePublisher<Order>

cancel​Order(id:​)

public func cancelOrder(id: UUID) -> ResponsePublisher<Order>

portfolio​History(period:​timeframe:​date​End:​extended​Hours:​)

public func portfolioHistory(period: String? = nil, timeframe: PortfolioHistory.Timeframe? = nil, dateEnd: Date? = nil, extendedHours: Bool? = nil) -> ResponsePublisher<PortfolioHistory>

positions()

public func positions() -> ResponsePublisher<[Position]>

position(asset​Id:​)

public func position(assetId: String) -> ResponsePublisher<Position>

position(asset​Id:​)

public func position(assetId: UUID) -> ResponsePublisher<Position>

position(symbol:​)

public func position(symbol: String) -> ResponsePublisher<Position>

close​Positions()

public func closePositions() -> ResponsePublisher<[MultiResponse<Order>]>

close​Position(asset​Id:​)

public func closePosition(assetId: String) -> ResponsePublisher<Order>

close​Position(asset​Id:​)

public func closePosition(assetId: UUID) -> ResponsePublisher<Order>

close​Position(symbol:​)

public func closePosition(symbol: String) -> ResponsePublisher<Order>

watchlists()

public func watchlists() -> ResponsePublisher<[Watchlist]>

create​Watchlist(name:​symbols:​)

public func createWatchlist(name: String, symbols: [String]) -> ResponsePublisher<Watchlist>

watchlist(id:​)

public func watchlist(id: String) -> ResponsePublisher<Watchlist>

watchlist(id:​)

public func watchlist(id: UUID) -> ResponsePublisher<Watchlist>

update​Watchlist(id:​name:​symbols:​)

public func updateWatchlist(id: String, name: String? = nil, symbols: [String]? = nil) -> ResponsePublisher<Watchlist>

update​Watchlist(id:​name:​symbols:​)

public func updateWatchlist(id: UUID, name: String? = nil, symbols: [String]? = nil) -> ResponsePublisher<Watchlist>

update​Watchlist(id:​add:​)

public func updateWatchlist(id: String, add symbol: String) -> ResponsePublisher<Watchlist>

update​Watchlist(id:​add:​)

public func updateWatchlist(id: UUID, add symbol: String) -> ResponsePublisher<Watchlist>

update​Watchlist(id:​remove:​)

public func updateWatchlist(id: String, remove symbol: String) -> ResponsePublisher<Watchlist>

update​Watchlist(id:​remove:​)

public func updateWatchlist(id: UUID, remove symbol: String) -> ResponsePublisher<Watchlist>

delete​Watchlist(id:​)

public func deleteWatchlist(id: String) -> EmptyResponsePublisher

delete​Watchlist(id:​)

public func deleteWatchlist(id: UUID) -> EmptyResponsePublisher