> For the complete documentation index, see [llms.txt](https://docs.ston.fi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ston.fi/developer-section/omniston/sdk.md). # SDK integration Compare Omniston SDK packages, find chain-specific integration guides, and explore the example application. The Omniston SDK packages for TypeScript and React provide typed access to the Omniston API. Use them to request quotes, build unsigned transactions or order payloads, and track settlement. Both packages and the React example app are maintained in the [Omniston SDK monorepo](https://github.com/ston-fi/omniston-sdk). If neither package fits your integration stack, use [Direct API integration](/developer-section/omniston/swap.md) to integrate over WebSocket or gRPC in your preferred language. ## SDK packages Choose a package based on your integration stack and how you want to manage requests and subscriptions: | Package | Use it for | Resources | | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `@ston-fi/omniston-sdk` | Core TypeScript SDK for integrations where you manage requests and subscriptions directly, including bots, backend services, and browser clients. Includes types generated from the [Omniston API proto files](https://github.com/ston-fi/stonfi-proto/tree/main/proto/stonfi/omni), WebSocket transport, automatic reconnection, and RxJS-style streaming subscriptions. | [TypeScript and JavaScript guide](/developer-section/omniston/sdk/nodejs.md) · [GitHub](https://github.com/ston-fi/omniston-sdk/tree/main/packages/omniston-sdk) · [npm](https://www.npmjs.com/package/@ston-fi/omniston-sdk) | | `@ston-fi/omniston-sdk-react` | React bindings for the core SDK. Provides `OmnistonProvider` and TanStack Query hooks, with caching and access to request data, loading status, errors, and streaming updates. | [React guide](/developer-section/omniston/sdk/react.md) · [GitHub](https://github.com/ston-fi/omniston-sdk/tree/main/packages/omniston-sdk-react) · [npm](https://www.npmjs.com/package/@ston-fi/omniston-sdk-react) | The React package builds on the base SDK and re-exports its API and types. You can combine hooks with direct calls to the same `Omniston` client. Each guide covers installation, configuration, RFQ, quote acceptance, settlement, and tracking. Your application supplies wallet signing, transaction submission, and persistence. ## Chain-specific requirements Use these guides alongside the SDK to complete the settlement flow on each network. They cover chain-specific asset and address formats, wallet authorization, signing, and submission: * [TON](/developer-section/omniston/sdk/ton.md): transaction builders, message encoding, wallet submission, and identifiers for swap tracking. * [EVM](/developer-section/omniston/sdk/evm.md): wallet kinds, token allowances and permits, and signature formats. * [TRON](/developer-section/omniston/sdk/tron.md): asset and address formats, order settlement, and TRON-specific signing and allowance requirements. ## Example application The maintained React example app illustrates SDK integration with React and Next.js. Explore its source alongside the [React SDK guide](/developer-section/omniston/sdk/react.md): * [Try the live example app](https://omniston.ston.fi) * [Browse the source code on GitHub](https://github.com/ston-fi/omniston-sdk/tree/main/examples/react-app) The example favors concise, readable code and supplies mock asset lists and metadata rather than connecting to third-party data APIs. It is not production-ready. ## References * [Omniston glossary](/developer-section/omniston/glossary.md) * [How Omniston works](/developer-section/omniston/how-omniston-works.md) * [Supported chains and assets](/developer-section/omniston/chains.md) * [Environments and endpoints](/developer-section/omniston/environments.md) * [Direct API integration](/developer-section/omniston/swap.md) * [API model v1beta8](/developer-section/omniston/swap/v1beta8.md) * [Integrator fees](/developer-section/omniston/referral-fees.md) * [History API](/developer-section/omniston/history.md) * [SDK 0.7 to 0.8 migration](/developer-section/omniston/migration/migration-v0.7-to-v0.8.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.ston.fi/developer-section/omniston/sdk.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.