Sign in

v51

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

Preview crypto order

Previews an order using the specified account.

post/accounts/{accountId}/trading/crypto/preview

Path parameters

accountIdstring uuid required

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

Example:917c8734-8470-4a3e-a18f-57c3f2ee6631

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

side'BUY' | 'SELL' required

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

type'MARKET' | 'LIMIT' | 'STOP_LOSS_MARKET' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT_MARKET' | 'TAKE_PROFIT_LIMIT' required

The type of order to place.

time_in_force'GTC' | 'FOK' | 'IOC' | 'GTD' 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.

  • 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.
  • GTD - Good Til Date. The order is valid until the specified date.
amountstring decimal required

The amount of the base currency to buy or sell.

limit_pricestring decimal

The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT.

stop_pricestring decimal

The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT, TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.

post_onlyboolean

Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees.

expiration_datestring date-time

The expiration date of the order. Required if the time_in_force is GTD.

Example request

{
  "instrument": {
    "symbol": "BTC"
  },
  "amount": "123.45",
  "limit_price": "123.45",
  "stop_price": "123.45",
  "expiration_date": "2024-01-01T00:00:00Z"
}

Response

OK

Example response

{
  "estimated_fee": {
    "currency": "BTC",
    "amount": "123.45"
  }
}