HEYQUANT / DOCUMENTATION

Python SDK reference

Public client methods, parameters and return behavior.

Installation and compatibility

Install from the public repository using the quickstart. The project requires Python 3.11+ and uses httpx for synchronous HTTP requests.

Client interface

Method	Behavior	Returns
`list_datasets()`	GET /datasets	JSON, typed as Any
`query(sql)`	POST /query	JSON, typed as Any
`create_export(dataset, *, symbols, start_date, end_date, format="parquet")`	POST /exports	JSON, typed as Any
`download(download_url, destination)`	Stream to a path or binary file	None
`close()`	Close the HTTP connection	None

Connection settings

The constructor takes base_url, an optional api_key, and keyword-only timeout=30.0. Context managers are supported. There is no public asynchronous client.

Error types

HeyQuantError extends RuntimeError and wraps HTTP status errors. Network, timeout, JSON parsing and file-writing errors are not uniformly wrapped by it. See error handling.

Source

Read the public client source. This page describes the client interface, not a guarantee that every service capability is publicly available.