Use the TypeScript or Python client to integrate with the Klineo Liquidity Operating System v2. Both provide generated request and response types, scoped authentication, exact resource versions, pagination, and deterministic sandbox study operations.
TypeScript & JavaScript
ESM client for Node.js and approved browser integrations. Compiled JavaScript and TypeScript declarations, with no runtime dependencies.
PYPython
Typed Python 3.11+ client using the standard library. Installable package, explicit timeouts, and structured transport errors.
Source repositories#
| SDK | SDK version | Source project | Download |
|---|---|---|---|
| TypeScript / JavaScript | 2.1.0 | klineo-typescript-sdk | Complete source archive |
| Python | 2.1.0 | klineo-python-sdk | Complete source archive |
Each project includes source, package metadata, runnable examples, transport tests, CI, and a release artifact workflow. Install from a reviewed source checkout or build a local package. npm and PyPI registry publication are separate release steps; the presence of a package name does not mean it is currently available on a registry.
The SDK source is public for review and remains proprietary, with all rights reserved. Obtain usage permission from Klineo-Ecosystem before using, modifying, or redistributing it. The repositories and downloads include the applicable license text.
Choose an integration#
Use TypeScript for Node.js services, JavaScript applications, and integrations that already use the Fetch API. The client supports an injected fetch, cancellation signals, and an optional response observer for signed download metadata.
Use Python for backend jobs, research tools, notebooks, and applications that want a standard-library HTTP client. The client supports typed operation inputs, explicit timeouts, structured errors, and response metadata observation.
Both clients expose the complete v2 contract. Their methods carry the same server-side restrictions: some operations are public, some accept scoped service credentials, and authority changes require an authorized interactive session. A generated method does not grant permission to call an endpoint.
Get started#
- Choose the approved environment and obtain its API base URL from your administrator.
- Read installation and build your selected SDK.
- Set your organization binding and scoped credentials according to authentication.
- Run the quickstart to read an authorized resource or submit a noncustodial sandbox study.
- Consult the API reference for exact fields, scopes, responses, and version preconditions.
Neither SDK stores issuer Safe keys, signs transactions, or bypasses approval, simulation, timelocks, policy checks, or onchain controls. Read the security guide before connecting an application to financial workflows.
API versions#
The two SDK 2.1.0 packages target API v2, contract version 2.0.0, whose current OpenAPI JSON contains 238 operations and 332 schemas. SDK and API versions identify different artifacts; upgrading the client does not change the /api/liquidity-studio/v2 base path.
Compared with SDK 2.0.0, SDK 2.1.0 adds getPartnerPreparationReceiptRecovery (get_partner_preparation_receipt_recovery in Python) and the PartnerPreparationReceipt and PartnerPreparationReceiptRecovery response types. See the changelog for the contract refresh and recovery limits.
The documentation also includes the v1 application API reference for existing Studio integrations. V1 and v2 resource models are distinct; use the matching base path and schema.