Hotdata API

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for eddietejeda from gravatar.com eddietejeda Avatar for zac_hotdata from gravatar.com zac_hotdata

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT
  • Author: Hotdata
  • Tags hotdata , api-client , data-platform
  • Requires: Python >=3.9
  • Provides-Extra: arrow
Report project as malware

Project description

hotdata

Official Python client for the Hotdata HTTP API: workspaces, connections, datasets, SQL queries, results, secrets, uploads, indexes, jobs, embedding providers, and workspace context.

Requirements

Python 3.9+

Install

pip install hotdata

For an unreleased revision:

pip install "git+https://github.com/hotdata-dev/sdk-python.git"

From a local checkout (editable):

pip install -e .

Authentication

The API uses an API key sent as Authorization: Bearer <key>, plus an X-Workspace-Id header on requests scoped to a workspace.

import hotdata

configuration = hotdata.Configuration(
    api_key="YOUR_API_KEY",
    workspace_id="YOUR_WORKSPACE_ID",
)

host defaults to https://api.hotdata.dev. Override it if you target another environment.

Usage

import hotdata
from hotdata.rest import ApiException

configuration = hotdata.Configuration(
    api_key="YOUR_API_KEY",
    workspace_id="YOUR_WORKSPACE_ID",
)

with hotdata.ApiClient(configuration) as api_client:
    workspaces = hotdata.WorkspacesApi(api_client)
    try:
        response = workspaces.list_workspaces()
    except ApiException as e:
        print(f"API error: {e.status} {e.reason}\n{e.body}")

Each Api class groups endpoints by resource. Construct the client, then call the typed methods you need.

Arrow results

Query results can be fetched as an Apache Arrow IPC stream instead of JSON, which is faster and far more memory-efficient for large result sets. Install the optional extra:

pip install 'hotdata[arrow]'

Use hotdata.arrow.ResultsApi (a drop-in subclass of ResultsApi that adds Arrow methods):

from hotdata import ApiClient, Configuration
from hotdata.arrow import ResultsApi

with ApiClient(Configuration(api_key="...", workspace_id="...")) as client:
    results = ResultsApi(client)

    # Buffered: returns a pyarrow.Table.
    table = results.get_result_arrow(result_id)

    # Streaming: yields a pyarrow.RecordBatchStreamReader without
    # materializing the full table in memory.
    with results.stream_result_arrow(result_id) as reader:
        for batch in reader:
            ...

Both methods accept offset and limit for pagination. They raise hotdata.arrow.ResultNotReadyError if the result is still pending or processing — poll results.get_result(result_id) until status == "ready" first.

API reference

Generated Markdown for every operation and model is in docs/:

  • Resource APIs: docs/*Api.md (for example QueryApi.md)
  • Request and response models: docs/<ModelName>.md

Support

Questions and issues: github.com/hotdata-dev/sdk-python.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for eddietejeda from gravatar.com eddietejeda Avatar for zac_hotdata from gravatar.com zac_hotdata

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT
  • Author: Hotdata
  • Tags hotdata , api-client , data-platform
  • Requires: Python >=3.9
  • Provides-Extra: arrow

Release history Release notifications | RSS feed

This version

0.2.2

0.2.1

0.2.0

0.1.0

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hotdata-0.2.2.tar.gz (110.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hotdata-0.2.2-py3-none-any.whl (257.3 kB view details)

Uploaded Python 3

File details

Details for the file hotdata-0.2.2.tar.gz.

File metadata

  • Download URL: hotdata-0.2.2.tar.gz
  • Upload date:
  • Size: 110.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hotdata-0.2.2.tar.gz
Algorithm Hash digest
SHA256 0a66c37bc7a53d4ff8cfbd14b77d43402ebbd006a88e84cf321aaafcbb4bd2ab
MD5 9642ab6c00fd47804509637032330010
BLAKE2b-256 f90581988ab357f05621b9258e4f1943d175f28720341e7ac1a98399f22bf24e

See more details on using hashes here.

Provenance

The following attestation bundles were made for hotdata-0.2.2.tar.gz:

Publisher: publish.yml on hotdata-dev/sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hotdata-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: hotdata-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 257.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hotdata-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 06882d99df7f6828b21aed3a66a560b7f65f3cdd368b5916a65c166c75d60a62
MD5 7f101e8a0f76c0e591d78f148066768f
BLAKE2b-256 3f2bbeb0422d82e4d15d9639d4d27be5487af591cf16dbbc94fe83c5b597e2f2

See more details on using hashes here.

Provenance

The following attestation bundles were made for hotdata-0.2.2-py3-none-any.whl:

Publisher: publish.yml on hotdata-dev/sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page