schema.md

Schema Types

Table of Contents

• Query
• Objects
  • Option
  • OptionChain
  • StockOverview
  • StockPrice
  • Ticker
• Scalars
  • Boolean
  • Float
  • Int
  • String

Query

Field	Argument	Type	Description
ticker		Ticker	Data for a single stock.
ticker		String!	A valid stock ticker.
startDate		String	A date in the form mm/dd/yyyy. Defaults to 365 days prior to the current date.
endDate		String	A date in the form mm/dd/yyyy. Defaults to the current date.
frequency		String	A given frequency for stock data. Values must be one of the following: 1d, 1wk, or, 1mo.
tickers		[Ticker]	Data for a list of stocks.
tickers		[String]	A list of valid stock tickers.
startDate		String	A date in the form mm/dd/yyyy. Defaults to 365 days prior to the current date.
endDate		String	A date in the form mm/dd/yyyy. Defaults to the current date.
frequency		String	A given frequency for stock data. Values must be one of the following: 1d, 1wk, or, 1mo.
calls		[Option]	Data on all call options for the given (optional) expiration date will be returned. By default calls from the current expiration month will be returned.If the data provided is not an exact expiration date the closest expiration following the provided date with be returned. If there aren't any options expiring after the provided date, the query will resolve to its default behavior.
underlying		String!	The ticker of the underlying stock.
expiration		String	The expiration date of the option contract in mm/dd/yyyy format. Defauts to the closest expiration.
puts		[Option]	Data on all put options for the given (optional) expiration date will be returned. By default puts from the current expiration month will be returned.If the data provided is not an exact expiration date the closest expiration following the provided date with be returned. If there aren't any options expiring after the provided date, the query will resolve to its default behavior.
underlying		String!	The ticker of the underlying stock.
expiration		String	The expiration date of the option contract in mm/dd/yyyy format. Defauts to the closest expiration.
optionStrikes		[Float]	A list of all available strikes for the given expiration date will be returned.
underlying		String!	The ticker of the underlying stock.
expiration		String	The expiration date of the option contract in mm/dd/yyyy format. Defauts to the closest expiration.
optionExpirationDates		[String]	A list of all currently available option expiration dates are return in mm/dd/yy format.
underlying		String!	The ticker of the underlying stock.

Objects

Option

Field	Argument	Type	Description
contractSymbol		String	A unique identifier giving information on the type, expiration, and strike of an option contract.
expiration		String	The expiration date of the option contract.
change		Float	Decimal value representing the change in price.
lastPrice		Float	The last price at which a contract was bought and sold.
inTheMoney		Boolean	Defines whether the option contract has intrinsic value.
impliedVolatility		Float	A measure of the markets expectation of price movements in the underlying asset prior to the option's expiration.
openInterest		Float	The number of open contracts for the underlying at the given strike
percentChange		Float	Percentage representing the change in price.
bid		Float	The price offered to buy the option.
ask		Float	The price offered to sell the option.
volume		Float	the total number of contracts for each strike that traded during the day.
lastTradeDate		String	Date showing the last time the contract was traded.
currency		String	The currency the option contract trades in.
strike		Float	The price at which the underlying asset can be bought or sold.
contractSize		String	The units of underlying that is represented by one contract. Typically one option contract covers 100 shares of stock.

OptionChain

Field	Argument	Type	Description
underlying		String!	The ticker of the underlying stock.
date		String!	The expiration date of the option contract.
strikes		[String]	A list of all available stike prices for the given expiration date.
calls		[Option]	A list of all call options for the given expiration date.
puts		[Option]	A list of all put options for the given expiration date.
allOptions		[Option]	A list of all call and put options for the given expiration date.

StockOverview

Field	Argument	Type	Description
symbol		String	The ticker for the stock.
openToday		Float	Todays price when the stock opened.
highToday		Float	The highest price the stock reached today.
lowToday		Float	The lowest price the stock reached today.
closePrevious		Float	The last trading days closing price.
recentPrice		Float	The most recent stock price available.
volumeToday		Float	The number of shares traded today.
sharesOutstanding		Float	The total number of shares availabe.
marketCap		Float	The total value of a companies equity.
fiftyTwoWeekHigh		Float	The stocks highest price over the last year.
fiftyTwoWeekLow		Float	The stocks lowest price over the last year.
fiftyTwoWeekRange		String	The low-high range over the last year.

StockPrice

Field	Argument	Type	Description
date		String	The date when the stock traded.
open		Float	The share price when the market opened.
high		Float	The highest share price on the given day.
low		Float	The lowest share price on the given day.
close		Float	The share price when the market closed.
volume		Float	The total amount of shares traded during the day.
adjclose		Float	The close price adjusted for dividends and stock splits.

Ticker

Field	Argument	Type	Description
ticker		String!	A valid stock ticker.
startDate		String!	The first date requested for stock data.
endDate		String!	The last date requested for stock data.
frequency		String	Determins the frequency of stock price data. 1d for daily, 1wk for weekly, and 1mo for monthly
stockPrices		[StockPrice]	A list of stock price data.
stockOverview		StockOverview	Basic information on the stock price performace on the day and over the year
relatedStocks		[StockOverview]	Current and yearly performance information on a list of related stock tickers
calls		[Option]	A list of near term call options for the given stock
puts		[Option]	A list of near term put options for the given stock.
optionChains		[OptionChain]	A list of all option contracts that expire on the same day.
limit		Int	Limit the number of results returned. Must be > 0.

Scalars

Boolean

The Boolean scalar type represents true or false.

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31 - 1) and 2^31 - 1 since represented in JSON as double-precision floating point numbers specifiedby IEEE 754.

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.