01 / OVERVIEW
Designed around the real API contract.
The SDK source lives at sdk/typescript in the Tidelight mother repository. It currently supports tokenized equity instrument listing and pagination, company research jobs (start, status, cancellation, bounded polling), and project webhook management and delivery history.
Use it from trusted server environments that can protect an API key. The API applies the same project authorization, scopes, quotas, and request accounting as direct REST calls.
02 / QUICKSTART
Install or build from source.
The npm package is ready to install. For a source checkout, clone the mother repository and run the SDK tests.
import { TidelightClient } from "@tidelight/sdk";
const client = new TidelightClient({
apiKey: process.env.TIDELIGHT_API_KEY!,
});
const page = await client.listTokenizedEquities({
limit: 20,
underlyingTicker: "AAPL",
});
for (const instrument of page.data) {
console.log(instrument.symbol, instrument.underlying_ticker);
}Authentication stays on your server. Set TIDELIGHT_API_KEY in your server environment. Never expose it in browser bundles, public examples, or client-side React components.
03 / API SURFACE
Supported operations
listTokenizedEquities(options?)Returns a typed page of supported rToken instruments.tokenizedEquities(options?)Iterates through pages with a typed async iterator.startCompanyResearch(ticker, idempotencyKey)Starts an asynchronous company research snapshot.getResearchJob(id) · cancelResearchJob(id)Checks job status or requests cancellation.waitForResearchJob(id, options?)Polls with a caller-bounded interval and timeout.createWebhook · listWebhookDeliveriesManages supported research event subscriptions.For exact field schemas and endpoint behavior, use the current API reference and OpenAPI contract.
04 / COMPATIBILITY
Runtime compatibility, stated precisely.
Node.js 22 is the runtime exercised by package CI. The npm release is available below; a broader runtime matrix and formal semver support window have not been announced.
05 / SECURITY & TRUST
Bounded behavior, protected credentials.
- API keys are supplied by the caller and must remain in trusted server code.
- Network errors, 429, and transient 5xx responses receive at most two bounded retries by default.
- Requests have a 10-second default timeout.
- Webhook mutations are not automatically retried because the API does not accept webhook idempotency keys.
- Errors include the HTTP status, API error code, and request ID for diagnosis.
RELEASE / LIVE REGISTRY
Published release details
Version, installation, registry status, and archive details below are refreshed from the public registry.
Official Tidelight TypeScript SDK
npm install @tidelight/sdk@0.1.1