IBKit – Interactive Brokers API, Swiftified

IBKit is a modern Swift implementation of the Interactive Brokers TWS/Gateway API. It enables market data access, historical queries, and automated trading – all with an ergonomic Swift Concurrency interface.

⚠️ IBKit is not affiliated with Interactive Brokers and is not an official API.

---

🔧 Requirements

• macOS 14.0+
• Swift 6.1+
• Xcode 15+
• IB Gateway or TWS

---

🚀 Installation

File > Swift Packages > Add Package Dependency

Enter:

https://github.com/TradeWithIt/IBKit

Select the main branch.

---

📦 Features

✅ Swift-native IBContract/IBRequest models
✅ AsyncStream-powered market and historical feeds
✅ Support for both paper and live trading
✅ Modular request/response architecture
✅ Combine-free and compatible with Swift Concurrency

---

🧠 Architecture: EventBroadcaster

IBKit introduces EventBroadcaster, a minimal actor that fans out incoming events to multiple AsyncStream consumers. This enables:

• Multiple parallel listeners (e.g., broker + charting tool)
• Backpressure-free async delivery
• Safer lifecycle with automatic teardown

actor EventBroadcaster<T: Sendable> {
    private var continuations: [AsyncStream<T>.Continuation] = []

    func stream() -> AsyncStream<T> {
        AsyncStream { continuation in
            continuations.append(continuation)
        }
    }

    func yield(_ event: T) {
        continuations.forEach { $0.yield(event) }
    }

    func finish() {
        continuations.forEach { $0.finish() }
        continuations.removeAll()
    }
}

---

🧪 Example: Query Historical Price Data

let client = IBClient.paper(id: 999)
try await client.connect()

let contract = IBContract.equity("AAPL", currency: "USD")
let interval = DateInterval.lookback(10, unit: .minute, until: .distantFuture)
let request = IBPriceHistoryRequest(
    requestID: client.nextRequestID,
    contract: contract,
    size: .minute,
    source: .trades,
    lookback: interval
)

for await event in try await client.stream(request: request) {
    switch event {
    case let response as IBPriceHistory:
        response.prices.forEach { print($0) }
    case let error as IBServerError:
        print("⚠️ Error: \(error.message)")
    default: break
    }
}

---

📊 Example: Real-Time Price Feed

let contract = IBContract.crypto("BTC", currency: "USD")
let request = IBRealTimeBarRequest(
    requestID: client.nextRequestID,
    contract: contract,
    source: .midpoint
)

for await event in try await client.stream(request: request) {
    if let bar = event as? IBPriceBarUpdate {
        print(bar)
    }
}

---

🛠 Configuration Tips

In IB Gateway:

• Enable API access under Settings > API > Settings
• Uncheck Read-only API
• Select Restart instead of Auto-logoff
• Note your Master Client ID, Host, and Port

---

📚 Documentation

See the included Swift Playgrounds for:

• Real-time streaming
• Historical queries
• Order placement
• Market quote snapshots

---

📝 License

MIT. See LICENSE.

---

🔗 Related

• Interactive Brokers API Docs
• IB Gateway Download

---

🙏 Acknowledgements

This project is a continuation and substantial evolution of the excellent work by @stensoosaar in the original IBKit repository.

We deeply appreciate the solid foundation and effort that went into building the original Swift interface for Interactive Brokers. Much of the protocol groundwork and initial implementation has been carried forward, modernized, and extended for async/await, stream-based data handling, and Linux support.

If you find this fork useful, please consider also ⭐️ starring the original repo as a gesture of thanks.