Documentation - Notus API

Withdraws a liquidity position and delivers the proceeds on another network in a single signature: the position is redeemed and consolidated on its own network, then bridged, and the destination leg delivers `tokenOut` to `toAddress`. Platform fees and gas are charged on the position's network.

Authorization

x-api-key

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

liquidityProvider?"UNISWAP_V3"

Optional provider for withdrawing from a liquidity pool. If not provided, Uniswap v3 will be used.

Value in

"UNISWAP_V3"

walletAddress*string

The wallet address (in hexadecimal format) that owns the liquidity position.

toAddress*string

The address (in hexadecimal format) that will receive the output tokens.

chainId*number

The blockchain network where the liquidity position exists. Supported EVM chains:

Arbitrum One: 42161
Avalanche: 43114
Base: 8453
BNB Smart Chain: 56
Ethereum: 1
Gnosis: 100
OP Mainnet: 10
Polygon: 137
X Layer Mainnet: 196
Robinhood Chain: 4663

tokenId*string

The NFT token ID representing the liquidity position.

tokenOut*string

The address (in hexadecimal format) of the token to receive after withdrawing and swapping.

percentage*number

Percentage of the liquidity position to withdraw (e.g., 100 for full withdrawal, 50 for half).

Range0.01 <= value <= 100

transactionFeePercent?number

Percentage fee applied to the transaction (e.g., 5 for 5%).

Range0 <= value <= 99.99

Default0

extraFee?

Optional extra fee that can be charged in addition to the transaction fee. This extra fee is deducted from the output token and sent to the specified toAddress.

metadata?

Custom metadata for the entity. Key-value pairs with string values. Max 1KB size.

chainIdOut*number

The blockchain network where the proceeds should land, when different from the position's own network. The exit is bridged inside the same signature; platform fees and gas are charged on the position's network. Supported EVM chains:

Arbitrum One: 42161
Avalanche: 43114
Base: 8453
BNB Smart Chain: 56
Ethereum: 1
Gnosis: 100
OP Mainnet: 10
Polygon: 137
X Layer Mainnet: 196
Robinhood Chain: 4663

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/liquidity/withdraw/cross-chain" \  -H "Content-Type: application/json" \  -d '{    "walletAddress": "0x6e397ddf51d9f15dbe0414538e7529f51f2e5464",    "toAddress": "0x1337133713371337133713371337133713371337",    "chainId": 42161,    "tokenId": "123456",    "tokenOut": "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",    "percentage": 100,    "chainIdOut": 0  }'

{  "operation": {    "liquidityProvider": "UNISWAP_V3",    "walletAddress": "0x6e397ddf51d9f15dbe0414538e7529f51f2e5464",    "toAddress": "0x1337133713371337133713371337133713371337",    "chainId": 42161,    "tokenId": "123456",    "tokenOut": "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",    "percentage": 100,    "transactionFeePercent": 2.5,    "extraFee": {      "percentage": 1.5,      "toAddress": "0x6e397ddf51d9f15dbe0414538e7529f51f2e5464"    },    "metadata": {      "key": "value"    },    "chainIdOut": 0  }}

Withdraw Liquidity Cross-Chain (Enso)

Authorization

Request Body

Response Body

200application/json

400application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`