Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0175184292.5 KB
Trading

Check equity order impact

Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a Trade object and the ID of the object can be used to place the order with the brokerage using the place checked order endpoint. Please note that the Trade object returned expires after 5 minutes. Any order placed using an expired Trade will be rejected.

post/trade/impact

Query parameters

userIdstring required

SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.

Example:snaptrade-user-123
userSecretstring required

SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the rotate user secret endpoint.

Example:adf2aa34-8219-40f7-a6b3-60156985cc61

Request body

account_idstring uuid required

Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.

action'BUY' | 'SELL' required

The action describes the intent or side of a trade. This is either BUY or SELL.

universal_symbol_idstring uuid required

Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.

order_type'Limit' | 'Market' | 'StopLimit' | 'Stop' required

The type of order to place.

  • For Limit and StopLimit orders, the price field is required.
  • For Stop and StopLimit orders, the stop field is required.
time_in_force'FOK' | 'Day' | 'GTC' | 'IOC' required

The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:

  • Day - Day. The order is valid only for the trading day on which it is placed.
  • GTC - Good Til Canceled. The order is valid until it is executed or canceled.
  • FOK - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.
  • IOC - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.
pricenumber nullable

The limit price for Limit and StopLimit orders.

stopnumber nullable

The price at which a stop order is triggered for Stop and StopLimit orders.

unitsnumber

Number of shares for the order. This can be a decimal for fractional orders. Must be null if notional_value is provided.

Example request

{
  "account_id": "917c8734-8470-4a3e-a18f-57c3f2ee6631",
  "universal_symbol_id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
  "order_type": "Market",
  "time_in_force": "Day",
  "price": 31.33,
  "stop": 31.33,
  "units": 10.5
}

Response

OK

Example response

{
  "trade": {
    "id": "139e307a-82f7-4402-b39e-4da7baa87758",
    "account": "917c8734-8470-4a3e-a18f-57c3f2ee6631",
    "order_type": "Market",
    "time_in_force": "Day",
    "symbol": {
      "universal_symbol_id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
      "currency": {
        "id": "87b24961-b51e-4db8-9226-f198f6518a89",
        "code": "USD",
        "name": "US Dollar"
      },
      "local_id": "1048101",
      "description": "Metaverse Global ETF",
      "symbol": "MVGP.U.TO",
      "brokerage_symbol_id": "2bcd7cc3-e922-4976-bce1-9858296801c3"
    },
    "units": 10.5,
    "price": 31.33
  },
  "trade_impacts": [
    {
      "account": "917c8734-8470-4a3e-a18f-57c3f2ee6631",
      "currency": "87b24961-b51e-4db8-9226-f198f6518a89",
      "remaining_cash": 1.11,
      "estimated_commission": 3.26,
      "forex_fees": 5.26
    }
  ],
  "combined_remaining_balance": {
    "account": {
      "id": "917c8734-8470-4a3e-a18f-57c3f2ee6631",
      "name": "Robinhood Individual",
      "number": "Q6542138443",
      "institution_account_id": "54953432",
      "sync_status": {
        "transactions": {
          "initial_sync_completed": true,
          "last_successful_sync": "2022-01-24",
          "first_transaction_date": "2022-01-24"
        },
        "holdings": {
          "initial_sync_completed": true,
          "last_successful_sync": "2024-06-28 18:42:46.561408+00:00",
          "holdings_unavailable": true
        }
      }
    },
    "currency": {
      "id": "87b24961-b51e-4db8-9226-f198f6518a89",
      "code": "USD",
      "name": "US Dollar"
    },
    "cash": 1.11
  }
}