Skip to main content

Backend Integration

Backend integration means interacting with Boros through its REST API and TypeScript SDK rather than calling contracts directly. This is the recommended path for most integrators: the API handles calldata generation, signature encoding, and on-chain submission, so you can build trading workflows without managing ABI encoding or gas mechanics yourself.


Services

All services are hosted under https://api.boros.finance, except the new Open API mount, which lives at https://api-boros.pendle.finance/apis/.

ServicePath / BasePurpose
Open APIhttps://api-boros.pendle.finance/apis/v1/interactive docs: api-boros.pendle.finance/apis/docsMarket data, calldata generation, account queries, simulations
Send Txs Bot/send-txs-bot/v2/ (programmatic) or /v3/ (browser session)Receives agent-signed calldatas, submits them on-chain, charges gas from user's gas balance
Stop Order/stop-order/v1/ to /v4/Off-chain conditional order (take-profit/stop-loss) management
Open API URL migration

The redesigned Open API at api-boros.pendle.finance/apis/ is the canonical location for all integrations. The interactive docs live at api-boros.pendle.finance/apis/docs.

The legacy mount at https://api.boros.finance/open-api/v1/ (and /v2/) — and its docs at https://api.boros.finance/open-api/docs — are deprecated. They are still served for older clients but no longer maintained, and new endpoints (e.g. /v1/indicators, /v1/incentives/*, /v1/market-acc/encode) are only on the new mount.


Request Flow

Boros uses a two-track signing model. Sensitive account actions are signed by the root wallet and sent directly to the blockchain. Non-sensitive trading actions are signed by an agent wallet and routed through the Send Txs Bot, which manages gas, nonce, and submission.

Root wallet  ──[sensitive: deposit / withdraw / approve-agent]──▶  Blockchain (direct)
Agent wallet ──[non-sensitive: place / cancel / transfer]──────▶ Send Txs Bot ──▶ Blockchain

The Send Txs Bot charges gas from the user's on-chain gas balance in USD at the actual Arbitrum cost, with no markup.


SDK

The official TypeScript SDK covers signature generation, calldata encoding, and type-safe API calls for all three services.

Install

npm install @pendle/boros-sdk-public

Packages

PackagePurpose
@pendle/boros-sdk-publicMain SDK — API clients, calldata builders, signature helpers
@pendle/boros-offchain-mathMath utilities — FixedX18 type, tick/rate conversion

Links


What's in This Section

PageContents
GlossaryKey terms and type definitions used throughout the API
AgentSetting up and managing agent wallets
SDKTypeScript wrapper (@pendle/boros-sdk-public) — calldata, signing, and dispatch for Node clients
APIFull REST endpoint reference and integration workflows
WebSocketReal-time market and account data streaming
Best PracticesPatterns for gas efficiency, error handling, and market management
Stop OrdersConditional take-profit and stop-loss order management
Historical DataMonthly NDJSON exports — trades, OHLCV, settlements, order book snapshots
IndicatorsIndicator letter codes (u, fp, fgi, ap, udma) and CSV export
Computing UnitsHow endpoint cost is reported and the static / dynamic CU model
Bot QuickstartEnd-to-end zero-to-functional grid bot — capstone that stitches the pages above into one runnable journey
API MigrationEndpoint mapping from the legacy /open-api/* and internal /core/* mounts to the redesigned /apis/v1/* API