GDAXKit 0.0.8

GDAXKit 0.0.8

×

Maintained by Steve Wight.

GDAXKit 0.0.8

  • By
  • Steve Wight

GDAXKit

Unofficial Swift 4 client library for accessing 💰*gdax.com's*💰 public market data through both the REST Market Data API and the real time Websocket Feed

Getting Started

Gdax.com is "The Most Trusted Digital Asset Exchange" and offers an extensive real time market data API for a handful of the biggest 💵cryptoCurrencies💵

The Docs

Take a look at the API Docs for an overview and more information on the publicly available currency data.

Note: GDAXKit currently only makes public data available and does not allow for accessing endpoints or websockets that require authentication.

Usage

Depending upon the data you want to access, you will use one of the two client objects provided. MarketClient for accessing snapshots of market data and SocketClient for accessing real-time market data updates for orders and trades.

Market Data API (MarketClient)

// Initialize a client
let client = MarketClient()

// Call one of the public endpoint methods
client.products { products, result in
	// Check if our call was a success or failure
	switch result {
	case .success(_):
		// Do stuff with the provided products
	case .failure(let error):
		// Handle the error
	}
}

To get access to historic data you can use the DateRange and Granularity enums provided by GDAXKit:

let pid = "BTC-USD"
let range = DateRange.fiveDays
let granularity = Granularity.oneHour

client.historic(pid:pid, range:range, granularity:granularity) { candles, result in
	switch result {
	case .success(_):
		// Do stuff with the provided candles
	case .failure(let error):
		// Handle error
	}
}

All MarketClient methods take a closure to handle returned objects

MarketClient's Public Interface

Socket Feed (SocketClient)

To access the websocket's real time updates, conform to the SocketClientDelegate protocol methods:

extension MyViewController: SocketClientDelegate {
	func socketClientConnected() { /.../ }
	func socketClientDisconnected() { /.../ }
	func socketClientTick(_ tick:SocketTicker)
  	func socketClientHeartbeat(_ heartbeat:Heartbeat)
   	func socketClientError(_ error:SocketError)
}

SocketClientDelegate Method Life-Cycle

When the client first connects successfully to the socket at wss://ws-feed.gdax.com, the socketClientConnected method is called.

Depending upon the SocketClient method that is called either the socketClientTick or socketClientHeartbeat delegate method will begin to be called. Any time the socket encounters an error, the socketClientError method will be called.

Finally the socketClientDisconnected method is called when connection to the socket ends.

Initializing Websocket Communication

To begin the socket stream, initialize the SocketClient by passing our delegate object in. Once you have initiliazed the SocketClient, and conformed to the SocketClientDelegate methods above, call one of the start stream methods:

class MyViewController: UIViewController {
	let socketClient:SocketClient!
	
	override func viewDidLoad() {
		// Use Products you want data for, from client.loadProducts
		let products = /... Product array from MarketClient .../
	
		// Initialize SocketClient and pass self as delegate
		socketClient = SocketClient(delegate:self)
		
		// Start Our ticker stream
		socketClient.startTickerStream(products: products)
		
		// Our delegate methods will now get called as necessary
	}
}

SocketClient's Public Interface

Installation

The easiest way to use GDAXKit is with CocoaPods

Installation with CocoaPods

To integrate GDAXKit into your Xcode project using CocoaPods, specify it in your Podfile:

platform :ios, '11.0'

target 'TargetName' do
  pod 'GDAXKit'
end

Then, run the following command:

$ pod install

Pre-Release Version

This is a pre-release version of GDAXKit and although it is stable and should be working in all the above cases, things will be added, changed and potentially break.

License

GDAXKit is released under the MIT license