TD Ameritrade · Schema
TD Ameritrade API Schemas
JSON Schema definitions extracted from the TD Ameritrade OpenAPI specification.
BrokerageTradingFinanceEquitiesOptionsMarket DataStreaming
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/api-evangelist/td-ameritrade/main/json-schema/td-ameritrade.json",
"title": "TD Ameritrade API Schemas",
"description": "JSON Schema definitions extracted from the TD Ameritrade OpenAPI specification.",
"definitions": {
"Account": {
"properties": {
"securitiesAccount": {
"$ref": "#/components/schemas/AccountType"
}
},
"type": "object"
},
"AccountType": {
"oneOf": [
{
"$ref": "#/components/schemas/CashAccount"
},
{
"$ref": "#/components/schemas/MarginAccount"
}
],
"type": "object"
},
"AssetType": {
"enum": [
"EQUITY",
"OPTION",
"FUTURE_OPTION",
"INDICATOR",
"FOREX",
"MUTUAL_FUND",
"INDEX",
"CASH_EQUIVALENT",
"FIXED_INCOME",
"CURRENCY",
"ETF",
"BOND",
"UNKNOWN"
],
"example": "'EQUITY' or 'OPTION' or 'INDEX' or 'MUTUAL_FUND' or 'CASH_EQUIVALENT' or 'FIXED_INCOME' or 'CURRENCY'",
"type": "string"
},
"Bond": {
"properties": {
"assetType": {
"$ref": "#/components/schemas/AssetType"
},
"bondPrice": {
"example": 0,
"type": "number"
},
"cusip": {
"example": "string",
"type": "string"
},
"description": {
"example": "string",
"type": "string"
},
"exchange": {
"example": "string",
"type": "string"
},
"symbol": {
"example": "string",
"type": "string"
}
},
"type": "object"
},
"CandleList": {
"properties": {
"candles": {
"items": {
"properties": {
"close": {
"example": 0,
"type": "number"
},
"datetime": {
"example": 0,
"type": "number"
},
"high": {
"example": 0,
"type": "number"
},
"low": {
"example": 0,
"type": "number"
},
"open": {
"example": 0,
"type": "number"
},
"volume": {
"example": 0,
"type": "number"
}
},
"type": "object"
},
"type": "array"
},
"empty": {
"type": "boolean"
},
"symbol": {
"example": "string",
"type": "string"
}
},
"type": "object"
},
"CashAccount": {
"properties": {
"accountId": {
"example": "string",
"type": "string"
},
"currentBalances": {
"properties": {
"accruedInterest": {
"example": 0,
"type": "number"
},
"bondValue": {
"example": 0,
"type": "number"
},
"cashAvailableForTrading": {
"example": 0,
"type": "number"
},
"cashAvailableForWithdrawal": {
"example": 0,
"type": "number"
},
"cashBalance": {
"example": 0,
"type": "number"
},
"cashCall": {
"example": 0,
"type": "number"
},
"cashDebitCallValue": {
"example": 0,
"type": "number"
},
"cashReceipts": {
"example": 0,
"type": "number"
},
"liquidationValue": {
"example": 0,
"type": "number"
},
"longMarketValue": {
"example": 0,
"type": "number"
},
"longNonMarginableMarketValue": {
"example": 0,
"type": "number"
},
"longOptionMarketValue": {
"example": 0,
"type": "number"
},
"moneyMarketFund": {
"example": 0,
"type": "number"
},
"mutualFundValue": {
"example": 0,
"type": "number"
},
"pendingDeposits": {
"example": 0,
"type": "number"
},
"savings": {
"example": 0,
"type": "number"
},
"shortMarketValue": {
"example": 0,
"type": "number"
},
"shortOptionMarketValue": {
"example": 0,
"type": "number"
},
"totalCash": {
"example": 0,
"type": "number"
},
"unsettledCash": {
"example": 0,
"type": "number"
}
},
"type": "object"
},
"initialBalances": {
"properties": {
"accountValue": {
"example": 0,
"type": "number"
},
"accruedInterest": {
"example": 0,
"type": "number"
},
"bondValue": {
"example": 0,
"type": "number"
},
"cashAvailableForTrading": {
"example": 0,
"type": "number"
},
"cashAvailableForWithdrawal": {
"example": 0,
"type": "number"
},
"cashBalance": {
"example": 0,
"type": "number"
},
"cashDebitCallValue": {
"example": 0,
"type": "number"
},
"cashReceipts": {
"example": 0,
"type": "number"
},
"isInCall": {
"type": "boolean"
},
"liquidationValue": {
"example": 0,
"type": "number"
},
"longOptionMarketValue": {
"example": 0,
"type": "number"
},
"longStockValue": {
"example": 0,
"type": "number"
},
"moneyMarketFund": {
"example": 0,
"type": "number"
},
"mutualFundValue": {
"example": 0,
"type": "number"
},
"pendingDeposits": {
"example": 0,
"type": "number"
},
"shortOptionMarketValue": {
"example": 0,
"type": "number"
},
"shortStockValue": {
"example": 0,
"type": "number"
},
"unsettledCash": {
"example": 0,
"type": "number"
}
},
"type": "object"
},
"isClosingOnlyRestricted": {
"type": "boolean"
},
"isDayTrader": {
"type": "boolean"
},
"orderStrategies": {
"items": {
"properties": {
"accountId": {
"example": 0,
"type": "number"
},
"activationPrice": {
"example": 0,
"type": "number"
},
"cancelTime": {
"properties": {
"date": {
"example": "string",
"type": "string"
},
"shortFormat": {
"type": "boolean"
}
},
"type": "object"
},
"cancelable": {
"type": "boolean"
},
"childOrderStrategies": {
"items": {
"type": "object"
},
"type": "array"
},
"closeTime": {
"example": "string",
"type": "string"
},
"complexOrderStrategyType": {
"$ref": "#/components/schemas/ComplexOrderStrategyType"
},
"destinationLinkName": {
"example": "string",
"type": "string"
},
"duration": {
"$ref": "#/components/schemas/Duration"
},
"editable": {
"type": "boolean"
},
"enteredTime": {
"example": "string",
"type": "string"
},
"filledQuantity": {
"example": 0,
"type": "number"
},
"orderActivityCollection": {
"items": {
"$ref": "#/components/schemas/Execution"
},
"type": "array"
},
"orderId": {
"example": 0,
"type": "number"
},
"orderLegCollection": {
"items": {
"properties": {
"instruction": {
"$ref": "#/components/schemas/Instruction"
},
"instrument": {
"$ref": "#/components/schemas/InstrumentType"
},
"legId": {
"example": 0,
"type": "number"
},
"orderLegType": {
"$ref": "#/components/schemas/AssetType"
},
"positionEffect": {
"$ref": "#/components/schemas/PositionEffect"
},
"quantity": {
"example": 0,
"type": "number"
},
"quantityType": {
"$ref": "#/components/schemas/QuantityType"
}
},
"type": "object"
},
"type": "array"
},
"orderStrategyType": {
"$ref": "#/components/schemas/OrderStrategyType"
},
"orderType": {
"$ref": "#/components/schemas/OrderType"
},
"price": {
"example": 0,
"type": "number"
},
"priceLinkBasis": {
"$ref": "#/components/schemas/PriceLinkBasis"
},
"priceLinkType": {
"$ref": "#/components/schemas/PriceLinkType"
},
"quantity": {
"example": 0,
"type": "number"
},
"releaseTime": {
"example": "string",
"type": "string"
},
"remainingQuantity": {
"example": 0,
"type": "number"
},
"replacingOrderCollection": {
"items": {
"type": "object"
},
"type": "array"
},
"requestedDestination": {
"$ref": "#/components/schemas/DestinationExchange"
},
"session": {
"$ref": "#/components/schemas/Session"
},
"specialInstruction": {
"$ref": "#/components/schemas/SpecialInstruction"
},
"status": {
"$ref": "#/components/schemas/OrderStatus"
},
"statusDescription": {
"example": "string",
"type": "string"
},
"stopPrice": {
"example": 0,
"type": "number"
},
"stopPriceLinkBasis": {
"$ref": "#/components/schemas/PriceLinkBasis"
},
"stopPriceLinkType": {
"$ref": "#/components/schemas/PriceLinkType"
},
"stopPriceOffset": {
"example": 0,
"type": "number"
},
"stopType": {
"$ref": "#/components/schemas/StopType"
},
"tag": {
"example": "string",
"type": "string"
},
"taxLotMethod": {
"$ref": "#/components/schemas/TaxLotMethod"
}
},
"type": "object"
},
"type": "array"
},
"positions": {
"items": {
"properties": {
"agedQuantity": {
"example": 0,
"type": "number"
},
"averagePrice": {
"example": 0,
"type": "number"
},
"currentDayProfitLoss": {
"example": 0,
"type": "number"
},
"currentDayProfitLossPercentage": {
"example": 0,
"type": "number"
},
"instrument": {
"$ref": "#/components/schemas/InstrumentType"
},
"longQuantity": {
"example": 0,
"type": "number"
},
"marketValue": {
"example": 0,
"type": "number"
},
"settledLongQuantity": {
"example": 0,
"type": "number"
},
"settledShortQuantity": {
"example": 0,
"type": "number"
},
"shortQuantity": {
"example": 0,
"type": "number"
}
},
"type": "object"
},
"type": "array"
},
"projectedBalances": {
"properties": {
"accruedInterest": {
"example": 0,
"type": "number"
},
"bondValue": {
"example": 0,
"type": "number"
},
"cashAvailableForTrading": {
"example": 0,
"type": "number"
},
"cashAvailableForWithdrawal": {
"example": 0,
"type": "number"
},
"cashBalance": {
"example": 0,
"type": "number"
},
"cashCall": {
"example": 0,
"type": "number"
},
"cashDebitCallValue": {
"example": 0,
"type": "number"
},
"cashReceipts": {
"example": 0,
"type": "number"
},
"liquidationValue": {
"example": 0,
"type": "number"
},
"longMarketValue": {
"example": 0,
"type": "number"
},
"longNonMarginableMarketValue": {
"example": 0,
"type": "number"
},
"longOptionMarketValue": {
"example": 0,
"type": "number"
},
"moneyMarketFund": {
"example": 0,
"type": "number"
},
"mutualFundValue": {
"example": 0,
"type": "number"
},
"pendingDeposits": {
"example": 0,
"type": "number"
},
"savings": {
"example": 0,
"type": "number"
},
"shortMarketValue": {
"example": 0,
"type": "number"
},
"shortOptionMarketValue": {
"example": 0,
"type": "number"
},
"totalCash": {
"example": 0,
"type": "number"
},
"unsettledCash": {
"example": 0,
"type": "number"
}
},
"type": "object"
},
"roundTrips": {
"example": 0,
"type": "number"
},
"type": {
"example": "'CASH' or 'MARGIN'",
"type": "string"
}
},
"type": "object"
},
"CashEquivalent": {
"properties": {
"assetType": {
"$ref": "#/components/schemas/AssetType"
},
"cusip": {
"example": "string",
"type": "string"
},
"description": {
"example": "string",
"type": "string"
},
"symbol": {
"example": "string",
"type": "string"
},
"type": {
"example": "'SAVINGS' or 'MONEY_MARKET_FUND'",
"type": "string"
}
},
"type": "object"
},
"ComplexOrderStrategyType": {
"enum": [
"NONE",
"COVERED",
"VERTICAL",
"BACK_RATIO",
"CALENDAR",
"DIAGONAL",
"STRADDLE",
"STRANGLE",
"COLLAR_SYNTHETIC",
"BUTTERFLY",
"CONDOR",
"IRON_CONDOR",
"VERTICAL_ROLL",
"COLLAR_WITH_STOCK",
"DOUBLE_DIAGONAL",
"UNBALANCED_BUTTERFLY",
"UNBALANCED_CONDOR",
"UNBALANCED_IRON_CONDOR",
"UNBALANCED_VERTICAL_ROLL",
"CUSTOM"
],
"example": "'NONE' or 'COVERED' or 'VERTICAL' or 'BACK_RATIO' or 'CALENDAR' or 'DIAGONAL' or 'STRADDLE' or 'STRANGLE' or 'COLLAR_SYNTHETIC' or 'BUTTERFLY' or 'CONDOR' or 'IRON_CONDOR' or 'VERTICAL_ROLL' or 'COLLAR_WITH_STOCK' or 'DOUBLE_DIAGONAL' or 'UNBALANCED_BUTTERFLY' or 'UNBALANCED_CONDOR' or 'UNBALANCED_IRON_CONDOR' or 'UNBALANCED_VERTICAL_ROLL' or 'CUSTOM'",
"type": "string"
},
"CreateWatchlist": {
"properties": {
"name": {
"example": "string",
"type": "string"
},
"watchlistItems": {
"items": {
"properties": {
"averagePrice": {
"example": 0,
"format": "int32",
"type": "integer"
},
"commission": {
"example": 0,
"format": "int32",
"type": "integer"
},
"instrument": {
"properties": {
"assetType": {
"$ref": "#/components/schemas/AssetType"
},
"symbol": {
"example": "string",
"type": "string"
}
},
"type": "object"
},
"purchasedDate": {
"example": "DateParam",
"type": "string"
},
"quantity": {
"example": 0,
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"CurrencyType": {
"enum": [
"USD",
"CAD",
"EUR",
"JPY"
],
"example": "'USD' or 'CAD' or 'EUR' or 'JPY'",
"type": "string"
},
"DestinationExchange": {
"enum": [
"INET",
"ECN_ARCA",
"CBOE",
"AMEX",
"PHLX",
"ISE",
"BOX",
"NYSE",
"NASDAQ",
"BATS",
"C2",
"AUTO"
],
"example": "'INET' or 'ECN_ARCA' or 'CBOE' or 'AMEX' or 'PHLX' or 'ISE' or 'BOX' or 'NYSE' or 'NASDAQ' or 'BATS' or 'C2' or 'AUTO'",
"type": "string"
},
"Duration": {
"enum": [
"DAY",
"GOOD_TILL_CANCEL",
"FILL_OR_KILL"
],
"example": "'DAY' or 'GOOD_TILL_CANCEL' or 'FILL_OR_KILL'",
"type": "string"
},
"EASObject": {
"properties": {
"access_token": {
"example": "string",
"type": "string"
},
"expires_in": {
"example": 0,
"type": "number"
},
"refresh_token": {
"example": "string",
"type": "string"
},
"refresh_token_expires_in": {
"example": 0,
"type": "number"
},
"scope": {
"example": "string",
"type": "string"
},
"token_type": {
"example": "string",
"type": "string"
}
},
"type": "object"
},
"ETF": {
"properties": {
"52WkHigh": {
"example": 0,
"type": "number"
},
"52WkLow": {
"example": 0,
"type": "number"
},
"askId": {
"example": "string",
"type": "string"
},
"askPrice": {
"example": 0,
"type": "number"
},
"askSize": {
"example": 0,
"type": "number"
},
"bidId": {
"example": "string",
"type": "string"
},
"bidPrice": {
"example": 0,
"type": "number"
},
"bidSize": {
"example": 0,
"type": "number"
},
"closePrice": {
"example": 0,
"type": "number"
},
"description": {
"example": "string",
"type": "string"
},
"digits": {
"example": 0,
"type": "number"
},
"divAmount": {
"example": 0,
"type": "number"
},
"divDate": {
"example": "string",
"type": "string"
},
"divYield": {
"example": 0,
"type": "number"
},
"exchange": {
"example": "string",
"type": "string"
},
"exchangeName": {
"example": "string",
"type": "string"
},
"highPrice": {
"example": 0,
"type": "number"
},
"lastId": {
"example": "string",
"type": "string"
},
"lastPrice": {
"example": 0,
"type": "number"
},
"lastSize": {
"example": 0,
"type": "number"
},
"lowPrice": {
"example": 0,
"type": "number"
},
"marginable": {
"type": "boolean"
},
"mark": {
"example": 0,
"type": "number"
},
"netChange": {
"example": 0,
"type": "number"
},
"openPrice": {
"example": 0,
"type": "number"
},
"peRatio": {
"example": 0,
"type": "number"
},
"quoteTimeInLong": {
"example": 0,
"type": "number"
},
"regularMarketLastPrice": {
"example": 0,
"type": "number"
},
"regularMarketLastSize": {
"example": 0,
"type": "number"
},
"regularMarketNetChange": {
"example": 0,
"type": "number"
},
"regularMarketTradeTimeInLong": {
"example": 0,
"type": "number"
},
"securityStatus": {
"example": "string",
"type": "string"
},
"shortable": {
"type": "boolean"
},
"symbol": {
"example": "string",
"type": "string"
},
"totalVolume": {
"example": 0,
"type": "number"
},
"tradeTimeInLong": {
"example": 0,
"type": "number"
},
"volatility": {
"example": 0,
"type": "number"
}
},
"type": "object"
},
"Equity": {
"properties": {
"assetType": {
"$ref": "#/components/schemas/AssetType"
},
"cusip": {
"example": "string",
"type": "string"
},
"description": {
"example": "string",
"type": "string"
},
"symbol": {
"example": "string",
"type": "string"
}
},
"type": "object"
},
"EquityPriceLinkType": {
"enum": [
"VALUE",
"PERCENT"
],
"example": "'VALUE' or 'PERCENT'",
"type": "string"
},
"Execution": {
"properties": {
"activityType": {
"example": "'EXECUTION' or 'ORDER_ACTION'",
"type": "string"
},
"executionLegs": {
"items": {
"properties": {
"legId": {
"example": 0,
"type": "number"
},
"mismarkedQuantity": {
"example": 0,
"type": "number"
},
"price": {
"example": 0,
"type": "number"
},
"quantity": {
"example": 0,
"type": "number"
},
"time": {
"example": "string",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"executionType": {
"example": "FILL",
"type": "string"
},
"orderRemainingQuantity": {
"example": 0,
"type": "number"
},
"quantity": {
"example": 0,
"type": "number"
}
},
"type": "object"
},
"ExpirationDate": {
"properties": {
"date": {
"example": "string",
"type": "string"
}
},
"type": "object"
},
"FixedIncome": {
"properties": {
"assetType": {
"$ref": "#/components/schemas/AssetType"
},
"cusip": {
"example": "string",
"type": "string"
},
"description": {
"example": "string",
"type": "string"
},
"factor": {
"example": 0,
"type": "number"
},
"maturityDate": {
"example": "string",
"type": "string"
},
"symbol": {
"example": "string",
"type": "string"
},
"variableRate": {
"example": 0,
"type": "number"
}
},
"type": "object"
},
"Forex": {
"properties": {
"52WkHighInDouble": {
"example": 0,
"type": "number"
},
"52WkLowInDouble": {
"example": 0,
"type": "number"
},
"askPriceInDouble": {
"example": 0,
"type": "number"
},
"bidPriceInDouble": {
"example": 0,
"type": "number"
},
"changeInDouble": {
"example": 0,
"type": "number"
},
"closePriceInDouble": {
"example": 0,
"type": "number"
},
"description": {
"example": "string",
"type": "string"
},
"digits": {
"example": 0,
"type": "number"
},
"exchange": {
"example": "string",
"type": "string"
},
"exchangeName": {
"example": "string",
"type": "string"
},
"highPriceInDouble": {
"example": 0,
"type": "number"
},
"isTradable": {
"type": "boolean"
},
"lastPriceInDouble": {
"example": 0,
"type": "number"
},
"lowPriceInDouble": {
"example": 0,
"type": "number"
},
"mark": {
"example": 0,
"type": "number"
},
"marketMaker": {
"example": "string",
"type": "string"
},
"openPriceInDouble": {
"example": 0,
"type": "number"
},
"percentChange": {
"example": 0,
"type": "number"
},
"product": {
"example": "string",
"type": "string"
},
"securityStatus": {
"example": "string",
"type": "string"
},
"symbol": {
"example": "string",
"type": "string"
},
"tick": {
"example": 0,
"type": "number"
},
"tickAmount": {
"example": 0,
"type": "number"
},
"tradingHours": {
"example": "string",
"type": "string"
}
},
"type": "object"
},
"Fundamental": {
"properties": {
"assetType": {
"$ref": "#/components/schemas/AssetType"
},
"cusip": {
"example": "string",
"type": "string"
},
"description": {
"example": "string",
"type": "string"
},
"exchange": {
"example": "string",
"type": "string"
},
"fundamental": {
"properties": {
"beta": {
"example": 0,
"type": "number"
},
"bookValuePerShare": {
"example": 0,
"type": "number"
},
"currentRatio": {
"example": 0,
"type": "number"
},
"divGrowthRate3Year": {
"example": 0,
"type": "number"
},
"dividendAmount": {
"example": 0,
"type": "number"
},
"dividendDate": {
"example": "string",
"type": "string"
},
"dividendPayAmount": {
"example": 0,
"type": "number"
},
"dividendPayDate": {
"example": "string",
"type": "string"
},
"dividendYield": {
"example": 0,
"type": "number"
},
"epsChange": {
"example": 0,
"type": "number"
},
"epsChangePercentTTM": {
"example": 0,
"type": "number"
},
"epsChangeYear": {
"example": 0,
"type": "number"
},
"epsTTM": {
"example": 0,
"type": "number"
},
"grossMarginMRQ": {
"example": 0,
"type": "number"
},
"grossMarginTTM": {
"example": 0,
"type": "number"
},
"high52": {
"example": 0,
"type": "number"
},
"interestCoverage": {
"example": 0,
"type": "number"
},
"low52": {
"example": 0,
"type": "number"
},
"ltDebtToEquity": {
"example": 0,
"type": "number"
},
"marketCap": {
"example": 0,
"type": "number"
},
"marketCapFloat": {
"example": 0,
"type": "number"
},
"netProfitMarginMRQ": {
"example": 0,
"type": "number"
},
"netProfitMarginTTM": {
"example": 0,
"type": "number"
},
"operatingMarginMRQ": {
"example": 0,
"type": "number"
},
"operatingMarginTTM": {
"example": 0,
"type": "number"
},
"pbRatio": {
"example": 0,
"type": "number"
},
"pcfRatio": {
"example": 0,
"type": "number"
},
"peRatio": {
"example": 0,
"type": "number"
},
"pegRatio": {
"example": 0,
"type": "number"
},
"prRatio": {
"example": 0,
"type": "number"
},
"quickRa
# --- truncated at 32 KB (119 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/td-ameritrade/refs/heads/main/json-schema/td-ameritrade.json