Uniswap Plan API is one of 14 APIs that Uniswap publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 6 JSON Schema definitions.
Tagged areas include Plan. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.
This API exposes
3 operations
across 2 paths,
and defines 50 schemas.
It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://trade-api.gateway.uniswap.org/v1.
The identity and technical contract details declared by the specification.
CreatePlanRequest
object
3 properties
2 required
PlanResponse
object
24 properties
9 required
ClientContext
object
Uni client-specific context describing how this wallet integrates with the application.
2 properties
tokenAmount
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…
Protocols
array
The protocols to use for the swap/order. If the protocols field is defined, then you can only set the routingPreference to BESTPRICE. Note that the value UNISW…
ClassicOutput
object
3 properties
ChainId
number
The unique ID of the blockchain. For a list of supported chains see the [FAQ](https://api-docs.uniswap.org/guides/faqs).
HooksOptions
string
The hook options to use for V4 pool quotes. V4HOOKSINCLUSIVE will get quotes for V4 pools with or without hooks. V4HOOKSONLY will only get quotes for V4 pools…
AutoSlippage
string
The auto slippage strategy to employ. For Uniswap Protocols (v2, v3, v4) the auto slippage will be automatically calculated when this field is set to DEFAULT.…
PlanStatus
string
The overall status of the plan execution. ACTIVE means the plan is ready to begin (all steps NOTREADY). AWAITINGACTION means at least one step requires user ac…
Err500
object
2 properties
TruncatedPlanStep
object
A truncated representation of a plan step containing only routing information.
6 properties
1 required
ProtocolItems
string
The protocol to use for the swap/order.
ClassicInput
object
2 properties
senderWalletAddress
string
The wallet address which will be used to send the token.
inputToken
string
The token which will be sent, specified by its token address. For a list of supported tokens, see the [FAQ](https://api-docs.uniswap.org/guides/faqs).
PlanStepStatus
string
The status of an individual step. NOTREADY means prerequisites are not met. AWAITINGACTION means the step is ready for user action. INPROGRESS means the step i…
RequestId
string
A unique ID for the request.
Err404
object
2 properties
gasFeeInCurrency
string
The total estimated gas cost of this transaction (eg. gasLimit multiplied by maxFeePerGas) in the quoted currency (e.g. output token) in the base units of the…
PlanStepMethod
string
The execution method for the step. SENDTX is a standard transaction. SIGNMSG is for signing a message (e.g., permit). SENDCALLS is for batch transaction execut…
Err504
object
2 properties
gasFee
string
The total estimated gas cost of this transaction (eg. gasLimit multiplied by maxFeePerGas) in the base unit of the chain.
TradeType
string
The handling of the amount field. EXACTINPUT means the requester will send the specified amount of input tokens and get a quote with a variable quantity of out…
PlanStep
object
24 properties
5 required
ScopeData
object
Data defining a wallet scope including accounts, methods, capabilities, chains, and client context.
5 properties
2 required
PlanStepType
string
The type of step in a plan, including swap types and approval types.
PlanStepPayloadType
string
The type of payload data. TX is a standard transaction object. EIP712 is a typed structured data for signing. EIP5792 is a batch of transaction calls.
WalletInfo
object
Information about the wallet.
3 properties
Err422
object
2 properties
WalletExecutionContext
object
Wallet execution context based on CAIP-25 Standard. Provides information about wallet capabilities and scopes.
2 properties
1 required
WalletProperties
object
Properties describing the wallet.
1 property
slippageTolerance
number
The slippage tolerance as a percentage up to a maximum of two decimal places. For Uniswap Protocols (v2, v3, v4), the slippage tolerance is the maximum amount…
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.
Err400
object
2 properties
PlanStepProof
object
Proof of execution for a plan step, provided after the step is completed.
3 properties
gasLimit
string
The maximum units of gas that will be consumed by this transaction.
GasStrategy
object
Gas strategy configuration for transaction fee estimation.
9 properties
3 required
gasFeeUSD
string
The total estimated gas cost of this transaction (eg. gasLimit multiplied by maxFeePerGas) denominated in USDC.
receiverWalletAddress
string
The wallet address which will receive the token.
StepUpdate
object
Represents a single step update with proof. Note: orderId is not accepted in update requests; it is system-generated after receiving a signature.
2 properties
2 required
gasPrice
string
The cost per unit of gas.
UpdatePlanRequest
object
1 property
1 required
Err401
object
2 properties
Err429
object
2 properties
TransactionHash
string
The unique hash of the transaction.
ChainedQuote
object
A quote for a chained transaction flow that spans multiple steps, potentially across multiple chains.
22 properties
8 required
quoteId
string
A unique ID for the quote.
outputToken
string
The token which will be received, specified by its token address. For a list of supported tokens, see the [FAQ](https://api-docs.uniswap.org/guides/faqs).
maxPriorityFeePerGas
string
The maximum tip to the block builder. Adjusted based upon the urgency specified in the request.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Uniswap publishes across the network.