HEYQUANT / DOCUMENTATION

Quickstart

Install the SDK from the public repository and discover datasets.

Install the client

The client is in early preview. Install in editable mode from the public repository. Python 3.11 or later is required.

git clone https://github.com/heyroute-ai/heyquant.git
cd heyquant
python -m pip install -e .

Configure access

Obtain a valid service URL and API key from your service provider before making requests. This website does not issue keys. Set HEYQUANT_BASE_URL and HEYQUANT_API_KEY in your environment. Never commit real keys or paste them into public examples.

Make your first request

Use a context manager to close connections automatically. list_datasets() returns server JSON; this guide does not assume its complete structure.

import os
from heyquant import HeyQuantClient

with HeyQuantClient(
    base_url=os.environ["HEYQUANT_BASE_URL"],
    api_key=os.environ["HEYQUANT_API_KEY"],
) as client:
    print(client.list_datasets())

Next steps

Explore queries or learn about exports. Without service access, you can still explore the synthetic homepage demo.