How to work with Coinbase Data in Apache Spark using SQL

Apache Spark is a fast and general engine for large-scale data processing. When paired with the CData JDBC Driver for Coinbase, Spark can work with live Coinbase data. This article describes how to connect to and query Coinbase data from a Spark shell.

The CData JDBC Driver offers unmatched performance for interacting with live Coinbase data due to optimized data processing built into the driver. When you issue complex SQL queries to Coinbase, the driver pushes supported SQL operations, like filters and aggregations, directly to Coinbase and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can work with and analyze Coinbase data using native data types.

Install the CData JDBC Driver for Coinbase

Download the CData JDBC Driver for Coinbase installer, unzip the package, and run the JAR file to install the driver.

Start a Spark Shell and Connect to Coinbase Data

1. Open a terminal and start the Spark shell with the CData JDBC Driver for Coinbase JAR file as the jars parameter: $ spark-shell --jars /CData/CData JDBC Driver for Coinbase/lib/cdata.jdbc.api.jar
2. With the shell running, you can connect to Coinbase with a JDBC URL and use the SQL Context load() function to read a table.

   Start by setting the Profile connection property to the location of the Coinbase Profile on disk (e.g. C:\profiles\Coinbase.apip). Next, set the ProfileSettings connection property to the connection string for Coinbase (see below).

   Coinbase API Profile Settings

   Coinbase uses OAuth-based authentication.

   First you need to register an OAuth app with Coinbase. This is done from your account under 'Settings' > 'API Access' > 'New OAuth2 Application'.

   After setting the following connection properties, you are ready to connect:

   • AuthScheme: Set this to OAuth.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
   • OAuthClientId: Set this to the ClientID that is specified in you app settings.
   • OAuthClientSecret: Set this to the ClientSecret that is specified in you app settings.
   • CallbackURL: Set this to the Redirect URI you specified in your app settings.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Coinbase JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.api.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   Configure the connection to Coinbase, using the connection string generated above.

   scala> val api_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:api:Profile=C:\profiles\Coinbase.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;").option("dbtable","Deposits").option("driver","cdata.jdbc.api.APIDriver").load()
3. Once you connect and the data is loaded you will see the table schema displayed.

4. Register the Coinbase data as a temporary table:

   scala> api_df.registerTable("deposits")

5. Perform custom SQL queries against the Data using commands like the one below:

   scala> api_df.sqlContext.sql("SELECT Id, Amount FROM Deposits WHERE Committed = true").collect.foreach(println)

   You will see the results displayed in the console, similar to the following: