Portfolio

Portfolio management endpoints

get

Authorizations

x-api-keybearer

x-api-keystringRequired

API key for authentication

Query parameters

networkstringRequiredExample: arbitrum

pagenumberOptionalDefault: 0

limitnumberOptionalDefault: 100

Responses

200

Successful response

application/json

401

Unauthorized.

403

Forbidden.

408

Request timeout.

429

Too many requests.

500

Internal server error

get

/api/v1/portfolio

HTTPcURLJavaScriptPython

GET /api/v1/portfolio?network=arbitrum HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "data": {
    "totalPositions": 1,
    "totalBalanceUsd": 1000,
    "totalFeesInUsd": 10.5,
    "positions": [
      {
        "isPoolManager": true,
        "amount0": "3000000",
        "amount1": "80000000000000000",
        "refund0": "800000",
        "refund1": "40000000000000000",
        "amountWithRefund0": "10000000000000000",
        "amountWithRefund1": "870000000000000000",
        "totalBalanceUsd": 80.9,
        "fees0": "10000000000000000",
        "fees1": "90000000000000000",
        "totalFeesInUsd": 8.9,
        "amountInStableCurrency": 1.9,
        "refundInStableCurrency": 0.9,
        "rewardsInStableCurrency": 18.9,
        "poolPartyPosition": {
          "positionId": "0xba264514ca70c33a0e71939717c11fde99e74b779ae1c0f60e9fe2bef91a8d8d",
          "name": "My Pool Party Position",
          "description": "This is a description of my pool party position.",
          "pool": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
          "poolView": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
          "poolManager": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
          "poolManagerFee": "0.01",
          "currency0": {
            "address": "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
            "symbol": "WETH",
            "name": "Wrapped Ether",
            "decimals": 18,
            "imageUrl": "https://example.com/images/weth.png"
          },
          "currency1": {
            "address": "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
            "symbol": "WETH",
            "name": "Wrapped Ether",
            "decimals": 18,
            "imageUrl": "https://example.com/images/weth.png"
          },
          "poolTvlUsd": 1000000,
          "feesApr": 0.05,
          "poolFeeTier": "500",
          "tokenId": "34567",
          "version": 1,
          "inRange": true,
          "tickLower": -100,
          "tickUpper": 100,
          "closed": false,
          "totalInvestors": "100",
          "dexPoolAddress": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
          "dexPoolTvlUsd": 500000,
          "totalSupply0": "1000000000000000000",
          "totalSupply1": "2000000000000000000",
          "refund0": "50000000000000000",
          "refund1": "100000000000000000",
          "tokensOwed0": "30000000000000000",
          "tokensOwed1": "60000000000000000",
          "totalDepositedFees0": "20000000000000000",
          "totalDepositedFees1": "40000000000000000",
          "totalSupplyWithRefund0": "1050000000000000000",
          "totalSupplyWithRefund1": "2100000000000000000",
          "totalAccruedFees0": "15000000000000000",
          "totalAccruedFees1": "30000000000000000",
          "totalFeesInUsd": 100,
          "creationTime": "1674820641",
          "isAllLiquiditySwappedToStableCurrency": true
        }
      }
    ]
  }
}

post

Authorizations

x-api-key

x-api-keystringRequired

API key for authentication

Body

application/json

networkstringRequiredExample: arbitrum

walletstringRequiredExample: 0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810

signaturestringRequiredExample: 0x220434085f5213628bd60f96483bcca16408a5b0135aedcc90c4d44e414a9ef109c349e27f8614367196c8e51a9251647a839eb3638bcb5439bcf1e738b937ad1b

feeTiernumberRequiredExample: 500

tickLowernumberRequiredExample: -10

tickUppernumberRequiredExample: 10

amount0MinstringRequiredExample: 1000000000000

amount1MinstringRequiredExample: 2000000000000

slippageTolerancenumberRequiredExample: 0.5

Responses

200

Successful response

application/json

401

Unauthorized.

403

Forbidden.

408

Request timeout.

429

Too many requests.

500

Internal server error

post

/api/v1/portfolio/build/create-pool-tx

HTTPcURLJavaScriptPython

POST /api/v1/portfolio/build/create-pool-tx HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 774

{
  "network": "arbitrum",
  "wallet": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
  "permitBatch": {
    "details": [
      {
        "token": "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
        "amount": "1000000000000000000",
        "expiration": "1748200641",
        "nonce": "1"
      }
    ],
    "spender": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
    "sigDeadline": "1748200641"
  },
  "signature": "0x220434085f5213628bd60f96483bcca16408a5b0135aedcc90c4d44e414a9ef109c349e27f8614367196c8e51a9251647a839eb3638bcb5439bcf1e738b937ad1b",
  "feeTier": 500,
  "tickLower": -10,
  "tickUpper": 10,
  "amount0Min": "1000000000000",
  "amount1Min": "2000000000000",
  "slippageTolerance": 0.5,
  "featureSettings": {
    "name": "DCA strategy",
    "description": "DCA strategy for stablecoin",
    "poolManagerFee": 10,
    "hiddenFields": {
      "showPriceRange": true,
      "showTokenPair": false,
      "showInOutRange": false
    }
  }
}

{
  "data": {
    "data": {
      "swapInfo": {
        "priceImpactPercentage": 0.5,
        "protocolFee": 0.01,
        "minAmountInStable": 10
      },
      "estimatedGasInUsd": 0.01,
      "estimatedGasInEth": 0.00001,
      "result": [
        "text"
      ],
      "tx": {
        "to": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "from": "0x40dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "data": "0x220434085f5213628bd60f96483bcca16408a5b0135aedcc90c4d44e414a9ef109c349e27f8614367196c8e51a9251647a839eb3638bcb5439bcf1e738b937ad1b"
      },
      "request": {
        "abi": [
          {}
        ],
        "args": [
          {}
        ],
        "address": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "functionName": "approve",
        "account": "0x40dc9E9fB8DB5F51Cb192407D30c71f02433c810"
      }
    }
  }
}

post

Authorizations

x-api-key

x-api-keystringRequired

API key for authentication

Body

application/json

networkstringRequiredExample: arbitrum

walletstringRequiredExample: 0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810

positionIdstringRequiredExample: 0xba264514ca70c33a0e71939717c11fde99e74b779ae1c0f60e9fe2bef91a8d8d

signaturestringRequiredExample: 0x220434085f5213628bd60f96483bcca16408a5b0135aedcc90c4d44e414a9ef109c349e27f8614367196c8e51a9251647a839eb3638bcb5439bcf1e738b937ad1b

Responses

200

Successful response

application/json

401

Unauthorized.

403

Forbidden.

408

Request timeout.

429

Too many requests.

500

Internal server error

post

/api/v1/portfolio/build/add-liquidity-tx

HTTPcURLJavaScriptPython

POST /api/v1/portfolio/build/add-liquidity-tx HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 532

{
  "network": "arbitrum",
  "wallet": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
  "positionId": "0xba264514ca70c33a0e71939717c11fde99e74b779ae1c0f60e9fe2bef91a8d8d",
  "permit": {
    "details": {
      "token": "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
      "amount": "1000000000000000000",
      "expiration": "1748200641",
      "nonce": "1"
    },
    "spender": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
    "sigDeadline": "1748200641"
  },
  "signature": "0x220434085f5213628bd60f96483bcca16408a5b0135aedcc90c4d44e414a9ef109c349e27f8614367196c8e51a9251647a839eb3638bcb5439bcf1e738b937ad1b"
}

{
  "data": {
    "data": {
      "swapInfo": {
        "priceImpactPercentage": 0.5,
        "protocolFee": 0.01,
        "minAmountInStable": 10
      },
      "estimatedGasInUsd": 0.01,
      "estimatedGasInEth": 0.00001,
      "result": [
        "text"
      ],
      "tx": {
        "to": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "from": "0x40dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "data": "0x220434085f5213628bd60f96483bcca16408a5b0135aedcc90c4d44e414a9ef109c349e27f8614367196c8e51a9251647a839eb3638bcb5439bcf1e738b937ad1b"
      },
      "request": {
        "abi": [
          {}
        ],
        "args": [
          {}
        ],
        "address": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "functionName": "approve",
        "account": "0x40dc9E9fB8DB5F51Cb192407D30c71f02433c810"
      }
    }
  }
}

post

Authorizations

x-api-key

x-api-keystringRequired

API key for authentication

Body

application/json

networkstringRequiredExample: arbitrum

walletstringRequiredExample: 0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810

positionIdstringRequiredExample: 0xba264514ca70c33a0e71939717c11fde99e74b779ae1c0f60e9fe2bef91a8d8d

percentagenumberRequiredExample: 50

slippageTolerancenumberRequiredExample: 0.5

shouldSwapFeesbooleanRequiredExample: true

Responses

200

Successful response

application/json

401

Unauthorized.

403

Forbidden.

408

Request timeout.

429

Too many requests.

500

Internal server error

post

/api/v1/portfolio/build/remove-liquidity-tx

HTTPcURLJavaScriptPython

POST /api/v1/portfolio/build/remove-liquidity-tx HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "network": "arbitrum",
  "wallet": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
  "positionId": "0xba264514ca70c33a0e71939717c11fde99e74b779ae1c0f60e9fe2bef91a8d8d",
  "percentage": 50,
  "slippageTolerance": 0.5,
  "shouldSwapFees": true
}

{
  "data": {
    "data": {
      "swapInfo": {
        "priceImpactPercentage": 0.5,
        "protocolFee": 0.01,
        "minAmountInStable": 10
      },
      "estimatedGasInUsd": 0.01,
      "estimatedGasInEth": 0.00001,
      "result": [
        "text"
      ],
      "tx": {
        "to": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "from": "0x40dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "data": "0x220434085f5213628bd60f96483bcca16408a5b0135aedcc90c4d44e414a9ef109c349e27f8614367196c8e51a9251647a839eb3638bcb5439bcf1e738b937ad1b"
      },
      "request": {
        "abi": [
          {}
        ],
        "args": [
          {}
        ],
        "address": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "functionName": "approve",
        "account": "0x40dc9E9fB8DB5F51Cb192407D30c71f02433c810"
      }
    }
  }
}

post

Authorizations

x-api-key

x-api-keystringRequired

API key for authentication

Body

application/json

networkstringRequiredExample: arbitrum

walletstringRequiredExample: 0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810

positionIdstringRequiredExample: 0xba264514ca70c33a0e71939717c11fde99e74b779ae1c0f60e9fe2bef91a8d8d

slippageTolerancenumberRequiredExample: 0.5

shouldSwapFeesbooleanRequiredExample: true

Responses

200

Successful response

application/json

401

Unauthorized.

403

Forbidden.

408

Request timeout.

429

Too many requests.

500

Internal server error

post

/api/v1/portfolio/build/collect-fees-tx

HTTPcURLJavaScriptPython

POST /api/v1/portfolio/build/collect-fees-tx HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "network": "arbitrum",
  "wallet": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
  "positionId": "0xba264514ca70c33a0e71939717c11fde99e74b779ae1c0f60e9fe2bef91a8d8d",
  "slippageTolerance": 0.5,
  "shouldSwapFees": true
}

{
  "data": {
    "data": {
      "swapInfo": {
        "priceImpactPercentage": 0.5,
        "protocolFee": 0.01,
        "minAmountInStable": 10
      },
      "estimatedGasInUsd": 0.01,
      "estimatedGasInEth": 0.00001,
      "result": [
        "text"
      ],
      "tx": {
        "to": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "from": "0x40dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "data": "0x220434085f5213628bd60f96483bcca16408a5b0135aedcc90c4d44e414a9ef109c349e27f8614367196c8e51a9251647a839eb3638bcb5439bcf1e738b937ad1b"
      },
      "request": {
        "abi": [
          {}
        ],
        "args": [
          {}
        ],
        "address": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "functionName": "approve",
        "account": "0x40dc9E9fB8DB5F51Cb192407D30c71f02433c810"
      }
    }
  }
}

post

Authorizations

x-api-key

x-api-keystringRequired

API key for authentication

Body

application/json

networkstringRequiredExample: arbitrum

walletstringRequiredExample: 0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810

positionIdstringRequiredExample: 0xba264514ca70c33a0e71939717c11fde99e74b779ae1c0f60e9fe2bef91a8d8d

slippageTolerancenumberRequiredExample: 0.5

shouldSwapFeesbooleanRequiredExample: false

Responses

200

Successful response

application/json

401

Unauthorized.

403

Forbidden.

408

Request timeout.

429

Too many requests.

500

Internal server error

post

/api/v1/portfolio/build/withdraw-tx

HTTPcURLJavaScriptPython

POST /api/v1/portfolio/build/withdraw-tx HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "network": "arbitrum",
  "wallet": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
  "positionId": "0xba264514ca70c33a0e71939717c11fde99e74b779ae1c0f60e9fe2bef91a8d8d",
  "slippageTolerance": 0.5,
  "shouldSwapFees": false
}

{
  "data": {
    "data": {
      "swapInfo": {
        "priceImpactPercentage": 0.5,
        "protocolFee": 0.01,
        "minAmountInStable": 10
      },
      "estimatedGasInUsd": 0.01,
      "estimatedGasInEth": 0.00001,
      "result": [
        "text"
      ],
      "tx": {
        "to": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "from": "0x40dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "data": "0x220434085f5213628bd60f96483bcca16408a5b0135aedcc90c4d44e414a9ef109c349e27f8614367196c8e51a9251647a839eb3638bcb5439bcf1e738b937ad1b"
      },
      "request": {
        "abi": [
          {}
        ],
        "args": [
          {}
        ],
        "address": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "functionName": "approve",
        "account": "0x40dc9E9fB8DB5F51Cb192407D30c71f02433c810"
      }
    }
  }
}

post

Authorizations

x-api-key

x-api-keystringRequired

API key for authentication

Body

application/json

networkstringRequiredExample: arbitrum

walletstringRequiredExample: 0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810

positionIdstringRequiredExample: 0xba264514ca70c33a0e71939717c11fde99e74b779ae1c0f60e9fe2bef91a8d8d

slippageTolerancenumberRequiredExample: 0.5

swapAllToStableCurrencybooleanRequiredExample: true

Responses

200

Successful response

application/json

201

The record has been successfully created.

application/json

401

Unauthorized.

403

Forbidden.

408

Request timeout.

429

Too many requests.

500

Internal server error

post

/api/v1/portfolio/build/close-pool-tx

HTTPcURLJavaScriptPython

POST /api/v1/portfolio/build/close-pool-tx HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 213

{
  "network": "arbitrum",
  "wallet": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
  "positionId": "0xba264514ca70c33a0e71939717c11fde99e74b779ae1c0f60e9fe2bef91a8d8d",
  "slippageTolerance": 0.5,
  "swapAllToStableCurrency": true
}

{
  "data": {
    "data": {
      "swapInfo": {
        "priceImpactPercentage": 0.5,
        "protocolFee": 0.01,
        "minAmountInStable": 10
      },
      "estimatedGasInUsd": 0.01,
      "estimatedGasInEth": 0.00001,
      "result": [
        "text"
      ],
      "tx": {
        "to": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "from": "0x40dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "data": "0x220434085f5213628bd60f96483bcca16408a5b0135aedcc90c4d44e414a9ef109c349e27f8614367196c8e51a9251647a839eb3638bcb5439bcf1e738b937ad1b"
      },
      "request": {
        "abi": [
          {}
        ],
        "args": [
          {}
        ],
        "address": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "functionName": "approve",
        "account": "0x40dc9E9fB8DB5F51Cb192407D30c71f02433c810"
      }
    }
  }
}

post

Authorizations

x-api-key

x-api-keystringRequired

API key for authentication

Body

application/json

networkstringRequiredExample: arbitrum

walletstringRequiredExample: 0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810

positionIdstringRequiredExample: 0xba264514ca70c33a0e71939717c11fde99e74b779ae1c0f60e9fe2bef91a8d8d

slippageTolerancenumberRequiredExample: 0.5

tickLowernumberRequiredExample: -10

tickUppernumberRequiredExample: 10

swapZeroForOneAmountstringRequiredExample: 1000000000000

swapOneForZeroAmountstringRequiredExample: 2000000000000

Responses

200

Successful response

application/json

401

Unauthorized.

403

Forbidden.

408

Request timeout.

429

Too many requests.

500

Internal server error

post

/api/v1/portfolio/build/move-range-tx

HTTPcURLJavaScriptPython

POST /api/v1/portfolio/build/move-range-tx HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 291

{
  "network": "arbitrum",
  "wallet": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
  "positionId": "0xba264514ca70c33a0e71939717c11fde99e74b779ae1c0f60e9fe2bef91a8d8d",
  "slippageTolerance": 0.5,
  "tickLower": -10,
  "tickUpper": 10,
  "swapZeroForOneAmount": "1000000000000",
  "swapOneForZeroAmount": "2000000000000"
}

{
  "data": {
    "data": {
      "swapInfo": {
        "priceImpactPercentage": 0.5,
        "protocolFee": 0.01,
        "minAmountInStable": 10
      },
      "estimatedGasInUsd": 0.01,
      "estimatedGasInEth": 0.00001,
      "result": [
        "text"
      ],
      "tx": {
        "to": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "from": "0x40dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "data": "0x220434085f5213628bd60f96483bcca16408a5b0135aedcc90c4d44e414a9ef109c349e27f8614367196c8e51a9251647a839eb3638bcb5439bcf1e738b937ad1b"
      },
      "request": {
        "abi": [
          {}
        ],
        "args": [
          {}
        ],
        "address": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "functionName": "approve",
        "account": "0x40dc9E9fB8DB5F51Cb192407D30c71f02433c810"
      }
    }
  }
}