Documentation

Preview an order

Preview an order. This allows you "place" an order without it being sent to the market. It will also provide useful information such as cost and commission of the requested order.

Endpoint

Method
POST
URL
/v1/accounts/{account_id}/orders

Headers

Accept
application/xml, application/json, application/javascript
Default: application/xml
Required: false
Authorization
Bearer {access token}
Required: true

Path Parameters

account_id
An account number

Form Parameters

preview
Set to true in order to preview.
class
The kind of order to be placed
Options: equity, option
Required: true
symbol
The symbol ordered.
Required: true
duration
Options: day, gtc
The time for which the order will be remain in effect
Required: true
side
The side of the order.
Equity order options: buy, buy_to_cover, sell, sell_short
Option order options: buy_to_open, buy_to_close, sell_to_open, sell_to_close
Required: true
quantity
The number of shares ordered.
Required: true
type
The type of order to be placed.
Options: market, limit, stop, stop_limit
Required: true
price
The desired order limit price for "limit" and "stop_limit" orders.
Required for "limit", "stop_limit"
stop
The stop price in a "stop" or "stop_limit" typed order.
Required for "stop" and "stop_limit"
option_symbol
An OCC formatted option symbol. Example: AAPL140118C00195000
Required for "option" orders

Response

Field Description
commission Estimated commission for the order
cost Estimated cost of the order (including commission)
extended_hours true if the order was placed in pre/post markets
fees Fee amount for the order
margin_change Change in margin if the order was placed
status Acknowledgement of receipt

Example

Command

$ curl -X POST -H "Authorization: Bearer {access token}" https://api.tradier.com/v1/accounts/12345678/orders

Request

POST /v1/accounts/12345678/orders HTTP/1.1
User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8r zlib/1.2.5
Host: api.tradier.com
Accept: */*
Authorization: Bearer 098f6bcd4621d373cade4e832627b4f6

symbol=AAPL&duration=day&side=buy&quantity=100&type=market&preview=true

Response

HTTP/1.1 200 OK
Content-Type: application/xml;charset=utf-8
Content-Length: 278

<?xml version="1.0" encoding="UTF-8"?>
<order>
    <commission>3.490000</commission>
    <cost>1917.090000</cost>
    <extended_hours>false</extended_hours>
    <fees>0.000000</fees>
    <margin_change>956.6500000</margin_change>
    <quantity>10.000000</quantity>
    <status>ok</status>
</order>

Tradier Inc. and its corresponding technology services (including API services) are distinct and separate from the services provided by Tradier Brokerage Inc. For more information regarding the services of Tradier, Inc., please contact techsupport@tradier.com. For more information regarding the services of Tradier Brokerage, Inc. please contact service@tradierbrokerage.com. Tradier Brokerage Inc. Member FINRA/SIPC

© 2017 Tradier Inc.
  • 11016 Rushmore Drive, Suite 350
  • Charlotte, NC 28277

All materials contained on this site and specifically the API documentation pages are protected by United States copyright law and may not be copied, reproduced, distributed, transmitted, displayed, published or broadcast without the prior written permission of Tradier Inc. The Structure, Format, Layout, Examples and Design of the pages are owned by Tradier Inc, and any efforts to willfully or accidently duplicate a whole or part of the pages on this site is a violation of United States copyright law.