{
  "info": {
    "title": "Account Positions",
    "version": "0.0.1"
  },
  "swagger": "2.0",
  "produces": [
    "application/json"
  ],
  "host": "api.tastyworks.com",
  "tags": [
    {
      "name": "balance-snapshots",
      "description": "Operations about balance-snapshots"
    },
    {
      "name": "accounts",
      "description": "Operations about accounts"
    },
    {
      "name": "positions",
      "description": "Operations about positions"
    },
    {
      "name": "Positions",
      "description": "Allows an API client to fetch data about account positions."
    }
  ],
  "paths": {
    "/accounts/{account_number}/balance-snapshots": {
      "get": {
        "description": "Returns most recent snapshot and current balance for an account",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "account_number",
            "type": "integer",
            "format": "int32",
            "required": true
          },
          {
            "in": "query",
            "name": "page-offset",
            "type": "integer",
            "format": "int32",
            "default": 0,
            "required": false
          },
          {
            "in": "query",
            "name": "per-page",
            "type": "integer",
            "format": "int32",
            "default": 250,
            "minimum": 1,
            "maximum": 2000,
            "required": false
          },
          {
            "in": "query",
            "name": "currency",
            "description": "Currency",
            "type": "string",
            "default": "USD",
            "required": false
          },
          {
            "in": "query",
            "name": "snapshot-date",
            "description": "The day of the balance snapshot to retrieve",
            "type": "string",
            "format": "date",
            "required": false
          },
          {
            "in": "query",
            "name": "time-of-day",
            "description": "The abbreviation for the time of day.",
            "type": "string",
            "enum": [
              "BOD",
              "EOD",
              "Intraday"
            ],
            "required": true
          },
          {
            "in": "query",
            "name": "start-date",
            "description": "The first date in a range of dates to retrieve",
            "type": "string",
            "format": "date",
            "required": false
          },
          {
            "in": "query",
            "name": "end-date",
            "description": "The last date in a range of dates to retrieve",
            "type": "string",
            "format": "date",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "Returns most recent snapshot and current balance for an account",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/AccountBalanceSnapshot"
              }
            }
          }
        },
        "tags": [
          "balance-snapshots"
        ],
        "operationId": "getAccountsAccountNumberBalanceSnapshots"
      }
    },
    "/accounts/{account_number}/balances": {
      "get": {
        "description": "Returns the current balances for an account",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "account_number",
            "type": "integer",
            "format": "int32",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the current balances for an account",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/AccountBalance"
              }
            }
          }
        },
        "tags": [
          "accounts"
        ],
        "operationId": "getAccountsAccountNumberBalances"
      }
    },
    "/accounts/{account_number}/balances/{currency}": {
      "get": {
        "description": "Returns the current balance values for an account and currency",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "account_number",
            "type": "integer",
            "format": "int32",
            "required": true
          },
          {
            "in": "path",
            "name": "currency",
            "type": "string",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the current balance values for an account and currency",
            "schema": {
              "$ref": "#/definitions/AccountBalance"
            }
          }
        },
        "tags": [
          "accounts"
        ],
        "operationId": "getAccountsAccountNumberBalancesCurrency"
      }
    },
    "/accounts/{account_number}/positions": {
      "get": {
        "description": "Returns a list of the account's positions.\n            Can be filtered by symbol, underlying_symbol",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "account_number",
            "type": "integer",
            "format": "int32",
            "required": true
          },
          {
            "in": "query",
            "name": "include-closed-positions",
            "description": "If closed positions should be included in the query",
            "type": "boolean",
            "default": false,
            "required": false
          },
          {
            "in": "query",
            "name": "include-marks",
            "description": "Include current quote mark (note: can decrease performance)",
            "type": "boolean",
            "default": false,
            "required": false
          },
          {
            "in": "query",
            "name": "instrument-type",
            "description": "The type of Instrument",
            "type": "string",
            "enum": [
              "Bond",
              "Cryptocurrency",
              "Currency Pair",
              "Equity",
              "Equity Offering",
              "Equity Option",
              "Event Contract",
              "Fixed Income Security",
              "Future",
              "Future Option",
              "Index",
              "Liquidity Pool",
              "Unknown",
              "Warrant"
            ],
            "required": false
          },
          {
            "in": "query",
            "name": "net-positions",
            "description": "Returns net positions grouped by instrument type and symbol",
            "type": "boolean",
            "default": false,
            "required": false
          },
          {
            "in": "formData",
            "name": "partition-keys",
            "description": "Account partition keys (example: partition-keys[]={value1}&partition-keys[]={value2})",
            "type": "array",
            "items": {
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "symbol",
            "description": "A single symbol. Stock Ticker Symbol `AAPL`, \\\n                                 OCC Option Symbol `AAPL  191004P00275000`, \\\n                                 TW Future Symbol `/ESZ9`, or \\\n                                 TW Future Option Symbol `./ESZ9 EW4U9 190927P2975`",
            "type": "string",
            "required": false
          },
          {
            "in": "query",
            "name": "underlying-product-code",
            "description": "The underlying Future's Product code. i.e `ES`",
            "type": "string",
            "required": false
          },
          {
            "in": "query",
            "name": "underlying-symbol",
            "description": "An array of Underlying symbol(s) for positions (example: underlying-symbol[]={value1}&underlying-symbol[]={value2})",
            "type": "array",
            "items": {
              "type": "string"
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a list of the account's positions.\n            Can be filtered by symbol, underlying_symbol",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/CurrentPosition"
              }
            }
          }
        },
        "tags": [
          "positions"
        ],
        "operationId": "getAccountsAccountNumberPositions"
      }
    }
  },
  "definitions": {
    "CurrentPosition": {
      "type": "object",
      "properties": {
        "account-number": {
          "description": "",
          "type": "string"
        },
        "instrument-type": {
          "description": "",
          "type": "string"
        },
        "streamer-symbol": {
          "description": "",
          "type": "string"
        },
        "symbol": {
          "description": "",
          "type": "string"
        },
        "underlying-symbol": {
          "description": "",
          "type": "string"
        },
        "quantity": {
          "description": "",
          "type": "object"
        },
        "average-daily-market-close-price": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "average-open-price": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "average-yearly-market-close-price": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "close-price": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "cost-effect": {
          "description": "",
          "type": "string"
        },
        "is-frozen": {
          "description": "",
          "type": "boolean"
        },
        "is-suppressed": {
          "description": "",
          "type": "boolean"
        },
        "mark": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "mark-price": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "multiplier": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "quantity-direction": {
          "description": "",
          "type": "string"
        },
        "restricted-quantity": {
          "description": "",
          "type": "object"
        },
        "expires-at": {
          "description": "",
          "type": "string",
          "format": "date-time"
        },
        "deliverable-type": {
          "description": "",
          "type": "string"
        },
        "fixing-price": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "realized-day-gain": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "realized-day-gain-date": {
          "description": "",
          "type": "string",
          "format": "date"
        },
        "realized-day-gain-effect": {
          "description": "",
          "type": "string"
        },
        "realized-today": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "realized-today-date": {
          "description": "",
          "type": "string",
          "format": "date"
        },
        "realized-today-effect": {
          "description": "",
          "type": "string"
        },
        "face-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "par-size": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "created-at": {
          "description": "",
          "type": "string",
          "format": "date-time"
        },
        "updated-at": {
          "description": "",
          "type": "string",
          "format": "date-time"
        },
        "order-id": {
          "description": "",
          "type": "integer",
          "format": "int32"
        },
        "update-type": {
          "description": "",
          "type": "string"
        }
      },
      "description": "CurrentPosition model"
    },
    "AccountBalance": {
      "type": "object",
      "properties": {
        "account-number": {
          "description": "",
          "type": "string"
        },
        "available-trading-funds": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "bond-margin-requirement": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "cash-available-to-withdraw": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "cash-balance": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "cash-settle-balance": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "closed-loop-available-balance": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "cryptocurrency-margin-requirement": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "currency": {
          "description": "",
          "type": "string"
        },
        "day-equity-call-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "day-trade-excess": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "day-trading-buying-power": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "day-trading-call-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "derivative-buying-power": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "equity-buying-power": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "equity-offering-margin-requirement": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "fixed-income-security-margin-requirement": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "futures-margin-requirement": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "intraday-equities-cash-amount": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "intraday-equities-cash-effect": {
          "description": "",
          "type": "string"
        },
        "intraday-equities-cash-effective-date": {
          "description": "",
          "type": "string",
          "format": "date"
        },
        "intraday-futures-cash-amount": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "intraday-futures-cash-effect": {
          "description": "",
          "type": "string"
        },
        "intraday-futures-cash-effective-date": {
          "description": "",
          "type": "string",
          "format": "date"
        },
        "long-bond-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "long-cryptocurrency-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "long-derivative-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "long-equity-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "long-fixed-income-security-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "long-futures-derivative-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "long-futures-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "long-margineable-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "maintenance-call-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "maintenance-requirement": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "margin-equity": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "margin-settle-balance": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "net-liquidating-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "pending-cash": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "pending-cash-effect": {
          "description": "",
          "type": "string"
        },
        "previous-date-cryptocurrency-fiat-effective-date": {
          "description": "",
          "type": "string",
          "format": "date"
        },
        "previous-day-cryptocurrency-fiat-amount": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "previous-day-cryptocurrency-fiat-effect": {
          "description": "",
          "type": "string"
        },
        "reg-t-call-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "short-cryptocurrency-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "short-derivative-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "short-equity-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "short-futures-derivative-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "short-futures-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "short-margineable-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "sma-equity-option-buying-power": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "special-memorandum-account-apex-adjustment": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "special-memorandum-account-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "total-settle-balance": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "unsettled-cryptocurrency-fiat-amount": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "unsettled-cryptocurrency-fiat-effect": {
          "description": "",
          "type": "string"
        },
        "used-derivative-buying-power": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "snapshot-date": {
          "description": "",
          "type": "string",
          "format": "date"
        },
        "time-of-day": {
          "description": "",
          "type": "string"
        },
        "reg-t-margin-requirement": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "futures-overnight-margin-requirement": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "futures-intraday-margin-requirement": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "maintenance-excess": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "pending-margin-interest": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "apex-starting-day-margin-equity": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "buying-power-adjustment": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "buying-power-adjustment-effect": {
          "description": "",
          "type": "string"
        },
        "effective-cryptocurrency-buying-power": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "total-pending-liquidity-pool-rebate": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "long-index-derivative-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "short-index-derivative-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "updated-at": {
          "description": "",
          "type": "string",
          "format": "date-time"
        }
      },
      "description": "AccountBalance model"
    },
    "AccountBalanceSnapshot": {
      "type": "object",
      "properties": {
        "account-number": {
          "description": "",
          "type": "string"
        },
        "available-trading-funds": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "bond-margin-requirement": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "cash-available-to-withdraw": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "cash-balance": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "cash-settle-balance": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "closed-loop-available-balance": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "cryptocurrency-margin-requirement": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "currency": {
          "description": "",
          "type": "string"
        },
        "day-equity-call-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "day-trade-excess": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "day-trading-buying-power": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "day-trading-call-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "derivative-buying-power": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "equity-buying-power": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "equity-offering-margin-requirement": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "fixed-income-security-margin-requirement": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "futures-margin-requirement": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "intraday-equities-cash-amount": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "intraday-equities-cash-effect": {
          "description": "",
          "type": "string"
        },
        "intraday-equities-cash-effective-date": {
          "description": "",
          "type": "string",
          "format": "date"
        },
        "intraday-futures-cash-amount": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "intraday-futures-cash-effect": {
          "description": "",
          "type": "string"
        },
        "intraday-futures-cash-effective-date": {
          "description": "",
          "type": "string",
          "format": "date"
        },
        "long-bond-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "long-cryptocurrency-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "long-derivative-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "long-equity-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "long-fixed-income-security-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "long-futures-derivative-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "long-futures-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "long-margineable-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "maintenance-call-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "maintenance-requirement": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "margin-equity": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "margin-settle-balance": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "net-liquidating-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "pending-cash": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "pending-cash-effect": {
          "description": "",
          "type": "string"
        },
        "previous-date-cryptocurrency-fiat-effective-date": {
          "description": "",
          "type": "string",
          "format": "date"
        },
        "previous-day-cryptocurrency-fiat-amount": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "previous-day-cryptocurrency-fiat-effect": {
          "description": "",
          "type": "string"
        },
        "reg-t-call-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "short-cryptocurrency-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "short-derivative-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "short-equity-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "short-futures-derivative-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "short-futures-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "short-margineable-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "sma-equity-option-buying-power": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "special-memorandum-account-apex-adjustment": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "special-memorandum-account-value": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "total-settle-balance": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "unsettled-cryptocurrency-fiat-amount": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "unsettled-cryptocurrency-fiat-effect": {
          "description": "",
          "type": "string"
        },
        "used-derivative-buying-power": {
          "description": "",
          "type": "number",
          "format": "double"
        },
        "snapshot-date": {
          "description": "",
          "type": "string",
          "format": "date"
        },
        "time-of-day": {
          "description": "",
          "type": "string"
        }
      },
      "description": "AccountBalanceSnapshot model"
    }
  }
}