BRC20 Swap API provides a set of Fractal-only interfaces for BRC20 Swap and InSwap services. BRC20 Swap and InSwap are equivalent product names; user requests that mention InSwap should be routed to these /v1/brc20-swap/* endpoints. It allows users to interact with the BRC20 Swap ecosystem, including balance checks, pool information, liquidity management, quote/preparation steps, liquidity operations, swap operations, and token transfers.
👉 View Swagger UI
| Route | Summary |
|---|---|
GET /v1/brc20-swap/config |
Get InSwap module, fee tick, and deposit confirmation config |
GET /v1/brc20-swap/balance |
Get an address’s InSwap balance for one tick |
GET /v1/brc20-swap/all_balance |
List all InSwap balances for an address |
GET /v1/brc20-swap/pool_info |
Get pool liquidity, volume, and reward details for a pair |
GET /v1/brc20-swap/select |
List address ticks available for InSwap trading |
GET /v1/brc20-swap/pre_deploy_pool |
Prepare signatures and fees for deploying an InSwap pool |
POST /v1/brc20-swap/deploy_pool |
Submit a signed InSwap pool deployment |
GET /v1/brc20-swap/pre_add_liq |
Prepare signatures and fee data for adding liquidity |
POST /v1/brc20-swap/add_liq |
Submit a signed InSwap add-liquidity operation |
GET /v1/brc20-swap/pre_remove_liq |
Prepare signatures and fee data for removing liquidity |
POST /v1/brc20-swap/remove_liq |
Submit a signed InSwap remove-liquidity operation |
GET /v1/brc20-swap/pre_send |
Prepare signatures and fees for an InSwap token transfer |
POST /v1/brc20-swap/pre_batch_send |
Prepare signatures and fees for batch InSwap transfers |
GET /v1/brc20-swap/pre_swap |
Prepare signatures and fees for an InSwap token swap |
POST /v1/brc20-swap/send |
Submit a signed InSwap token transfer |
POST /v1/brc20-swap/batch_send |
Submit signed batch InSwap token transfers |
POST /v1/brc20-swap/swap |
Submit a signed InSwap token swap |
GET /v1/brc20-swap/pool_list |
List InSwap pools with TVL, volume, and reserves |
GET /v1/brc20-swap/my_pool_list |
List an address’s InSwap liquidity positions |
GET /v1/brc20-swap/my_pool |
Get an address’s InSwap position in one pool |
GET /v1/brc20-swap/overview |
Get InSwap liquidity, volume, transaction, and pair totals |
GET /v1/brc20-swap/gas_history |
List InSwap gas fee history |
GET /v1/brc20-swap/send_history |
List InSwap token transfer history |
GET /v1/brc20-swap/liq_history |
List InSwap add/remove liquidity history |
GET /v1/brc20-swap/swap_history |
List InSwap token swap history |
GET /v1/brc20-swap/rollup_history |
List InSwap rollup inscription history |
GET /v1/brc20-swap/deposit_list |
List InSwap deposit records for an address |
GET /v1/brc20-swap/create_deposit |
Build InSwap deposit signing material |
POST /v1/brc20-swap/confirm_deposit |
Submit signed InSwap deposit transactions |
GET /v1/brc20-swap/system_status |
Check whether InSwap rollup committing is active |
GET /v1/brc20-swap/withdraw_history |
List InSwap withdrawal records for an address |
GET /v1/brc20-swap/create_retry_withdraw |
Build payment and approve PSBTs for retrying a withdrawal |
POST /v1/brc20-swap/confirm_retry_withdraw |
Submit signed PSBTs to retry an InSwap withdrawal |
GET /v1/brc20-swap/create_withdraw |
Build InSwap withdrawal signing data |
POST /v1/brc20-swap/confirm_withdraw |
Submit a signed InSwap withdrawal confirmation |
GET /v1/brc20-swap/withdraw_process |
Get confirmation progress for an InSwap withdrawal |
GET /v1/brc20-swap/quote_swap |
Quote expected output for an InSwap token swap |
GET /v1/brc20-swap/quote_add_liq |
Quote required amounts and LP for adding liquidity |
GET /v1/brc20-swap/quote_remove_liq |
Quote token outputs for removing InSwap liquidity |
GET /v1/brc20-swap/pre_stake |
Prepare signatures and fees for staking InSwap LP |
GET /v1/brc20-swap/pre_unstake |
Prepare signatures and fees for unstaking InSwap LP |
GET /v1/brc20-swap/pre_claim |
Prepare signatures and fees for claiming InSwap rewards |
GET /v1/brc20-swap/pre_send_lp |
Prepare signatures and fees for transferring LP tokens |
POST /v1/brc20-swap/send_lp |
Submit a signed InSwap LP token transfer |
POST /v1/brc20-swap/stake |
Submit a signed InSwap LP stake operation |
POST /v1/brc20-swap/unstake |
Submit a signed InSwap LP unstake operation |
POST /v1/brc20-swap/claim |
Submit a signed InSwap reward claim |
GET /v1/brc20-swap/lp_reward_history |
List LP reward history for an InSwap pool position |
GET /v1/brc20-swap/stake_history |
List InSwap stake, unstake, and claim history |
GET /v1/brc20-swap/stake_list |
List active InSwap staking campaigns and reward pools |
GET /v1/brc20-swap/stake_item |
Get one InSwap staking campaign by event id |
GET /v1/brc20-swap/stake_user_info |
Get staking-related InSwap user information |
GET /v1/brc20-swap/user_info |
Get an address’s default InSwap fee payment settings |
GET /v1/brc20-swap/select_deposit |
Get deposit selection data for an InSwap address |
GET /v1/brc20-swap/func_info |
Get execution details for one InSwap function id |
GET /v1/brc20-swap/deposit_balance |
Get depositable balance data for one tick |
GET /v1/brc20-swap/deposit_process |
Get confirmation progress for an InSwap deposit |
GET /v1/brc20-swap/tick_price |
Get the current InSwap price for one tick |
GET /v1/brc20-swap/address_gas |
Get an address’s available fee-tick gas amount |
GET /v1/brc20-swap/price_line |
Get historical InSwap price points for a pair |
GET /v1/brc20-swap/tick_holders |
List top holders for an InSwap tick |
GET /v1/brc20-swap/pool_holders |
List LP holders for an InSwap pool |
GET /v1/brc20-swap/reward_curve |
Get InSwap reward curve data for a pool position |
GET /v1/brc20-swap/send_lp_history |
List InSwap LP token transfer history |
GET /v1/brc20-swap/burn_history |
List InSwap LP burn history and burn totals |
GET /v1/brc20-swap/task_list |
List InSwap task completion items for an address |
GET /v1/brc20-swap/address_usd |
Get an address’s InSwap asset and LP USD values |
GET /v1/brc20-swap/pre_lock_lp |
Prepare signatures and fees for locking InSwap LP |
POST /v1/brc20-swap/lock_lp |
Submit a signed InSwap LP lock operation |
GET /v1/brc20-swap/pre_unlock_lp |
Prepare signatures and fees for unlocking InSwap LP |
POST /v1/brc20-swap/unlock_lp |
Submit a signed InSwap LP unlock operation |
GET /v1/brc20-swap/lock_lp_history |
List InSwap LP lock history |
GET /v1/brc20-swap/unlock_lp_history |
List InSwap LP unlock history |
GET /v1/brc20-swap/export_lock_lp_history |
Export InSwap LP lock history as CSV |
GET /v1/brc20-swap/my_lock_lp |
Get an address’s locked and available LP for a pool |
GET /v1/brc20-swap/select_pool |
List routed pool candidates for an InSwap trade |
GET /v1/brc20-swap/pre_multi_swap |
Prepare signatures and fees for a multi-hop InSwap swap |
POST /v1/brc20-swap/multi_swap |
Submit signed multi-hop InSwap swaps |
GET /v1/brc20-swap/quote_multi_swap |
Quote expected output and route amounts for a multi-hop swap |
GET /v1/brc20-swap/multi_swap_history |
List InSwap multi-hop swap history |
POST /v1/brc20-swap/batch_history |
Fetch multiple InSwap history categories in one request |
Method: GET
Path: /v1/brc20-swap/config
Swagger Link: View in Swagger UI
Returns Fractal BRC20 Swap service settings, including module id, service gas tick, and confirmation thresholds for direct and matching deposits.
Default Response
code (number): requiredmsg (string): requireddata (object):
moduleId (string):serviceGasTick (string): The tick used for the second layer gas.pendingDepositDirectNum (number): Number of confirmations required for direct deposit.pendingDepositMatchingNum (number): Number of confirmations required for matching deposit.Method: GET
Path: /v1/brc20-swap/balance
Swagger Link: View in Swagger UI
Returns module, swap, pending-swap, and pending-available balances plus decimal precision for a specific address and token tick.
address (query, string) (required):tick (query, string) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
balance (object):
module (string): Confirmed module balance.swap (string): Confirmed swap balance.pendingSwap (string): The balance converted from pending to swap.pendingAvailable (string): The balance converted from pending to module.decimal (string):Method: GET
Path: /v1/brc20-swap/all_balance
Swagger Link: View in Swagger UI
Returns a ticker-keyed balance map with module, swap, pending balances, decimals, asset type, network type, and optional price metadata.
address (query, string) (required):pubkey (query, string):Successful response returning all token balances for the address.
code (number): requiredmsg (string): requireddata (object): required; A map where each key is a token ticker symbol.Method: GET
Path: /v1/brc20-swap/pool_info
Swagger Link: View in Swagger UI
Returns pair-level pool metadata, including whether the pool exists, token reserves, LP supply, TVL, recent volume, reward fields, and per-token asset metadata.
tick0 (query, string):tick1 (query, string):Default Response
code (number): requiredmsg (string): requireddata (object):
existed (boolean): Is the pool existedaddLiq (boolean): Has LP been added to the pooltick0 (string):tick1 (string):lp (string): Quantity of pool lptvl (string):volume24h (string):volume7d (string):reward0 (string):reward1 (string):activedPid (string): Active pool IDmarketCap (number): Market capmarketCapTick (string): Market cap ticknetworkType0 (string): Network type for tick0networkType1 (string): Network type for tick1assetType0 (string): Asset type for tick0assetType1 (string): Asset type for tick1l1Tick0 (string): L1 tick0l1Tick1 (string): L1 tick1amount0 (string): Amount of tick0amount1 (string): Amount of tick1volume30d (string): 30 days volumeMethod: GET
Path: /v1/brc20-swap/select
Swagger Link: View in Swagger UI
Returns BRC-20 ticks available to an address for swap operations, including decimal precision, module balance, and swap balance.
address (query, string) (required):search (query, string): Fuzzy matchingDefault Response
code (number): requiredmsg (string): requireddata (array):
tick (string):decimal (string):brc20Balance (string): Module balance (not participate in swap calculations)swapBalance (string): Swap balanceMethod: GET
Path: /v1/brc20-swap/pre_deploy_pool
Swagger Link: View in Swagger UI
Returns signature ids, sign messages, fee amount, fee tick price, fee balance, and USD fee value needed before submitting a pool deployment.
address (query, string) (required):tick0 (query, string) (required):tick1 (query, string) (required):ts (query, number) (required): Timestamp (seconds)feeTick (query, string) (required): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.payType (query, string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotaDefault Response
code (number): requiredmsg (string): requireddata (object):
ids (array): User signature idsignMsgs (array): User signature informationfeeAmount (string): The fee that the user needs to payfeeTickPrice (string): The price of fee tickfeeBalance (string): The user’s fee tick balanceusdPrice (string): The dollar value of the feefeeTick (string): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.totalFreeQuota (string): Total free quotaremainingFreeQuota (string): Remaining free quotatotalUsedFreeQuota (string): Total used free quotausageFreeQuota (string): Usage free quotahasVoucher (boolean): Has voucherassetFeeAmount (string): Asset fee amountassetFeeTick (string): Asset fee tickassetFeeTickPrice (string): Asset fee tick priceassetFeeTickBalance (string): Asset fee tick balanceMethod: POST
Path: /v1/brc20-swap/deploy_pool
Swagger Link: View in Swagger UI
Creates a new swap pool using prepared signature data, token pair, timestamp, fee tick, and fee payment fields. Review the pair, fee amount, and signatures before submission.
Content-Type: application/json (required)
address (string): requiredtick0 (string): requiredtick1 (string): requiredts (number): required; Timestamp (seconds)feeTick (string): required; Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.feeAmount (string): required; The fee that the user needs to payfeeTickPrice (string): required; The price of fee ticksigs (array): User signaturepayType (string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotarememberPayType (boolean):Default Response
code (number): requiredmsg (string): requireddata (object):Method: GET
Path: /v1/brc20-swap/pre_add_liq
Swagger Link: View in Swagger UI
Returns signature ids, sign messages, fee fields, and pool-share preparation data for adding two token amounts into an InSwap liquidity pool.
address (query, string) (required):tick0 (query, string) (required):tick1 (query, string) (required):amount0 (query, string) (required): Input amount of tick0amount1 (query, string) (required): Input amount of tick1lp (query, string) (required): Expect amount of lpslippage (query, string) (required):ts (query, number) (required): Timestamp (seconds)feeTick (query, string) (required): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.payType (query, string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotaDefault Response
code (number): requiredmsg (string): requireddata (object):
ids (array): User signature idsignMsgs (array): User signature informationfeeAmount (string): The fee that the user needs to payfeeTickPrice (string): The price of fee tickfeeBalance (string): The user’s fee tick balanceusdPrice (string): The dollar value of the feefeeTick (string): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.totalFreeQuota (string): Total free quotaremainingFreeQuota (string): Remaining free quotatotalUsedFreeQuota (string): Total used free quotausageFreeQuota (string): Usage free quotahasVoucher (boolean): Has voucherassetFeeAmount (string): Asset fee amountassetFeeTick (string): Asset fee tickassetFeeTickPrice (string): Asset fee tick priceassetFeeTickBalance (string): Asset fee tick balanceMethod: POST
Path: /v1/brc20-swap/add_liq
Swagger Link: View in Swagger UI
Adds token amounts to a liquidity pool using prepared signatures, fee fields, and slippage controls. Review both token amounts, expected LP, fee payment, and signatures before submission.
Content-Type: application/json (required)
address (string): requiredtick0 (string): requiredtick1 (string): requiredamount0 (string): required; Input amount of tick0amount1 (string): required; Input amount of tick1lp (string): requiredslippage (string): requiredts (number): required; Timestamp (seconds)feeTick (string): required; Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.feeAmount (string): required; The fee that the user needs to payfeeTickPrice (string): required; The price of fee ticksigs (array): User signaturepayType (string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotarememberPayType (boolean):Default Response
code (number): requiredmsg (string): requireddata (object):
id (string): Function idrollupInscriptionId (string): The rollup inscription id where the function is locatedaddress (string):type (string):tick0 (string):tick1 (string):amount0 (string): required; Input amount of tick0amount1 (string): required; Input amount of tick1lp (string):ts (number):success (boolean): Operation success statusvalue (number): Operation valuepreResult (object): Pre-operation resultresult (object): Operation resultMethod: GET
Path: /v1/brc20-swap/pre_remove_liq
Swagger Link: View in Swagger UI
Returns signature ids, sign messages, fee fields, and expected token amounts for removing LP from an InSwap liquidity pool.
address (query, string) (required):tick0 (query, string) (required):tick1 (query, string) (required):amount0 (query, string) (required): Input amount of tick0amount1 (query, string) (required): Input amount of tick1lp (query, string) (required):slippage (query, string) (required):ts (query, number) (required):feeTick (query, string) (required): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.payType (query, string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotaDefault Response
code (number): requiredmsg (string): requireddata (object):
ids (array): User signature idsignMsgs (array): User signature informationfeeAmount (string): The fee that the user needs to payfeeTickPrice (string): The price of fee tickfeeBalance (string): The user’s fee tick balanceusdPrice (string): The dollar value of the feefeeTick (string): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.totalFreeQuota (string): Total free quotaremainingFreeQuota (string): Remaining free quotatotalUsedFreeQuota (string): Total used free quotausageFreeQuota (string): Usage free quotahasVoucher (boolean): Has voucherassetFeeAmount (string): Asset fee amountassetFeeTick (string): Asset fee tickassetFeeTickPrice (string): Asset fee tick priceassetFeeTickBalance (string): Asset fee tick balancereward0 (string): Reward amount for tick0reward1 (string): Reward amount for tick1Method: POST
Path: /v1/brc20-swap/remove_liq
Swagger Link: View in Swagger UI
Removes LP from a liquidity pool using prepared signatures and fee fields, returning execution metadata. Review LP amount, expected token outputs, fee payment, and signatures before submission.
Content-Type: application/json (required)
address (string): requiredtick0 (string): requiredtick1 (string): requiredlp (string): requiredamount0 (string): required; Input amount of tick0amount1 (string): required; Input amount of tick1slippage (string): requiredts (number): required; Timestamp (seconds)feeTick (string): required; Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.feeAmount (string): required; The fee that the user needs to payfeeTickPrice (string): required; The price of fee ticksigs (array): User signaturepayType (string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotarememberPayType (boolean):Default Response
code (number): requiredmsg (string): requireddata (object):
id (string): Function idrollupInscriptionId (string): The rollup inscription id where the function is locatedaddress (string):type (string):tick0 (string):tick1 (string):amount0 (string): required; Input amount of tick0amount1 (string): required; Input amount of tick1lp (string):ts (number):success (boolean): Operation success statusvalue (number): Operation valuepreResult (object): Pre-operation resultresult (object): Operation resultMethod: GET
Path: /v1/brc20-swap/pre_send
Swagger Link: View in Swagger UI
Returns signature ids, sign messages, fee amount, fee tick price, fee balance, and USD fee value for transferring a tick amount to a recipient.
address (query, string) (required):tick (query, string) (required): Send tickamount (query, string) (required): The amount of send tickto (query, string) (required): The receiver of send tickts (query, number) (required): Timestamp (seconds)feeTick (query, string) (required): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.payType (query, string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotaDefault Response
code (number): requiredmsg (string): requireddata (object):
ids (array): User signature idsignMsgs (array): User signature informationfeeAmount (string): The fee that the user needs to payfeeTickPrice (string): The price of fee tickfeeBalance (string): The user’s fee tick balanceusdPrice (string): The dollar value of the feeMethod: POST
Path: /v1/brc20-swap/pre_batch_send
Swagger Link: View in Swagger UI
Returns per-item signature ids, sign messages, and fee metadata for transferring multiple tick amounts to recipients in one batch workflow.
Content-Type: application/json (required)
address (string): requiredtick (string): required; Send tickamount (string): The amount of send tick. Either amount or amountList must be provided.amountList (array): Optional per-recipient amounts. When provided, its length must match to.to (array): The receiver of send tickts (number): required; Timestamp (seconds)feeTick (string): required; Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.payType (string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotaDefault Response
code (number): requiredmsg (string): requireddata (object):
ids (array): User signature idsignMsgs (array): User signature informationfeeAmount (string): The fee that the user needs to payfeeTickPrice (string): The price of fee tickfeeBalance (string): The user’s fee tick balanceusdPrice (string): The dollar value of the feeMethod: GET
Path: /v1/brc20-swap/pre_swap
Swagger Link: View in Swagger UI
Returns signature ids, sign messages, fee fields, and fee-balance metadata for a quoted swap between input and output ticks.
address (query, string) (required):tickIn (query, string) (required): Input ticktickOut (query, string) (required): Output tickamountIn (query, string) (required): The amount of input tickamountOut (query, string) (required): The amount of output tickslippage (query, string) (required):exactType (query, string) (required): enum: exactIn, exactOut; example: "exactIn"ts (query, number) (required): Timestamp(seconds)feeTick (query, string) (required): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.payType (query, string): Pay type. Allowed values are tick, freeQuota, and assetFeeTick.; enum: tick, freeQuota, assetFeeTickDefault Response
code (number): requiredmsg (string): requireddata (object):
ids (array): User signature idsignMsgs (array): User signature informationfeeAmount (string): The fee that the user needs to payfeeTickPrice (string): The price of fee tickfeeBalance (string): The user’s fee tick balanceusdPrice (string): The dollar value of the feeMethod: POST
Path: /v1/brc20-swap/send
Swagger Link: View in Swagger UI
Transfers a tick amount from an address to one or more recipients using prepared signatures and fee fields. Review recipients, amounts, fee payment, and signatures before submission.
Content-Type: application/json (required)
address (string): requiredtick (string): required; Send tickamount (string): The amount of send tick. Either amount or amountList must be provided.amountList (array): Optional per-recipient amounts. When provided, its length must match to.to (string): required; The receiver of send tickts (number): required; Timestamp (seconds)feeTick (string): required; Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.feeAmount (string): required; The fee that the user needs to payfeeTickPrice (string): required; The price of fee ticksigs (array): User signaturepayType (string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotarememberPayType (boolean):Default Response
code (number): requiredmsg (string): requireddata (object):Method: POST
Path: /v1/brc20-swap/batch_send
Swagger Link: View in Swagger UI
Executes multiple prepared tick transfers in one request using per-item signatures and fee fields. Review every recipient, amount, fee payment, and signature before submission.
Content-Type: application/json (required)
address (string): requiredtick (string): required; Send tickamount (string): required; The amount of send tickto (array): The receiver of send tickts (number): required; Timestamp (seconds)feeTick (string): required; Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.feeAmount (string): required; The fee that the user needs to payfeeTickPrice (string): required; The price of fee ticksigs (array): User signaturepayType (string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotarememberPayType (boolean):Default Response
code (number): requiredmsg (string): requireddata (object):Method: POST
Path: /v1/brc20-swap/swap
Swagger Link: View in Swagger UI
Executes a prepared swap between input and output ticks with exact-in or exact-out semantics. Review quoted amounts, slippage, fee payment, and signatures before submission.
Content-Type: application/json (required)
address (string): requiredtickIn (string): required; Input ticktickOut (string): required; Output tickamountIn (string): required; The amount of input tickamountOut (string): required; The amount of output tickfeeTick (string): required; Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.slippage (string): requiredexactType (string): required; enum: exactIn, exactOutts (number): required; Timestamp (seconds)feeAmount (string): required; The fee that the user needs to payfeeTickPrice (string): required; The price of fee ticksigs (array): User signaturepayType (string): Pay type. Allowed values are tick, freeQuota, and assetFeeTick.; enum: tick, freeQuota, assetFeeTickrememberPayType (boolean):assetFeeTick (string): Required when payType is assetFeeTick. Used as the fee asset tick for swap.assetFeeAmount (string): Required when payType is assetFeeTick. Fee amount charged in assetFeeTick.assetFeeTickPrice (string): Required when payType is assetFeeTick. Price of assetFeeTick.Default Response
code (number): requiredmsg (string): requireddata (object):
id (string): Function idrollupInscriptionId (string): The rollup inscription id where the function is locatedaddress (string):tickIn (string):tickOut (string):amountIn (string):amountOut (string):exactType (string):ts (number):success (boolean): Operation success statusvalue (number): Operation valuepreResult (object): Pre-operation resultresult (object): Operation resultMethod: GET
Path: /v1/brc20-swap/pool_list
Swagger Link: View in Swagger UI
Returns paginated pool pairs with LP token, TVL, 24h/7d/30d volume, and reserve amounts for each token.
search (query, string): Fuzzy matchingstart (query, number) (required):limit (query, number) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
tick0 (string):tick1 (string):lp (string):tvl (string): Total pool valuevolume24h (string):volume7d (string):volume30d (string): 30 days volumeamount0 (string): Amount of tick0amount1 (string): Amount of tick1Method: GET
Path: /v1/brc20-swap/my_pool_list
Swagger Link: View in Swagger UI
Returns paginated pool positions for an address, including LP amount, pool share, token amounts, and claimed or unclaimed rewards.
address (query, string) (required):tick (query, string):start (query, number) (required):limit (query, number) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
lp (string):shareOfPool (string):tick0 (string):tick1 (string):amount0 (string): required; Amount of tick0amount1 (string): required; Amount of tick1claimedReward0 (string):claimedReward1 (string):unclaimedReward0 (string):unclaimedReward1 (string):Method: GET
Path: /v1/brc20-swap/my_pool
Swagger Link: View in Swagger UI
Returns LP amount, pool share, token amounts, locked LP, and claimed or unclaimed rewards for a specific address and token pair.
address (query, string) (required):tick0 (query, string) (required):tick1 (query, string) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
lp (string):shareOfPool (string):tick0 (string):tick1 (string):amount0 (string): required; Amount of tick0amount1 (string): required; Amount of tick1lockedLp (string): Locked LP amountclaimedReward0 (string): Claimed reward for tick0claimedReward1 (string): Claimed reward for tick1unclaimedReward0 (string): Unclaimed reward for tick0unclaimedReward1 (string): Unclaimed reward for tick1Method: GET
Path: /v1/brc20-swap/overview
Swagger Link: View in Swagger UI
Returns protocol overview metrics including total liquidity, 24h and 7d volume, 24h transaction count, and number of active pairs.
Default Response
code (number): requiredmsg (string): requireddata (object):
liquidity (string): Total value of all poolsvolume7d (string): 7 days volumevolume24h (string): 24 hours volumetransactions (number): Number of transactions in 24 hourspairs (number):Method: GET
Path: /v1/brc20-swap/gas_history
Swagger Link: View in Swagger UI
Returns paginated gas-fee records with function type, token pair, gas amount, fee tick, recipient address, and timestamp.
address (query, string):start (query, number) (required):limit (query, number) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
funcType (string): Function type; example: "swap"tickA (string):tickB (string):gas (string):tick (string): Fee tickto (string): Recipient addressts (number):Method: GET
Path: /v1/brc20-swap/send_history
Swagger Link: View in Swagger UI
Returns paginated transfer records filtered by address or tick, including token tick, amount, recipient, and timestamp.
address (query, string):tick (query, string):start (query, number) (required):limit (query, number) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
tick (string):amount (string):to (string):ts (number):Method: GET
Path: /v1/brc20-swap/liq_history
Swagger Link: View in Swagger UI
Returns paginated liquidity records with action type, token pair, token amounts, rewards, LP amount, and timestamp.
address (query, string):tick (query, string):type (query, string): Optional liquidity history type filter.; enum: add, removestart (query, number) (required):limit (query, number) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
type (string):tick0 (string):tick1 (string):amount0 (string):amount1 (string):reward0 (string): Reward amount for tick0reward1 (string): Reward amount for tick1lp (string):ts (number):Method: GET
Path: /v1/brc20-swap/swap_history
Swagger Link: View in Swagger UI
Returns paginated swap records filtered by address or tick, including input/output ticks, amounts, exact type, and timestamp.
address (query, string):tick (query, string):start (query, number) (required):limit (query, number) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
tickIn (string): required; Input ticktickOut (string): required; Output tickamountIn (string): required; The amount of input tickamountOut (string): required; The amount of output tickexactType (string):ts (number):Method: GET
Path: /v1/brc20-swap/rollup_history
Swagger Link: View in Swagger UI
Returns paginated rollup records with transaction id, block height, transaction count, inscription id, inscription number, and timestamp.
start (query, number) (required):limit (query, number) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
txid (string):height (number):transactionNum (number): Number of transactions in the inscriptioninscriptionId (string): Rollup inscription idinscriptionNumber (number): Rollup inscription numberts (number):Method: GET
Path: /v1/brc20-swap/deposit_list
Swagger Link: View in Swagger UI
Returns paginated deposit records with tick, amount, current and required confirmations, timestamp, txid, and deposit type.
address (query, string) (required):tick (query, string):start (query, number) (required):limit (query, number) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
tick (string):amount (string):cur (number): Current number of confirmationssum (number): Total number of confirmationsts (number):txid (string):type (string):Method: GET
Path: /v1/brc20-swap/create_deposit
Swagger Link: View in Swagger UI
Returns either a single psbt or a BRC20 transaction chain, selected from the available balance and transfer inscriptions. Sign each returned PSBT using its corresponding ToSignInputs when provided, then submit the signed fields to confirm_deposit. A Fractal BRC20 request with inscriptionId can omit tick and amount; both are read from the inscription. Transaction chains contain commitPsbt and revealPsbt, an optional consumePsbt, and sendPsbt for BTC deposits.
inscriptionId (query, string): Existing BRC20 transfer inscription. Omit to let the service select or build transfer transactions.pubkey (query, string) (required):address (query, string) (required):amount (query, string): Required unless depositing a Fractal BRC20 inscription specified by inscriptionId.tick (query, string): Required unless depositing a Fractal BRC20 inscription specified by inscriptionId.assetType (query, string): Asset type. Non-BRC20 assets use a single bridge PSBT.; enum: btc, brc20, runes, alkanes; default: brc20networkType (query, string): Source network. Must be supported by the configured indexer and bridge service.; enum: FRACTAL_BITCOIN_MAINNET, FRACTAL_BITCOIN_TESTNET, BITCOIN_MAINNET, BITCOIN_TESTNET, BITCOIN_TESTNET4, BITCOIN_SIGNET; default: FRACTAL_BITCOIN_MAINNETfeeRate (query, number): Positive network fee rate in sat/vB. Omit to use the service default; zero is not accepted.Single PSBT or BRC20 transaction chain to sign.
code (number): requiredmsg (string): requireddata (object):
psbt (string): Single deposit PSBT. Returned instead of transaction-chain PSBT fields.type (string): Deposit type.; enum: direct, matching, bridgeexpiredTimestamp (number):recommendDeposit (string):consumePsbt (string): Optional transaction consuming existing transferable inscriptions.commitPsbt (string): Commit transaction for a new transfer inscription.revealPsbt (string): Reveal transaction for the new transfer inscription.sendPsbt (string): Final bridge send transaction for BTC BRC20 deposits.consumeToSignInputs (array):
index (integer): required; Zero-based PSBT input index to sign.address (string): required; Address whose key signs this input.disableTweakSigner (boolean): Whether the Taproot signer must disable key tweaking for this input.commitToSignInputs (array):
index (integer): required; Zero-based PSBT input index to sign.address (string): required; Address whose key signs this input.disableTweakSigner (boolean): Whether the Taproot signer must disable key tweaking for this input.revealToSignInputs (array):
index (integer): required; Zero-based PSBT input index to sign.address (string): required; Address whose key signs this input.disableTweakSigner (boolean): Whether the Taproot signer must disable key tweaking for this input.sendToSignInputs (array):
index (integer): required; Zero-based PSBT input index to sign.address (string): required; Address whose key signs this input.disableTweakSigner (boolean): Whether the Taproot signer must disable key tweaking for this input.Method: POST
Path: /v1/brc20-swap/confirm_deposit
Swagger Link: View in Swagger UI
Submit either psbt for a single transaction or the signed transaction-chain fields returned by create_deposit; do not mix them. A Fractal BRC20 single deposit only requires psbt; inscriptionId is optional. A BRC20 chain requires address, tick, amount, commitPsbt and revealPsbt. Include consumePsbt if it was returned. BTC BRC20 chains additionally require pubkey and sendPsbt. BTC single deposits and non-BRC20 bridge deposits require psbt, pubkey, address, tick, amount, assetType and networkType. Transaction chains only support BRC20. Omitted networkType and assetType default to FRACTAL_BITCOIN_MAINNET and brc20. Returns the transaction id and required confirmation count.
Content-Type: application/json (required)
assetType (string): enum: brc20Deposit transaction submitted.
code (number): requiredmsg (string): requireddata (object):
txid (string): Transaction IDpendingNum (number): Required number of confirmations for the deposit.Method: GET
Path: /v1/brc20-swap/system_status
Swagger Link: View in Swagger UI
Returns the current system committing flag so clients can decide whether rollup-related operations are temporarily in progress.
Default Response
code (number): requiredmsg (string): requireddata (object):
committing (boolean): Is rollup inscription committingMethod: GET
Path: /v1/brc20-swap/withdraw_history
Swagger Link: View in Swagger UI
Returns paginated withdrawal records with id, tick, total and completed amounts, confirmation progress, status, type, and timestamp.
address (query, string) (required):start (query, number) (required):limit (query, number) (required):tick (query, string):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
id (string):tick (string):totalAmount (string): Total amount withdrawalcompletedAmount (string): The number of withdrawal completedts (number):totalConfirmedNum (number): The current number of confirmationstotalNum (number): The total number of confirmationsstatus (string):type (string):Method: GET
Path: /v1/brc20-swap/create_retry_withdraw
Swagger Link: View in Swagger UI
Returns payment PSBT, approve-inscription PSBT, and network fee required to retry a previously created withdrawal order.
id (query, string) (required):pubkey (query, string) (required):address (query, string) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
paymentPsbt (string): The user psbt with paymentapprovePsbt (string): The user psbt with approve insctiptionnetworkFee (number):Method: POST
Path: /v1/brc20-swap/confirm_retry_withdraw
Swagger Link: View in Swagger UI
Confirms a retry withdrawal order by submitting its id with signed payment and approve PSBTs. Verify the order id and both signed PSBTs before submission.
Content-Type: application/json (required)
id (string): required; The withdraw order idpaymentPsbt (string): requiredapprovePsbt (string): requiredDefault Response
code (number): requiredmsg (string): requireddata (object):Method: GET
Path: /v1/brc20-swap/create_withdraw
Swagger Link: View in Swagger UI
Prepares withdrawal data for a tick amount, fee tick, payment type, and optional bridge asset metadata before the signed confirmation step.
pubkey (query, string) (required):address (query, string) (required):tick (query, string) (required):amount (query, string) (required):ts (query, number) (required):feeTick (query, string) (required): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.payType (query, string) (required): Withdraw creation currently only supports tick.; enum: tickfeeRate (query, number):assetType (query, string): Required for bridge withdrawals.; enum: btc, brc20, runes, alkanesnetworkType (query, string): Required for bridge withdrawals.; enum: FRACTAL_BITCOIN_MAINNET, FRACTAL_BITCOIN_TESTNET, BITCOIN_MAINNET, BITCOIN_TESTNET, BITCOIN_TESTNET4, BITCOIN_SIGNETDefault Response
code (number): requiredmsg (string): requireddata (object):Method: POST
Path: /v1/brc20-swap/confirm_withdraw
Swagger Link: View in Swagger UI
Confirms a withdrawal order using payment and approve PSBTs plus fee and signature fields. Review order id, amount, tick, fee payment, and signed PSBTs before submission.
Content-Type: application/json (required)
id (string): required; The withdraw order idpaymentPsbt (string): requiredapprovePsbt (string): requiredfeeTick (string): required; Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.feeAmount (string): The fee that the user needs to payfeeTickPrice (string): The price of fee ticksigs (array): User signaturepayType (string): required; Withdraw confirmation currently only supports tick.; enum: tickrememberPayType (boolean):ts (number):pubkey (string):address (string):amount (string):tick (string):assetType (string): enum: btc, brc20, runes, alkanesnetworkType (string): enum: FRACTAL_BITCOIN_MAINNET, FRACTAL_BITCOIN_TESTNET, BITCOIN_MAINNET, BITCOIN_TESTNET, BITCOIN_TESTNET4, BITCOIN_SIGNETDefault Response
code (number): requiredmsg (string): requireddata (object):Method: GET
Path: /v1/brc20-swap/withdraw_process
Swagger Link: View in Swagger UI
Returns withdrawal status details including confirmation counts, rollup/payment/inscribe/approve txids, completed amount, and match history.
id (query, string) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
id (string):tick (string):amount (string):ts (number):status (string):totalConfirmedNum (number):totalNum (number): Total number of confirmations (rollUp + approve)rollUpConfirmNum (number):rollUpTotalNum (number): Total number of rollUp confirmationsapproveConfirmNum (number):approveTotalNum (number): Total number of approve confirmationscancelConfirmedNum (number):cancelTotalNum (number):rollUpTxid (string): Decrease operation is required to withdraw, which in rollup inscriptionpaymentTxid (string):inscribeTxid (string):approveTxid (string):completedAmount (string):matchHistory (array):
approveInscriptionId (string): Withdraw inscriptiontransferInscriptionId (string): Deposit inscriptiontick (string):consumeAmount (string):remainAmount (string): Residual cash withdrawalapproveAddress (string): Withdraw user addresstransferAddress (string): Deposit user addresstxid (string): Matching txidts (number):Method: GET
Path: /v1/brc20-swap/quote_swap
Swagger Link: View in Swagger UI
Estimates swap result values for exact-in or exact-out requests, including input USD value, expected USD value, and expected token amount.
address (query, string) (required):tickIn (query, string) (required): Input ticktickOut (query, string) (required): Output tickamount (query, string) (required): If it is exactIn, it is the amount of input tick, else is the amount of output tickexactType (query, string) (required): Exact input or exact output; enum: exactIn, exactOut; example: "exactIn"Default Response
code (number): requiredmsg (string): requireddata (object):
amountUSD (string): Input amount of usd valueexpectUSD (string): Estimated amount of usd valueexpect (string): Estimated amountMethod: GET
Path: /v1/brc20-swap/quote_add_liq
Swagger Link: View in Swagger UI
Estimates real token amounts, USD values, LP minted, pair exchange ratios, and resulting pool share for an add-liquidity request.
address (query, string) (required):tick0 (query, string) (required):tick1 (query, string) (required):amount0 (query, string): The expect amount of tick0amount1 (query, string): The expect amount of tick1Default Response
code (number): requiredmsg (string): requireddata (object):
amount0 (string): The real amount of tick0amount1 (string): The real amount of tick1amount0USD (string): The usd value of amount0amount1USD (string): The usd value of amount1lp (string): Estimated lptick0PerTick1 (string): tick0/tick1tick1PerTick0 (string): tick1/tick0shareOfPool (string): The proportion of the injected quantity in the poolMethod: GET
Path: /v1/brc20-swap/quote_remove_liq
Swagger Link: View in Swagger UI
Estimates the token pair amounts and USD values returned when removing a specified LP amount from a pool.
address (query, string) (required):tick0 (query, string) (required):tick1 (query, string) (required):lp (query, string) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
tick0 (string):tick1 (string):amount0 (string): required; Amount of tick0amount1 (string): required; Amount of tick1amount0USD (string):amount1USD (string):Method: GET
Path: /v1/brc20-swap/pre_stake
Swagger Link: View in Swagger UI
Returns signature ids, sign messages, fee amount, fee tick price, fee balance, and USD fee value for staking an LP amount in a reward pool.
pid (query, string) (required):address (query, string) (required):amount (query, string) (required): The amount of send tickts (query, number) (required): Timestamp (seconds)feeTick (query, string) (required): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.payType (query, string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotaDefault Response
code (number): requiredmsg (string): requireddata (object):
ids (array): User signature idsignMsgs (array): User signature informationfeeAmount (string): The fee that the user needs to payfeeTickPrice (string): The price of fee tickfeeBalance (string): The user’s fee tick balanceusdPrice (string): The dollar value of the feeMethod: GET
Path: /v1/brc20-swap/pre_unstake
Swagger Link: View in Swagger UI
Returns signature ids, sign messages, fee amount, fee tick price, fee balance, and USD fee value for unstaking an LP amount from a reward pool.
pid (query, string) (required):address (query, string) (required):amount (query, string) (required): The amount of send tickts (query, number) (required): Timestamp (seconds)feeTick (query, string) (required): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.payType (query, string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotaDefault Response
code (number): requiredmsg (string): requireddata (object):
ids (array): User signature idsignMsgs (array): User signature informationfeeAmount (string): The fee that the user needs to payfeeTickPrice (string): The price of fee tickfeeBalance (string): The user’s fee tick balanceusdPrice (string): The dollar value of the feeMethod: GET
Path: /v1/brc20-swap/pre_claim
Swagger Link: View in Swagger UI
Returns signature ids, sign messages, fee amount, fee tick price, fee balance, and USD fee value for claiming rewards from a staking pool.
pid (query, string) (required):address (query, string) (required):ts (query, number) (required): Timestamp (seconds)feeTick (query, string) (required): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.payType (query, string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotaDefault Response
code (number): requiredmsg (string): requireddata (object):
ids (array): User signature idsignMsgs (array): User signature informationfeeAmount (string): The fee that the user needs to payfeeTickPrice (string): The price of fee tickfeeBalance (string): The user’s fee tick balanceusdPrice (string): The dollar value of the feeMethod: GET
Path: /v1/brc20-swap/pre_send_lp
Swagger Link: View in Swagger UI
Returns signature ids, sign messages, fee fields, LP token conversion data, and fee-balance metadata for sending LP tokens to another address.
address (query, string) (required):tick0 (query, string) (required): Lp tick0tick1 (query, string) (required): Lp tick1amount (query, string) (required): The amount of send tickto (query, string) (required): The receiver of send tickts (query, number) (required): Timestamp (seconds)feeTick (query, string) (required): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.payType (query, string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotaDefault Response
code (number): requiredmsg (string): requireddata (object):
ids (array): User signature idsignMsgs (array): User signature informationfeeAmount (string): The fee that the user needs to payfeeTickPrice (string): The price of fee tickfeeBalance (string): The user’s fee tick balanceusdPrice (string): The dollar value of the feeamount0PerLp (string):amount1PerLp (string):Method: POST
Path: /v1/brc20-swap/send_lp
Swagger Link: View in Swagger UI
Transfers LP tokens for a token pair to another address using prepared signatures and fee fields. Review recipient, LP amount, fee payment, and signatures before submission.
Content-Type: application/json (required)
address (string): requiredtick0 (string): required; Lp tick0tick1 (string): required; Lp tick1amount (string): required; The amount of send tickto (string): required; The receiver of send tickts (number): required; Timestamp (seconds)feeTick (string): required; Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.feeAmount (string): required; The fee that the user needs to payfeeTickPrice (string): required; The price of fee ticksigs (array): User signaturepayType (string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotarememberPayType (boolean):Default Response
code (number): requiredmsg (string): requireddata (object):Method: POST
Path: /v1/brc20-swap/stake
Swagger Link: View in Swagger UI
Stakes an LP amount in a reward pool using prepared signatures and fee fields. Review pool id, amount, fee payment, and signatures before submission.
Content-Type: application/json (required)
pid (string): requiredaddress (string): requiredamount (string): required; The amount of send tickts (number): required; Timestamp (seconds)feeTick (string): required; Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.feeAmount (string): required; The fee that the user needs to payfeeTickPrice (string): required; The price of fee ticksigs (array): User signaturepayType (string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotarememberPayType (boolean):Default Response
code (number): requiredmsg (string): requireddata (object):Method: POST
Path: /v1/brc20-swap/unstake
Swagger Link: View in Swagger UI
Unstakes an LP amount from a reward pool using prepared signatures and fee fields. Review pool id, amount, fee payment, and signatures before submission.
Content-Type: application/json (required)
pid (string): requiredaddress (string): requiredamount (string): required; The amount of send tickts (number): required; Timestamp (seconds)feeTick (string): required; Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.feeAmount (string): required; The fee that the user needs to payfeeTickPrice (string): required; The price of fee ticksigs (array): User signaturepayType (string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotarememberPayType (boolean):Default Response
code (number): requiredmsg (string): requireddata (object):Method: POST
Path: /v1/brc20-swap/claim
Swagger Link: View in Swagger UI
Claims rewards from a staking pool using prepared signatures and fee fields, returning the claimed reward amount when available.
Content-Type: application/json (required)
pid (string): requiredaddress (string): requiredts (number): required; Timestamp (seconds)feeTick (string): required; Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.feeAmount (string): required; The fee that the user needs to payfeeTickPrice (string): required; The price of fee ticksigs (array): User signaturepayType (string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotarememberPayType (boolean):Default Response
code (number): requiredmsg (string): requireddata (object):
amount (string): Claimed reward amountMethod: GET
Path: /v1/brc20-swap/lp_reward_history
Swagger Link: View in Swagger UI
Returns paginated LP reward records for an address and token pair, including reward amounts, event type, and timestamp.
address (query, string) (required):tick0 (query, string) (required):tick1 (query, string) (required):start (query, number) (required):limit (query, number) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
id (string):type (string):address (string):tick0 (string):tick1 (string):reward0 (string):reward1 (string):ts (number):Method: GET
Path: /v1/brc20-swap/stake_history
Swagger Link: View in Swagger UI
Returns paginated staking records for an address, filtered by pool, search text, and action type, with pool pair, amount, reward tick, and timestamp.
pid (query, string):search (query, string):address (query, string) (required):type (query, string) (required): Stake history type.; enum: all, stake, unstake, claimstart (query, number) (required):limit (query, number) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
pid (string):address (string):poolTick0 (string):poolTick1 (string):type (string):amount (string):tick (string):ts (number):Method: GET
Path: /v1/brc20-swap/stake_list
Swagger Link: View in Swagger UI
Returns staking campaign windows with reward pool summaries, including pool id, pool pair, reward tick, current total LP, base reward, and staged reward thresholds.
Default Response
code (number): requiredmsg (string): requireddata (object):
list (array):
startBlock (number):endBlock (number):stakePools (array):
summary (object):
pid (string):poolTick0 (string):poolTick1 (string):rewardTick (string):curTotalLp (string):baseReward (string):stageNeedLp (array):stageAddedRewards (array):Method: GET
Path: /v1/brc20-swap/stake_item
Swagger Link: View in Swagger UI
Returns a staking campaign item plus newest indexed height, including reward pool summaries, staged LP requirements, and staged added rewards.
eid (query, string) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
item (object):
startBlock (number):endBlock (number):stakePools (array):
summary (object):
pid (string):poolTick0 (string):poolTick1 (string):rewardTick (string):curTotalLp (string):baseReward (string):stageNeedLp (array):stageAddedRewards (array):newestHeight (number):Method: GET
Path: /v1/brc20-swap/stake_user_info
Swagger Link: View in Swagger UI
Returns staking user data for an address. The response is extensible because the server may include campaign-specific or user-specific fields.
address (query, string):Default Response
code (number): requiredmsg (string): requireddata (object): requiredMethod: GET
Path: /v1/brc20-swap/user_info
Swagger Link: View in Swagger UI
Returns the user’s remembered fee payment preference, including default pay type and whether the preference should be remembered.
address (query, string) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
defaultPayType (string): User default pay type.; enum: tick, freeQuota, assetFeeTickrememberPayType (boolean):Method: GET
Path: /v1/brc20-swap/select_deposit
Swagger Link: View in Swagger UI
Returns server-provided deposit selection data for a pubkey and address. The schema is intentionally open to support direct, matching, or bridge deposit choices.
pubkey (query, string) (required):address (query, string) (required):v (query, string):Default Response
code (number): requiredmsg (string): requireddata (object): requiredMethod: GET
Path: /v1/brc20-swap/func_info
Swagger Link: View in Swagger UI
Returns server-side function execution data for a submitted operation id. The response is open because details vary by operation type.
id (query, string) (required):Default Response
code (number): requiredmsg (string): requireddata (object): requiredMethod: GET
Path: /v1/brc20-swap/deposit_balance
Swagger Link: View in Swagger UI
Returns server-provided deposit balance data for a pubkey, address, and tick. The response shape is open to support multiple deposit modes.
pubkey (query, string) (required):address (query, string) (required):tick (query, string) (required):Default Response
code (number): requiredmsg (string): requireddata (object): requiredMethod: GET
Path: /v1/brc20-swap/deposit_process
Swagger Link: View in Swagger UI
Returns deposit progress by txid, including tick, amount, current and required confirmations, timestamp, type, and status.
txid (query, string) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
tick (string):amount (string):cur (number): Current number of confirmationssum (number): Total number of confirmationsts (number):txid (string):type (string):status (string):Method: GET
Path: /v1/brc20-swap/tick_price
Swagger Link: View in Swagger UI
Returns the latest price value for a tick as used by InSwap quote, valuation, or portfolio views.
tick (query, string) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
price (number):Method: GET
Path: /v1/brc20-swap/address_gas
Swagger Link: View in Swagger UI
Returns the total available fee-token amount for an address and fee tick, useful before preparing fee-paying swap operations.
address (query, string) (required):feeTick (query, string) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):Method: GET
Path: /v1/brc20-swap/price_line
Swagger Link: View in Swagger UI
Returns time-series price and USD price points for a token pair over a selected range such as 24h, 7d, 30d, 90d, or all.
tick0 (query, string) (required):tick1 (query, string) (required):timeRange (query, string) (required): Time range for price line aggregation.; enum: 24h, 7d, 30d, 90d, allDefault Response
code (number): requiredmsg (string): requireddata (object):
list (array):
price (number):usdPrice (number):ts (number):Method: GET
Path: /v1/brc20-swap/tick_holders
Swagger Link: View in Swagger UI
Returns paginated holder records for a tick, including address, amount, overall percentage, and relative percentage.
tick (query, string) (required):start (query, number) (required):limit (query, number) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
address (string):amount (string):percentage (number):relativePercentage (number):Method: GET
Path: /v1/brc20-swap/pool_holders
Swagger Link: View in Swagger UI
Returns paginated LP holder records for a token pair, including token amounts, LP amount, pool share, and locked LP breakdown.
tick0 (query, string) (required):tick1 (query, string) (required):start (query, number) (required):limit (query, number) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
address (string):amount0 (string):amount1 (string):lp (string):shareOfPool (string):lockLp (object):
lp (string):amount0 (string):amount1 (string):Method: GET
Path: /v1/brc20-swap/reward_curve
Swagger Link: View in Swagger UI
Returns reward-curve data for an address and token pair over a time range. The response is open because curve series fields may vary by campaign.
address (query, string) (required):tick0 (query, string) (required):tick1 (query, string) (required):startTime (query, number) (required):endTime (query, number) (required):Default Response
code (number): requiredmsg (string): requireddata (object): requiredMethod: GET
Path: /v1/brc20-swap/send_lp_history
Swagger Link: View in Swagger UI
Returns paginated LP transfer records filtered by address or tick, including tick, amount, recipient, and timestamp.
address (query, string):tick (query, string):fuzzySearch (query, boolean):start (query, number) (required):limit (query, number) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
tick (string):amount (string):to (string):ts (number):Method: GET
Path: /v1/brc20-swap/burn_history
Swagger Link: View in Swagger UI
Returns paginated burn records plus total LP and burned LP amounts, with optional address, tick, fuzzy-search, and timestamp filters.
address (query, string):tick (query, string):fuzzySearch (query, boolean):start (query, number) (required):limit (query, number) (required):ts (query, number):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):totalLp (string): Total LP amountburnedLp (string): Burned LP amountlist (array):
tick (string):amount (string):to (string):ts (number):Method: GET
Path: /v1/brc20-swap/task_list
Swagger Link: View in Swagger UI
Returns task metadata for an address, including task id, item ids, completion flags, and task start/end times when available.
tid (query, string): default: 1address (query, string) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
tid (string):list (array):
tid (string):itemId (string):address (string):done (boolean):Method: GET
Path: /v1/brc20-swap/address_usd
Swagger Link: View in Swagger UI
Returns USD valuation entries for an address, separating token asset value and LP position value.
address (query, string) (required):Default Response
code (number): requiredmsg (string): requireddata (array):
assetsUSD (string):lpUSD (string):Method: GET
Path: /v1/brc20-swap/pre_lock_lp
Swagger Link: View in Swagger UI
Returns signature ids, sign messages, fee fields, LP token conversion data, and fee-balance metadata for locking LP tokens for a selected duration.
address (query, string) (required):lockDay (query, string) (required):tick0 (query, string) (required): Lp tick0tick1 (query, string) (required): Lp tick1amount (query, string) (required): The amount of lock tickts (query, number) (required): Timestamp (seconds)feeTick (query, string) (required): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.payType (query, string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotaDefault Response
code (number): requiredmsg (string): requireddata (object):
ids (array): User signature idsignMsgs (array): User signature informationfeeAmount (string): The fee that the user needs to payfeeTickPrice (string): The price of fee tickfeeBalance (string): The user’s fee tick balanceusdPrice (string): The dollar value of the feeamount0PerLp (string):amount1PerLp (string):Method: POST
Path: /v1/brc20-swap/lock_lp
Swagger Link: View in Swagger UI
Locks LP tokens for a token pair and lock duration using prepared signatures and fee fields. Review lock duration, LP amount, fee payment, and signatures before submission.
Content-Type: application/json (required)
address (string): requiredlockDay (string): requiredtick0 (string): requiredtick1 (string): requiredamount (string): required; The amount of lock tickts (number): required; Timestamp (seconds)feeTick (string): required; Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.feeAmount (string): required; The fee that the user needs to payfeeTickPrice (string): required; The price of fee ticksigs (array): User signaturepayType (string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotarememberPayType (boolean):Default Response
code (number): requiredmsg (string): requireddata (object):Method: GET
Path: /v1/brc20-swap/pre_unlock_lp
Swagger Link: View in Swagger UI
Returns signature ids, sign messages, fee fields, LP token conversion data, and fee-balance metadata for unlocking previously locked LP tokens.
address (query, string) (required):tick0 (query, string) (required): Lp tick0tick1 (query, string) (required): Lp tick1amount (query, string) (required): The amount of unlock tickts (query, number) (required): Timestamp (seconds)feeTick (query, string) (required): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.payType (query, string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotaDefault Response
code (number): requiredmsg (string): requireddata (object):
ids (array): User signature idsignMsgs (array): User signature informationfeeAmount (string): The fee that the user needs to payfeeTickPrice (string): The price of fee tickfeeBalance (string): The user’s fee tick balanceusdPrice (string): The dollar value of the feeamount0PerLp (string):amount1PerLp (string):Method: POST
Path: /v1/brc20-swap/unlock_lp
Swagger Link: View in Swagger UI
Unlocks LP tokens for a token pair using prepared signatures and fee fields. Review LP amount, fee payment, and signatures before submission.
Content-Type: application/json (required)
address (string): requiredtick0 (string): requiredtick1 (string): requiredamount (string): required; The amount of unlock tickts (number): required; Timestamp (seconds)feeTick (string): required; Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.feeAmount (string): required; The fee that the user needs to payfeeTickPrice (string): required; The price of fee ticksigs (array): User signaturepayType (string): Pay type. Allowed values are tick and freeQuota.; enum: tick, freeQuotarememberPayType (boolean):Default Response
code (number): requiredmsg (string): requireddata (object):Method: GET
Path: /v1/brc20-swap/lock_lp_history
Swagger Link: View in Swagger UI
Returns paginated LP lock records with address, pair, LP amount, token amounts, USD values, lock duration, unlock time, pool share, and timestamp.
tick (query, string):tick0 (query, string):tick1 (query, string):start (query, number) (required):limit (query, number) (required):address (query, string):lockDay (query, number):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
id (string):address (string):tick0 (string):tick1 (string):lp (string):amount0 (string):amount1 (string):amount0USD (string):amount1USD (string):lockDay (number):unlockTime (string):ts (number):shareOfPool (string):Method: GET
Path: /v1/brc20-swap/unlock_lp_history
Swagger Link: View in Swagger UI
Returns paginated LP unlock records with address, pair, LP amount, token amounts, USD values, and timestamp.
tick (query, string):tick0 (query, string):tick1 (query, string):start (query, number) (required):limit (query, number) (required):address (query, string):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
id (string):address (string):tick0 (string):tick1 (string):lp (string):amount0 (string):amount1 (string):amount0USD (string):amount1USD (string):ts (number):Method: GET
Path: /v1/brc20-swap/export_lock_lp_history
Swagger Link: View in Swagger UI
Downloads CSV-formatted LP lock records for a token pair, optionally filtered by lock duration or lock time.
tick0 (query, string) (required):tick1 (query, string) (required):lockDay (query, number):lockTime (query, number):CSV file download
Method: GET
Path: /v1/brc20-swap/my_lock_lp
Swagger Link: View in Swagger UI
Returns total LP, locked LP, available LP, available underlying token amounts, and pool share for one address and token pair.
tick0 (query, string) (required):tick1 (query, string) (required):address (query, string) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
lp (string):lockLp (string):availableLp (string):availableAmount0 (string):availableAmount1 (string):shareOfPool (string):Method: GET
Path: /v1/brc20-swap/select_pool
Swagger Link: View in Swagger UI
Returns swappable tick candidates for an address with decimals, module balance, swap balance, and available route ticks.
address (query, string) (required):tickIn (query, string):tickOut (query, string):search (query, string):Default Response
code (number): requiredmsg (string): requireddata (array):
tick (string):decimal (string):brc20Balance (string): Module balance (not participate in swap calculations)swapBalance (string): Swap balanceroutes (array): Available routes for swappingMethod: GET
Path: /v1/brc20-swap/pre_multi_swap
Swagger Link: View in Swagger UI
Returns per-route signature ids, sign messages, fee fields, and fee-balance metadata for a multi-hop swap between input and output ticks.
address (query, string) (required):tickIn (query, string) (required): Input ticktickOut (query, string) (required): Output tickamountIn (query, string) (required): The amount of input tickamountOut (query, string) (required): The amount of output tickslippage (query, string) (required):exactType (query, string) (required): enum: exactIn, exactOut; example: "exactIn"ts (query, number) (required): Timestamp(seconds)feeTick (query, string) (required): Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.payType (query, string): Pay type. Allowed values are tick, freeQuota, and assetFeeTick.; enum: tick, freeQuota, assetFeeTickDefault Response
code (number): requiredmsg (string): requireddata (array):
ids (array): User signature idsignMsgs (array): User signature informationfeeAmount (string): The fee that the user needs to payfeeTickPrice (string): The price of fee tickfeeBalance (string): The user’s fee tick balanceusdPrice (string): The dollar value of the feeMethod: POST
Path: /v1/brc20-swap/multi_swap
Swagger Link: View in Swagger UI
Executes one or more prepared multi-hop swap items and returns per-item success, amounts, exact type, value, timestamp, and failure reason when applicable.
Content-Type: application/json (required)
items (array):
address (string): requiredtickIn (string): required; Input ticktickOut (string): required; Output tickamountIn (string): required; The amount of input tickamountOut (string): required; The amount of output tickfeeTick (string): required; Tick used as fee. Use /v1/brc20-swap/config to fetch available feeTicks.slippage (string): requiredexactType (string): required; enum: exactIn, exactOutts (number): required; Timestamp (seconds)feeAmount (string): required; The fee that the user needs to payfeeTickPrice (string): required; The price of fee ticksigs (array): User signaturepayType (string): Pay type. Allowed values are tick, freeQuota, and assetFeeTick.; enum: tick, freeQuota, assetFeeTickrememberPayType (boolean):assetFeeTick (string): Required when payType is assetFeeTick. Used as the fee asset tick for swap.assetFeeAmount (string): Required when payType is assetFeeTick. Fee amount charged in assetFeeTick.assetFeeTickPrice (string): Required when payType is assetFeeTick. Price of assetFeeTick.Default Response
code (number): requiredmsg (string): requireddata (array):
address (string):tickIn (string):tickOut (string):success (boolean):amountIn (string):amountOut (string):exactType (string):value (number):ts (number):failureReason (string):Method: GET
Path: /v1/brc20-swap/quote_multi_swap
Swagger Link: View in Swagger UI
Estimates a multi-hop swap with input USD value, expected USD value, expected output amount, and per-route expected amounts.
address (query, string) (required):tickIn (query, string) (required): Input ticktickOut (query, string) (required): Output tickamount (query, string) (required): If it is exactIn, it is the amount of input tick, else is the amount of output tickexactType (query, string) (required): Exact input or exact output; enum: exactIn, exactOut; example: "exactIn"Default Response
code (number): requiredmsg (string): requireddata (object):
amountUSD (string): Input amount of usd valueexpectUSD (string): Estimated amount of usd valueexpect (string): Estimated amountroutesExpect (array): Estimated amounts for each routeMethod: GET
Path: /v1/brc20-swap/multi_swap_history
Swagger Link: View in Swagger UI
Returns paginated multi-hop swap records with aggregate input/output amounts, value, route details, route success flags, and failure reasons.
address (query, string):tick (query, string):fuzzySearch (query, boolean):start (query, number) (required):limit (query, number) (required):Default Response
code (number): requiredmsg (string): requireddata (object):
total (number):list (array):
address (string):tickIn (string): required; Input ticktickOut (string): required; Output tickamountIn (string): required; The amount of input tickamountOut (string): required; The amount of output tickexactType (string):ts (number):value (number): Swap valueroute0 (object): First route details
id (string):tickIn (string):tickOut (string):amountIn (string):amountOut (string):exactType (string):ts (number):success (boolean):failureReason (string):route1 (object): Second route details
id (string):tickIn (string):tickOut (string):amountIn (string):amountOut (string):exactType (string):ts (number):success (boolean):failureReason (string):Method: POST
Path: /v1/brc20-swap/batch_history
Swagger Link: View in Swagger UI
Returns selected history groups for an address, such as gas, send, liquidity, swap, withdrawal, stake, LP transfer, burn, LP lock, LP unlock, and multi-hop swap records.
Content-Type: application/json (required)
start (number): required; Start index for paginationlimit (number): required; Maximum number of items to returnaddress (string): required; User addresstypes (array): Array of history types to queryDefault Response
code (number): requiredmsg (string): requireddata (object):
gas (object): Gas history data (if requested)
total (number):list (array):
funcType (string): Function type; example: "swap"tickA (string):tickB (string):gas (string):tick (string): Fee tickto (string): Recipient addressts (number):send (object): Send history data (if requested)
total (number):list (array):
tick (string):amount (string):to (string):ts (number):liq (object): Liquidity history data (if requested)
total (number):list (array):
type (string):tick0 (string):tick1 (string):amount0 (string):amount1 (string):reward0 (string): Reward amount for tick0reward1 (string): Reward amount for tick1lp (string):ts (number):swap (object): Swap history data (if requested)
total (number):list (array):
tickIn (string): required; Input ticktickOut (string): required; Output tickamountIn (string): required; The amount of input tickamountOut (string): required; The amount of output tickexactType (string):ts (number):withdraw (object): Withdraw history data (if requested)
total (number):list (array):
id (string):tick (string):totalAmount (string): Total amount withdrawalcompletedAmount (string): The number of withdrawal completedts (number):totalConfirmedNum (number): The current number of confirmationstotalNum (number): The total number of confirmationsstatus (string):type (string):stake (object): Stake history data (if requested)
total (number):list (array):
pid (string):address (string):poolTick0 (string):poolTick1 (string):type (string):amount (string):tick (string):ts (number):send_lp (object): Send LP history data (if requested)
total (number):list (array):
tick (string):amount (string):to (string):ts (number):burn (object): Burn history data (if requested)
total (number):totalLp (string): Total LP amountburnedLp (string): Burned LP amountlist (array):
tick (string):amount (string):to (string):ts (number):lock_lp (object): Lock LP history data (if requested)
total (number):list (array):
id (string):address (string):tick0 (string):tick1 (string):lp (string):amount0 (string):amount1 (string):amount0USD (string):amount1USD (string):lockDay (number):unlockTime (string):ts (number):shareOfPool (string):unlock_lp (object): Unlock LP history data (if requested)
total (number):list (array):
id (string):address (string):tick0 (string):tick1 (string):lp (string):amount0 (string):amount1 (string):amount0USD (string):amount1USD (string):ts (number):multi_swap (object): Multi swap history data (if requested)
total (number):list (array):
address (string):tickIn (string): required; Input ticktickOut (string): required; Output tickamountIn (string): required; The amount of input tickamountOut (string): required; The amount of output tickexactType (string):ts (number):value (number): Swap valueroute0 (object): First route details
id (string):tickIn (string):tickOut (string):amountIn (string):amountOut (string):exactType (string):ts (number):success (boolean):failureReason (string):route1 (object): Second route details
id (string):tickIn (string):tickOut (string):amountIn (string):amountOut (string):exactType (string):ts (number):success (boolean):failureReason (string):