01 / OVERVIEW
Python access to the supported API surface.
The client source lives at sdk/python in the Tidelight mother repository. It supports tokenized-equity instrument listing and pagination, asynchronous company research jobs, and research-job webhook management and delivery history.
It does not expose strategies, scenarios, trading, account administration, or a generic HTTP passthrough. API authorization and provider availability are enforced by Tidelight services.
02 / QUICKSTART
Install from PyPI or build from source.
Install the published distribution with python -m pip install tidelight. The source setup below installs from the mother repository; the market and research examples use the current client methods.
git clone https://github.com/TidelightOrg/tidelight.git
cd tidelight
python -m venv .venv
. .venv/bin/activate
pip install -e ./sdk/python
cd sdk/python && PYTHONPATH=src python -m unittest discover -s tests -vKeep credentials in a trusted server environment. Set TIDELIGHT_API_KEY outside source control and never include it in notebooks, public logs, or client-side applications.
03 / API SURFACE
Supported operations
list_tokenized_equities(...)Returns paginated typed instrument results with source and underlying mapping; requires market:read.tokenized_equities(...)Iterates through the supported instrument pages.start_company_research(ticker, key)Creates a research job with a caller-provided idempotency key; requires research:run.get_research_job(id) · cancel_research_job(id)Reads status or requests cancellation for a supported job.wait_for_research_job(id, ...)Polls at a bounded interval and timeout.create_webhook · update_webhook · list_webhook_deliveriesManages supported research event subscriptions with alerts:manage; signing secrets are returned once.For the exact request and response schema, see the API reference and OpenAPI contract.
04 / COMPATIBILITY
Runtime compatibility, stated precisely.
The project declares Python >=3.10; CI currently exercises Python 3.10 and 3.12. No public compatibility or support window has been announced.
05 / SECURITY & TRUST
Server-side use with bounded transport.
- Keys are caller-supplied and kept in process memory; the SDK does not persist credentials.
- Remote HTTPS requests are limited to
api.tidelight.app; redirects are not followed. HTTP is allowed only for local development hosts. - Network errors, 429, and transient 5xx responses receive at most two retries by default, except
provider_terms_unconfirmed, which is returned immediately. - Requests have a 10-second default timeout; polling is bounded to 10 minutes.
- Webhook mutations are not retried without server idempotency support; signing secrets must be stored securely by the caller.
Provider redistribution terms are not confirmed. Market calls may return provider_terms_unconfirmed; there is no fallback source. Project scopes, tenant ownership, and quotas remain authoritative at the API boundary.
RELEASE / LIVE REGISTRY
Published release details
Version, installation, registry status, and archive details below are refreshed from the public registry.
Official Tidelight Intelligence Cloud Python client
python -m pip install tidelight==0.1.1