Liquidity Provisioning Endpoints

Create Pool and Position

This request allows the caller to create a position in a pool or, if the pool does not yet exist, to create a new pool. If a new pool must be created, a transaction is returned for the pool creation. In either case, a transaction is returned to create the new position in the pool. If the parameter simulateTransaction is set to true, then the response will include the gas fee for the creation transaction(s).

Different fields are required depending on the pool version (V2, V3, or V4) into which a new position will be created, in addition to the fields which are always required. When creating a position in a V2 pool, the position object must contain token0 and token1 addresses. When creating a position in a V3 pool, the position object must contain all fields except for hooks which are not supported in V3 pools. When creating a position in a V4 pool, all fields within the position object are required except for hooks which is optional. Note that both V3 and V4 pools require the population of tickLower and tickUpper fields. Furthermore, poolLiquidity, currentTick, and sqrtRatioX96 are always required when creating a position in a V3 or V4 pool. All pool versions require the population of amount0 and amount1, which specify the quantity of tokens being entered into the pool.

When creating a pool, additional fields are required depending on the pool version being created, in addition to the fields which are always required. When creating a V3 or V4 pool, either initialPrice or poolLiquidity, currentTick, and sqrtRatioX96 are required. When creating a V2 pool, only initialPrice is required. V3 and V4 pools require amount0 and amount1 fields to be populated, as the creation of the pool must include seeding of liquidity. V2 pools may optionally have amount0 and amount1 populated; V2 pools do not require liquidity to be seeded when creating the pool.

POST

create

Create pool and position calldata

curl --request POST \
  --url https://trade-api.gateway.uniswap.org/v1/lp/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "protocol": "V2",
  "position": {
    "pool": {
      "token0": "<string>",
      "token1": "<string>",
      "fee": 123,
      "tickSpacing": 123,
      "hooks": "<string>"
    },
    "tickLower": 123,
    "tickUpper": 123
  },
  "walletAddress": "<string>",
  "chainId": 1,
  "initialPrice": "<string>",
  "poolLiquidity": "<string>",
  "currentTick": 123,
  "sqrtRatioX96": "<string>",
  "amount0": "<string>",
  "amount1": "<string>",
  "independentAmount": "<string>",
  "independentToken": "TOKEN_0",
  "initialDependentAmount": "<string>",
  "defaultDependentAmount": "<string>",
  "slippageTolerance": 123,
  "deadline": 123,
  "signature": "<string>",
  "batchPermitData": {
    "domain": {},
    "values": {},
    "types": {}
  },
  "simulateTransaction": true
}
'

{
  "requestId": "<string>",
  "create": {
    "to": "<string>",
    "from": "<string>",
    "data": "<string>",
    "value": "<string>",
    "chainId": 1,
    "gasLimit": "<string>",
    "maxFeePerGas": "<string>",
    "maxPriorityFeePerGas": "<string>",
    "gasPrice": "<string>"
  },
  "gasFee": "<string>",
  "dependentAmount": "<string>",
  "poolLiquidity": "<string>",
  "currentTick": 123,
  "sqrtRatioX96": "<string>"
}

Authorizations

x-api-key

string

header

required

Body

application/json

protocol

enum<string>

The protocol to use for the swap/order.

Available options:

V2,

V3,

V4,

UNISWAPX,

UNISWAPX_V2,

UNISWAPX_V3

position

object

Show child attributes

position.pool

object

required

Show child attributes

position.pool.token0

string

required

position.pool.token1

string

required

position.pool.fee

number

The fee of the pool in basis points.

position.pool.tickSpacing

number

The width of ticks in this pool (e.g. the price range between two ticks) specified in basis points. For more information see the Uniswap V3 Whitepaper.

position.pool.hooks

string

position.tickLower

number

position.tickUpper

number

walletAddress

string

chainId

enum<number>

default:1

The unique ID of the blockchain. For a list of supported chains see the FAQ.

Available options:

1,

10,

56,

130,

137,

324,

480,

1868,

8453,

10143,

42161,

42220,

43114,

81457,

7777777,

1301,

84532,

11155111,

143

initialPrice

string

poolLiquidity

string

The amount of liquidity in the pool at a given tick. For more information see the Uniswap V3 Whitepaper.

currentTick

number

The current tick of the pool. For more information see the Uniswap V3 Whitepaper.

sqrtRatioX96

string

The square root of the ratio of the token0 and token1 in the pool, as a Q64.64 number. For more information see the Uniswap V3 Whitepaper.

amount0

string

The quantity of tokens denominated in the token's base units. (For example, for an ERC20 token one token is 1x10^18 base units. For one USDC token one token is 1x10^6 base units.) This value must be greater than 0.

amount1

string

independentAmount

string

independentToken

enum<string>

Available options:

TOKEN_0,

TOKEN_1

initialDependentAmount

string

defaultDependentAmount

string

slippageTolerance

number

deadline

number

The unix timestamp at which the order will be reverted if not filled.

signature

string

The signed permit.

batchPermitData

object

the permit2 message object for the customer to sign to permit spending by the permit2 contract.

Show child attributes

batchPermitData.domain

object

batchPermitData.values

object

batchPermitData.types

object

simulateTransaction

boolean

Response

Create LP Position successful.

requestId

string

A unique ID for the request.

create

object

Show child attributes

create.to

string

required

The wallet address which will receive the token.

create.from

string

required

The wallet address which will be used to send the token.

create.data

string

required

The calldata for the transaction.

create.value

string

required

The quantity of ETH tokens approved for spending by the transaction, denominated in wei. Note that by default Uniswap Labs sets this to the maximum approvable spend.

create.chainId

enum<number>

default:1

required

The unique ID of the blockchain. For a list of supported chains see the FAQ.

Available options:

1,

10,

56,

130,

137,

324,

480,

1868,

8453,

10143,

42161,

42220,

43114,

81457,

7777777,

1301,

84532,

11155111,

143

create.gasLimit

string

The maximum units of gas that will be consumed by this transaction.

create.maxFeePerGas

string

The sum of the base fee and priority fee. Subtracting maxPriorityFeePerGas from this value will yield the base fee to be paid for this transaction.

create.maxPriorityFeePerGas

string

The maximum tip to the block builder. Adjusted based upon the urgency specified in the request.

create.gasPrice

string

The cost per unit of gas.

gasFee

string

The total estimated gas cost of this transaction (eg. gasLimit multiplied by maxFeePerGas) in the base unit of the chain.

dependentAmount

string

poolLiquidity

string

The amount of liquidity in the pool at a given tick. For more information see the Uniswap V3 Whitepaper.

currentTick

number

The current tick of the pool. For more information see the Uniswap V3 Whitepaper.

sqrtRatioX96

string

The square root of the ratio of the token0 and token1 in the pool, as a Q64.64 number. For more information see the Uniswap V3 Whitepaper.

Increase PositionThe response will also have the transaction to increase the position for the corresponding pool. If the parameter `simulateTransaction` is set to `true`, then the response will include the gas fees for the increase transaction.

⌘I

Create pool and position calldata

curl --request POST \
  --url https://trade-api.gateway.uniswap.org/v1/lp/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "protocol": "V2",
  "position": {
    "pool": {
      "token0": "<string>",
      "token1": "<string>",
      "fee": 123,
      "tickSpacing": 123,
      "hooks": "<string>"
    },
    "tickLower": 123,
    "tickUpper": 123
  },
  "walletAddress": "<string>",
  "chainId": 1,
  "initialPrice": "<string>",
  "poolLiquidity": "<string>",
  "currentTick": 123,
  "sqrtRatioX96": "<string>",
  "amount0": "<string>",
  "amount1": "<string>",
  "independentAmount": "<string>",
  "independentToken": "TOKEN_0",
  "initialDependentAmount": "<string>",
  "defaultDependentAmount": "<string>",
  "slippageTolerance": 123,
  "deadline": 123,
  "signature": "<string>",
  "batchPermitData": {
    "domain": {},
    "values": {},
    "types": {}
  },
  "simulateTransaction": true
}
'

{
  "requestId": "<string>",
  "create": {
    "to": "<string>",
    "from": "<string>",
    "data": "<string>",
    "value": "<string>",
    "chainId": 1,
    "gasLimit": "<string>",
    "maxFeePerGas": "<string>",
    "maxPriorityFeePerGas": "<string>",
    "gasPrice": "<string>"
  },
  "gasFee": "<string>",
  "dependentAmount": "<string>",
  "poolLiquidity": "<string>",
  "currentTick": 123,
  "sqrtRatioX96": "<string>"
}

Swapping Endpoints

Liquidity Provisioning Endpoints

Reference Data Endpoints

Utility Endpoints

Create Pool and Position

Authorizations

Body

Response