Hubspot Connector for Python

Hubspot Connector can be used to integrate Hubspot and your data source, e.g. Microsoft SQL Server, Oracle, Excel, Power BI, etc. Get, write, delete Hubspot data in a few clicks!

In this article you will learn how to quickly and efficiently integrate Hubspot data in Python. We will use high-performance Hubspot Connector to easily connect to Hubspot and then access the data inside Python.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

Hubspot Connector for Python is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few.

Connect to Hubspot in other apps

Connect to Hubspot in SSIS

Connect to Hubspot in SQL Server

Connect to Hubspot in Power BI

Connect to Hubspot in SSRS

Connect to Hubspot in Informatica

Connect to Hubspot in MS Access

Connect to Hubspot in MS Excel

Connect to Hubspot in SSAS

Connect to Hubspot in C#

Connect to Hubspot in JAVA

Connect to Hubspot in Tableau

Connect to Hubspot in SAP Crystal Reports

Connect to Hubspot in Azure Data Factory (Pipeline)

Connect to Hubspot in Azure Data Factory (SSIS)

Connect to Hubspot in Talend Studio

Connect to Hubspot in UiPath

Connect to Hubspot in PowerShell

Connect to Hubspot in ODBC

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from Hubspot using Python we first need to create a DSN (Data Source) which will access data from Hubspot. We will later be able to read data using Python. Perform these steps:

Download and install ODBC PowerPack.
Open ODBC Data Sources (x64):
Create a User data source (User DSN) based on ZappySys API Driver

ZappySys API Driver
- Create and use User DSN if the client application is run under a User Account. This is an ideal option in design-time, when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit.
- Create and use System DSN if the client application is launched under a System Account, e.g. as a Windows Service. Usually, this is an ideal option to use in a production environment. Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
When the Configuration window appears give your data source a name if you haven't done that already, then select "Hubspot" from the list of Popular Connectors. If "Hubspot" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

HubspotDSN

Hubspot

Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

Private app (Static Access Token) [Http]

Private apps allow you to use HubSpot's APIs to access specific data from your HubSpot account. You can authorize what each private app can request or change in your account, which will generate an access token that's unique to your app. [API reference]

Steps how to get and use Hubspot credentials

Follow these instructions to create a Private app in HubSpot and configure HubSpot authentication in SSIS package or ODBC data source:

First of all, go to HubSpot portal.
Then click Data Management option on the left and then hit Integrations menu item:
Move on by clicking Private Apps menu item and then click Create a private app button to create one:
Then continue by following the instructions on HubSpot Docs.
Once you create an app, go to SSIS package or ODBC data source and in Private App authentication set these parameters:
- For AccessToken field use Access token value from the Private app configuration in HubSpot.
Done! Now you are ready to use HubSpot Connector!

Fill in all required parameters and set optional parameters if needed:

HubspotDSN

Hubspot

Private app (Static Access Token) [Http]

https://api.hubapi.com

Required Parameters
AccessToken	Fill-in the parameter...
Optional Parameters
RetryMode	RetryWhenStatusCodeMatch
RetryStatusCodeList	429
RetryCountMax	5
RetryMultiplyWaitTime	True

Public app [OAuth]

In HubSpot, a public app is a type of integration that can be installed on customer accounts or listed on the App Marketplace. It requires authentication via OAuth. Once a user installs your app on their HubSpot account, you’ll be able to make API calls to that account using an OAuth access token. [API reference]

Steps how to get and use Hubspot credentials

Follow these instructions to create a Public app in HubSpot and configure HubSpot authentication in SSIS package or ODBC data source:

First of all, if you don't have HubSpot Developer's account, register one.
Go to HubSpot and select your Developer account.
Click Apps on the left hand side and then click Create app button to create a Public app:
Then continue by following the instructions in HubSpot Docs.
NOTE: If you don't have a working Redirect URL, you can use https://zappysys.com/oauth (it's safe).

Once you create an app, go to SSIS package or ODBC data source and in Public app authentication set these parameters (use values from your Public app configuration in HubSpot):

For ClientId field use Client ID value.
For ClientSecret field use Client secret value.

For Scope field use Scopes values, e.g.:

accounting
tickets
files

crm.lists.read
crm.lists.write

crm.objects.contacts.read
crm.objects.contacts.write
crm.schemas.contacts.read

crm.objects.custom.read
crm.objects.custom.write
crm.schemas.custom.read

crm.objects.companies.read
crm.objects.companies.write
crm.schemas.companies.read

crm.objects.deals.read
crm.objects.deals.write
crm.schemas.deals.read

crm.objects.quotes.read
crm.objects.quotes.write
crm.schemas.quotes.read

crm.objects.line_items.read
crm.objects.line_items.write
crm.schemas.line_items.read

NOTE: You can use other scopes too, but they must match the scopes defined in your Public app.

For ReturnUrl field use one of Redirect URLs.

When you are done with that, click Generate Token button to generate Access and Refresh Tokens.
Done! Now you are ready to use HubSpot Connector!

Fill in all required parameters and set optional parameters if needed:

HubspotDSN

Hubspot

Public app [OAuth]

https://api.hubapi.com

Required Parameters
UseCustomApp	Fill-in the parameter...
Scope (Must Match with App Scopes)	Fill-in the parameter...
Optional Parameters
Client ID
Client Secret
ReturnUrl
RetryMode	RetryWhenStatusCodeMatch
RetryStatusCodeList	429
RetryCountMax	5
RetryMultiplyWaitTime	True

Developer API key (Deprecated) [Http]

Deprecated authentication method. Use [Private app] instead. [API reference]

Steps how to get and use Hubspot credentials

Using HubSpot API key is deprecated method for authentication. Use Private app authentication instead. If you still need one, then follow these instructions to get HubSpot API key:

First of all, if you don't have HubSpot Developer's account, register one.
Go to HubSpot and select your Developer account.
Click Apps on the left hand side and then click Get HubSpot API key button to get one:
When a popup appears, click Show Key button and then hit Copy button to copy API key:
Once copy the API key, go to SSIS package or ODBC data source and use it in API Key authentication configuration:
- Paste it in ApiKey parameter field.
Done! Now you are ready to use HubSpot Connector!

Fill in all required parameters and set optional parameters if needed:

HubspotDSN

Hubspot

Developer API key (Deprecated) [Http]

https://api.hubapi.com

Required Parameters
ApiKey	Fill-in the parameter...
Optional Parameters
RetryMode	RetryWhenStatusCodeMatch
RetryStatusCodeList	429
RetryCountMax	5
RetryMultiplyWaitTime	True

Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

ZappySys API Driver - Hubspot

Hubspot Connector can be used to integrate Hubspot and your data source, e.g. Microsoft SQL Server, Oracle, Excel, Power BI, etc. Get, write, delete Hubspot data in a few clicks!

HubspotDSN
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in Python to retrieve data from Hubspot. Hit OK button to use this query in the next step.
```
SELECT * FROM Companies --Where Id=123
```
Some parameters configured in this window will be passed to the Hubspot API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.
Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in Python:
ZappySys API Driver - Hubspot

Hubspot Connector can be used to integrate Hubspot and your data source, e.g. Microsoft SQL Server, Oracle, Excel, Power BI, etc. Get, write, delete Hubspot data in a few clicks!

HubspotDSN
```
SELECT * FROM Companies --Where Id=123
```
You can also access data quickly from the tables dropdown by selecting <Select table>.

A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Hubspot API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Hubspot servers).
Click OK to finish creating the data source.

Video Tutorial

Watch this video on YouTube

Read data in Python

Using ODBC DSN

Python code to get the data:

HubspotDSN')
When you run the code it will make the API call and read the data:

Here is Python program's code in text format:


    import pyodbc
    conn = pyodbc.connect('DSN=HubspotDSN')

    cursor = conn.cursor()

    #execute query to fetch data from API service
    cursor.execute("SELECT id,title FROM products")

    row = cursor.fetchone()
    while row:
        print(row)
        row = cursor.fetchone()

    ##For loop example
    #for row in cursor:
    #    print(row)

Using a full ODBC connection string

If you want to avoid being dependent on a DSN and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String:

Open ODBC data source configuration and click Copy settings:

ZappySys API Driver - Configuration [Version: 2.0.1.10418]

ZappySys API Driver - Hubspot

Hubspot Connector can be used to integrate Hubspot and your data source, e.g. Microsoft SQL Server, Oracle, Excel, Power BI, etc. Get, write, delete Hubspot data in a few clicks!

HubspotDSN
The window opens, telling us the connection string was successfully copied to the clipboard:

Then in your Python code use Connection String when initializing OdbcConnection object, for example:

conn = pyodbc.connect('DRIVER={ZappySys API Driver};ServiceUrl=https://yourservices.provider.com/api/xxxx....;AuthName=Http;')

How to install `pyodbc` in the Python?

You would need to install pyodbc in Python if you intend to establish connections to databases that support ODBC (Open Database Connectivity). This module facilitates communication between Python applications and various database management systems, enabling you to perform operations such as querying, retrieving data, and managing databases. Here's how you can install pyodbc in Python:

Installation Steps:

Ensure you have Python installed on your system. If not, download it from the official Python website and follow the installation instructions.
Open your terminal or command prompt.
Use the following command to install pyodbc using pip, the Python package installer:
```
python -m pip install "pyodbc"
```
Make sure you have a stable internet connection and the necessary permissions to install Python packages.

Reasons to Install:

If pyodbc is not installed, your Python script will generate the following error:
```
"ModuleNotFoundError: No module named 'pyodbc'"
```
.
Database Connectivity: pyodbc allows Python to connect to various databases that support ODBC, such as Microsoft SQL Server, PostgreSQL, MySQL, and more.
Data Operations: It facilitates the execution of SQL queries, retrieval of data, and other database operations from within Python scripts.
Cross-Platform Support: pyodbc is designed to work across different operating systems, including Windows, macOS, and various Linux distributions.
Simplicity and Efficiency: The module provides an intuitive interface for managing database transactions and connections, simplifying the process of working with databases in Python.

By installing pyodbc, you can seamlessly integrate your Python applications with a wide range of ODBC-supported databases, enabling efficient and effective data management and analysis.