> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bigdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Authentication

<Warning>
  We are sunsetting our SDKs and will no longer add new features, security patches, bug fixes, or technical support for them. To access the latest capabilities and ongoing improvements, we encourage you to migrate to our [RESTful API](/api-rest/introduction).

  SDK support will officially end on **December 31, 2026**. On this date, the underlying endpoints used by the SDKs and related documentation will be decommissioned.

  To avoid any disruption to your services, please ensure your migration is complete by that date.

  For migration assistance, please contact us at [support@bigdata.com](mailto:support@bigdata.com).
</Warning>

Bigdata.com provides two Python SDKs:

* [bigdata-client](https://pypi.org/project/bigdata-client/)
* [bigdata-research-tools](https://github.com/Bigdata-com/bigdata-research-tools?tab=readme-ov-file#bigdata-research-tools---user-guide)

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](./environment_variables) to specify your credentials.

<Tabs>
  <Tab title="Username and password">
    The username and password are the same you use to log in to the Bigdata App.

    ```python highlight={5-7} theme={null}
    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)
    ```
  </Tab>

  <Tab title="API Key">
    You can create your API Keys in the [Developer Platform > API Keys](https://platform.bigdata.com/api-keys)

    <img src="https://mintcdn.com/ravenpackinternational/f62VnqoeoLD7OgQl/images/authentication/api_key_settings.png?fit=max&auto=format&n=f62VnqoeoLD7OgQl&q=85&s=cf16d5701fa628a8ec548137caa2fa18" alt="Developer Platform > API Keys" data-og-width="1536" width="1536" data-og-height="689" height="689" data-path="images/authentication/api_key_settings.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/ravenpackinternational/f62VnqoeoLD7OgQl/images/authentication/api_key_settings.png?w=280&fit=max&auto=format&n=f62VnqoeoLD7OgQl&q=85&s=8cc7a63e03af48aaa3cb5d1f4d697128 280w, https://mintcdn.com/ravenpackinternational/f62VnqoeoLD7OgQl/images/authentication/api_key_settings.png?w=560&fit=max&auto=format&n=f62VnqoeoLD7OgQl&q=85&s=1c74493718b528caf178749e536dc404 560w, https://mintcdn.com/ravenpackinternational/f62VnqoeoLD7OgQl/images/authentication/api_key_settings.png?w=840&fit=max&auto=format&n=f62VnqoeoLD7OgQl&q=85&s=53a485901a8d4ea94b9d1c689d9255c4 840w, https://mintcdn.com/ravenpackinternational/f62VnqoeoLD7OgQl/images/authentication/api_key_settings.png?w=1100&fit=max&auto=format&n=f62VnqoeoLD7OgQl&q=85&s=62c0768c1fbdcf18d17f9331b381ad4c 1100w, https://mintcdn.com/ravenpackinternational/f62VnqoeoLD7OgQl/images/authentication/api_key_settings.png?w=1650&fit=max&auto=format&n=f62VnqoeoLD7OgQl&q=85&s=ef7be32d0790f9e1a1a9b2f03a8fe709 1650w, https://mintcdn.com/ravenpackinternational/f62VnqoeoLD7OgQl/images/authentication/api_key_settings.png?w=2500&fit=max&auto=format&n=f62VnqoeoLD7OgQl&q=85&s=1311b4ec9fe05b5d341614768ceed10f 2500w" />

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

    ```python highlight={5-6} theme={null}
    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)
    ```

    <Warning>
      API keys is not supported for interacting with the `bigdata.uploads` service yet.
    </Warning>
  </Tab>
</Tabs>

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

<CardGroup cols={1} className="max-w-screen-lg mx-8">
  <Card title="Search" icon="magnifying-glass-dollar" horizontal="True" href="/getting-started/quickstart_guide">
    Query unified financial intelligence across premium sources and your own data through one API.
  </Card>

  <Card title="Research Agent (API only)" icon="messages" horizontal="True" href="/getting-started/quickstart_guide_research_agent">
    Create intelligent assistants that combine web and premium data with your proprietary content for deeper insights and productivity.
  </Card>

  <Card title="Chat Service (SDK only)" icon="comments-dollar" horizontal="True" href="/getting-started/quickstart_guide_chat">
    (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.
  </Card>
</CardGroup>
