Skip to main content

Documentation Index

Fetch the complete documentation index at: https://staging-docs.orderly.network/llms.txt

Use this file to discover all available pages before exploring further.

The Orderly Module Marketplace lets DEX builders install ready-made trading features, build custom modules, and publish them for other builders to use. Modules are built on top of the Orderly SDK and the Orderly REST/WebSocket API.
Terminology: A module is the complete feature you ship. It includes a plugin (the frontend UI that plugs into your DEX) and optionally a builder-hosted backend service for persistent logic.

​
Live Modules

Browse existing modules for inspiration or install them directly into your DEX. Builders and AI agents can also explore modules through orderly-devkit. Please test thoroughly in your own environment before deploying to production.
ModuleDescriptionBuildernpmDemoSource
OnramperFiat-to-crypto on-ramp — adds a Buy Crypto tab to the Transfer dialog (Deposit → Buy Crypto)Orderly@orderly.network/onramper-plugindemoGitHub
Fast Place OrderDraggable quick-order widget for one-click market buy/sellOrderly@orderly.network/fast-place-order-plugindemoGitHub
OrderBook ShimmerDesktop orderbook shimmer/flash effectOrderly@orderly.network/orderbook-shimmer-plugindemoGitHub

​
Install a Module

Install the npm package and register it in your OrderlyAppProvider: 
npm install @orderly.network/onramper-plugin

import { OrderlyAppProvider } from "@orderly.network/react-app";
import { registerOnramperPlugin } from "@orderly.network/onramper-plugin";

<OrderlyAppProvider
  brokerId="your-broker-id"
  networkId="mainnet"
  plugins={[registerOnramperPlugin()]}
>
  <TradingPage />
</OrderlyAppProvider>
Each module’s source repo includes specific configuration options. For more integration patterns, see the integration guide.

​
Build Your Own

The plugin system requires Orderly SDK v3.0.0 or above.

​
What you can build

Modules can range from simple UI enhancements to full-stack trading strategies. The SDK plugin system handles the frontend; the Orderly REST and WebSocket API handles the trading infrastructure. Builders decide how to combine them. Frontend-only modules — everything runs client-side in the browser, no builder-hosted server needed. Your plugin can use SDK hooks, call the Orderly REST and WebSocket API directly (the SDK provides the authenticated context), or embed third-party services. Build using the SDK’s plugin system to ensure your module stays compatible across SDK upgrades and is shareable with other builders. See the Plugin Developer Handbook for the full development guide. For example:
  • Custom UI and styling enhancements
  • Analytics dashboard, market screener, leaderboard
  • Social PnL sharing, notification widgets
  • Custom deposit/withdraw UI, portfolio visualization
  • Third-party service integrations
Modules with your own backend — a frontend plugin provides the user-facing UI, while your backend service handles persistent logic that outlives a browser session (e.g. strategy execution, scheduled orders, cross-user features) by talking directly to the Orderly REST and WebSocket API. For example:
  • TWAP, Grid Bot, DCA
  • Copy Trading, Portfolio Rebalancer
  • Alert / notification system

​
Plugin developer toolchain

The following tools are for building the frontend plugin portion of your module. If you use an AI coding agent (Cursor, Claude Code, Codex, etc.), install the plugin skills and MCP server alongside the CLI for guided workflows.
ToolWhat it doesInstall
orderly-devkit CLIScaffold, build, and submit pluginspnpm add -g @orderly.network/devkit
Plugin agent skillsGuided workflows for AI coding agents (create → write → integrate → submit)orderly-devkit skills install
SDK Docs MCPQuery Orderly SDK docs from your agentorderly-devkit mcp install
For the full development guide, see the Plugin Developer Handbook. If you use an AI coding agent, start with the skills-first workflow.

​
Connect your backend (if needed)

If your module needs persistent logic beyond the browser session, you can run your own backend service. How you design it is up to you — your backend can call the Orderly REST and WebSocket API, run its own logic, or both. See the API reference in the sidebar for details.

​
List on the Module Marketplace

Once your module is published to npm, you can submit it for listing on the Module Marketplace. Follow the Marketplace submission tutorial to get started. Why list your module:
  • Distribution — listed modules appear across Orderly-powered UIs, giving your module instant reach
  • Discoverability — builders and AI agents can explore and install modules through orderly-devkit, making your work easy to find and adopt
  • Monetization — modules that provide a service can monetize through their own business model (e.g. transaction fees, subscriptions, or profit sharing through the module’s backend)