Clearstreet8e71 · Schema

Order

A trading order with its current state and execution details. This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking.

CompanyFinTechBrokerageAPIInstitutional

Properties

Name Type Description
account_id object Account placing the order
average_fill_price stringnull Average fill price across all executions. For multileg orders this is the venue's strategy-level average when reported, else the signed net package price derived from the leg averages: net debit posit
client_order_id string Client-provided identifier echoed back.
created_at string Timestamp when order was created (UTC)
details array Contains execution, rejection or cancellation details, if any
expires_at stringnull Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.
extended_hours booleannull Whether the order is eligible for extended-hours trading.
filled_quantity string Cumulative filled quantity
id string Engine-assigned unique identifier for this order (UUID).
instrument_id stringnull Instrument identifier for the traded instrument. `null` when the order is a multileg strategy whose legs are reported individually in `legs[]`. When a null/undefined value is observed, it indicates it
instrument_type object
leaves_quantity string Remaining unfilled quantity
limit_offset stringnull Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.
limit_price stringnull Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
order_type object Type of order (MARKET, LIMIT, etc.)
quantity string Total order quantity
queue_state object
releases_at stringnull Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.
side object Side of the order (BUY or SELL)
status object Current status of the order
stop_price stringnull Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
strategy object The execution strategy the order was submitted with, if any.
symbol stringnull Trading symbol. `null` when the order is a multileg strategy whose legs are reported individually in `legs[]`. When a null/undefined value is observed, it indicates it does not apply.
time_in_force object Time in force instruction
trailing_limit_px stringnull Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_offset stringnull Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_offset_type object
trailing_stop_px stringnull Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_px stringnull Trailing watermark price for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a nul
trailing_watermark_ts stringnull Trailing watermark timestamp for trailing orders. Strategy-computed, so it is absent on the order-submission acknowledgement and only appears once fetched via the order fetch or list endpoints. When a
underlying_instrument_id stringnull Instrument ID of the option's underlying instrument. Populated only for options orders. A `null` means one of two things: the order is not an option, so the field does not apply; or the order is an op
underlying_instrument_type object
updated_at string Timestamp of the most recent update (UTC)
venue string MIC code of the venue where the order is routed
View JSON Schema on GitHub

JSON Schema

clearstreet8e71-order-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/clearstreet8e71/main/json-schema/clearstreet8e71-order-schema.json",
  "title": "Order",
  "description": "A trading order with its current state and execution details.\n\nThis is the unified API representation of an order across its lifecycle,\ncombining data from execution reports, order status queries, and parent/child tracking.",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/clearstreet8e71-openapi.yaml#/components/schemas/Order",
  "type": "object",
  "required": [
    "id",
    "client_order_id",
    "account_id",
    "venue",
    "side",
    "quantity",
    "order_type",
    "time_in_force",
    "status",
    "filled_quantity",
    "leaves_quantity",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "account_id": {
      "$ref": "#/$defs/i64",
      "description": "Account placing the order"
    },
    "average_fill_price": {
      "type": [
        "string",
        "null"
      ],
      "description": "Average fill price across all executions. For multileg orders this is the venue's\nstrategy-level average when reported, else the signed net package price derived from\nthe leg averages: net debit positive, net credit negative, zero possible.\nWhen a null/undefined value is observed, it indicates that there is no available data."
    },
    "client_order_id": {
      "type": "string",
      "description": "Client-provided identifier echoed back."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when order was created (UTC)"
    },
    "details": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Contains execution, rejection or cancellation details, if any"
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.\nWhen a null/undefined value is observed, it indicates it does not apply."
    },
    "extended_hours": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether the order is eligible for extended-hours trading."
    },
    "filled_quantity": {
      "type": "string",
      "description": "Cumulative filled quantity"
    },
    "id": {
      "type": "string",
      "description": "Engine-assigned unique identifier for this order (UUID)."
    },
    "instrument_id": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "Instrument identifier for the traded instrument. `null` when the order is a\nmultileg strategy whose legs are reported individually in `legs[]`.\nWhen a null/undefined value is observed, it indicates it does not apply."
    },
    "instrument_type": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/$defs/SecurityType",
          "description": "Type of security. `null` when the order is a multileg strategy whose legs are\nreported individually in `legs[]`.\nWhen a null/undefined value is observed, it indicates it does not apply."
        }
      ]
    },
    "leaves_quantity": {
      "type": "string",
      "description": "Remaining unfilled quantity"
    },
    "limit_offset": {
      "type": [
        "string",
        "null"
      ],
      "description": "Limit offset for trailing stop-limit orders (signed)\nWhen a null/undefined value is observed, it indicates it does not apply."
    },
    "limit_price": {
      "type": [
        "string",
        "null"
      ],
      "description": "Limit price (for LIMIT and STOP_LIMIT orders)\nWhen a null/undefined value is observed, it indicates it does not apply."
    },
    "order_type": {
      "$ref": "#/$defs/OrderType",
      "description": "Type of order (MARKET, LIMIT, etc.)"
    },
    "quantity": {
      "type": "string",
      "description": "Total order quantity"
    },
    "queue_state": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/$defs/QueueState",
          "description": "Parent order queue state, present when the order is awaiting release or released.\nWhen a null/undefined value is observed, it indicates it does not apply."
        }
      ]
    },
    "releases_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Scheduled release time for orders awaiting release.\nWhen a null/undefined value is observed, it indicates it does not apply."
    },
    "side": {
      "$ref": "#/$defs/Side",
      "description": "Side of the order (BUY or SELL)"
    },
    "status": {
      "$ref": "#/$defs/OrderStatus",
      "description": "Current status of the order"
    },
    "stop_price": {
      "type": [
        "string",
        "null"
      ],
      "description": "Stop price (for STOP and STOP_LIMIT orders)\nWhen a null/undefined value is observed, it indicates it does not apply."
    },
    "strategy": {
      "type": "object",
      "description": "The execution strategy the order was submitted with, if any.",
      "required": [
        "type"
      ],
      "properties": {
        "destination": {
          "type": "string",
          "description": "Venue code the order is routed to. DMA only."
        },
        "end_at": {
          "type": "string",
          "format": "date-time",
          "description": "UTC timestamp (RFC 3339) at which execution ends."
        },
        "start_at": {
          "type": "string",
          "format": "date-time",
          "description": "UTC timestamp (RFC 3339) at which execution begins."
        },
        "type": {
          "type": "string",
          "description": "Execution strategy type.",
          "enum": [
            "SOR",
            "VWAP",
            "TWAP",
            "DMA"
          ]
        }
      },
      "additionalProperties": true
    },
    "symbol": {
      "type": [
        "string",
        "null"
      ],
      "description": "Trading symbol. `null` when the order is a multileg strategy whose legs are\nreported individually in `legs[]`.\nWhen a null/undefined value is observed, it indicates it does not apply."
    },
    "time_in_force": {
      "$ref": "#/$defs/TimeInForce",
      "description": "Time in force instruction"
    },
    "trailing_limit_px": {
      "type": [
        "string",
        "null"
      ],
      "description": "Current trailing limit price computed by the trailing strategy\nWhen a null/undefined value is observed, it indicates it does not apply."
    },
    "trailing_offset": {
      "type": [
        "string",
        "null"
      ],
      "description": "Trailing offset amount for trailing orders\nWhen a null/undefined value is observed, it indicates it does not apply."
    },
    "trailing_offset_type": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/$defs/TrailingOffsetType",
          "description": "Trailing offset type for trailing orders\nWhen a null/undefined value is observed, it indicates it does not apply."
        }
      ]
    },
    "trailing_stop_px": {
      "type": [
        "string",
        "null"
      ],
      "description": "Current trailing stop price computed by the trailing strategy\nWhen a null/undefined value is observed, it indicates it does not apply."
    },
    "trailing_watermark_px": {
      "type": [
        "string",
        "null"
      ],
      "description": "Trailing watermark price for trailing orders. Strategy-computed, so it\nis absent on the order-submission acknowledgement and only appears\nonce fetched via the order fetch or list endpoints.\nWhen a null/undefined value is observed, it indicates it does not apply."
    },
    "trailing_watermark_ts": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Trailing watermark timestamp for trailing orders. Strategy-computed, so\nit is absent on the order-submission acknowledgement and only appears\nonce fetched via the order fetch or list endpoints.\nWhen a null/undefined value is observed, it indicates it does not apply."
    },
    "underlying_instrument_id": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "Instrument ID of the option's underlying instrument. Populated only for\noptions orders. A `null` means one of two things: the order is not an\noption, so the field does not apply; or the order is an option whose\nunderlier has not yet been resolved.\nWhen a null/undefined value is observed, it indicates it does not apply."
    },
    "underlying_instrument_type": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/$defs/SecurityType",
          "description": "Type of the underlying instrument, alongside `underlying_instrument_id`.\nWhen a null/undefined value is observed, it indicates it does not apply."
        }
      ]
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp of the most recent update (UTC)"
    },
    "venue": {
      "type": "string",
      "description": "MIC code of the venue where the order is routed"
    }
  },
  "$defs": {
    "OrderStatus": {
      "type": "string",
      "description": "Order status",
      "enum": [
        "PENDING_NEW",
        "QUEUED",
        "PENDING_TRIGGER",
        "NEW",
        "PARTIALLY_FILLED",
        "FILLED",
        "CANCELED",
        "REJECTED",
        "EXPIRED",
        "PENDING_CANCEL",
        "PENDING_REPLACE",
        "REPLACED",
        "DONE_FOR_DAY",
        "STOPPED",
        "SUSPENDED",
        "CALCULATED",
        "OTHER"
      ]
    },
    "OrderType": {
      "type": "string",
      "description": "Order type",
      "enum": [
        "MARKET",
        "LIMIT",
        "STOP",
        "STOP_LIMIT",
        "TRAILING_STOP",
        "TRAILING_STOP_LIMIT",
        "OTHER"
      ]
    },
    "QueueState": {
      "type": "string",
      "description": "Parent order queue or hold state.",
      "enum": [
        "AWAITING_RELEASE",
        "RELEASED"
      ]
    },
    "SecurityType": {
      "type": "string",
      "description": "Security type",
      "enum": [
        "COMMON_STOCK",
        "INDEX",
        "OPTION",
        "CASH"
      ]
    },
    "Side": {
      "type": "string",
      "description": "Side of the order (BUY or SELL).",
      "enum": [
        "BUY",
        "SELL"
      ]
    },
    "TimeInForce": {
      "type": "string",
      "description": "Time in force",
      "enum": [
        "DAY",
        "GOOD_TILL_CANCEL",
        "IMMEDIATE_OR_CANCEL",
        "FILL_OR_KILL",
        "GOOD_TILL_DATE",
        "AT_OPEN",
        "AT_CLOSE",
        "OTHER"
      ]
    },
    "TrailingOffsetType": {
      "type": "string",
      "description": "Trailing offset type for trailing stop orders.",
      "enum": [
        "PRICE",
        "BPS"
      ]
    },
    "i64": {
      "type": "integer",
      "format": "int64"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/clearstreet8e71-order"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.