# Welcome to Panora
The Super App of Aptos
[Panora](https://panora.exchange/) is the Super App of Aptos offering an all-in-one trading platform designed to provide users with the best rates and routes for their trades. Our mission is to redefine DeFi trading through:
* Superior execution
* Streamlined user experiences
* Intelligent liquidity routing
Panora's current product suite consists of:
1. **Swap:**
* A Meta-DEX Aggregator that consolidates 100% on-chain liquidity from AMMs, CLAMMs, CLOBs, LSDs, and also other DEX aggregators.
* Offers the best trading rates through advanced routing strategies, including multi-hop and transaction splitting.
2. **Flows:**
* Unifies bridge and DEX aggregation in one sleek, intuitive interface empowering users to move and swap assets across 10+ blockchains into Aptos with ease.
3. **Limit Orders:**
* Panora’s Limit Orders bring precision and control to on-chain trading. Instead of constantly watching the market, users can set buy or sell orders at their preferred price points.
* Once the market reaches the target price, the order executes automatically on-chain, without relying on custodians or third parties.
4. **Dollar Cost Averaging (DCA):**
* Panora’s DCA product makes disciplined investing simple. Users can schedule recurring buys of a token at regular intervals, spreading their entry across time instead of entering the market all at once.
* By automating the execution directly on-chain, DCA helps smooth out volatility and reduces the stress of market timing. Each scheduled purchase is routed through Panora’s aggregator, ensuring the best available execution across Aptos liquidity.
5. **Terminal:**
* Aptos' all-in-one command center for data analytics and quick trading. It combines advanced on-chain insights, real-time data feeds, and swap execution into a single powerful interface with integrated portfolio view and best-rate swap execution via Panora Swap.
6. **Developer Toolkit:**
* Developer-friendly APIs and SDKs for the entire Panora product suite, including Aptos token list and price feeds - everything one needs to build on top of Aptos .
\
Built on the Aptos blockchain, Panora leverages its proprietary routing algorithms to provide best rates, efficient execution, minimal price impact, and near-instant finality, all of it at 0 network gas fees.
# Official Links
Website:
App: [https://app.panora.exchange](https://app.panora.exchange/swap)
X:
Discord:
Telegram Chat:
Telegram Announcements:
Medium:
LinkedIn:
Documentation:
Github:
Brand Kit:
# Swap
The superior swapping experience
Panora's Swap Aggregator provides seamless access to the best prices and liquidity across multiple liquidity sources. It intelligently aggregates:
* AMM DEXs
* On-Chain Orderbooks
* DEX Aggregators
This allows users to get the most optimal swap routes and reduce trading costs, making complex DeFi strategies accessible and profitable.
#### **Key Features:**
1. **Optimal Routing**:
* Finds the best trading paths using its proprietary routing algorithm to get the best rates across Aptos.
2. **Transaction Splitting**:
* Splits large trades across multiple DEXs to optimize price and minimize impact on liquidity pools.
3. **Multi-Hop Functionality**:
* Executes complex trades across different tokens and DEXs in one transaction, reducing time and price impact.
4. **User-Centric Design**:
* Clean interface with advanced filtering, allowing even novice users to trade like professionals.
#### **Why Choose Panora Swap?**
With integrations across 100% on-chain liquidity venues of Aptos, and support for **5+ wallets** in the Aptos ecosystem, Panora offers an unmatched trading experience by balancing efficiency, transparency, and ease of use. Our platform is designed to handle any trading scenario - from basic swaps to complex arbitrage - while maintaining high performance and security.
**Fees:** Currently, Panora takes 0 fees on swaps done via the Panora frontend. Panora earns via revenue kickback, integrator fee share from certain DEX's, and surplus sharing. These are not extra fee on top of the DEX themselves. We also integrate sources with no fee sharing, and in those cases we don't make any money while routing through them.
Alongwith surplus sharing, Panora levies an infrastructure fee on certain API keys. Any fee levied will be reflected in swap API response and quotes displayed would be post fee and surplus share, if any. There aren't any additional Panora swap fees currently. This policy is subject to change, and any new fee categories or adjustments will be reflected here.
# Limit
Trade On Your Own Terms
## Introduction
**Panora Limit Orders** give you full control over your trading strategy. Set your desired token prices in advance, and once market conditions meet your criteria, the trade is executed directly on-chain by Panora’s decentralized network of executors. You can easily place, update, or cancel limit orders at no additional cost using Panora’s intuitive interface.
**No need to constantly watch the markets or wait for the perfect moment.**\
Panora executes your trades automatically when market conditions meet your preset price, and in some cases, you may even receive more tokens than anticipated. Most importantly, your assets remain fully in your control until a suitable match is found and the trade is finalized.\
\
The [Panora Interface](https://app.panora.exchange/limit) offers a streamlined interface to create, adjust, and monitor all your limit orders with ease.
## User Guide
**These guides are built for traders who prefer a hands-off approach to market execution.**\
By setting specific price targets, users can let their trades trigger automatically—no constant monitoring needed. [Panora Interface](https://app.panora.exchange/limit) offers a clean and user-friendly dashboard to keep track of all active and historical orders with ease.
Connect Wallet
* To begin, connect your wallet using the **“Connect”** button located at the top-right corner of the interface, or directly through the **“Connect Wallet”** option within the DCA widget.
Create a Limit Order
**Step 1: Select token pair**
You can either do this manually using the individual token selection buttons on the limit screen or by searching for your desired token pair using the search field.
#### **Step 2**: Configure your order amount
Specify the amount you would like to offer by typing in an amount manually into the “You Selling” field. Please ensure that your wallet balance is sufficient to cover the order amount.
#### **Step 3**: Configure your order price
Set the price by manually entering a price at the rate field. This will calculate an estimate of the amount you should receive in the “You're Buying” field. Panora will provide you with a percentage estimate of how much more favorable/unfavorable to you (the market maker) the specified price is relative to the current market price.
#### **Step 4**: Specify the time limit of your order
If your order is not filled by the end of this time limit, it will be automatically cancelled. You can either select from a list of set times or specify a custom expiry time and date. Note that you can still manually cancel your order (or any unfilled portion of your order) before it expires.
#### **Step 5**: Review and confirm your order
Once you are satisfied with the details of the limit order, click “Create Order” to proceed.
Once the order has been confirmed you should see it appear in the Active Orders screen of the limit interface.
Note: When your order is *completely* filled it will be moved to the Completed tab of this interface.
Cancel a Limit Order
Find the active limit order you would like to cancel and click on its red Cancel button.
**Fees:** Currently, 1% fees are levied for Limit orders on the Panora interface.
# DCA
## Introduction
Panora DCA Orders help you invest smarter, consistently.
\
Set up recurring token purchases at fixed intervals and let Panora handle the rest — automatically and on-chain. Whether you're entering a volatile market or building a long-term position, DCA smooths out price fluctuations over time and removes the pressure of market timing.
With Panora’s decentralized network of executors, your DCA orders are executed reliably and securely without needing constant supervision. You retain full custody of your assets until each scheduled order is triggered and settled directly on-chain.
You can easily configure the amount, frequency, and duration of your DCA strategy — or cancel through [*Panora’s intuitive interface*](https://app.panora.exchange/dca).
## User Guide
These guides are designed for traders who prefer a hands-off, consistent investment strategy.
\
By scheduling recurring token purchases, users can steadily build their position over time—no need to constantly watch the markets. The Panora Interface provides a clean and intuitive dashboard to easily manage, track, and adjust all active and past DCA orders. of all active and historical orders with ease.
Connect Wallet
* To begin, connect your wallet using the **“Connect”** button located at the top-right corner of the interface, or directly through the **“Connect Wallet”** option within the DCA widget.
Create DCA Order
**Step 1: Select token pair**
You can either do this manually using the individual token selection buttons on the dca screen or by searching for your desired token pair using the search field.
**Step 2: Configure your order amount**
Specify the amount you would like to offer by typing in an amount manually into the "Selling” field. Please ensure that your wallet balance is sufficient to cover the order amount.
**Step 3: Configure your price range**
To add custom price range, click on the gear button at the top right section of the dca widget and enable the pricing strategy option
**Step 4: Set DCA Interval**
Choose how frequently you want each purchase to be executed — such as every hour, day, or week. This interval determines the time gap between each recurring order in your DCA strategy.
**Step 5: Specify Number of Orders**
Enter the total number of DCA orders you want to place. Your strategy will automatically stop once this number is reached.
\
You can still cancel the strategy manually at any time to stop any remaining unexecuted orders.
**Step 6: Review and confirm your order**
Once you are satisfied with the details of the dca order, click “Create Order” to proceed.
Once the order has been confirmed you should see it appear in the Active Orders screen of the limit interface.
Note: When your order is completely filled it will be moved to the Completed tab of this interface.
Cancel a DCA Order
**Fees:** Currently, 1% fees are levied for DCA orders on the Panora interface.
# Flows
Seamlessly move and exchange assets across multiple blockchain networks
## Introduction
With the launch of Flows, Panora evolves from a simple swap service into a robust, all-in-one trading platform on Aptos. Users can now bridge and swap across 10+ chains through a unified interface, eliminating the need to navigate across multiple protocols or platforms.
Panora’s Cross-Chain Swap feature leverages aggregated liquidity from multiple third-party cross-chain swap protocols to deliver a seamless and efficient trading experience. Its core capabilities include:
* **Intelligent Quote Aggregation**: Panora automatically scans and compares real-time quotes across integrated providers to secure the best available rate for the user.
* **Multi-Chain Support**: The platform supports both EVM-compatible and non-EVM blockchains, enabling broader access and greater flexibility across diverse ecosystems.
* **Unified Transaction Tracking**: Users can monitor the full lifecycle of their cross-chain transactions through a single, integrated interface, ensuring transparency and ease of use from initiation to completion.
Supported Networks
* Aptos
* Solana
* Sui
* Ethereum
* Optimism
* Arbitrum
* Base
* Bnb
* Polygon
* Avalance
## User Guide
To experience seamless asset swaps across multiple blockchain networks, navigate to the **Cross-Chain** tab on the Panora interface or visit .
Connect Wallet
* To begin, connect both your **Source** and **Destination** Web3 wallets using the **“Connect”** button located at the top-right corner of the interface, or directly through the **“Connect Wallet”** option within the Cross-Chain Swap widget.
* Ensure that both wallets are connected to their respective blockchain networks. If either wallet is connected to an incorrect network, Panora will automatically prompt you to switch to the appropriate one before proceeding with the cross-chain swap.
Configure your transaction details
To initiate a cross-chain swap on Panora, configure the following parameters:
* **Source Network**: Select the blockchain network where your current token is held.
* **Destination Network**: Choose the target blockchain where you want to receive the output token.
* **Token Pair**: Specify the token you want to swap **from** on the source chain, and the token you wish to receive **on** the destination chain.
* **Amount**: Enter the amount of the source token you want to swap.
Panora will automatically aggregate and evaluate all available routing options from supported cross-chain protocols, selecting the most efficient and cost-effective path for your swap.
Review Transaction and Confirm Swap
After configuring your swap details, you will be prompted to **confirm the transaction**.
A confirmation dialog will appear, displaying key information such as:
* Token amounts
* Estimated amount to be received
* Estimated processing time and network fees
Carefully review all details before proceeding. Once verified, click **“Confirm Transaction”** and approve the transaction in your connected wallet to initiate the cross-chain swap.
Review Transaction History
Once a cross-chain swap is initiated, users can monitor the **entire transaction lifecycle** directly within the Panora interface—eliminating the need to check multiple platforms or external dashboards.
Transaction statuses are updated in real time to reflect their current state:
* **Active**: The transaction is underway. This includes the initial swap on the source chain, the bridging process, and settlement on the destination chain.
> *Note: Some blockchain networks or protocols may require additional time to complete. You can refer to the “Estimated Processing Time” provided in the confirmation dialog before proceeding.*
* **Completed**
* **Success**: The transaction has been completed successfully, and the output tokens have been delivered to your receiving address on the destination network.
* **Failed**: The transaction could not be completed. In such cases, it is automatically reverted and your tokens are returned to the wallet.
Panora provides integrated, real-time visibility into every transaction, ensuring users remain informed at every step, from initial approval to final settlement. Whether verifying a high-value trade, troubleshooting a failed swap, or reviewing historical activity, the **Panora transaction history** panel offers a transparent, and user-friendly view of all cross-chain interactions.
## Fees
* **Non-Aptos Swap:** Panora does not charge any fees. However, third-party swap providers may apply their own. Currently, we use LiFi, which charges a 0.25% fee.
* **Bridge:** Stargate includes a relayer fee. No fees is currently levied by Circle CCTP.
* **Aptos Swap:** Currently, 1% fees are levied for swaps on Aptos.
* **Network Fees:** Standard gas fees apply separately.
# Terminal
Aptos' DeFi trading powerhouse
Panora Terminal is the all-in-one command center for analytics and trading on Aptos. It combines advanced on-chain insights, real-time data feeds, and swap execution into a single powerful interface. With integrated portfolio view and best-price execution via Panora Swap, Panora Terminal delivers precision, speed, and clarity to every move you make.\
\
If it’s on Aptos, it’s tracked on Panora Terminal.
**Features:**
* **Overview & Data Dashboard:** This is the live pulse of Aptos tokens. Prices, percentage changes, liquidity, market cap, every essential metric you need at a glance. Whether you’re looking for the next hot token or analyzing price movements, this is where the action unfolds.
* **Category Filters:** Filter tokens by Meme Coins, Native Assets, Trending, Gainers, Losers, and even Emoji Tokens. Additionally, the Terminal gives you powerful tools to personalize your experience by setting Favorite Tokens, having a portfolio overview and also filter tokens based on graduation status
* **One-Click Buy Feature:** Execute a swap instantly with the BUY button, no unnecessary steps, just pure speed.
* **Trending Bar:** This bar showcases the hottest tokens, market movers, and trending assets in real time.
* **Portfolio Overview:** Provides users a real-time snapshot of the complete portfolio, displaying token balances, market values, and performance metrics at a glance.
**Fees:** Panora levies 1% fees on transactions executed via Terminal tab
# Trade
The Ultimate CEX replacement
**Panora Trade** is a fully decentralized on-chain order book powered by **Econia’s settlement engine**, offering a CEX-like trading experience with the transparency and security of DeFi. Built on the Aptos blockchain, it delivers unparalleled speed and efficiency for all users.
#### **Key Features:**
* **CEX-Like Experience**: Intuitive interface similar to traditional exchanges, making it accessible for all traders.
* **High Performance**: Low latency and high throughput for quick and precise order execution.
* **Transparent and Secure**: Every trade is recorded on-chain, ensuring immutability and verifiability.
Experience CLOB like UI/UX on-chain with Panora
# Exchanges
Thala
Liquidswap
Cellana
Pancakeswap
Sushiswap
Baptswap
Animeswap
Cetus
Aux
# Aggregators
OpenOcean
Kana Labs
# On-chain Orderbook
Econia
# Wallets
Petra
Pontem
Martian
Nightly
OKX
MSafe
Fewcha
Rise
# Bridges
LayerZero
Wormhole
Celer
# Swap
Explore these docs and let our API empower your swap, algorithmic and/or arbitrage trading!
Easily integrate Panora’s swap aggregator into your app for efficient, real-time trading.
### **Key Features**
* **Optimized Transactions:** Access best rates and routes for swaps.
* **Flexible Integration:** Build custom trading strategies with ease.
* **Secure & Reliable:** Robust design for safe and stable transactions.
### **Getting Started**
* **Public API Key**:
```
a4^KV_EaTf4MW#ZdvgGKX#HUD^3IFEAOV_kzpIE^3BQGA8pDnrkT7JcIy#HNlLGi
```
***Note:** This API key's limits should be sufficient for most use cases. Protocols within the Aptos ecosystem with specific requirements or customization may submit a ticket on Discord.*
* **Sample Scripts:** [View on GitHub](https://github.com/PanoraExchange/Swap-SDK-Examples).
* **Try it:** [Swagger](https://api.panora.exchange/swagger).
### **Attribution**
Kindly include proper attribution when using the API in projects or presentations. Mention *“Powered by Panora”* wherever applicable.
# Sources
Panora currently supports the below mentioned liquidity sources on Aptos mainnet.
| Caliber | ThalaSwapV3 | Hyperion |
| -------------- | ------------ | --------- |
| ThalaSwapV2 | TappExchange | Cellana |
| LiquidswapV0.5 | ThalaSwapV1 | Booster |
| LiquidswapV0 | PancakeSwap | Sushiswap |
| AmnisLSD | ThalaLSD | Emojicoin |
| AnimeSwap | Cetus | Aptoswap |
| Aux | Earnium | |
# API
Explore authentication, endpoints, and trading operations to start trading efficiently. Whether you're a developer or a trader, this guide has everything you need to get started with Panora's APIs.
### Usage
Use the below endpoint to get quotes for the swap (also contains transaction data that can be sent to wallet adapter directly or used to build, sign and submit)
`POST` `https://api.panora.exchange/swap`
#### Headers
* **Public API Key**:
```
a4^KV_EaTf4MW#ZdvgGKX#HUD^3IFEAOV_kzpIE^3BQGA8pDnrkT7JcIy#HNlLGi
```
***Note:** This API key's limits should be sufficient for most use cases. Protocols within the Aptos ecosystem with specific requirements or customization may submit a ticket on Discord.*
Name
Value
Description
x-api-key
Your API Key
Use the public API key or enter the API key provided by Panora
### Query Parameters
{% hint style="info" %}
**Note**: Panora's APIs supports the following.
1. **ExactIn Swap:** When fromTokenAmount is entered, the endpoint returns the maximum toTokenAmount that will be received. Example: If the fromToken is APT, fromTokenAmount is 10.5 and toToken is USDC, then the toTokenAmount response is the maximum USDC a user would receive for swapping from 10.5 APT.
2. **ExactOut Swap:** When toTokenAmount is entered, the endpoint returns the minimum fromTokenAmount that has to be paid. Example: If the toToken is USDC, toTokenAmount is 100 and fromToken is APT, then the fromTokenAmount response is the minimum APT a user would pay for swapping to 100 USDC.
{% endhint %}
Parameter
Required
Type
Description
chainId
no
number
ID for the chain for which the endpoint is being invoked.
Note: Default chainID is 1 for Aptos Mainnet
fromTokenAddress
yes
string
Address of the token being swapped from
Example: If you want to swap 10.5 APT to USDC, then fromTokenAddress is 0xa
toTokenAddress
yes
string
Address of the token being swapped to
Example: If you want to swap 10.5 APT to USDC, then toTokenAddress is 0xbae207659db88bea0cbead6da0ed00aac12edcdda169e591cd41c94180b46f3b
Amount of the token being swapped from. Please set the amount without Token decimals
Example: If you want to swap 10.5 APT to USDC, then fromTokenAmount is 10.5
toTokenAmount
yes*
number
Amount of the token being swapped to. Please set the amount without Token decimals
Example: If you want to swap from APT to 100 USDC, then toTokenAmount is 100
toWalletAddress
yes
string
Address of the wallet to which the swapped tokens will be sent
slippagePercentage
no
number
Slippage tolerance as 'auto' (which lets Panora choose the optimal slippage for the transaction, up to a maximum of 5%) or a percentage value.
Example: For 3% slippage tolerance, set the value as 3. This can be set as 0.1, 0.5, 1.0 or any custom slippage percentage between 0 and 100.
Note: If nothing is entered, slippage tolerance will be set to auto by default. If a numeric value is entered, anything after two decimal places will be truncated.
integratorFeePercentage
no
number
Integrator fee as a percentage value
Example: For 2% integrator fee, set the value as 2. This can be set as 0.1, 0.5, 1.0 or any custom integrator fee between 0 and 2.
Note: Fee sharing applicable. Fee amount is auto-swapped to APT, whenever possible. If nothing is entered, integrator fee will be set to 0 by default. If a numeric value is entered, anything after two decimal places will be truncated.
integratorFeeAddress
no
string
Wallet Address where integrators want to receive their fee share. The fee share is settled immediately with the swap transaction to the provided wallet address.
Note: Ensure it starts with 0x followed by 64 characters
includeSources
no
string
List of liquidity sources to be included for route calculation.
Example: Hyperion, ThalaSwapV2
Note: If nothing is entered, all available sources are included by default. Check entire list here.
excludeSources
no
string
List of liquidity sources to be excluded from the route.
Example: SushiSwap
Note: If nothing is entered, none of the sources will be excluded by default. Check entire list here.
includePools
no
string
List of pool addresses to be included for route calculation.
Note: If nothing is entered, all available pools are included by default. Max 10 pool addresses are supported. Coin standard DEX pools with comma ( , ) within the pool address would get skipped
maxHops
no
string
Set a value between 1 and 5, or max, to limit the maximum number of hops allowed in each split section of the route (default: max)
disableSplits
no
boolean
Set to true to disable splitting pools across the entire route (default: false)
onlyDirectRoutes
no
boolean
Set to true to restrict to direct routes without intermediate hops or splits. Default is false.
{% hint style="warning" %} \*Please send either fromTokenAmount or toTokenAmount at a time.
{% endhint %}
### Request Example
{% tabs %}
{% tab title="Javascript" %}
```javascript
//CALL THE BELOW FUNCTION WITH THE ASYNC
const end_point = 'https://api.panora.exchange/swap'
const query = {
fromTokenAddress:"0xbae207659db88bea0cbead6da0ed00aac12edcdda169e591cd41c94180b46f3b"
toTokenAddress:"0xa"
fromTokenAmount:100
toWalletAddress:"0x1c3206329806286fd2223647c9f9b130e66baeb6d7224a18c1f642ffe48f3b4c"
};
const headers = {
"x-api-key": "Your API key"
};
const queryString = new URLSearchParams(query).toString();
const url = `${end_point}?${queryString}`;
const response = await (
await fetch(url, {
method: 'POST',
headers: headers
})
).json();
```
{% endtab %}
{% tab title="Python" %}
```python
import requests
end_point = 'https://api.panora.exchange/swap'
query = {
'fromTokenAddress': '0xbae207659db88bea0cbead6da0ed00aac12edcdda169e591cd41c94180b46f3b',
'toTokenAddress':'0xa',
'fromTokenAmount': '100',
'toWalletAddress':'0x1c3206329806286fd2223647c9f9b130e66baeb6d7224a18c1f642ffe48f3b4c'
}
headers = {
'x-api-key': 'Your API key',
}
url = f"{end_point}?{'&'.join([f'{key}={value}' for key, value in query.items()])}"
response = requests.post(url, headers=headers)
print(response.json())
```
{% endtab %}
{% tab title="Go" %}
```go
import (
"fmt"
"net/http"
"io/ioutil"
"net/url"
)
func main() {
endPoint := "https://api.panora.exchange/swap"
query := url.Values{
"fromTokenAddress": {"0xbae207659db88bea0cbead6da0ed00aac12edcdda169e591cd41c94180b46f3b"},
"toTokenAddress":{"0xa"},
"fromTokenAmount": {"100"},
"toWalletAddress":{"0x1c3206329806286fd2223647c9f9b130e66baeb6d7224a18c1f642ffe48f3b4c"}
}
headers := map[string]string{
"x-api-key": "Your API key",
}
url := endPoint + "?" + query.Encode()
req, err := http.NewRequest("POST", url, nil)
if err != nil {
fmt.Println("Error creating request:", err)
return
}
for key, value := range headers {
req.Header.Set(key, value)
}
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
fmt.Println("Error sending request:", err)
return
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
fmt.Println("Error reading response:", err)
return
}
fmt.Println(string(body))
}
```
{% endtab %}
{% tab title="Curl" %}
```
// Copy and paste the below command in your terminal
curl -X POST \
'https://api.panora.exchange/swap?fromTokenAddress=0xbae207659db88bea0cbead6da0ed00aac12edcdda169e591cd41c94180b46f3b&toTokenAddress=0xa&fromTokenAmount=100&toWalletAddress=0x1c3206329806286fd2223647c9f9b130e66baeb6d7224a18c1f642ffe48f3b4c' \
-H 'x-api-key: Your API key'
```
{% endtab %}
{% endtabs %}
### Response
#### Scenario 1: For ExactIn Swap where fromTokenAmount is entered (instead of toTokenAmount), the endpoint returns the maximum toTokenAmount
Name
Type
Description
fromToken
object
An object containing the details of the fromToken, which includes address , decimals and current_price
toToken
object
An object containing the details of the toToken, which includes address , decimals and current_price
feeToken
object
An object containing the details of the feeToken, which includes address, name, symbol, decimals and current_price
fromTokenAmount
string
Amount of token being swapped from
Note: Amount is without Token decimals
fromTokenAmountUSD
string
USD equivalent of fromTokenAmount
Note: Will be null for those tokens whose usd price is not available from external price feeds
quotes
array
An object (within an array) containing the swap details.The object consists of:
toTokenAmount: Amount of the token (without Token decimals) being swapped to.
priceImpact: percentage difference between USD price of fromTokenAmount and toTokenAmount. Will be null if either fromTokenAmountUSD or toTokenAmountUSD is null
slippagePercentage: Percentage of slippage tolerance
feeTokenAmount: Platform fee for the transaction
minToTokenAmount: Minimum amount of token (without Token decimals) user would receive after reducing slippage.
txData: Details of the transaction for the swap
toTokenAmountUSD: USD equivalent of toTokenAmount. Will be null for those tokens whose USD price is not available from external price feeds
Note: Values are of type string
status Code
200: Successful response 400: Bad Request
401: Unauthorized (in case no/wrong API key is passed)
404: Not Found
429: Too many requests (in case of rate limit breach) 500: Internal Server Error
#### Scenario 2: For ExactOut Swap where toTokenAmount is entered (instead of fromTokenAmount), the endpoint returns the minimum toTokenAmount
Name
Type
Description
fromToken
object
An object containing the details of the fromToken, which includes address , decimals and current_price
toToken
object
An object containing the details of the toToken, which includes address , decimals and current_price
feeToken
object
An object containing the details of the feeToken, which includes address, name, symbol, decimals and current_price
toTokenAmount
string
Amount of token user desires to get after the swap
Note: Amount is without Token decimals
toTokenAmountUSD
string
USD equivalent of toTokenAmount.
Note: Will be null for those tokens whose usd price is not available from external price feeds
quotes
array
An object (within an array) containing the swap details.The object consists of:
fromTokenAmount: Amount of tokens (without Token decimals) user needs to pay for the swap
maxFromTokenAmount: Maximum amount of tokens (without Token decimals) user would need to pay after adding slippage.
slippagePercentage: Percentage of slippage tolerance
feeTokenAmount: Platform fee for the transaction
priceImpact: percentage difference between USD price of fromTokenAmount and toTokenAmount. Will be null if either fromTokenAmountUSD or toTokenAmountUSD is null
txData: Details of the transaction for the swap
fromTokenAmountUSD: USD equivalent of fromTokenAmount. Will be null for those tokens whose usd price is not available from external price feeds
Note: Values are of type string
status code
200: Successful response 400: Bad Request
401: Unauthorized (in case no/wrong API key is passed)
404: Not Found
429: Too many requests (in case of rate limit breach) 500: Internal Server Error
[^1]:
# SDK
SDK for swaps, balances, token lists, and prices
## Installation
Using npm
```
npm install @panoraexchange/swap-sdk
```
Using yarn
```
yarn add @panoraexchange/swap-sdk
```
Using pnpm
```
pnpm add @panoraexchange/swap-sdk
```
## Usage
### 1. Initialize
```javascript
import Panora, { PanoraConfig } from "@panoraexchange/swap-sdk"
const config: PanoraConfig = {
panoraApiKey: "PANORA_API_KEY", // Optional. Default is Panora's public api key
geomiApiKey: "GEOMI_API_KEY", // Optional. Default is no api key. Takes higher priority over rpcUrl
rpcUrl: "CUSTOM_RPC_URL", // Optional
}
const panora = new Panora(config)
```
* **Public API Key**:
```
a4^KV_EaTf4MW#ZdvgGKX#HUD^3IFEAOV_kzpIE^3BQGA8pDnrkT7JcIy#HNlLGi
```
***Note:** This API key's limits should be sufficient for most use cases. Protocols within the Aptos ecosystem with specific requirements or customization may submit a ticket on Discord.*
### 2. Swap
Fetches a swap quote and executes the transaction on-chain in a single step. Use this when you want to trigger end-to-end transaction without fetching or managing quotes separately. Refer [API page](https://docs.panora.exchange/developer/swap/api) for all available query parameters
#### i. ExactInSwap:
```javascript
const exactInSwap = async () => {
const response = await panora.swap({
params: {
chainId: "1",
fromTokenAddress:
"0xbae207659db88bea0cbead6da0ed00aac12edcdda169e591cd41c94180b46f3b",
toTokenAddress: "0xa",
fromTokenAmount: "100",
toWalletAddress: "YOUR WALLET ADDRESS",
slippagePercentage: "1",
integratorFeeAddress: "INTEGRATOR FEE WALLET ADDRESS",
integratorFeePercentage: "1",
},
private_key: "YOUR PRIVATE KEY",
})
}
```
#### ii. ExactOutSwap:
```javascript
const exactOutSwap = async () => {
const response = await panora.swap({
params: {
chainId: "1",
fromTokenAddress:
"0xbae207659db88bea0cbead6da0ed00aac12edcdda169e591cd41c94180b46f3b",
toTokenAddress: "0xa",
toTokenAmount: "10.5",
toWalletAddress: "YOUR WALLET ADDRESS",
slippagePercentage: "1",
integratorFeeAddress: "INTEGRATOR FEE WALLET ADDRESS",
integratorFeePercentage: "1",
},
private_key: "YOUR_PRIVATE_KEY",
})
}
```
### 3. Quote & Execute
#### a. Quote: Returns quote for a swap transaction. Contains transaction data that can be used to build, sign and submit directly
#### i. ExactInSwapQuote
```javascript
const exactInSwapQuote = async () => {
const response = await panora.getQuote({
params: {
chainId: "1",
fromTokenAddress:
"0xbae207659db88bea0cbead6da0ed00aac12edcdda169e591cd41c94180b46f3b",
toTokenAddress: "0xa",
fromTokenAmount: "100",
toWalletAddress: "YOUR WALLET ADDRESS",
slippagePercentage: "1",
integratorFeeAddress: "INTEGRATOR FEE WALLET ADDRESS",
integratorFeePercentage: "1",
},
});
};
```
#### ii. ExactOutSwapQuote
```javascript
const exactOutSwapQuote = async () => {
const response = await panora.getQuote({
params: {
chainId: "1",
fromTokenAddress:
"0xbae207659db88bea0cbead6da0ed00aac12edcdda169e591cd41c94180b46f3b",
toTokenAddress: "0xa",
toTokenAmount: "10.5",
toWalletAddress: "YOUR WALLET ADDRESS",
slippagePercentage: "1",
integratorFeeAddress: "INTEGRATOR FEE WALLET ADDRESS",
integratorFeePercentage: "1",
},
});
};
```
#### b. Execute Quote: Executes a transaction using a pre-fetched swap quote. Unlike swap function, this function does not fetch the quote itself. Use getQuote function to fetch a swap quote.
```typescript
const quoteResponse = await panora.getQuote({
params: {
chainId: "1",
fromTokenAddress:
"0xbae207659db88bea0cbead6da0ed00aac12edcdda169e591cd41c94180b46f3b",
toTokenAddress: "0xa",
toTokenAmount: "10.5",
toWalletAddress: "YOUR WALLET ADDRESS",
slippagePercentage: "1",
integratorFeeAddress: "INTEGRATOR FEE WALLET ADDRESS",
integratorFeePercentage: "1",
},
});
const txResponse = await panora.executeQuote({
quote: quoteResponse,
privateKey: "YOUR_PRIVATE_KEY"
});
```
### 4. Get Balances
Fetch wallet balances
```typescript
const response = await panora.getBalances({
walletAddress: "YOUR WALLET ADDRESS",
});
```
### 5. Get Tokenlist
Fetch Panora's Aptos Token List
```tsx
const response = await panora.getTokenList()
```
### 6. Get Prices
Fetch Token Prices
```typescript
const response = await panora.getPrices({
tokenAddress: ["0xa"],
});
```
## Attribution
Kindly include proper attribution when using the SDK in projects or presentations. Mention “Powered by Panora” wherever applicable.
# Contract
Learn how to integrate Panora swap contract within your contract in just a few minutes.
To integrate the Panora contract, the first step is familiarity with our [Swap API](https://docs.panora.exchange/developer/swap-api-and-sdk) as the type arguments and arguments required by our contract are provided by the Panora Swap API endpoint. The Swap endpoint returns the parameters necessary for the router entry function and covers both ExactInSwap and ExactOutSwap.
**API Response Structure**
The response will include a consistent structure across all scenarios, containing a key named txData
* txData: This txData contains the details required for executing the swap.
* Usage: Send the txData directly to your contract. No modifications are needed to accommodate different token types (fungible assets or coins).
Contract Integration Sample:
# Widget
Easily integrate Panora's swap functionality into your application with our lightweight, plug-and-play SDK — enabling seamless token swaps and real-time data directly within your platform.
### Key Features
* **Quick Setup** — Add swaps to your app in under 5 minutes
* **Three Display Modes** — Integrated (inline), Widget (floating button), or Modal (popup)
* **Fully Customizable** — Theme colors, default tokens, locale, slippage, and more
* **Multi-Language** — Supports 11 locales out of the box
* **Wallet Support** — Built-in wallet connection UI, or bring your own
### Display Modes
| Mode | Description |
| ------------ | -------------------------------------------------------------------------- |
| `INTEGRATED` | Renders inline inside a target `
` you provide |
| `WIDGET` | Renders a floating button (configurable corner). Click to open the swap UI |
| `MODAL` | Opens a centered popup dialog with a backdrop overlay |
### Supported Frameworks
* Plain HTML / Vanilla JS
* React (Vite, CRA)
* Next.js (App Router & Pages Router)
* Any framework that can run JavaScript
### Getting an API Key
A default public API key is available for development and typical usage:
```
a4^KV_EaTf4MW#ZdvgGKX#HUD^3IFEAOV_kzpIE^3BQGA8pDnrkT7JcIy#HNlLGi
```
For production or high-traffic use cases, open a ticket on [Discord](https://discord.gg/panora) to request a dedicated key.
### Installation
**npm**
```bash
npm install @panoraexch/widget-sdk
```
**yarn**
```bash
yarn add @panoraexch/widget-sdk
```
**pnpm**
```bash
pnpm add @panoraexch/widget-sdk
```
**CDN (no bundler needed)**
```bash
```
### Quick Start
#### Option A: NPM (React / Next.js)
```typescript
import { init, close } from "@panoraexch/widget-sdk";
// Open the widget
await init({
displayMode: "INTEGRATED",
integratedTargetId: "my-swap-container",
panoraApiKey: "YOUR_API_KEY",
});
// Later, tear it down
close();
```
#### Option B: CDN (plain HTML)
```html
```
## React App Example
A complete guide to integrating Panora Widget SDK into a React + Vite application.
### 1. Create a New Project
```bash
npm create vite@latest my-app -- --template react-ts
cd my-app
```
### 2. Install the SDK
```bash
npm install @panoraexch/widget-sdk
```
### 3. Add the Widget
Replace `src/App.tsx` with:
```tsx
import { useEffect, useState } from "react";
import { init, close } from "@panoraexch/widget-sdk";
const API_KEY = import.meta.env.VITE_PANORA_API_KEY || "";
const DEFAULT_FROM = "0xa" as const;
const DEFAULT_TO =
"0x..." as const;
type Tab = "INTEGRATED" | "WIDGET" | "MODAL";
export default function App() {
const [activeTab, setActiveTab] = useState("INTEGRATED");
useEffect(() => {
// Clean up any previous instance
close();
// MODAL is opened on-demand, not on mount
if (activeTab === "MODAL") return;
const timeout = setTimeout(() => {
if (activeTab === "INTEGRATED") {
init({
panoraApiKey: API_KEY,
displayMode: "INTEGRATED",
integratedTargetId: "panora-widget-container",
defaultFromTokenAddress: DEFAULT_FROM,
defaultToTokenAddress: DEFAULT_TO,
locale: "en",
showNotifications: true,
});
} else if (activeTab === "WIDGET") {
init({
panoraApiKey: API_KEY,
displayMode: "WIDGET",
defaultFromTokenAddress: DEFAULT_FROM,
defaultToTokenAddress: DEFAULT_TO,
locale: "en",
widgetBtnDirection: "right-bottom",
});
}
}, 100);
return () => {
clearTimeout(timeout);
close();
};
}, [activeTab]);
return (
My App
{/* ── Integrated Mode ── */}
{activeTab === "INTEGRATED" && (
)}
{/* ── Modal Mode — open / close on demand ── */}
{activeTab === "MODAL" && (
)}
);
}
```
### 4. Run
```bash
npm run dev
```
### Using the React Component
If you prefer a declarative approach instead of the imperative `init()` / `close()` API, the SDK also exports a `` React component:
```tsx
import { PanoraWidget } from "@panoraexch/widget-sdk";
export default function App() {
return (
);
}
```
> **Note:** `` always renders in `INTEGRATED` mode. For `WIDGET` or `MODAL` modes, use the imperative `init()` / `close()` API.
### Key Points
* Always call `close()` before re-initializing to avoid duplicate instances
* The `100ms` timeout gives the DOM time to settle before the widget mounts
* Store your API key in `.env` as `VITE_PANORA_API_KEY`
***
## Next.js Example (App Router)
A complete guide to integrating Panora Widget SDK into a Next.js App Router application.
### 1. Create a New Project
```bash
npx create-next-app@latest my-app --typescript
cd my-app
```
### 2. Install the SDK
```bash
npm install @panoraexch/widget-sdk
```
### 3. Add the Widget
Create or replace `src/app/page.tsx`:
```tsx
"use client";
import { useEffect, useState } from "react";
import { init, close } from "@panoraexch/widget-sdk";
const API_KEY = process.env.NEXT_PUBLIC_PANORA_API_KEY || "";
const DEFAULT_FROM = "0xa" as const;
const DEFAULT_TO =
"0x..." as const;
export default function Home() {
const [ready, setReady] = useState(false);
useEffect(() => {
setReady(true);
}, []);
useEffect(() => {
if (!ready) return;
init({
panoraApiKey: API_KEY,
displayMode: "INTEGRATED",
integratedTargetId: "panora-widget-container",
defaultFromTokenAddress: DEFAULT_FROM,
defaultToTokenAddress: DEFAULT_TO,
locale: "en",
showNotifications: true,
});
return () => {
close();
};
}, [ready]);
return (
My App
);
}
```
> **Important:** The `"use client"` directive is required. The widget uses browser APIs (`document`, `window`) and cannot run during server-side rendering.
### Widget Mode Example
```tsx
"use client";
import { useEffect } from "react";
import { init, close } from "@panoraexch/widget-sdk";
export default function WidgetPage() {
useEffect(() => {
init({
panoraApiKey: process.env.NEXT_PUBLIC_PANORA_API_KEY || "",
displayMode: "WIDGET",
widgetBtnDirection: "right-bottom",
locale: "en",
});
return () => close();
}, []);
return (
Widget floating in the corner
);
}
```
### Modal Mode Example
```tsx
"use client";
import { init, close } from "@panoraexch/widget-sdk";
export default function ModalPage() {
return (
);
}
```
### Next.js Pages Router
If you use the Pages Router instead of App Router, the code is nearly identical — just drop the `"use client"` directive and place your file in `src/pages/index.tsx`. No other changes needed.
### Key Points
* Store your API key in `.env.local` as `NEXT_PUBLIC_PANORA_API_KEY`
* Always call `close()` in the `useEffect` cleanup to prevent memory leaks
* The widget loads its UI from the CDN at runtime, so your Next.js bundle size is unaffected
***
## HTML App Example
The simplest integration — no bundler, no framework, just a single `
