> 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/quickstart.md). # Quickstart Choose Omniston, Widget, or direct DEX integration and open the guide for your task. Choose how to integrate STON.fi, then open the guide for your task. ## Choose your integration ### Omniston: build your own aggregated swap flow Use Omniston to add swaps to your own interface, bot, or service. One integration gives you streaming quotes, liquidity aggregation, and settlement for TON and cross-chain swaps. * [TypeScript and JavaScript](/developer-section/omniston/sdk/nodejs.md): frontend, backend, bots, and scripts using the base SDK. * [React](/developer-section/omniston/sdk/react.md): providers and hooks for quotes, settlement, and tracking. Each guide covers the quote-to-settlement flow and links to wallet integration for TON, EVM, and TRON. #### Server integration with gRPC Use gRPC for backend services that need direct protocol access or clients in languages other than JavaScript and TypeScript. Generate typed clients from the [protobuf definitions](https://github.com/ston-fi/omniston-sdk/tree/main/packages/omniston-sdk/src/api/proto), then implement quote streams, settlement requests, and result tracking. This path requires more integration work than the SDK: your service manages the generated clients, stream lifecycle, and protocol messages. Start with the [gRPC API guide](/developer-section/omniston/swap/grpc.md) for client generation and the quote-to-settlement flow. For JSON-RPC over WebSocket, use the [WebSocket API guide](/developer-section/omniston/swap/overview.md). ### Widget: add a ready-made swap interface Use the Widget to embed a configurable TON swap interface with wallet connection and quote selection. Start with [Integration and configuration](/developer-section/widget/widget.md) for installation, embedding, TonConnect modes, themes, and fees. ### DEX: interact directly with STON.fi pools Use the DEX SDK for direct pool swaps, liquidity management, and LP farming on TON. * [Swap](/developer-section/dex/sdk/swap.md): simulate a swap and build its transaction. * [Add liquidity](/developer-section/dex/sdk/provide-liquidity.md): deposit assets and receive LP tokens. * [Withdraw liquidity](/developer-section/dex/sdk/burn-lp-tokens.md): burn LP tokens to receive the underlying assets. * [Farm](/developer-section/dex/sdk/farm.md): stake LP tokens, claim rewards, and manage your position NFT. For deposits held in an LP account, use [Recover pending liquidity](/developer-section/dex/sdk/refund-liquidity.md). ## Other developer paths * [Resolver integration](/developer-section/omniston/resolvers.md): provide quotes and liquidity to Omniston. * [DEX REST API](/developer-section/dex/api.md): query assets, pools, wallets, simulation, and statistics. * [Omniston History](/developer-section/omniston/history.md): query finalized orders and reporting data. ## Before you integrate * Select your [Omniston environment](/developer-section/omniston/environments.md) or follow [DEX setup](/developer-section/dex/sdk/v2.md). * Find network identifiers and token addresses in [Supported chains and assets](/developer-section/omniston/chains.md). * Prepare your wallet integration. [TON Basics](/developer-section/common.md) covers TON wallets, jettons, and transaction sending. ## Existing integration See [Omniston Versions and migrations](/developer-section/omniston/migration.md) or [DEX Versions and migrations](/developer-section/dex/migration.md) for upgrade paths. --- # 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/quickstart.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.