Uniswap · JSON Structure

Uniswap Order Response Structure

JSON Structure for OrderResponse from Uniswap Trading API

Type: Properties: 0
BlockchainCryptocurrencyDeFiDecentralized ExchangeLiquiditySwaps

Uniswap Order Response Structure is a JSON Structure definition published by Uniswap. It conforms to the https://json-schema.org/draft/2020-12/schema meta-schema.

Meta-schema: https://json-schema.org/draft/2020-12/schema

JSON Structure

Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "OrderResponse Structure",
  "description": "JSON Structure for OrderResponse from Uniswap Trading API",
  "structure": {
    "type": "object",
    "properties": {
      "requestId": {
        "type": "string",
        "description": "A unique ID for the request."
      },
      "orderId": {
        "type": "string",
        "description": "A unique ID for the order. Used to track the order's status."
      },
      "orderStatus": {
        "type": "string",
        "description": "The status of the order. Note that all of these are final states with the exception of Open, meaning that no further state changes will occur. \n Open - order is not yet filled by a filler.\n Expired - order has expired without being filled and is no longer fillable.\n Error - a catchall for other final states which are not otherwise specified, where the order will not be filled.\n Cancelled - order is cancelled. Note that to cancel an order, a new order must be placed with the same nonce as the prior open order and it must be placed within the same block as the original order.\n Filled - order is filled.\n Insufficient-funds - the swapper (you) do not have enough funds for the order to be completed and the order is cancelled and will not be filled.\n Unverified - order has not been verified yet.",
        "enum": [
          "open",
          "expired",
          "error",
          "cancelled",
          "filled",
          "unverified",
          "insufficient-funds"
        ]
      }
    },
    "required": [
      "requestId",
      "orderId",
      "orderStatus"
    ]
  }
}