Get order

Retrieve order details

Fetches the status and details of a specific order for the given account. Note: Order placement is asynchronous. This endpoint may return HTTP 404 if the order has not yet been indexed for retrieval. In some cases, the order may already be active in the market but momentarily not yet visible through this API due to eventual consistency.

GET/userapigateway/trading/{accountId}/order/{orderId}

Parameters

Path Parameters

accountId*

string

orderId*

string

Parameters

Name	Type	Required	Description
accountId	string	Yes	-
orderId	string (uuid)	Yes	-

Body

application/json

No request body defined

Responses

Response

200

application/json

orderIdstring

instrument

createdAtstring

Creation time of the order

typeenum<string>

Available options: MARKET,LIMIT,STOP,STOP_LIMIT

sideenum<string>

Available options: BUY,SELL

statusenum<string>

Available options: NEW,PARTIALLY_FILLED,CANCELLED,QUEUED_CANCELLED,FILLED,REJECTED,PENDING_REPLACE,PENDING_CANCEL,EXPIRED,REPLACED

quantitystring

Quantity of the order, mutually exclusive with notional value

notionalValuestring

Notional value (dollar amount) of the order, mutually exclusive with quantity

expiration

limitPricestring

Present if type = LIMIT

stopPricestring

Present if type = STOP

closedAtstring

The time the order reached a terminal state, like CANCELLED, FILLED, REJECTED, REPLACED

openCloseIndicatorenum<string>

Present if the order is a single-leg option order

Available options: OPEN,CLOSE

filledQuantitystring

The filled quantity of the order, present if the order had at least one trade

averagePricestring

The average price per unit, present if the order had at least one trade

legsobject[]

If instrument.type = MULTI_LEG_INSTRUMENT, this contains the list of legs

Response

404application/json

Order not found (may not be processed yet).

No response body defined

The Public Individual API is for your own personal, non-commercial use. Unauthorized access is prohibited. You are responsible for all trades made via the API. Learn more

curl --request GET \
  --url https://api.public.com/userapigateway/trading/{accountId}/order/{orderId} \
  --header 'Authorization: Bearer YOUR_API_KEY'

{
  "orderId": "ef0e12e1-2797-4b61-9c75-efae493d7021",
  "instrument": {
    "symbol": "string",
    "type": "EQUITY"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "type": "MARKET",
  "side": "BUY",
  "status": "NEW",
  "quantity": "string",
  "notionalValue": "string",
  "expiration": {
    "timeInForce": "DAY",
    "expirationTime": "2023-11-07T05:31:56Z"
  },
  "limitPrice": "string",
  "stopPrice": "string",
  "closedAt": "2023-11-07T05:31:56Z",
  "openCloseIndicator": "OPEN",
  "filledQuantity": "string",
  "averagePrice": "string",
  "legs": [
    {
      "instrument": {
        "symbol": "string",
        "type": "EQUITY"
      },
      "side": "BUY",
      "openCloseIndicator": "OPEN",
      "ratioQuantity": 123
    }
  ]
}

The Public Individual API is for your own personal, non-commercial use. Unauthorized access is prohibited. You are responsible for all trades made via the API. Learn more