Tradestation API

https://tradestation.github.io/api-docs/swagger.json
Admin
This document describes the resources of the official TradeStation API, detailing how to access...
Tokens:42,108
Snippets:102
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example Tradestation API HTTP Request with cURL

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This snippet demonstrates a basic HTTP GET request to the TradeStation API using cURL. It shows how to retrieve a quote for 'msft' and the expected HTTP response, including headers and a JSON body.

```cURL
curl -i https://api.tradestation.com/v2/data/quote/msft?APIVersion=20160101

HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 1545
Content-Type: application/default+json; charset=utf-8
Access-Control-Allow-Origin: *
APIVersion: 20160101
Date: Wed, 30 Nov 2016 01:51:45 GMT

[
...json...
]
```

--------------------------------

### TradeStation API Example Throttled HTTP Request

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This snippet demonstrates an HTTP GET request to the TradeStation API that could lead to a rate limit exceeding. It shows the typical headers, including Host and Authorization, used when requesting data quotes for multiple symbols.

```HTTP
GET https://api.tradestation.com/v2/data/quotes/IBM,NFLX,MSFT,AMZN,AAPL HTTP/1.1
Host: api.tradestation.com
Authorization: bearer eE45VkdQSnlBcmI0Q2RqTi82SFdMSVE0SXMyOFo5Z3dzVzdzdk
Accept: application/json
```

--------------------------------

### Example TradeStation API HTTP Chunk with Multiple JSON Objects

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This example illustrates an HTTP chunked stream where a single chunk contains multiple complete JSON objects. Developers must be prepared for such scenarios, as intermediate proxies may re-chunk the stream, combining or splitting application messages. Robust parsing logic is required to correctly extract all JSON objects.

```HTTP
GET https://sim.api.tradestation.com/v2/stream/barchart/$DJI/1/Minute/12-26-2016/01-24-2017

HTTP/1.1 200 OK
Date: Wed, 14 Jun 2017 01:17:36 GMT
Content-Type: application/vnd.tradestation.streams+json
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
Cache-Control: private

22d
{"Close":19956.09,"DownTicks":26,"DownVolume":940229,"High":19961.77,"Low":19943.46,"Open":19943.46,"Status":13,"TimeStamp":"\/Date(1482849060000)\/","TotalTicks":59,"TotalVolume":3982533,"UnchangedTicks":0,"UnchangedVolume":0,"UpTicks":33,"UpVolume":3042304,"OpenInterest":0}
{"Close":19950.82,"DownTicks":32,"DownVolume":440577,"High":19959.15,"Low":19947.34,"Open":19955.64,"Status":13,"TimeStamp":"\/Date(1482849120000)\/","TotalTicks":60,"TotalVolume":761274,"UnchangedTicks":0,"UnchangedVolume":0,"UpTicks":28,"UpVolume":320697,"OpenInterest":0}
END
```

--------------------------------

### TradeStation API: Get Account Balances

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This endpoint fetches the balance information for specified accounts. It supports querying up to 25 account keys, comma-separated, with a recommended batch size of 10. OAuth2 authentication with 'readaccount' scope is required.

```APIDOC
GET /v2/accounts/{account_keys}/balances

Summary: Get Account Balances
Description: Returns the Balance for the given accounts.
Operation ID: getBalancesByAccounts
Tags: brokerage

Security:
  - OAuth2-Auth-Code: [readaccount]
  - OAuth2-Refresh-Token: [readaccount]

Parameters:
  - Name: account_keys
    In: path
    Type: array
    Items: string
    Description: 1 to 25 account keys can be specified, comma separated. Recommended batch size is 10.
    Required: true

Responses:
  - Status: 200
    Description: Account Balances Response
    Schema: #/definitions/AccountBalancesDefinition
  - Status: 400
    Description: Bad Request
    Schema: #/definitions/Error
  - Status: 401
    Description: Unauthorized
    Schema: #/definitions/Error
  - Status: 403
    Description: Forbidden
    Schema: #/definitions/Error
  - Status: 404
    Description: Account Not Found
    Schema: #/definitions/Error
  - Status: 500
    Description: Unexpected Error
    Schema: #/definitions/Error
  - Status: 502
    Description: Bad Gateway
    Schema: #/definitions/Error
  - Status: 504
    Description: Gateway Timeout
    Schema: #/definitions/Error
```

--------------------------------

### Get Suggested Symbols from TradeStation API

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This API endpoint suggests symbols semantically based on partial input of symbol name, company name, or description. It does not return Options symbols. Dependencies include a valid OAuth2 token for authentication.

```APIDOC
Endpoint: /v2/data/symbols/suggest/{text}
Method: GET
Summary: Suggest Symbols
Description: Suggests symbols semantically based upon partial input of symbol name, company name, or description. Does not return Options symbols.
Tags: marketdata
Security:
  - OAuth2-Auth-Code (marketdata)
  - OAuth2-Refresh-Token (marketdata)
Parameters:
  - name: $top
    in: query
    type: integer
    description: The top number of results to return.
    required: false
  - name: $filter
    in: query
    type: string
    description: An OData filter to apply to the results. Supports the `eq` and `neq` filter opeators. E.g. `AAP?$filter=Category%20neq%20%27Stock%27`. Valid values are: `Category` (`Stock`, `Index`, `Future`, `Forex`), `Country` (E.g. `United States`, `GB`) `Currency` (E.g. `USD`, `AUD`), and `Exchange` (E.g. `NYSE`).
    required: false
  - name: text
    in: path
    type: string
    description: Symbol text for suggestion. Partial input of a symbol name, company name, or description.
    required: true
Responses:
  - 200: Symbol Suggest (Schema: #/definitions/SymbolSuggestDefinition)
  - 400: Bad Request (Schema: #/definitions/Error)
  - 401: Unauthorized (Schema: #/definitions/Error)
  - 403: Forbidden (Schema: #/definitions/Error)
  - 500: Unexpected Error (Schema: #/definitions/Error)
  - 502: Bad Gateway (Schema: #/definitions/Error)
  - 504: Gateway Timeout (Schema: #/definitions/Error)
```

```shell
curl -H "Authorization: Bearer 1JUjFiNFFGWEdDM" "https://api.tradestation.com/v2/data/symbols/suggest/A"
```

--------------------------------

### Requesting Specific Tradestation API Version

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

To ensure future compatibility and access the latest features, always explicitly request the desired API version using the APIVersion querystring parameter. This example demonstrates requesting version 20160101 for a quote.

```APIDOC
https://api.tradestation.com/v2/data/quote/msft?APIVersion=20160101
```

--------------------------------

### Exchange TradeStation OAuth2 Authorization Code for Access Token (Response)

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This section provides an example of the successful JSON response received after exchanging the authorization code. It includes the refresh token, access token, expiration, token type, and user ID.

```JSON
HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 927
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 06 Dec 2011 20:50:32 GMT

{
    "refresh_token": "eGlhc2xvTTVJaEdXMWs4VjhraWx4bk5QMHJMaA==",
    "expires_in": 1200,
    "access_token": "eGlhc2xvozT2IxWnVITmdwGVFPQ==",
    "token_type": "AccessToken",
    "userid": "testUser"
}
```

--------------------------------

### Get All Symbol Lists API (TradeStation)

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This API endpoint retrieves a comprehensive list of all available symbol lists from TradeStation. It provides a way to discover and manage various predefined or custom symbol groupings.

```APIDOC
GET /v2/data/symbollists

Summary: Get all Symbol Lists
Description: Gets a list of all Symbol Lists.

Parameters:
  (None)

Responses:
  - 200:
    description: Symbol Lists Response

Security:
  - OAuth2-Auth-Code (marketdata)
  - OAuth2-Refresh-Token (marketdata)
```

```shell
curl -H "Authorization: Bearer 1JUjFiNFFGWEdDM" "https://api.tradestation.com/v2/data/symbollists"
```

--------------------------------

### TradeStation API Example Failed HTTP 403 Rate Limit Response

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This snippet illustrates the HTTP 403 'Quota Exceeded' response returned by the TradeStation API when a user's request limit is reached. It includes standard HTTP headers and a simple HTML body indicating the error.

```HTTP
HTTP/1.1 403 Quota Exceeded
Content-Length: 15
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
Date: Tue, 06 Dec 2011 20:50:32 GMT

<html><body>Quota Exceeded</body></html>
```

--------------------------------

### TradeStation API HTTP Streaming JSON Object Example

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This snippet shows a single JSON object that might be part of an HTTP stream from the TradeStation API. It illustrates the structure of data like quote information, including price, volume, and timestamp, which can be split across HTTP chunks.

```JSON
{
  "Ask":71.67,
  "AskSize":100,
  "Bid":71.65,
  "BidSize":100,
  "Close":71.66,
  "Description":"APPLE INC",
  "Exchange":"NASDAQ",
  "High":71.67,
  "Low":71.65,
  "Open":71.66,
  "Status":13,
  "TimeStamp":"\/Date(1497016260000)\/",
  "TotalTicks":77,
  "TotalVolume":17270,
  "UnchangedTicks":0,
  "UnchangedVolume":0,
  "UpTicks":32,
  "UpVolume":11864,
  "OpenInterest":0
}
```

--------------------------------

### Example TradeStation API Healthy HTTP Chunked Stream

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This snippet demonstrates a typical healthy HTTP chunked stream from the TradeStation API. It shows the HTTP request and response headers, followed by variable-length chunks containing parsable JSON objects, terminated by an 'END' message. Clients must handle stream lifetime and connection closing based on these signals.

```HTTP
GET https://sim.api.tradestation.com/v2/stream/barchart/$DJI/1/Minute/12-26-2016/01-24-2017

HTTP/1.1 200 OK
Date: Wed, 14 Jun 2017 01:17:36 GMT
Content-Type: application/vnd.tradestation.streams+json
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
Cache-Control: private

114
{"Close":19956.09,"DownTicks":26,"DownVolume":940229,"High":19961.77,"Low":19943.46,"Open":19943.46,"Status":13,"TimeStamp":"\/Date(1482849060000)\/","TotalTicks":59,"TotalVolume":3982533,"UnchangedTicks":0,"UnchangedVolume":0,"UpTicks":33,"UpVolume":3042304,"OpenInterest":0}


112
{"Close":19950.82,"DownTicks":32,"DownVolume":440577,"High":19959.15,"Low":19947.34,"Open":19955.64,"Status":13,"TimeStamp":"\/Date(1482849120000)\/","TotalTicks":60,"TotalVolume":761274,"UnchangedTicks":0,"UnchangedVolume":0,"UpTicks":28,"UpVolume":320697,"OpenInterest":0}


END
```

--------------------------------

### APIDOC: Get List of Available Exchanges

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This API endpoint provides a list of valid exchanges that a client can specify when posting an order. It details the expected successful response containing an array of ExchangeDefinition objects, as well as various error responses for common issues like bad requests or unauthorized access.

```APIDOC
{
  "path": "/v2/orderexecution/exchanges",
  "method": "get",
  "summary": "Request Available Exchanges",
  "description": "Returns a list of valid exchanges that a client can specify when posting an order.",
  "operationId": "getExchanges",
  "tags": [
    "order-execution"
  ],
  "responses": {
    "200": {
      "description": "Get Exchange List",
      "schema": {
        "type": "object",
        "properties": {
          "Exchange": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/ExchangeDefinition"
            }
          }
        }
      }
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "$ref": "#/definitions/Error"
      }
    },
    "401": {
      "description": "Unauthorized",
      "schema": {
        "$ref": "#/definitions/Error"
      }
    },
    "403": {
      "description": "Forbidden",
      "schema": {
        "$ref": "#/definitions/Error"
      }
    },
    "500": {
      "description": "Unexpected Error",
      "schema": {
        "$ref": "#/definitions/Error"
      }
    }
  }
}
```

--------------------------------

### Tradestation API Base URLs for Live and Simulator Environments

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This snippet provides the base URLs for accessing the TradeStation API in both live and simulated (SIM) environments. The live API is used for real trading, while the SIM API allows for paper trading and testing without financial risk.

```APIDOC
Live API Base URL: https://api.tradestation.com/v2
Simulator API Base URL: https://sim-api.tradestation.com/v2
```

--------------------------------

### Execute TradeStation Get Quote API Call with cURL

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This cURL command demonstrates how to make an authenticated GET request to the TradeStation API to retrieve a Level 1 quote for a specific symbol, such as AMZN. Ensure you replace '1JUjFiNFFGWEdDM' with your valid Bearer token obtained through OAuth2 authentication.

```shell
curl -H \"Authorization: Bearer 1JUjFiNFFGWEdDM\" \"https://api.tradestation.com/v2/data/quote/AMZN\"\n
```

--------------------------------

### APIDOC: TradeStation Order Definition Schema

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

Defines the structure for placing a new order, including details for single or multi-leg orders and required trade parameters.

```APIDOC
OrderDefinition (object)
  Description: Defines the structure for placing a new order, including details for single or multi-leg orders and required trade parameters.
  Properties:
    Legs (array of object) - Required. Collection of individual legs for a multi-leg order.
      Properties:
        Symbol (string) - Required. Must be UPPERCASE.
        Quantity (string) - Required.
        TradeAction (string) - Required. Conveys the intent of the trade.
          Enum: BUY, SELL, BUYTOCOVER, SELLSHORT, BUYTOOPEN, BUYTOCLOSE, SELLTOOPEN, SELLTOCLOSE
          Description: BUY - equity and futures trades; SELL - equity and futures trades; BUYTOCOVER - equity trade to close a short position; SELLSHORT - equity trade to open a short position; BUYTOOPEN - option trades; BUYTOCLOSE - option trades; SELLTOOPEN - option trades; SELLTOCLOSE - option trades.
    AssetType (string) - Required.
    Symbol (string) - Required.
    Quantity (string) - Required.
    OrderType (string) - Required.
    Duration (string) - Required.
    AccountKey (string) - Required.
    TradeAction (string) - Required.
```

--------------------------------

### TradeStation API: Get Account Positions

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This endpoint retrieves the current positions for specified accounts. It requires OAuth2 authentication with 'readaccount' scope. The account keys are provided as a path parameter.

```APIDOC
GET /v2/accounts/{account_keys}/positions

Summary: Get Account Positions
Description: Returns the Positions for the given accounts.
Operation ID: getPositionsByAccounts
Tags: brokerage

Security:
  - OAuth2-Auth-Code: [readaccount]
  - OAuth2-Refresh-Token: [readaccount]
```

--------------------------------

### APIDOC: TradeStation Advanced Order Options Definition Schema

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

Advanced Options for an order.

```APIDOC
AdvancedOptionsDefinition (object)
  Description: Advanced Options for an order.
  Properties:
    TrailingStop (object) - Optional. Reference: #/definitions/TrailingStopDefinition.
    MarketActivationRules (array of object) - Optional. Set of market-based activation rules that must be met before order is sent to the exchange. Max 4 rules. Reference: #/definitions/MarketActivationRuleDefinition.
    TimeActivationRules (array of object) - Optional. Set of time-based activation rules that must be met before order is sent to the exchange. Max 1 rule. Reference: #/definitions/TimeActivationRuleDefinition.
```

--------------------------------

### TradeStation API: Get User Accounts

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This endpoint retrieves all accounts associated with a given user ID. It requires OAuth2 authentication with 'readaccount' scope. The user ID is a required path parameter.

```APIDOC
GET /v2/users/{user_id}/accounts

Summary: Get User Accounts
Description: Returns all accounts for the given user.
Operation ID: getAccountsByUserID
Tags: brokerage

Security:
  - OAuth2-Auth-Code: [readaccount]
  - OAuth2-Refresh-Token: [readaccount]

Parameters:
  - Name: user_id
    In: path
    Type: string
    Description: User ID for Accounts Lookup.
    Required: true

Responses:
  - Status: 200
    Description: Accounts Response
    Schema: #/definitions/UserAccountsDefinition
  - Status: 400
    Description: Bad Request
    Schema: #/definitions/Error
  - Status: 401
    Description: Unauthorized
    Schema: #/definitions/Error
  - Status: 403
    Description: Forbidden
    Schema: #/definitions/Error
  - Status: 404
    Description: User Not Found
    Schema: #/definitions/Error
  - Status: 500
    Description: Unexpected Error
    Schema: #/definitions/Error
  - Status: 502
    Description: Bad Gateway
    Schema: #/definitions/Error
  - Status: 504
    Description: Gateway Timeout
    Schema: #/definitions/Error
```

--------------------------------

### APIDOC: Retrieve Available Activation Triggers

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This API endpoint allows clients to request a list of available activation triggers. A valid TriggerKey obtained from this resource is required when placing orders with activation triggers. It specifies the security requirements for OAuth2 authentication and outlines the expected responses, including a successful response with a list of ActivationTriggerDefinition objects.

```APIDOC
{
  "path": "/v2/orderexecution/activationtriggers",
  "method": "get",
  "summary": "Request Available Activation Triggers",
  "description": "To place orders with activation triggers, a valid TriggerKey must be sent with the order.  This resource provides the available trigger methods with their corresponding key.",
  "operationId": "getActivationTriggers",
  "tags": [
    "order-execution"
  ],
  "security": [
    {
      "OAuth2-Auth-Code": [
        "trade"
      ]
    },
    {
      "OAuth2-Refresh-Token": [
        "trade"
      ]
    }
  ],
  "responses": {
    "200": {
      "description": "Get Activation Triggers Response",
      "schema": {
        "type": "object",
        "properties": {
          "ActivationTriggers": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/ActivationTriggerDefinition"
            }
          }
        }
      }
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "$ref": "#/definitions/Error"
      }
    },
    "401": {
      "description": "Unauthorized",
      "schema": {
        "$ref": "#/definitions/Error"
      }
    },
    "403": {
      "description": "Forbidden",
      "schema": {
        "$ref": "#/definitions/Error"
      }
    },
    "500": {
      "description": "Unexpected Error",
      "schema": {
        "$ref": "#/definitions/Error"
      }
    },
    "502": {
      "description": "Bad Gateway",
      "schema": {
        "$ref": "#/definitions/Error"
      }
    },
    "504": {
      "description": "Gateway Timeout",
      "schema": {
        "$ref": "#/definitions/Error"
      }
    }
  }
}
```

--------------------------------

### Stream BarChart Data API (TradeStation)

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

Streams barchart data starting from a specified date, with each bar representing a quantity of a given unit. This API allows for custom session templates for US equity symbols.

```APIDOC
Path: /v2/stream/barchart/{symbol}/{interval}/{unit}/{startDate}
Method: GET
Summary: Stream BarChart - Starting on Date
Description: Streams barchart data starting from startDate, each bar filling quantity of unit.
Tags: marketdata
Security:
  - OAuth2-Auth-Code (marketdata)
  - OAuth2-Refresh-Token (marketdata)
Produces: application/vnd.tradestation.streams+json
Parameters:
  - name: SessionTemplate
    in: query
    description: United States (US) stock market session templates, that extend bars returned to include those outside of the regular trading session. Ignored for non-US equity symbols.
    type: string
    enum: [USEQPre, USEQPost, USEQPreAndPost, USEQ24Hour, Default]
    required: false
  - name: symbol
    in: path
    description: A Symbol Name.
    type: string
    required: true
  - name: interval
    in: path
    description: The interval value for the bar (e.g., 1, 5, 60).
    type: integer
    required: true
  - name: unit
    in: path
    description: The unit of time for the bar (e.g., Minute, Hour, Day).
    type: string
    enum: [Minute, Hour, Day, Week, Month, Tick, Volume]
    required: true
  - name: startDate
    in: path
    description: The start date for the bar chart data (MM-DD-YYYY).
    type: string
    format: date
    required: true
Responses:
  - 200: BarChart Stream Response (Schema: #/definitions/BarChartDefinition)
  - 400: Bad Request (Schema: #/definitions/Error)
  - 401: Unauthorized (Schema: #/definitions/Error)
  - 403: Forbidden (Schema: #/definitions/Error)
  - 404: Symbol Not Found (Schema: #/definitions/Error)
  - 500: Unexpected Error (Schema: #/definitions/Error)
```

```shell
curl -H "Accept: application/vnd.tradestation.streams+json" -H "Authorization: Bearer 1JUjFiNFFGWEdDM" "https://api.tradestation.com/v2/stream/barchart/AMZN/5/Minute/12-01-2016?SessionTemplate=USEQPreAndPost"
```

--------------------------------

### Define TradeStation Order Confirmation Request Schema

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This API documentation defines the `OrderConfirmRequestDefinition` schema used for confirming and placing orders within the TradeStation platform. It outlines essential properties such as account details, asset type, order duration, pricing, and trade actions. This schema is crucial for constructing valid order requests.

```APIDOC
{
  "OrderConfirmRequestDefinition": {
    "properties": {
      "AccountKey": {
        "description": "Must be a valid Account Key for that user and Asset Type\n",
        "type": "string"
      },
      "AdvancedOptions": {
        "$ref": "#/definitions/AdvancedOptionsDefinition"
      },
      "AssetType": {
        "type": "string",
        "enum": [
          "EQ",
          "FU",
          "OP"
        ]
      },
      "Duration": {
        "type": "string",
        "enum": [
          "DAY",
          "DYP",
          "GTC",
          "GCP",
          "GTD",
          "GDP",
          "OPG",
          "CLO",
          "IOC",
          "FOK",
          1,
          "1 MIN",
          3,
          "3 MIN",
          5,
          "5 MIN"
        ],
        "description": "Allowed durations vary by Asset Type\n* DAY - Day, valid until the end of the regular trading session.\n* DYP - Day Plus; valid until the end of the extended trading session\n* GTC - Good till canceled\n* GCP - Good till canceled plus\n* GTD - Good through date\n* GDP - Good through date plus\n* OPG - At the opening; only valid for listed stocks at the opening session Price\n* CLO - On Close; orders that target the closing session of an exchange.\n* IOC - Immediate or Cancel; filled immediately or canceled, partial fills are accepted\n* FOK - Fill or Kill; orders are filled entirely or canceled, partial fills are not accepted\n* 1 or 1 MIN - 1 minute; expires after the 1 minute\n* 3 or 3 MIN - 3 minutes; expires after the 3 minutes\n* 5 or 5 MIN - 5 minutes; expires after the 5 minutes\n"
      },
      "GTDDate": {
        "description": "Date that Order is valid through. Input Format: MM/DD/YYYY\nRequired for orders with Duration = GTD.\n",
        "maxLength": 10,
        "type": "string",
        "format": "mmddyyyy"
      },
      "LimitPrice": {
        "type": "string"
      },
      "StopPrice": {
        "type": "string"
      },
      "OrderType": {
        "type": "string",
        "enum": [
          "Limit",
          "Market",
          "StopLimit",
          "StopMarket"
        ]
      },
      "Quantity": {
        "type": "string"
      },
      "Route": {
        "type": "string",
        "description": "The route of the order. For Stocks and Options, Route value will default to `Intelligent` if no value is set.\nMust be UPPERCASE. Routes can be obtained from [Retrieve Available Exchanges](#operation/getExchanges).\n"
      },
      "Symbol": {
        "description": "Must be UPPERCASE",
        "type": "string"
      },
      "TradeAction": {
        "type": "string",
        "description": "Conveys the intent of the trade\n* BUY - `equities` and `futures`\n* SELL - `equities` and `futures`\n* BUYTOCOVER - `equities`\n* SELLSHORT - `equities`\n* BUYTOOPEN - `options`\n* BUYTOCLOSE - `options`\n* SELLTOOPEN - `options`\n* SELLTOCLOSE - `options`\n",
        "enum": [
          "BUY",
          "SELL",
          "BUYTOCOVER",
          "SELLSHORT",
          "BUYTOOPEN",
          "BUYTOCLOSE",
          "SELLTOOPEN",
          "SELLTOCLOSE"
        ]
      },
      "OSOs": {
        "items": {
          "type": "object",
          "properties": {
            "Type": {
              "type": "string",
              "enum": [
                "NORMAL",
                "BRK",
                "OCO"
              ]
            },
            "Orders": {
              "items": {
                "$ref": "#/definitions/OrderConfirmRequestDefinition"
              },
              "minItems": 1,
              "type": "array",
              "uniqueItems": true
            }
          },
          "required": [
            "Type"
          ]
        },
        "minItems": 1,
        "type": "array",
        "uniqueItems": true
      },
      "Legs": {
        "items": {
          "type": "object",
          "properties": {
            "Symbol": {
              "description": "Must be UPPERCASE",
              "type": "string"
            },
            "Quantity": {
              "type": "string"
            },
            "TradeAction": {
              "type": "string",
              "enum": [
                "BUY",
                "SELL"
              ]
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### API: Get TradeStation Account Orders

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This API endpoint retrieves orders for specified accounts, sorted descending by most recent order. It supports pagination and filtering by a 'since' date. Intermediate order state changes are not available.

```APIDOC
GET /v2/accounts/{account_keys}/orders

Summary: Get Account Orders

Description: Returns the Orders for the given accounts sorted descending, most recent order first.\n\nNote: Intermediate order state changes are not available.

Security:
  - OAuth2-Auth-Code: readaccount
  - OAuth2-Refresh-Token: readaccount

Parameters:
  - since (query, string, optional):
    Description: Start Date from which to pull older orders. MM-DD-YYYY format. Limited to 90 days prior to the current date.
  - account_keys (path, array<string>, required):
    Description: 1 to 25 account keys can be specified, comma separated. Recommended batch size is 10.
  - pageSize (query, string, optional):
    Description: Conveys the number of order items to return in the request. (Default page size is 600). Note that an empty set will be returned for a pageNum/pageSize combination that doesn't contain orders. Pagination applies to current and historical orders separately when a value for "since" is specified.
  - pageNum (query, string, optional):
    Description: Conveys the page number to return, given a set of orders and a page size. Note that an empty set will be returned for a pageNum/pageSize combination that doesn't contain orders.

Responses:
  - 200 OK:
    Description: Account Orders Response
    Schema: #/definitions/AccountOrdersDefinition
  - 400 Bad Request:
    Description: Bad Request
    Schema: #/definitions/Error
  - 401 Unauthorized:
    Description: Unauthorized
    Schema: #/definitions/Error
  - 403 Forbidden:
    Description: Forbidden
    Schema: #/definitions/Error
  - 404 Account Not Found:
    Description: Account Not Found
    Schema: #/definitions/Error
```

--------------------------------

### APIDOC: TradeStation Cancel/Replace Time Activation Rule Definition Schema

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

Advanced Options for an order.

```APIDOC
CancelReplaceTimeActivationRuleDefinition (object)
  Description: Advanced Options for an order.
  Properties:
    ClearAll (boolean) - Optional. If 'True', removes all activation rules when replacing the order and ignores any rules sent in `Rules`.
    Rules (array of object) - Optional. Set of time-based activation rules that must be met before order is sent to the exchange. Max 1 rule. Reference: #/definitions/TimeActivationRuleDefinition.
```

--------------------------------

### TradeStation API: Submit New Order (POST /v2/orders)

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This API endpoint facilitates the submission of one or more orders to TradeStation. It supports a range of order types including Market, Limit, Stop Market, Stop Limit, Options, and Order Sends Order (OSO). This is the primary endpoint for placing live trades.

```APIDOC
Method: POST
Path: /v2/orders
Summary: Submit Order
Description: Submits 1 or more orders. Request valid for Market, Limit, Stop Market, Stop Limit, Options and Order Sends Order (OSO) order types.
Operation ID: postOrder
Tags:
  - order-execution
Security:
  - OAuth2-Auth-Code: ["trade"]
  - OAuth2-Refresh-Token: ["trade"]
Parameters:
  - name: body
    in: body
    required: true
    schema: #/definitions/OrderRequestDefinition
Responses:
  - 200: Orders Response (schema: #/definitions/OrderResponseDefinition)
  - 400: Bad Request (schema: #/definitions/Error)
  - 401: Unauthorized (schema: #/definitions/Error)
  - 403: Forbidden (schema: #/definitions/Error)
  - 500: Unexpected Error (schema: #/definitions/Error)
```

--------------------------------

### TradeStation API Core Swagger/OpenAPI Definition Snippet

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This snippet provides a partial view of the TradeStation API's Swagger/OpenAPI definition. It includes metadata such as API version, logo, contact information, host, base path, schemes, content types, and the definition for OAuth2 security.

```JSON
"version": "20160101",
"x-logo": {
  "url": "ts-logo.png"
},
"contact": {
  "name": "TradeStation API Team",
  "email": "ClientExperience@tradestation.com",
  "url": "https://developer.tradestation.com/webapi"
},
"host": "api.tradestation.com",
"basePath": "/",
"schemes": [
  "https"
],
"consumes": [
  "application/json; charset=utf-8"
],
"produces": [
  "application/json; charset=utf-8"
],
"securityDefinitions": {
  "OAuth2-Auth-Code": {
```

--------------------------------

### API: Get TradeStation Account Positions

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This API endpoint retrieves detailed position information for one or more specified accounts. It supports filtering by symbol and requires valid account keys. The response provides current positions or an error if accounts are not found or unauthorized.

```APIDOC
GET /v2/accounts/{account_keys}/positions

Summary: Retrieve Account Positions

Security:
  - OAuth2-Auth-Code: readaccount
  - OAuth2-Refresh-Token: readaccount

Parameters:
  - account_keys (path, array<string>, required):
    Description: 1 to 25 account keys can be specified, comma separated. Recommended batch size is 10.
  - $filter (query, string, optional):
    Description: An OData v2.0 filter. Available Fields: Symbol (Symbol Name for Position).

Responses:
  - 200 OK:
    Description: Account Positions Response
    Schema: #/definitions/AccountPositionsDefinition
  - 400 Bad Request:
    Description: Bad Request
    Schema: #/definitions/Error
  - 401 Unauthorized:
    Description: Unauthorized
    Schema: #/definitions/Error
  - 403 Forbidden:
    Description: Forbidden
    Schema: #/definitions/Error
  - 404 Account Not Found:
    Description: Account Not Found
    Schema: #/definitions/Error
  - 500 Unexpected Error:
    Description: Unexpected Error
    Schema: #/definitions/Error
  - 502 Bad Gateway:
    Description: Bad Gateway
    Schema: #/definitions/Error
  - 504 Gateway Timeout:
    Description: Gateway Timeout
    Schema: #/definitions/Error
```

--------------------------------

### Understand Order Confirmation Response in TradeStation API

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This definition details the structure of the response received after an order confirmation, providing key information about the order's routing, duration, associated account, and unique confirmation ID. It also includes estimated price and cost details, which may vary for market or conditional orders. This response is vital for verifying order submission and understanding its initial parameters.

```APIDOC
Definition: OrderConfirmResponseDefinition
  Description: Order Confirm definition. The response will also contain asset-specific fields
  Type: object
  Properties:
    - Route (string): The path chosen for directing a trade to a certain destination, such as an ECN, MM, Exchange, or Intelligent.
    - Duration (string): The amount of time for which an order is valid. Duration is the same as TIF (Time in Force).
    - Account (string): The number that identifies a specific TradeStation account that is being used for a particular order.
    - OrderConfirmId (string): Unique id generated per order per API Key and User
    - EstimatedPrice (number): An estimated value that is calculated using current market information. The actual cost for Market orders and orders with conditions, such as Trailing Stop or Activation Rule orders, may differ significantly from this estimate.
    - EstimatedPriceDisplay (string): Equity and Futures Orders; Estimated price formatted for display
    - EstimatedCost (number): The actual cost for Market orders and orders with conditions, such as Trailing Stop or Activation Rule orders.
    - EstimatedCostDisplay (string): Equity Orders; Estimated cost formatted for display
    - DebitCreditEstimatedCost (number)
```

--------------------------------

### Redirect User for TradeStation OAuth2 Authorization

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This step outlines how to redirect the end-user to the TradeStation MFA login page to initiate the authorization process. It specifies the authorization URI and required query string parameters for the redirect.

```HTTP
Authorize Uri:
- https://api.tradestation.com/v2/authorize

Required query string parameters:
- redirect_uri
- client_id = the client application’s API key
- response_type = code

Example Authorization Page Url:
https://api.tradestation.com/v2/authorize/?redirect_uri=https://exampleclientapp.com/authcode.aspx&client_id=D7635234&response_type=code
```

--------------------------------

### APIDOC: Get All TradeStation Symbol Lists

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This API endpoint retrieves a list of all symbol lists available to the authenticated user. It requires OAuth2 authentication with 'marketdata' scope. The response includes a collection of symbol list definitions or an error if the request is malformed or unauthorized.

```APIDOC
{
  "path": "/v2/data/symbollists",
  "method": "get",
  "summary": "Get Symbol Lists",
  "description": "Gets all Symbol Lists available to the user.",
  "tags": ["marketdata"],
  "security": [
    {"OAuth2-Auth-Code": ["marketdata"]},
    {"OAuth2-Refresh-Token": ["marketdata"]}
  ],
  "parameters": [],
  "responses": {
    "200": {
      "description": "SymbolLists Response",
      "schema": {"$ref": "#/definitions/SymbolListsDefinition"}
    },
    "400": {
      "description": "Bad Request",
      "schema": {"$ref": "#/definitions/Error"}
    },
    "401": {
      "description": "Unauthorized",
      "schema": {"$ref": "#/definitions/Error"}
    },
    "403": {
      "description": "Forbidden",
      "schema": {"$ref": "#/definitions/Error"}
    },
    "500": {
      "description": "Unexpected Error",
      "schema": {"$ref": "#/definitions/Error"}
    },
    "502": {
      "description": "Bad Gateway",
      "schema": {"$ref": "#/definitions/Error"}
    },
    "504": {
      "description": "Gateway Timeout",
      "schema": {"$ref": "#/definitions/Error"}
    }
  }
}
```

--------------------------------

### Stream BarChart - Bars Back API (TradeStation)

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This API endpoint streams barchart data starting from a specified number of bars back from a given last date. Each bar fills an interval of a defined unit. It requires OAuth2 authentication with 'marketdata' scope.

```APIDOC
{
  "path": "/v2/stream/barchart/{symbol}/{interval}/{unit}/{barsBack}/{lastDate}/...",
  "method": "get",
  "summary": "Stream BarChart - Bars Back",
  "description": "Streams barchart data starting from a number of bars back from last date, each bar filling interval of unit.",
  "operationId": "streamBarchartsBarsBack",
  "tags": [
    "marketdata"
  ],
  "security": [
    {
      "OAuth2-Auth-Code": [
        "marketdata"
      ]
    },
    {
      "OAuth2-Refresh-Token": [
        "marketdata"
      ]
    }
  ],
  "produces": [
    "application/vnd.tradestation.streams+json"
  ],
  "parameters": [
    {
      "name": "SessionTemplate",
      "in": "query",
      "description": "United States (US) stock market session templates, that extend bars returned to include those outside of the regular trading session. Ignored for non-US equity symbols.",
      "type": "string",
      "enum": [
        "USEQPre",
        "USEQPost",
        "USEQPreAndPost",
        "USEQ24Hour",
        "Default"
      ],
      "required": false
    },
    {
      "name": "symbol",
      "in": "path",
      "description": "A Symbol name.",
      "type": "string",
      "required": true
    },
    {
      "name": "interval",
      "in": "path",
      "description": "Interval that each bar will consist of. **For Daily, Weekly, and Monthly units this value must be 1.**",
      "type": "integer",
      "minimum": 1,
      "maximum": 1440,
      "required": true
    },
    {
      "name": "unit",
      "in": "path",
      "description": "Unit of time for each bar interval.",
      "type": "string",
      "enum": [
        "Minute",
        "Daily",
        "Weekly",
        "Monthly"
      ],
      "required": true
    },
    {
      "name": "barsBack",
      "in": "path",
      "description": "The number of bars to stream, going back from time 00:00:00 of the day specified in lastDate.",
      "type": "integer",
      "minimum": 1,
      "maximum": 57600,
      "required": true
    },
    {
      "name": "lastDate",
      "in": "path"
    }
  ],
  "responses": {
    "200": {
      "description": "Barchart Response",
      "schema": {
        "$ref": "#/definitions/BarchartDefinition"
      }
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "$ref": "#/definitions/BarchartError400"
      }
    },
    "401": {
      "description": "Unauthorized",
      "schema": {
        "$ref": "#/definitions/Error"
      }
    },
    "403": {
      "description": "Forbidden",
      "schema": {
        "$ref": "#/definitions/Error"
      }
    },
    "404": {
      "description": "Symbol Not Found",
      "schema": {
        "$ref": "#/definitions/BarchartError404"
      }
    },
    "500": {
      "description": "Unexpected Error",
      "schema": {
        "$ref": "#/definitions/Error"
      }
    },
    "502": {
      "description": "Bad Gateway",
      "schema": {
        "$ref": "#/definitions/Error"
      }
    },
    "504": {
      "description": "Gateway Timeout",
      "schema": {
        "$ref": "#/definitions/Error"
      }
    }
  }
}
```

```shell
curl -H "Accept: application/vnd.tradestation.streams+json" -H "Authorization: Bearer 1JUjFiNFFGWEdDM" "https://api.tradestation.com/v2/stream/barchart/AMZN/5/Minute/25/12-01-2016?SessionTemplate=USEQPreAndPost"
```

--------------------------------

### APIDOC: TradeStation Cancel/Replace Market Activation Rule Definition Schema

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

Advanced Options for an order.

```APIDOC
CancelReplaceMarketActivationRuleDefinition (object)
  Description: Advanced Options for an order.
  Properties:
    ClearAll (boolean) - Optional. If 'True', removes all activation rules when replacing the order and ignores any rules sent in `Rules`.
    Rules (array of object) - Optional. Set of market-based activation rules that must be met before order is sent to the exchange. Max 4 rules. Reference: #/definitions/MarketActivationRuleDefinition.
```

--------------------------------

### TradeStation API: Group Order Request Definition

Source: https://tradestation.github.io/api-docs/swagger.json/swagger

This API definition outlines the structure for submitting a group of orders. It requires a collection of individual order requests and specifies how the Order Execution system should process this group, supporting normal, OCO, or BRK order types.

```APIDOC
{
  "GroupOrderRequestDefinition": {
    "description": "",
    "properties": {
      "Orders": {
        "minItems": 1,
        "type": "array",
        "uniqueItems": true,
        "items": {
          "$ref": "#/definitions/OrderRequestDefinition"
        }
      },
      "Type": {
        "description": "Indicates how Order Execution should treat this group of orders.\n",
        "type": "string",
        "enum": [
          "NORMAL",
          "OCO",
          "BRK"
        ]
      }
    },
    "required": [
      "Type",
      "Orders"
    ],
    "type": "object"
  }
}
```
Tokens:
Raw