Tidelight Python SDK

Typed access to Tidelight Intelligence Cloud API v1.

Product · API guide · Mother repository

The official Python client supports tokenized-equity market listings, asynchronous company research jobs, and research webhooks. It preserves provider provenance, stable error codes, and request IDs while applying bounded timeouts and retries.

Install

python -m pip install tidelight==0.1.2

Keep the project API key in trusted server code. Market calls require market:read; research calls require research:run; webhook calls require alerts:manage.

Quickstart

import os
from tidelight import Client

client = Client(os.environ["TIDELIGHT_API_KEY"])
page = client.list_tokenized_equities(limit=20, underlying_ticker="AAPL")

for instrument in page.data:
    print(instrument.symbol, instrument.underlying_ticker)

Supported workflows

A tokenized-equity spot instrument is not a direct share or a stock perpetual. When provider terms block a market response, the SDK surfaces provider_terms_unconfirmed without retrying or substituting data.

Reliability and security

The default request timeout is 10 seconds. Network errors, 429, and transient 5xx responses receive at most two bounded retries. Webhook mutations are not automatically retried because the API does not accept webhook idempotency keys. The default transport rejects redirects and restricts bearer credentials to api.tidelight.app.

Webhook creation and secret rotation return a one-time signing secret. TODO: Persist it in your approved secret manager immediately. Do not print it; it cannot be recovered by listing the endpoint.

Build and test from source

python -m pip install -e ./sdk/python
PYTHONPATH=sdk/python/src python -m unittest discover -s sdk/python/tests -v

Canonical source lives in sdk/python in the mother repository. The standalone Python repository is a synchronized source mirror. Make source changes in the mother repository.

Further reading

• API reference
• OpenAPI contract
• Changelog
• Security policy