Using the CData ODBC Driver for Alchemy in PyCharm

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for Alchemy from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for Alchemy as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

1. Click File -> Settings to open the project settings window.
2. Click Project Interpreter from the Project: YourProjectName menu.
3. To add pyodbc, click the + button and enter pyodbc.
4. Click Install Package to install pyodbc.

Connect to Alchemy

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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

Alchemy API Profile Settings

Alchemy uses API key authentication. The API key is supplied in the request URL path. To obtain an API key:

1. Sign in to your Alchemy account at https://dashboard.alchemy.com.
2. Open an existing app or create a new one.
3. Copy the app's API key from the API Key dialog.

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• Network: Optional. The blockchain network slug for NFT API requests (for example, eth-mainnet, base-mainnet, polygon-mainnet). Defaults to eth-mainnet.

Set the following in the ProfileSettings connection property:

• APIKey: Set this to your Alchemy app API key.

Below is the syntax for a DSN:

[CData API Source]
Driver = CData ODBC Driver for Alchemy
Description = My Description
Profile = C:\profiles\Alchemy.apip
AuthScheme = APIKey
Network = eth-mainnet
ProfileSettings = 'APIKey = your_api_key'

Execute SQL to Alchemy

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for API};Profile = C:\profiles\Alchemy.apip;AuthScheme = APIKey;Network = eth-mainnet;ProfileSettings = 'APIKey = your_api_key';')
cursor = cnxn.cursor()
cursor.execute("SELECT Address, Name FROM ContractsForOwner WHERE Owner = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'")
rows = cursor.fetchall()
for row in rows:
  print(row.Address, row.Name)

After connecting to Alchemy in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Alchemy data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].