Authentication

Bigdata.com provides two Python SDKs:

You can log in either with a username and password or with an API key. First of all, we recommend to create a file with environment variables to specify your credentials.

Username and password
API Key

The username and password are the same you use to log in to the Bigdata App.

import os
from bigdata_client import Bigdata

# Initialize the Bigdata API
username = os.environ.get("BIGDATA_USERNAME")
password = os.environ.get("BIGDATA_PASSWORD")
bigdata = Bigdata(username, password)

You can create your API Keys in the Developer Platform > API Keys

Then, you can save it in your environment variables and instantiate the Bigdata class with the the following code:

import os
from bigdata_client import Bigdata

# Initialize the Bigdata API
my_api_key = os.environ.get("BIGDATA_API_KEY")
bigdata = Bigdata(api_key=my_api_key)

API keys is not supported for interacting with the bigdata.uploads service yet.

The default constructor of Bigdata will read the environment variables and use them to authenticate. API keys take precedence over the username and password.

Search

Query unified financial intelligence across premium sources and your own data through one API.

Research Agent (API only)

Create intelligent assistants that combine web and premium data with your proprietary content for deeper insights and productivity.

Chat Service (SDK only)

(Sunsetting) This is the former version of the Research Agent. It is still available in the SDK for backward compatibility, but it is recommended to use the Research Agent API instead.

Environment Variables

Introduction

Research Service

Search

Research Agent (API only)

Chat Service (SDK only)