OData Connector for Python OData Connector can be used to integrated any REST API which supports OData Standard. You can view tables, read data from tables using this connector. It also comes with some example OData Services to get started. In this article you will learn how to quickly and efficiently integrate OData data in Python. We will use high-performance OData Connector to easily connect to OData and then access the data inside Python. Let's follow the steps below to see how we can accomplish that! Download Documentation OData 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 OData in other apps Connect to OData in SSIS Connect to OData in SQL Server Connect to OData in Power BI Connect to OData in SSRS Connect to OData in Informatica Connect to OData in MS Access Connect to OData in MS Excel Connect to OData in SSAS Connect to OData in C# Connect to OData in JAVA Connect to OData in Tableau Connect to OData in SAP Crystal Reports Connect to OData in Azure Data Factory (Pipeline) Connect to OData in Azure Data Factory (SSIS) Connect to OData in Talend Studio Connect to OData in UiPath Connect to OData in PowerShell Connect to OData in ODBC

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

Step-by-step instructions

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

1. Download and install ODBC PowerPack.

2. Open ODBC Data Sources (x64):

   

3. 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.

4. When the Configuration window appears give your data source a name if you haven't done that already, then select "OData" from the list of Popular Connectors. If "OData" 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:

   OdataDSN

   OData

   

5. 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.

    No Authentication [Http]

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

   OdataDSN

   OData

   No Authentication [Http]

   https://services.odata.org/V3/Northwind/Northwind.svc

   Optional Parameters
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429
   RetryCountMax	5
   RetryMultiplyWaitTime	True
   IgnoreSSLCertificateErrors
   SslVersion

   

    Windows Authentication [Http]

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

   OdataDSN

   OData

   Windows Authentication [Http]

   https://services.odata.org/V3/Northwind/Northwind.svc

   This Authentication Type has no parameters to fill-in.

   

    Basic Authentication [Http]

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

   OdataDSN

   OData

   Basic Authentication [Http]

   https://services.odata.org/V3/Northwind/Northwind.svc

   Required Parameters
   UserName	Fill-in the parameter...
   Password	Fill-in the parameter...
   Optional Parameters
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429
   RetryCountMax	5
   RetryMultiplyWaitTime	True
   IgnoreSSLCertificateErrors
   SslVersion

   

    NTLM Authentication [Http]

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

   OdataDSN

   OData

   NTLM Authentication [Http]

   https://services.odata.org/V3/Northwind/Northwind.svc

   Required Parameters
   UserName (i.e. Domain\UserName)	Fill-in the parameter...
   Password	Fill-in the parameter...
   Optional Parameters
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429
   RetryCountMax	5
   RetryMultiplyWaitTime	True
   IgnoreSSLCertificateErrors
   SslVersion

   

    Token Authentication [Http]

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

   OdataDSN

   OData

   Token Authentication [Http]

   https://services.odata.org/V3/Northwind/Northwind.svc

   Required Parameters
   Token	Fill-in the parameter...
   Optional Parameters
   AuthScheme	Bearer
   AuthHeader	Authorization
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429
   RetryCountMax	5
   RetryMultiplyWaitTime	True
   IgnoreSSLCertificateErrors
   SslVersion

   

    OAuth Connection for OData API [OAuth]

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

   OdataDSN

   OData

   OAuth Connection for OData API [OAuth]

   https://services.odata.org/V3/Northwind/Northwind.svc

   Optional Parameters
   GrantType	Default
   OAuthVersion	Default
   ClientId
   ClientSecret
   UserName
   Password
   Scope
   AuthUrl	https://some-domain.com/api/auth
   TokenUrl	https://some-domain.com/api/token
   ReturnUrl	https://zappysys.com/oauth
   ExtraAttributesForTokenRequest
   ExtraAttributesForAuthRequest
   DoNotIncludeCredentialsInHeader
   DoNotIncludeCredentialsInBody
   RenewBeforeSec
   ExtraHeaders (e.g. x-hdr1:AAA||x-hdr2:BBB)
   ContentType
   EnableCodeVerifier
   RemoveAuthHeader
   CustomAuthHeader
   CustomTokenPrefix
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429
   RetryCountMax	5
   RetryMultiplyWaitTime	True
   IgnoreSSLCertificateErrors
   SslVersion

   

6. 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 - OData

   OData Connector can be used to integrated any REST API which supports OData Standard. You can view tables, read data from tables using this connector. It also comes with some example OData Services to get started.

   OdataDSN

   

7. 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 OData. Hit OK button to use this query in the next step.

   SELECT * FROM Customers

   
   Some parameters configured in this window will be passed to the OData 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.

8. 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 - OData

   OData Connector can be used to integrated any REST API which supports OData Standard. You can view tables, read data from tables using this connector. It also comes with some example OData Services to get started.

   OdataDSN

   SELECT * FROM Customers

   
   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 OData 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 OData servers).

9. Click OK to finish creating the data source.

Video Tutorial

Read data in Python

Using ODBC DSN

1. Python code to get the data:
   

   OdataDSN')

   

2. When you run the code it will make the API call and read the data:
   

3. Here is Python program's code in text format:

   
       import pyodbc
       conn = pyodbc.connect('DSN=OdataDSN')
   
       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:

1. Open ODBC data source configuration and click Copy settings:
   

   ZappySys API Driver - Configuration [Version: 2.0.1.10418]

   ZappySys API Driver - OData

   OData Connector can be used to integrated any REST API which supports OData Standard. You can view tables, read data from tables using this connector. It also comes with some example OData Services to get started.

   OdataDSN

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

3. 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?

Actions supported by OData Connector

Learn how to perform common OData actions directly in Python with these how-to guides:

• Generic Read Data (JSON API)
• Generic Read Data (XML API)
• List Tables (JSON API)
• List Tables (XML API)
• Read [Dynamic Endpoint]
• Generic Request
• Generic Request (Bulk Write)

Conclusion

In this article we showed you how to connect to OData in Python and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to OData, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).

We encourage you to download OData Connector for Python and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download OData Connector for Python Documentation

More integrations

Other connectors for Python

Amazon Ads

Amazon Athena

Amazon Selling Partner (SP-API)

Apache Derby

Apache Hive

Apache Spark

Asana

Azure DevOps

Cosmos DB

DropBox

ElasticSearch

FastSpring

Google Ads

Google BigQuery

Google Calendar

Google Drive

Google Sheets

Hubspot

Infor Data Lake

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

MariaDB

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Starburst

Stripe

Trino

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

Other application integration scenarios for OData

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

C#

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC

Common Searches: