Build integrations for token liquidity research, deterministic simulations, and reviewed operating decisions with KlineO Liquidity Studio.
KlineO brings market observations, issuer objectives, strategy definitions, treasury evidence, and decision records into an organization workspace. The API gives your application access to the same records and evidence used by the web application. The TypeScript and Python SDKs provide named methods, request types, authentication headers, and structured errors for the v2 API.
What you can build#
| Integration | Starting point |
|---|---|
| A dashboard that reads market quality, alerts, or execution receipts | Use the corresponding read scope and list methods. |
| A service that compares liquidity scenarios | Run a deterministic study and inspect its recorded inputs and results. |
| A strategy preparation workflow | Validate a declarative strategy, compile policy intent, and prepare evidence for review. |
| A reporting integration | Read authorized proof records and download supported report artifacts. |
| An event consumer | Subscribe to supported webhooks and verify signed deliveries. |
SDK method coverage does not grant permission to every operation. Public source inspection, organization reads, evidence preparation, and authority changes each have their own admission requirements. See authentication and service scopes before choosing credentials.
How the workflow fits together#
- Observe. Inspect supported public project sources or read authorized workspace observations. Keep the source, timestamp, and freshness of an observation with the result you display.
- Define. Express liquidity objectives as an issuer intent: trade size, usable depth, slippage tolerance, reserves, capital ceiling, and prohibited behaviors.
- Simulate. Compare plan variants using explicit scenario inputs and a fixed seed. A study records the inputs, lineage, evidence commitments, and modeled result.
- Review. Prepare strategies, policies, and decision records for the relevant workspace roles. A recommendation or prepared proposal does not itself move assets.
- Operate and verify. When a deployment has the required contracts, providers, authorization, and runtime configuration, admitted operations can progress through their execution workflow. Receipts and reconciled evidence describe what occurred.
Read platform overview for the application journey, liquidity mechanics for the financial model, and decisions for the review and execution boundaries.
Start with a scoped integration#
The shortest path is a server-side integration with an organization-bound API key and scores:read. Install an SDK, set your environment's API URL and organization ID, then request one page of scores. An empty collection is a valid result for a workspace that has no score records yet.
The quickstart includes both languages and a complete optional sandbox study. The sandbox persists deterministic evidence with SANDBOX source lineage. It grants no custody, signing, or execution authority, and its results are marked INELIGIBLE_SANDBOX for publication admission.
Choose your SDK#
| SDK | Package and import | Runtime | Guide |
|---|---|---|---|
| TypeScript | @klineo/liquidity-os-sdk |
Node.js 22.18 or newer | TypeScript SDK |
| Python | klineo-liquidity-os; import klineo_liquidity_os |
Python 3.11 or newer | Python SDK |
Both clients use the same generated OpenAPI contract. TypeScript uses the platform fetch API. Python uses the standard library and has no runtime package dependencies. The SDKs carry API requests; they do not hold issuer Safe keys or sign transactions.
Installation explains source and local package installation. Package registry publication is a separate release step; these guides do not assume that an npm or PyPI release is available.
API version and environment#
Set your API base URL to the v2 API root supplied for your environment, ending in /api/liquidity-studio/v2. SDK methods append paths such as /scores and /sandbox/studies; do not add those resource paths to the base URL.
The API serves its generated contract at GET /openapi.json under that root. API overview explains request conventions and links to the reference. Use the schema served by your target environment when checking compatibility.
Runtime availability is specific to a deployment. The source configuration targets BOT testnet and defaults runtime activation, automated execution, new-vault funding, and operated workers to disabled. Documentation of an operation does not establish that it is enabled in your environment. Review the roadmap and security model for capability status and trust boundaries.
Keep evidence in your integration#
Treat monetary atomic amounts as decimal strings and percentages in pips as integers. Keep record IDs, resourceVersion, artifactHash, and source timestamps when persisting integration results. These fields connect a later decision to the exact evidence that was reviewed.
When a mutation requires If-Match, submit the current strong resource version. Use an idempotency key for a single intended mutation and retain that key for retries. The idempotency guide and error guide explain how to recover from stale records and uncertain responses.
Continue with installation, then run the quickstart.