{"components":{"parameters":{"AggregateAdjusted":{"description":"Whether or not the results are adjusted for splits.  By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n","example":true,"in":"query","name":"adjusted","schema":{"type":"boolean"}},"AggregateDate":{"description":"The beginning date for the aggregate window.","example":"2025-11-03","in":"path","name":"date","required":true,"schema":{"type":"string"}},"AggregateLimitMax50000":{"description":"Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\n\u003ca href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\"\u003eAggregate Data API Improvements\u003c/a\u003e.\n","example":120,"in":"query","name":"limit","schema":{"type":"integer"}},"AggregateMultiplier":{"description":"The size of the timespan multiplier.","example":1,"in":"path","name":"multiplier","required":true,"schema":{"type":"integer"}},"AggregateSort":{"description":"Sort the results by timestamp.\n`asc` will return results in ascending order (oldest at the top),\n`desc` will return results in descending order (newest at the top).\n","example":"asc","in":"query","name":"sort","schema":{"enum":["asc","desc"]}},"AggregateTimeFrom":{"description":"The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","example":"2025-11-03","in":"path","name":"from","required":true,"schema":{"type":"string"}},"AggregateTimeTo":{"description":"The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","example":"2025-11-28","in":"path","name":"to","required":true,"schema":{"type":"string"}},"AggregateTimespan":{"description":"The size of the time window.","example":"day","in":"path","name":"timespan","required":true,"schema":{"enum":["second","minute","hour","day","week","month","quarter","year"],"type":"string"}},"CryptoTickerPathParam":{"description":"The ticker symbol of the currency pair.","example":"X:BTCUSD","in":"path","name":"cryptoTicker","required":true,"schema":{"type":"string"}},"CryptoTickersQueryParam":{"description":"A case-sensitive comma separated list of tickers to get snapshots for. For example, X:BTCUSD, X:ETHBTC, and X:BOBAUSD. Empty string defaults to querying all tickers.","in":"query","name":"tickers","schema":{"items":{"type":"string"},"type":"array"}},"ForexTickerPathParam":{"description":"The ticker symbol of the currency pair.","example":"C:EURUSD","in":"path","name":"forexTicker","required":true,"schema":{"type":"string"}},"ForexTickersQueryParam":{"description":"A case-sensitive comma separated list of tickers to get snapshots for. For example, C:EURUSD, C:GBPCAD, and C:AUDINR. Empty string defaults to querying all tickers.","in":"query","name":"tickers","schema":{"items":{"type":"string"},"type":"array"}},"GeneralTickerPathParam":{"description":"The ticker symbol of the asset.","example":"AAPL","in":"path","name":"ticker","required":true,"schema":{"type":"string"}},"IncludeOTC":{"description":"Include OTC securities in the response. Default is false (don't include OTC securities).\n","in":"query","name":"include_otc","schema":{"type":"boolean"}},"IndicesAggregateTimeFrom":{"description":"The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","example":"2025-11-03","in":"path","name":"from","required":true,"schema":{"type":"string"}},"IndicesAggregateTimeTo":{"description":"The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","example":"2025-11-28","in":"path","name":"to","required":true,"schema":{"type":"string"}},"IndicesTickerPathParam":{"description":"The ticker symbol of Index.","example":"I:NDX","in":"path","name":"indicesTicker","required":true,"schema":{"type":"string"}},"LimitMax10000":{"description":"Limit the size of the response, max 10000.","example":100,"in":"query","name":"limit","schema":{"type":"integer"}},"LimitMax50000":{"description":"Limit the size of the response, max 50000 and default 5000.","example":10,"in":"query","name":"limit","schema":{"type":"integer"}},"LimitNoMax":{"description":"Limit the number of results.\n","example":5,"in":"query","name":"limit","schema":{"type":"integer"}},"OptionsTickerPathParam":{"description":"The ticker symbol of the options contract.","example":"O:SPY251219C00650000","in":"path","name":"optionsTicker","required":true,"schema":{"type":"string"}},"ReverseOrder":{"description":"Reverse the order of the results.\n","example":true,"in":"query","name":"reverse","schema":{"type":"boolean"}},"SnapshotDirection":{"description":"The direction of the snapshot results to return.\n","example":"gainers","in":"path","name":"direction","required":true,"schema":{"enum":["gainers","losers"],"type":"string"}},"StocksTickerPathParam":{"description":"Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.","example":"AAPL","in":"path","name":"stocksTicker","required":true,"schema":{"type":"string"}},"TickersQueryParam":{"description":"A case-sensitive comma separated list of tickers to get snapshots for. For example, AAPL,TSLA,GOOG. Empty string defaults to querying all tickers.","in":"query","name":"tickers","schema":{"items":{"type":"string"},"type":"array"}}},"responses":{"Conflict":{"description":"Parameter is invalid or incorrect."},"DefaultError":{"description":"Unexpected error"},"NotFound":{"description":"The specified resource was not found"},"Unauthorized":{"description":"Unauthorized - Check our API Key and account status"}},"schemas":{"Adjusted":{"description":"Whether or not this response was adjusted for splits.","type":"boolean"},"AskExchangeId":{"description":"The ask exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"AskPrice":{"description":"The ask price.","format":"double","type":"number"},"AskSize":{"description":"The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.","type":"integer"},"BidExchangeId":{"description":"The bid exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"BidPrice":{"description":"The bid price.","format":"double","type":"number"},"BidSize":{"description":"The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price.","type":"integer"},"Close":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"CloseIndices":{"description":"The close value for the symbol in the given time period.","format":"double","type":"number"},"Company":{"properties":{"active":{"description":"Indicates if the security is actively listed.  If false, this means the company is no longer listed and cannot be traded.","type":"boolean"},"bloomberg":{"description":"The Bloomberg guid for the symbol.","type":"string"},"ceo":{"description":"The name of the company's current CEO.","type":"string"},"cik":{"description":"The official CIK guid used for SEC database/filings.","type":"string"},"country":{"description":"The country in which the company is registered.","type":"string"},"description":{"description":"A description of the company and what they do/offer.","type":"string"},"employees":{"description":"The approximate number of employees for the company.","type":"integer"},"exchange":{"description":"The symbol's primary exchange.","type":"string"},"exchangeSymbol":{"description":"The exchange code (id) of the symbol's primary exchange.","type":"string"},"figi":{"description":"The OpenFigi project guid for the symbol. (\u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://openfigi.com/\"\u003ehttps://openfigi.com/\u003c/a\u003e)","type":"string"},"hq_address":{"description":"The street address for the company's headquarters.","type":"string"},"hq_country":{"description":"The country in which the company's headquarters is located.","type":"string"},"hq_state":{"description":"The state in which the company's headquarters is located.","type":"string"},"industry":{"description":"The industry in which the company operates.","type":"string"},"lei":{"description":"The Legal Entity Identifier (LEI) guid for the symbol. (\u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Legal_Entity_Identifier\"\u003ehttps://en.wikipedia.org/wiki/Legal_Entity_Identifier\u003c/a\u003e)","type":"string"},"listdate":{"description":"The date that the symbol was listed on the exchange.","format":"date","type":"string"},"logo":{"description":"The URL of the entity's logo.","type":"string"},"marketcap":{"description":"The current market cap for the company.","type":"integer"},"name":{"description":"The name of the company/entity.","type":"string"},"phone":{"description":"The phone number for the company. This is usually a corporate contact number.","type":"string"},"sector":{"description":"The sector of the indsutry in which the symbol operates.","type":"string"},"sic":{"description":"Standard Industrial Classification (SIC) id for the symbol. (\u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Standard_Industrial_Classification\"\u003ehttps://en.wikipedia.org/wiki/Legal_Entity_Identifier\u003c/a\u003e)","type":"integer"},"similar":{"description":"A list of ticker symbols for similar companies.","items":{"description":"The exchange symbol that this item is traded under.","type":"string"},"type":"array"},"symbol":{"description":"The exchange symbol that this item is traded under.","type":"string"},"tags":{"items":{"description":"A list of words related to the company.","type":"string"},"type":"array"},"type":{"description":"The type or class of the security.  (\u003ca alt=\"Full List of Ticker Types\" href=\"https://massive.com/docs/rest/stocks/tickers/ticker-types\"\u003eFull List of Ticker Types\u003c/a\u003e)","type":"string"},"updated":{"description":"The last time this company record was updated.","format":"date","type":"string"},"url":{"description":"The URL of the company's website","type":"string"}},"type":"object"},"ConditionTypeMap":{"properties":{"condition":{"description":"Massive's mapping for condition codes.  For more information, see our \u003ca href=\"https://massive.com/glossary/trade-conditions\" alt=\"Trade Conditions Glossary\" target=\"_blank\"\u003eTrade Conditions Glossary\u003c/a\u003e.\n","type":"string"}},"type":"object"},"Conditions":{"description":"A list of condition codes.\n","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.\n","type":"integer"},"type":"array"},"Count":{"description":"The total number of results for this request.","type":"integer"},"CryptoExchange":{"items":{"properties":{"id":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"market":{"description":"Market data type this exchange contains ( crypto only currently )","type":"string"},"name":{"description":"Name of the exchange","type":"string"},"type":{"description":"Type of exchange feed","type":"string"},"url":{"description":"URL of this exchange","type":"string"}},"required":["id","type","market","name","url"],"type":"object"},"type":"array"},"CryptoGroupedResults":{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the end of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","t","T"],"type":"object"},"type":"array"}},"type":"object"},"CryptoHistoricTrades":{"properties":{"day":{"description":"The date that was evaluated from the request.","format":"date","type":"string"},"map":{"description":"A map for shortened result keys.","type":"object"},"msLatency":{"description":"The milliseconds of latency for the query results.","type":"integer"},"symbol":{"description":"The symbol pair that was evaluated from the request.","type":"string"},"ticks":{"items":{"properties":{"c":{"description":"A list of condition codes.\n","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.\n","type":"integer"},"type":"array"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size of a trade (also known as volume).\n","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"x":{"description":"The exchange that this crypto trade happened on.  \nSee \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\"\u003eExchanges\u003c/a\u003e for a mapping of exchanges to IDs.\n","type":"integer"}},"required":["p","s","x","c","t","i"],"type":"object"},"type":"array"}},"required":["day","map","msLatency","symbol","ticks"],"type":"object"},"CryptoLastTrade":{"properties":{"last":{"properties":{"conditions":{"description":"A list of condition codes.\n","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.\n","type":"integer"},"type":"array"},"exchange":{"description":"The exchange that this crypto trade happened on.  \nSee \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\"\u003eExchanges\u003c/a\u003e for a mapping of exchanges to IDs.\n","type":"integer"},"price":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"size":{"description":"The size of a trade (also known as volume).\n","format":"double","type":"number"},"timestamp":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"}},"required":["conditions","exchange","price","size","timestamp"],"type":"object"},"symbol":{"description":"The symbol pair that was evaluated from the request.","type":"string"}},"required":["symbol"],"type":"object"},"CryptoOpenClose":{"properties":{"close":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"closingTrades":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"A list of condition codes.\n","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.\n","type":"integer"},"type":"array"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size of a trade (also known as volume).\n","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"x":{"description":"The exchange that this crypto trade happened on.  \nSee \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\"\u003eExchanges\u003c/a\u003e for a mapping of exchanges to IDs.\n","type":"integer"}},"required":["p","s","x","c","t","i"],"type":"object"},"type":"array"},"day":{"description":"The date requested.","format":"date","type":"string"},"isUTC":{"description":"Whether or not the timestamps are in UTC timezone.","type":"boolean"},"open":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"openTrades":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"A list of condition codes.\n","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.\n","type":"integer"},"type":"array"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size of a trade (also known as volume).\n","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"x":{"description":"The exchange that this crypto trade happened on.  \nSee \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\"\u003eExchanges\u003c/a\u003e for a mapping of exchanges to IDs.\n","type":"integer"}},"required":["p","s","x","c","t","i"],"type":"object"},"type":"array"},"symbol":{"description":"The symbol pair that was evaluated from the request.","type":"string"}},"required":["symbol","isUTC","day","open","close","openTrades","closingTrades"],"type":"object"},"CryptoSnapshotMinute":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw","t","n"],"type":"object"},"CryptoSnapshotTicker":{"properties":{"ticker":{"description":"Contains the requested snapshot data for the specified ticker.","properties":{"day":{"description":"The most recent daily bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"lastTrade":{"description":"The most recent trade for this ticker.","properties":{"c":{"description":"The trade conditions.","items":{"type":"integer"},"type":"array"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size (volume) of the trade.","type":"number"},"t":{"description":"The millisecond accuracy timestamp. This is the timestamp of when the trade was generated at the exchange.","type":"integer"},"x":{"description":"The exchange that this crypto trade happened on.  \nSee \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\"\u003eExchanges\u003c/a\u003e for a mapping of exchanges to IDs.\n","type":"integer"}},"required":["c","i","p","s","t","x"],"type":"object"},"min":{"description":"The most recent minute bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw","t","n"],"type":"object"},"prevDay":{"description":"The previous day's bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"todaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"todaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"required":["day","lastTrade","min","prevDay","ticker","todaysChange","todaysChangePerc","updated"],"type":"object"}},"type":"object"},"CryptoSnapshotTickerFullBook":{"properties":{"data":{"properties":{"askCount":{"description":"The combined total number of asks in the book.","format":"double","type":"number"},"asks":{"items":{"properties":{"p":{"description":"The price of this book level.","format":"double","type":"number"},"x":{"description":"A map of the exchange ID to number of shares at this price level.\n\u003cbr /\u003e\n\u003cbr /\u003e\n**Example:**\n\u003cbr /\u003e\n`{\n  \"p\": 16302.94,\n  \"x\": {\n    \"1\": 0.02859424,\n    \"6\": 0.023455\n  }\n}`\n\u003cbr /\u003e\n\u003cbr /\u003e\nIn this example, exchange ID 1 has 0.02859424 shares available at $16,302.94,\nand exchange ID 6 has 0.023455 shares at the same price level.\n","type":"object"}},"required":["p","x"],"type":"object"},"type":"array"},"bidCount":{"description":"The combined total number of bids in the book.","format":"double","type":"number"},"bids":{"items":{"properties":{"p":{"description":"The price of this book level.","format":"double","type":"number"},"x":{"description":"A map of the exchange ID to number of shares at this price level.\n\u003cbr /\u003e\n\u003cbr /\u003e\n**Example:**\n\u003cbr /\u003e\n`{\n  \"p\": 16302.94,\n  \"x\": {\n    \"1\": 0.02859424,\n    \"6\": 0.023455\n  }\n}`\n\u003cbr /\u003e\n\u003cbr /\u003e\nIn this example, exchange ID 1 has 0.02859424 shares available at $16,302.94,\nand exchange ID 6 has 0.023455 shares at the same price level.\n","type":"object"}},"required":["p","x"],"type":"object"},"type":"array"},"spread":{"description":"The difference between the best bid and the best ask price across exchanges.","format":"double","type":"number"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"required":["ticker","bids","asks","bidCount","askCount","spread","updated"],"type":"object"}},"type":"object"},"CryptoSnapshotTickers":{"properties":{"tickers":{"description":"An array of snapshot data for the specified tickers.","items":{"properties":{"day":{"description":"The most recent daily bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"lastTrade":{"description":"The most recent trade for this ticker.","properties":{"c":{"description":"The trade conditions.","items":{"type":"integer"},"type":"array"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size (volume) of the trade.","type":"number"},"t":{"description":"The millisecond accuracy timestamp. This is the timestamp of when the trade was generated at the exchange.","type":"integer"},"x":{"description":"The exchange that this crypto trade happened on.  \nSee \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\"\u003eExchanges\u003c/a\u003e for a mapping of exchanges to IDs.\n","type":"integer"}},"required":["c","i","p","s","t","x"],"type":"object"},"min":{"description":"The most recent minute bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw","t","n"],"type":"object"},"prevDay":{"description":"The previous day's bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"todaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"todaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"required":["day","lastTrade","min","prevDay","ticker","todaysChange","todaysChangePerc","updated"],"type":"object"},"type":"array"}},"type":"object"},"CryptoTick":{"properties":{"c":{"description":"A list of condition codes.\n","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.\n","type":"integer"},"type":"array"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size of a trade (also known as volume).\n","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"x":{"description":"The exchange that this crypto trade happened on.  \nSee \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\"\u003eExchanges\u003c/a\u003e for a mapping of exchanges to IDs.\n","type":"integer"}},"required":["p","s","x","c","t","i"],"type":"object"},"CryptoTradeExchange":{"description":"The exchange that this crypto trade happened on.  \nSee \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\"\u003eExchanges\u003c/a\u003e for a mapping of exchanges to IDs.\n","type":"integer"},"Date":{"oneOf":[{"format":"date-time","type":"string"},{"format":"date","type":"string"}]},"Exchange":{"items":{"properties":{"code":{"description":"A unique identifier for the exchange internal to Massive.  This is not an industry code or ISO standard.","type":"string"},"id":{"description":"The ID of the exchange.","type":"number"},"market":{"description":"The market data type that this exchange contains.","type":"string"},"mic":{"description":"The Market Identification Code or MIC as defined in ISO 10383 (\u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Market_Identifier_Code\"\u003ehttps://en.wikipedia.org/wiki/Market_Identifier_Code\u003c/a\u003e).","type":"string"},"name":{"description":"The name of the exchange.","type":"string"},"tape":{"description":"The tape id of the exchange.","type":"string"},"type":{"description":"The type of exchange.\n- TRF = Trade Reporting Facility\n- exchange = Reporting exchange on the tape\n","type":"string"}},"type":"object"},"type":"array"},"ExchangeId":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"Financial":{"properties":{"cashChange":{"example":7202000000,"type":"integer"},"cashFlow":{"example":28293000000,"type":"integer"},"costOfRevenue":{"example":54381000000,"type":"integer"},"currentAssets":{"example":143810000000,"type":"integer"},"currentCash":{"example":27491000000,"type":"integer"},"currentDebt":{"example":18478000000,"type":"integer"},"grossProfit":{"example":33912000000,"type":"integer"},"netIncome":{"example":20065000000,"type":"integer"},"operatingExpense":{"example":7638000000,"type":"integer"},"operatingGainsLosses":{"type":"number"},"operatingIncome":{"example":26274000000,"type":"integer"},"operatingRevenue":{"example":88293000000,"type":"integer"},"reportDate":{"description":"Report Date","example":"2017-12-31T00:00:00.000Z","format":"date-time","type":"string"},"reportDateStr":{"description":"Report date as non date format","example":"2017-12-31","type":"string"},"researchAndDevelopment":{"example":3407000000,"type":"integer"},"shareholderEquity":{"example":140199000000,"type":"integer"},"symbol":{"description":"Stock Symbol","example":"AAPL","type":"string"},"totalAssets":{"example":406794000000,"type":"integer"},"totalCash":{"example":77153000000,"type":"integer"},"totalDebt":{"example":122400000000,"type":"integer"},"totalLiabilities":{"example":266595000000,"type":"integer"},"totalRevenue":{"example":88293000000,"type":"integer"}},"required":["symbol","reportDate","reportDateStr"],"type":"object"},"Financials":{"description":"Financials","properties":{"EBITDAMargin":{"format":"double","type":"number"},"accumulatedOtherComprehensiveIncome":{"type":"integer"},"accumulatedRetainedEarningsDeficit":{"type":"integer"},"assetTurnover":{"type":"integer"},"assets":{"type":"integer"},"assetsAverage":{"type":"integer"},"assetsCurrent":{"type":"integer"},"assetsNonCurrent":{"type":"integer"},"averageEquity":{"type":"integer"},"bookValuePerShare":{"format":"double","type":"number"},"calendarDate":{"example":"2019-03-31","format":"date-time","type":"string"},"capitalExpenditure":{"type":"integer"},"cashAndEquivalents":{"type":"integer"},"cashAndEquivalentsUSD":{"type":"integer"},"consolidatedIncome":{"type":"integer"},"costOfRevenue":{"type":"integer"},"currentLiabilities":{"type":"integer"},"currentRatio":{"format":"double","type":"number"},"debt":{"type":"integer"},"debtCurrent":{"type":"integer"},"debtNonCurrent":{"type":"integer"},"debtToEquityRatio":{"format":"double","type":"number"},"debtUSD":{"type":"integer"},"deferredRevenue":{"type":"integer"},"deposits":{"type":"integer"},"depreciationAmortizationAndAccretion":{"type":"integer"},"dividendYield":{"type":"integer"},"dividendsPerBasicCommonShare":{"type":"integer"},"earningBeforeInterestTaxes":{"type":"integer"},"earningBeforeInterestTaxesUSD":{"type":"integer"},"earningsBeforeInterestTaxesDepreciationAmortization":{"type":"integer"},"earningsBeforeInterestTaxesDepreciationAmortizationUSD":{"type":"integer"},"earningsBeforeTax":{"type":"integer"},"earningsPerBasicShare":{"format":"double","type":"number"},"earningsPerBasicShareUSD":{"format":"double","type":"number"},"earningsPerDilutedShare":{"format":"double","type":"number"},"effectOfExchangeRateChangesOnCash":{"type":"integer"},"enterpriseValue":{"type":"integer"},"enterpriseValueOverEBIT":{"type":"integer"},"enterpriseValueOverEBITDA":{"format":"double","type":"number"},"foreignCurrencyUSDExchangeRate":{"type":"integer"},"freeCashFlow":{"type":"integer"},"freeCashFlowPerShare":{"format":"double","type":"number"},"goodwillAndIntangibleAssets":{"type":"integer"},"grossMargin":{"format":"double","type":"number"},"grossProfit":{"type":"integer"},"incomeTaxExpense":{"type":"integer"},"interestExpense":{"type":"integer"},"inventory":{"type":"integer"},"investedCapital":{"type":"integer"},"investedCapitalAverage":{"type":"integer"},"investments":{"type":"integer"},"investmentsCurrent":{"type":"integer"},"investmentsNonCurrent":{"type":"integer"},"issuanceDebtSecurities":{"type":"integer"},"issuanceEquityShares":{"type":"integer"},"liabilitiesNonCurrent":{"type":"integer"},"marketCapitalization":{"type":"integer"},"netCashFlow":{"type":"integer"},"netCashFlowBusinessAcquisitionsDisposals":{"type":"integer"},"netCashFlowFromFinancing":{"type":"integer"},"netCashFlowFromInvesting":{"type":"integer"},"netCashFlowFromOperations":{"type":"integer"},"netCashFlowInvestmentAcquisitionsDisposals":{"type":"integer"},"netIncome":{"type":"integer"},"netIncomeCommonStock":{"type":"integer"},"netIncomeCommonStockUSD":{"type":"integer"},"netIncomeToNonControllingInterests":{"type":"integer"},"netLossIncomeFromDiscontinuedOperations":{"type":"integer"},"operatingExpenses":{"type":"integer"},"operatingIncome":{"type":"integer"},"paymentDividendsOtherCashDistributions":{"type":"integer"},"payoutRatio":{"type":"integer"},"period":{"description":"Reporting period.","enum":["Q","T","QA","TA","Y","YA"],"example":"Q","type":"string"},"preferredDividendsIncomeStatementImpact":{"type":"integer"},"priceEarnings":{"format":"double","type":"number"},"priceSales":{"format":"double","type":"number"},"priceToBookValue":{"format":"double","type":"number"},"priceToEarningsRatio":{"format":"double","type":"number"},"priceToSalesRatio":{"format":"double","type":"number"},"profitMargin":{"format":"double","type":"number"},"propertyPlantEquipmentNet":{"type":"integer"},"reportPeriod":{"example":"2019-03-31","format":"date-time","type":"string"},"researchAndDevelopmentExpense":{"type":"integer"},"returnOnAverageAssets":{"type":"integer"},"returnOnAverageEquity":{"type":"integer"},"returnOnInvestedCapital":{"type":"integer"},"returnOnSales":{"format":"double","type":"number"},"revenues":{"type":"integer"},"revenuesUSD":{"type":"integer"},"salesPerShare":{"format":"double","type":"number"},"sellingGeneralAndAdministrativeExpense":{"type":"integer"},"shareBasedCompensation":{"type":"integer"},"shareFactor":{"type":"integer"},"sharePriceAdjustedClose":{"format":"double","type":"number"},"shareholdersEquity":{"type":"integer"},"shareholdersEquityUSD":{"type":"integer"},"shares":{"type":"integer"},"tangibleAssetValue":{"type":"integer"},"tangibleAssetsBookValuePerShare":{"format":"double","type":"number"},"taxAssets":{"type":"integer"},"taxLiabilities":{"type":"integer"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"totalLiabilities":{"type":"integer"},"tradeAndNonTradePayables":{"type":"integer"},"tradeAndNonTradeReceivables":{"type":"integer"},"updated":{"example":"1999-03-28","format":"date-time","type":"string"},"weightedAverageShares":{"type":"integer"},"weightedAverageSharesDiluted":{"type":"integer"},"workingCapital":{"type":"integer"}},"required":["ticker","exDate","paymentDate","ratio","tofactor","forfactor"],"type":"object"},"Fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"ForexConversion":{"properties":{"converted":{"description":"The result of the conversion.","format":"double","type":"number"},"from":{"description":"The \"from\" currency symbol.","type":"string"},"initialAmount":{"description":"The amount to convert.","format":"double","type":"number"},"last":{"properties":{"ask":{"description":"The ask price.","format":"double","type":"number"},"bid":{"description":"The bid price.","format":"double","type":"number"},"exchange":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/forex/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"timestamp":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"}},"required":["ask","bid","exchange","timestamp"],"type":"object"},"to":{"description":"The \"to\" currency symbol.","type":"string"}},"required":["from","to","initialAmount","converted"],"type":"object"},"ForexExchangeId":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/forex/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"ForexGroupedResults":{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the end of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","t","T"],"type":"object"},"type":"array"}},"type":"object"},"ForexHistoricTrades":{"properties":{"day":{"description":"The date that was evaluated from the request.","format":"date","type":"string"},"map":{"description":"A map for shortened result keys.","type":"object"},"msLatency":{"description":"The milliseconds of latency for the query results.","type":"integer"},"pair":{"description":"The currency pair that was evaluated from the request.","type":"string"},"ticks":{"items":{"properties":{"a":{"description":"The ask price.","format":"double","type":"number"},"b":{"description":"The bid price.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"x":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/forex/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"}},"required":["a","b","x","t"],"type":"object"},"type":"array"}},"required":["day","map","msLatency","pair","ticks"],"type":"object"},"ForexPairLastQuote":{"properties":{"last":{"properties":{"ask":{"description":"The ask price.","format":"double","type":"number"},"bid":{"description":"The bid price.","format":"double","type":"number"},"exchange":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/forex/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"timestamp":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"}},"required":["ask","bid","exchange","timestamp"],"type":"object"},"symbol":{"description":"The symbol pair that was evaluated from the request.","type":"string"}},"required":["symbol"],"type":"object"},"ForexPreviousClose":{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["T","v","o","c","h","l","t"],"type":"object"},"type":"array"}},"type":"object"},"ForexSnapshotLastQuote":{"properties":{"a":{"description":"The ask price.","format":"double","type":"number"},"b":{"description":"The bid price.","format":"double","type":"number"},"t":{"description":"The millisecond accuracy timestamp of the quote.","type":"integer"},"x":{"description":"The exchange ID on which this quote happened.","type":"integer"}},"required":["a","b","t","x"],"type":"object"},"ForexSnapshotPrevDay":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ForexSnapshotTicker":{"properties":{"ticker":{"description":"Contains the requested snapshot data for the specified ticker.","properties":{"day":{"description":"The most recent daily bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"}},"required":["o","h","l","c","v"],"type":"object"},"fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"lastQuote":{"description":"The most recent quote for this ticker.","properties":{"a":{"description":"The ask price.","format":"double","type":"number"},"b":{"description":"The bid price.","format":"double","type":"number"},"t":{"description":"The millisecond accuracy timestamp of the quote.","type":"integer"},"x":{"description":"The exchange ID on which this quote happened.","type":"integer"}},"required":["a","b","t","x"],"type":"object"},"min":{"description":"The most recent minute bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"}},"type":"object"},"prevDay":{"description":"The previous day's bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"todaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"todaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"required":["day","lastQuote","min","prevDay","ticker","todaysChange","todaysChangePerc","updated"],"type":"object"}},"type":"object"},"ForexSnapshotTickers":{"properties":{"tickers":{"description":"An array of snapshot data for the specified tickers.","items":{"properties":{"day":{"description":"The most recent daily bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"}},"required":["o","h","l","c","v"],"type":"object"},"fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"lastQuote":{"description":"The most recent quote for this ticker.","properties":{"a":{"description":"The ask price.","format":"double","type":"number"},"b":{"description":"The bid price.","format":"double","type":"number"},"t":{"description":"The millisecond accuracy timestamp of the quote.","type":"integer"},"x":{"description":"The exchange ID on which this quote happened.","type":"integer"}},"required":["a","b","t","x"],"type":"object"},"min":{"description":"The most recent minute bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"}},"type":"object"},"prevDay":{"description":"The previous day's bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"todaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"todaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"required":["day","lastQuote","min","prevDay","ticker","todaysChange","todaysChangePerc","updated"],"type":"object"},"type":"array"}},"type":"object"},"ForexTickerResults":{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","t"],"type":"object"},"type":"array"}},"type":"object"},"High":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"HighIndices":{"description":"The highest value for the symbol in the given time period.","format":"double","type":"number"},"IndexAggsBase":{"properties":{"queryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"resultsCount":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","queryCount","resultsCount","request_id"],"type":"object"},"Indicators":{"description":"The indicators. For more information, see our glossary of [Conditions and\nIndicators](https://massive.com/glossary/conditions-indicators).\n","items":{"description":"The indicator code.\n","type":"integer"},"type":"array"},"IndicesGroupedResults":{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"The close value for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest value for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest value for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open value for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"}},"required":["o","h","l","c","t"],"type":"object"},"type":"array"}},"type":"object"},"IndicesOpenClose":{"properties":{"afterHours":{"description":"The close value of the ticker symbol in after hours trading.","format":"double","type":"number"},"close":{"description":"The close value for the symbol in the given time period.","format":"double","type":"number"},"from":{"description":"The requested date.","format":"date","type":"string"},"high":{"description":"The highest value for the symbol in the given time period.","format":"double","type":"number"},"low":{"description":"The lowest value for the symbol in the given time period.","format":"double","type":"number"},"open":{"description":"The open value for the symbol in the given time period.","format":"double","type":"number"},"preMarket":{"description":"The open value of the ticker symbol in pre-market trading.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"},"symbol":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"required":["status","from","symbol","open","high","low","close"],"type":"object"},"IndicesTickerResults":{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"The close value for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest value for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest value for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open value for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"}},"required":["o","h","l","c","t"],"type":"object"},"type":"array"}},"type":"object"},"Locales":{"properties":{"results":{"items":{"properties":{"locale":{"description":"An abbreviated country name.","type":"string"},"name":{"description":"The name of the country.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"Low":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"LowIndices":{"description":"The lowest value for the symbol in the given time period.","format":"double","type":"number"},"Map":{"description":"A mapping of the keys returned in the results to their descriptive name and data types.","properties":{"key":{"description":"A dynamic key from the results set","properties":{"name":{"description":"The descriptive name of this results key","type":"string"},"type":{"description":"The data type of this results key","enum":["string","int","int64","float64"],"type":"string"}},"type":"object"}},"type":"object"},"MarketHoliday":{"description":"An array of upcoming market holidays and their corresponding dates.","items":{"properties":{"close":{"description":"The market close time on the holiday (if it's not closed).","format":"date-time","type":"string"},"date":{"description":"The date of the holiday.","format":"date","type":"string"},"exchange":{"description":"Which market the record is for.","type":"string"},"name":{"description":"The name of the holiday.","type":"string"},"open":{"description":"The market open time on the holiday (if it's not closed).","format":"date-time","type":"string"},"status":{"description":"The status of the market on the holiday.","type":"string"}},"required":["exchange","date","name","status"],"type":"object"},"type":"array"},"MarketStatus":{"properties":{"afterHours":{"description":"Whether or not the market is in post-market hours.","type":"boolean"},"currencies":{"properties":{"crypto":{"description":"The status of the crypto market.","type":"string"},"fx":{"description":"The status of the forex market.","type":"string"}},"type":"object"},"earlyHours":{"description":"Whether or not the market is in pre-market hours.","type":"boolean"},"exchanges":{"properties":{"nasdaq":{"description":"The status of the Nasdaq market.","type":"string"},"nyse":{"description":"The status of the NYSE market.","type":"string"},"otc":{"description":"The status of the OTC market.","type":"string"}},"type":"object"},"market":{"description":"The status of the market as a whole.","type":"string"},"serverTime":{"description":"The current time of the server.","format":"date-time","type":"string"}},"type":"object"},"Markets":{"properties":{"results":{"description":"A list of supported markets.","items":{"properties":{"desc":{"description":"A description of the market.","type":"string"},"market":{"description":"The name of the market.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"MsLatency":{"description":"The milliseconds of latency for the query results.","type":"integer"},"News":{"items":{"properties":{"image":{"description":"A URL of the image for the news article, if found.","type":"string"},"keywords":{"description":"A list of common keywords related to the news article.","items":{"description":"Common keywords of the news article.","type":"string"},"type":"array"},"source":{"description":"The publication source of the article.","type":"string"},"summary":{"description":"A summary of the news article.","type":"string"},"symbols":{"description":"A list of ticker symbols relating to the article.","items":{"description":"The exchange symbol that this item is traded under.","type":"string"},"type":"array"},"timestamp":{"description":"The timestamp of the news article.","format":"date-time","type":"string"},"title":{"description":"The title of the news article.","type":"string"},"url":{"description":"A direct link to the news article from its source publication.","type":"string"}},"type":"object"},"type":"array"},"NumberOfItems":{"description":"The number of transactions in the aggregate window.","type":"integer"},"OTC":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"Open":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"OpenIndices":{"description":"The open value for the symbol in the given time period.","format":"double","type":"number"},"PaginationHooksBase":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"}},"type":"object"},"Price":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"QueryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"RatingSection":{"properties":{"current":{"description":"Analyst Rating at current month","example":0,"type":"number"},"month1":{"description":"Analyst Ratings at 1 month in the future","example":1,"type":"number"},"month2":{"description":"Analyst Ratings at 2 month in the future","example":3,"type":"number"},"month3":{"description":"Analyst Ratings at 3 month in the future","example":4,"type":"number"},"month4":{"description":"Analyst Ratings at 4 month in the future","example":3,"type":"number"},"month5":{"description":"Analyst Ratings at 5 month in the future","example":2,"type":"number"}},"required":["month1","month2","month3","current"],"type":"object"},"RequestID":{"description":"A request id assigned by the server.","type":"string"},"RequestIdBase":{"properties":{"request_id":{"description":"A request id assigned by the server.","type":"string"}},"required":["request_id"],"type":"object"},"SequenceNumber":{"description":"The sequence number represents the sequence in which message events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).\n","format":"int64","type":"integer"},"Size":{"description":"The size of a trade (also known as volume).\n","format":"double","type":"number"},"SnapshotMinOHLCV":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"}},"type":"object"},"SnapshotOHLCV":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"}},"required":["o","h","l","c","v"],"type":"object"},"SnapshotOHLCVVW":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"SnapshotOHLCVVWOtc":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"dv":{"description":"The volume including fractional shares, respresented as a string.","type":"string"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"StandardBase":{"allOf":[{"properties":{"request_id":{"description":"A request id assigned by the server.","type":"string"}},"required":["request_id"],"type":"object"},{"properties":{"count":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"}]},"Status":{"description":"The status of this request's response.","type":"string"},"StatusBase":{"properties":{"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"},"StatusCountBase":{"properties":{"count":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"},"StockSymbol":{"description":"The exchange symbol that this item is traded under.","type":"string"},"StocksGroupedResults":{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix millisecond timestamp for the end of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","t","v","T"],"type":"object"},"type":"array"}},"type":"object"},"StocksOpenClose":{"properties":{"afterHours":{"description":"The close price of the ticker symbol in after hours trading.","format":"double","type":"number"},"close":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"from":{"description":"The requested date.","format":"date","type":"string"},"high":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"low":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"open":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"preMarket":{"description":"The open price of the ticker symbol in pre-market trading.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"},"symbol":{"description":"The exchange symbol that this item is traded under.","type":"string"},"volume":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"}},"required":["status","from","symbol","open","high","low","close","volume"],"type":"object"},"StocksSnapshotLastQuote":{"properties":{"P":{"description":"The ask price.","format":"double","type":"number"},"S":{"description":"The ask size in lots.","type":"integer"},"p":{"description":"The bid price.","format":"double","type":"number"},"s":{"description":"The bid size in lots.","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"}},"required":["p","s","P","S","t"],"type":"object"},"StocksSnapshotMinute":{"properties":{"av":{"description":"The accumulated volume.","type":"integer"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"dav":{"description":"The accumulated volume including fractional shares, respresented as a string.","type":"string"},"dv":{"description":"The volume including fractional shares, respresented as a string.","type":"string"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["av","dav","o","h","l","c","v","vw","t","n"],"type":"object"},"StocksSnapshotMinuteOTC":{"properties":{"av":{"description":"The accumulated volume.","type":"integer"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"dav":{"description":"The accumulated volume including fractional shares, respresented as a string.","type":"string"},"dv":{"description":"The volume including fractional shares, respresented as a string.","type":"string"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["av","dav","o","h","l","c","v","vw","t","n"],"type":"object"},"StocksSnapshotPrevDay":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"StocksSnapshotTicker":{"properties":{"ticker":{"description":"Contains the requested snapshot data for the specified ticker.","properties":{"day":{"description":"The most recent daily bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"dv":{"description":"The volume including fractional shares, respresented as a string.","type":"string"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"lastQuote":{"description":"The most recent quote for this ticker.  This is only returned if your current plan includes quotes.","properties":{"P":{"description":"The ask price.","format":"double","type":"number"},"S":{"description":"The ask size in lots.","type":"integer"},"p":{"description":"The bid price.","format":"double","type":"number"},"s":{"description":"The bid size in lots.","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"}},"required":["p","s","P","S","t"],"type":"object"},"lastTrade":{"description":"The most recent trade for this ticker.  This is only returned if your current plan includes trades.","properties":{"c":{"description":"The trade conditions.","items":{"type":"integer"},"type":"array"},"ds":{"description":"The size of the trade including fractional shares, respresented as a string.","type":"string"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size (volume) of the trade.","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"x":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"}},"required":["c","i","p","s","t","x","ds"],"type":"object"},"min":{"description":"The most recent minute bar for this ticker.","properties":{"av":{"description":"The accumulated volume.","type":"integer"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"dav":{"description":"The accumulated volume including fractional shares, respresented as a string.","type":"string"},"dv":{"description":"The volume including fractional shares, respresented as a string.","type":"string"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["av","dav","o","h","l","c","v","vw","t","n"],"type":"object"},"prevDay":{"description":"The previous day's bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"todaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"todaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"type":"object"}},"type":"object"},"StocksSnapshotTickers":{"properties":{"tickers":{"description":"An array of snapshot data for the specified tickers.","items":{"properties":{"day":{"description":"The most recent daily bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"dv":{"description":"The volume including fractional shares, respresented as a string.","type":"string"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"lastQuote":{"description":"The most recent quote for this ticker.  This is only returned if your current plan includes quotes.","properties":{"P":{"description":"The ask price.","format":"double","type":"number"},"S":{"description":"The ask size in lots.","type":"integer"},"p":{"description":"The bid price.","format":"double","type":"number"},"s":{"description":"The bid size in lots.","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"}},"required":["p","s","P","S","t"],"type":"object"},"lastTrade":{"description":"The most recent trade for this ticker.  This is only returned if your current plan includes trades.","properties":{"c":{"description":"The trade conditions.","items":{"type":"integer"},"type":"array"},"ds":{"description":"The size of the trade including fractional shares, respresented as a string.","type":"string"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size (volume) of the trade.","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"x":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"}},"required":["c","i","p","s","t","x","ds"],"type":"object"},"min":{"description":"The most recent minute bar for this ticker.","properties":{"av":{"description":"The accumulated volume.","type":"integer"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"dav":{"description":"The accumulated volume including fractional shares, respresented as a string.","type":"string"},"dv":{"description":"The volume including fractional shares, respresented as a string.","type":"string"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["av","dav","o","h","l","c","v","vw","t","n"],"type":"object"},"prevDay":{"description":"The previous day's bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"todaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"todaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"StocksTickerResultsOTC":{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","t"],"type":"object"},"type":"array"}},"type":"object"},"StocksV2Base":{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"f":{"description":"The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.","type":"integer"},"q":{"description":"The sequence number represents the sequence in which message events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).\n","format":"int64","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"y":{"description":"The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.","type":"integer"}},"required":["T","t","y","f","q"],"type":"object"},"StocksV2NBBO":{"allOf":[{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"f":{"description":"The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.","type":"integer"},"q":{"description":"The sequence number represents the sequence in which message events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).\n","format":"int64","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"y":{"description":"The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.","type":"integer"}},"required":["T","t","y","f","q"],"type":"object"},{"properties":{"P":{"description":"The ask price.","format":"double","type":"number"},"S":{"description":"The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.","type":"integer"},"X":{"description":"The ask exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"c":{"description":"A list of condition codes.\n","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.\n","type":"integer"},"type":"array"},"i":{"description":"The indicators. For more information, see our glossary of [Conditions and\nIndicators](https://massive.com/glossary/conditions-indicators).\n","items":{"description":"The indicator code.\n","type":"integer"},"type":"array"},"p":{"description":"The bid price.","format":"double","type":"number"},"s":{"description":"The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price.","type":"integer"},"x":{"description":"The bid exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"z":{"description":"There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C.\n* Tape A is NYSE listed securities\n* Tape B is NYSE ARCA / NYSE American\n* Tape C is NASDAQ\n","type":"integer"}},"required":["c","i","p","s","x","P","S","X","z"],"type":"object"}]},"StocksV2NBBOs":{"properties":{"results":{"items":{"allOf":[{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"f":{"description":"The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.","type":"integer"},"q":{"description":"The sequence number represents the sequence in which message events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).\n","format":"int64","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"y":{"description":"The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.","type":"integer"}},"required":["T","t","y","f","q"],"type":"object"},{"properties":{"P":{"description":"The ask price.","format":"double","type":"number"},"S":{"description":"The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.","type":"integer"},"X":{"description":"The ask exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"c":{"description":"A list of condition codes.\n","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.\n","type":"integer"},"type":"array"},"i":{"description":"The indicators. For more information, see our glossary of [Conditions and\nIndicators](https://massive.com/glossary/conditions-indicators).\n","items":{"description":"The indicator code.\n","type":"integer"},"type":"array"},"p":{"description":"The bid price.","format":"double","type":"number"},"s":{"description":"The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price.","type":"integer"},"x":{"description":"The bid exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"z":{"description":"There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C.\n* Tape A is NYSE listed securities\n* Tape B is NYSE ARCA / NYSE American\n* Tape C is NASDAQ\n","type":"integer"}},"required":["c","i","p","s","x","P","S","X","z"],"type":"object"}]},"type":"array"}},"type":"object"},"StocksV2Trade":{"allOf":[{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"f":{"description":"The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.","type":"integer"},"q":{"description":"The sequence number represents the sequence in which message events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).\n","format":"int64","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"y":{"description":"The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.","type":"integer"}},"required":["T","t","y","f","q"],"type":"object"},{"properties":{"c":{"description":"A list of condition codes.\n","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.\n","type":"integer"},"type":"array"},"e":{"description":"The trade correction indicator.\n","type":"integer"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"r":{"description":"The ID for the Trade Reporting Facility where the trade took place.\n","type":"integer"},"s":{"description":"The size of a trade (also known as volume).\n","format":"double","type":"number"},"x":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"z":{"description":"There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C.\n* Tape A is NYSE listed securities\n* Tape B is NYSE ARCA / NYSE American\n* Tape C is NASDAQ\n","type":"integer"}},"required":["c","i","p","s","e","x","r","z"],"type":"object"}]},"StocksV2Trades":{"properties":{"results":{"items":{"allOf":[{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"f":{"description":"The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.","type":"integer"},"q":{"description":"The sequence number represents the sequence in which message events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).\n","format":"int64","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"y":{"description":"The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.","type":"integer"}},"required":["T","t","y","f","q"],"type":"object"},{"properties":{"c":{"description":"A list of condition codes.\n","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.\n","type":"integer"},"type":"array"},"e":{"description":"The trade correction indicator.\n","type":"integer"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"r":{"description":"The ID for the Trade Reporting Facility where the trade took place.\n","type":"integer"},"s":{"description":"The size of a trade (also known as volume).\n","format":"double","type":"number"},"x":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"z":{"description":"There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C.\n* Tape A is NYSE listed securities\n* Tape B is NYSE ARCA / NYSE American\n* Tape C is NASDAQ\n","type":"integer"}},"required":["c","i","p","s","e","x","r","z"],"type":"object"}]},"type":"array"}},"type":"object"},"SymbolPair":{"description":"The symbol pair that was evaluated from the request.","type":"string"},"Tape":{"description":"There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C.\n* Tape A is NYSE listed securities\n* Tape B is NYSE ARCA / NYSE American\n* Tape C is NASDAQ\n","type":"integer"},"TickerBase":{"properties":{"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"required":["ticker"],"type":"object"},"TickerResults":{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","t"],"type":"object"},"type":"array"}},"type":"object"},"TickerSymbol":{"description":"The exchange symbol that this item is traded under.","type":"string"},"Timestamp":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"TimestampExchange":{"description":"The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.","type":"integer"},"TimestampSIP":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"TimestampTRF":{"description":"The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.","type":"integer"},"TodaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"TodaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"TradeDetailsMapItem":{"properties":{"name":{"description":"Name of the trade detail item","type":"string"},"type":{"description":"Actual type of the trade detail item","type":"string"}},"type":"object"},"TradeExchange":{"description":"The exchange that this trade happened on.","type":"integer"},"TradeId":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"Updated":{"description":"The last updated timestamp.","type":"integer"},"V1LastBase":{"properties":{"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","type":"string"},"symbol":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"required":["symbol","status","request_id"],"type":"object"},"V2AggsBase":{"properties":{"adjusted":{"description":"Whether or not this response was adjusted for splits.","type":"boolean"},"queryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"resultsCount":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","adjusted","queryCount","resultsCount","request_id"],"type":"object"},"V2LastBase":{"properties":{"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","request_id"],"type":"object"},"V2TicksBase":{"properties":{"db_latency":{"description":"Latency in milliseconds for the query results from the database.","type":"integer"},"results_count":{"description":"The total number of results for this request.","type":"integer"},"success":{"description":"Whether or not this query was executed successfully.","type":"boolean"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"type":"object"},"Volume":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"VolumeWeight":{"description":"The volume weighted average price.","format":"double","type":"number"}},"securitySchemes":{"apiKey":{"in":"query","name":"apiKey","type":"apiKey"}}},"info":{"description":"The future of fintech.","title":"Polygon API","version":"1.0.0"},"openapi":"3.0.3","paths":{"/benzinga/v1/analyst-insights":{"get":{"description":"A comprehensive database of financial analyst insights and ratings for various publicly traded companies, capturing detailed information about analyst recommendations and price targets.","operationId":"get_benzinga_v1_analyst-insights","parameters":[{"description":"The calendar date (formatted as YYYY-MM-DD) when the rating was issued.","in":"query","name":"date","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"date.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"date.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"date.lte","schema":{"type":"string"}},{"description":"The stock symbol of the company being rated.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.lte","schema":{"type":"string"}},{"description":"The name of the research firm or investment bank issuing the rating.","in":"query","name":"firm","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"firm.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"firm.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"firm.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"firm.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"firm.lte","schema":{"type":"string"}},{"description":"The description of the change in rating from the firm's last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved.","in":"query","name":"rating_action","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"rating_action.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"rating_action.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"rating_action.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"rating_action.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"rating_action.lte","schema":{"type":"string"}},{"description":"The identifer used by Benzinga for the firm record.","in":"query","name":"benzinga_firm_id","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"benzinga_firm_id.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"benzinga_firm_id.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"benzinga_firm_id.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"benzinga_firm_id.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"benzinga_firm_id.lte","schema":{"type":"string"}},{"description":"The identifier used by Benzinga for the rating record.","in":"query","name":"benzinga_rating_id","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"benzinga_rating_id.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"benzinga_rating_id.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"benzinga_rating_id.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"benzinga_rating_id.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"benzinga_rating_id.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'last_updated' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"last_updated.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"benzinga_firm_id":"606af0aa6538960001bced21","benzinga_id":"681363c1fd0258abcbedc074","benzinga_rating_id":"6813624c09c1f6000103ac25","date":"2025-05-01","firm":"Needham","insight":"Needham maintained their Buy rating on Etsy's stock with a price target of $55.00.  \n\n **Growth Initiatives and Market Penetration**: Etsy's focus on growth initiatives, including leveraging its app for a more personalized shopping experience and marketing, has been a key factor in maintaining its Buy rating. The company's ability to drive greater consideration and purchase frequency through technology and product initiatives, alongside its significant app penetration of gross merchandise sales (GMS), showcases its strong position to capture more of the consumer wallet.\n\n**Resilience Amid Economic Uncertainty**: Despite the economic uncertainty, including potential impacts from tariffs, Etsy's asset-light model and strategic focus on product enhancements position it to navigate macro headwinds effectively. The company's efforts to lean into paid social channels for marketing and its ability to adapt to changes in consumer behavior underline its resilience and potential for sustained growth, supporting the Buy rating.","last_updated":"2025-05-01T12:06:36Z","price_target":55,"rating":"buy","rating_action":"maintains"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"benzinga_firm_id":{"description":"The identifer used by Benzinga for the firm record.","type":"string"},"benzinga_id":{"description":"The identifer used by Benzinga for this record.","type":"string"},"benzinga_rating_id":{"description":"The identifier used by Benzinga for the rating record.","type":"string"},"company_name":{"description":"The name of the company being rated.","type":"string"},"date":{"description":"The calendar date (formatted as YYYY-MM-DD) when the rating was issued.","type":"string"},"firm":{"description":"The name of the research firm or investment bank issuing the rating.","type":"string"},"insight":{"description":"Narrative commentary or reasoning provided by the analyst or firm to explain the rating or price target.","type":"string"},"last_updated":{"description":"The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system.","format":"date-time","type":"string"},"price_target":{"description":"The current price target set by the analyst.","format":"double","type":"number"},"rating":{"description":"The current rating set by the analyst.","type":"string"},"rating_action":{"description":"The description of the change in rating from the firm's last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved.","type":"string"},"ticker":{"description":"The stock symbol of the company being rated.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["benzinga"]}},"/benzinga/v1/analysts":{"get":{"description":"A comprehensive database of financial analysts, containing detailed performance metrics and identification information for individual analysts across various financial firms.","operationId":"get_benzinga_v1_analysts","parameters":[{"description":"The identifier used by Benzinga for this record.","in":"query","name":"benzinga_id","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"benzinga_id.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"benzinga_id.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"benzinga_id.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"benzinga_id.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"benzinga_id.lte","schema":{"type":"string"}},{"description":"The unique identifier assigned by Benzinga to the research firm or investment bank.","in":"query","name":"benzinga_firm_id","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"benzinga_firm_id.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"benzinga_firm_id.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"benzinga_firm_id.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"benzinga_firm_id.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"benzinga_firm_id.lte","schema":{"type":"string"}},{"description":"The name of the research firm or investment bank issuing the ratings.","in":"query","name":"firm_name","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"firm_name.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"firm_name.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"firm_name.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"firm_name.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"firm_name.lte","schema":{"type":"string"}},{"description":"The full name of the analyst associated with the ratings.","in":"query","name":"full_name","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"full_name.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"full_name.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"full_name.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"full_name.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"full_name.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'full_name' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"full_name.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"benzinga_firm_id":"5e17143f7da4190001b2eaa6","benzinga_id":"65eb18289b25ca0001b34332","firm_name":"B of A Securities","full_name":"Alice Xiao","last_updated":"2025-05-19T04:31:12Z","overall_avg_return":12.48,"overall_avg_return_percentile":66.53,"overall_success_rate":100,"smart_score":67.94,"total_ratings":4,"total_ratings_percentile":32.17}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"benzinga_firm_id":{"description":"The unique identifier assigned by Benzinga to the research firm or investment bank.","type":"string"},"benzinga_id":{"description":"The identifier used by Benzinga for this record.","type":"string"},"firm_name":{"description":"The name of the research firm or investment bank issuing the ratings.","type":"string"},"full_name":{"description":"The full name of the analyst associated with the ratings.","type":"string"},"last_updated":{"description":"The timestamp (formatted as an ISO 8601 timestamp) when the analyst record was last updated in the system.","type":"string"},"overall_avg_return":{"description":"The average percent price difference per rating since the date of recommendation.","format":"double","type":"number"},"overall_avg_return_percentile":{"description":"The analyst's percentile rank based on average return, relative to other analysts.","format":"double","type":"number"},"overall_success_rate":{"description":"The percentage of gain/loss ratings that resulted in a gain overall.","format":"double","type":"number"},"smart_score":{"description":"A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate.","format":"double","type":"number"},"total_ratings":{"description":"The total number of ratings issued by the analyst included in the performance calculation.","format":"double","type":"number"},"total_ratings_percentile":{"description":"The analyst's percentile rank based on the total number of ratings issued, relative to other analysts.","format":"double","type":"number"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["benzinga"]}},"/benzinga/v1/bulls-bears-say":{"get":{"description":"A comprehensive database of analyst bull and bear case summaries for publicly traded companies, providing concise summaries of both bullish and bearish investment arguments to help investors see both sides of the story before making investment decisions.","operationId":"get_benzinga_v1_bulls-bears-say","parameters":[{"description":"The stock ticker symbol for the company associated with the bull and bear case summaries.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"The unique identifier used by Benzinga for this bull/bear case record.","in":"query","name":"benzinga_id","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"benzinga_id.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"benzinga_id.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"benzinga_id.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"benzinga_id.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"benzinga_id.lte","schema":{"type":"string"}},{"description":"The timestamp (formatted as an ISO 8601 timestamp) when the bull/bear case was last updated in the system. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'.","in":"query","name":"limit","schema":{"default":100,"maximum":5001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'ticker' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"ticker.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"bear_case":"Apple faces increasing regulatory scrutiny globally, potential market saturation in core iPhone markets, and intense competition in emerging categories. Supply chain vulnerabilities and dependence on China for manufacturing pose significant risks, while slowing innovation cycles could impact premium pricing.","benzinga_id":"550e8400-e29b-41d4-a716-446655440000","bull_case":"Apple's strong ecosystem integration, loyal customer base, and continued innovation in services and hardware drive sustainable revenue growth. The company's expanding services segment provides high-margin recurring revenue, while its brand strength and pricing power maintain premium market positioning.","last_updated":"2025-12-16T10:30:00Z","ticker":"AAPL"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"bear_case":{"description":"A concise summary of the bearish investment thesis, highlighting potential risks, challenges, and reasons why the stock could decline in value.","type":"string"},"benzinga_id":{"description":"The unique identifier used by Benzinga for this bull/bear case record.","type":"string"},"bull_case":{"description":"A concise summary of the bullish investment thesis, highlighting positive aspects, growth opportunities, and reasons why the stock could appreciate in value.","type":"string"},"last_updated":{"description":"The timestamp (formatted as an ISO 8601 timestamp) when the bull/bear case was last updated in the system.","format":"date-time","type":"string"},"ticker":{"description":"The stock ticker symbol for the company associated with the bull and bear case summaries.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["benzinga"]}},"/benzinga/v1/consensus-ratings/{ticker}":{"get":{"description":"A comprehensive financial consensus ratings table that aggregates analyst recommendations and price targets for individual stock tickers, capturing detailed rating breakdowns and statistical insights.","operationId":"get_benzinga_v1_consensus-ratings","parameters":[{"description":"The date range to aggregate analyst ratings over. For example, date.gte=2024-10-01 and date.lt=2025-01-01 for ratings published in Q4 2024. By default, all ratings are aggregated regardless of date.","in":"query","name":"date","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"date.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"date.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"date.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"The requested ticker.","in":"path","name":"ticker","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"buy_ratings":6,"consensus_price_target":23.28,"consensus_rating":"hold","consensus_rating_value":4.14,"high_price_target":32.14,"hold_ratings":3,"low_price_target":6.34,"price_target_contributors":15,"ratings_contributors":14,"sell_ratings":0,"strong_buy_ratings":5,"strong_sell_ratings":0,"ticker":"AAPL"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"buy_ratings":{"description":"The count of 'Buy' ratings from contributing analysts.","format":"int64","type":"integer"},"consensus_price_target":{"description":"The average price target across all analysts, rounded to 2 decimal places.","format":"double","type":"number"},"consensus_rating":{"description":"The overall rating category determined by the average consensus weight. Possible values: 'strong_buy', 'buy', 'hold', 'sell', 'strong_sell'.","type":"string"},"consensus_rating_value":{"description":"The numerical average of all consensus weights, rounded to 2 decimal places. Scale ranges from 1 (Strong Sell) to 5 (Strong Buy).","format":"double","type":"number"},"high_price_target":{"description":"The highest price target among all contributing analysts.","format":"double","type":"number"},"hold_ratings":{"description":"The count of 'Hold' ratings from contributing analysts.","format":"int64","type":"integer"},"low_price_target":{"description":"The lowest price target among all contributing analysts.","format":"double","type":"number"},"price_target_contributors":{"description":"The number of unique analysts contributing price targets.","format":"int64","type":"integer"},"ratings_contributors":{"description":"The number of unique analysts contributing to the overall ratings consensus.","format":"int64","type":"integer"},"sell_ratings":{"description":"The count of 'Sell' ratings from contributing analysts.","format":"int64","type":"integer"},"strong_buy_ratings":{"description":"The count of 'Strong Buy' ratings from contributing analysts.","format":"int64","type":"integer"},"strong_sell_ratings":{"description":"The count of 'Strong Sell' ratings from contributing analysts.","format":"int64","type":"integer"},"ticker":{"description":"The requested ticker.","type":"string"}},"required":["ratings_contributors","price_target_contributors","strong_buy_ratings","buy_ratings","hold_ratings","sell_ratings","strong_sell_ratings"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["benzinga"]}},"/benzinga/v1/earnings":{"get":{"description":"This table contains earnings data from Benzinga, tracking both actual and estimated financial metrics for publicly traded companies. It includes EPS and revenue figures with surprise calculations, along with metadata like fiscal periods, company identifiers, and reporting timestamps.","operationId":"get_benzinga_v1_earnings","parameters":[{"description":"The calendar date (formatted as YYYY-MM-DD) when the earnings are scheduled or were reported.","in":"query","name":"date","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"date.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"date.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"date.lte","schema":{"type":"string"}},{"description":"The stock symbol of the company reporting earnings.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer.","in":"query","name":"importance","schema":{"format":"int64","type":"integer"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer.","in":"query","name":"importance.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be an integer.","in":"query","name":"importance.gt","schema":{"format":"int64","type":"integer"}},{"description":"Filter greater than or equal to the value. Value must be an integer.","in":"query","name":"importance.gte","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than the value. Value must be an integer.","in":"query","name":"importance.lt","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than or equal to the value. Value must be an integer.","in":"query","name":"importance.lte","schema":{"format":"int64","type":"integer"}},{"description":"The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.lte","schema":{"type":"string"}},{"description":"Indicates whether the date of the earnings report has been confirmed. Possible values include: projected, confirmed.","in":"query","name":"date_status","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"date_status.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"date_status.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"date_status.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"date_status.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"date_status.lte","schema":{"type":"string"}},{"description":"The percentage difference between the actual and estimated EPS. Value must be a floating point number.","in":"query","name":"eps_surprise_percent","schema":{"format":"double","type":"number"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number.","in":"query","name":"eps_surprise_percent.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"eps_surprise_percent.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"eps_surprise_percent.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"eps_surprise_percent.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"eps_surprise_percent.lte","schema":{"format":"double","type":"number"}},{"description":"The percentage difference between the actual and estimated revenue. Value must be a floating point number.","in":"query","name":"revenue_surprise_percent","schema":{"format":"double","type":"number"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number.","in":"query","name":"revenue_surprise_percent.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"revenue_surprise_percent.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"revenue_surprise_percent.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"revenue_surprise_percent.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"revenue_surprise_percent.lte","schema":{"format":"double","type":"number"}},{"description":"The fiscal year in which the earnings period falls. Value must be an integer.","in":"query","name":"fiscal_year","schema":{"format":"int64","type":"integer"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer.","in":"query","name":"fiscal_year.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be an integer.","in":"query","name":"fiscal_year.gt","schema":{"format":"int64","type":"integer"}},{"description":"Filter greater than or equal to the value. Value must be an integer.","in":"query","name":"fiscal_year.gte","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than the value. Value must be an integer.","in":"query","name":"fiscal_year.lt","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than or equal to the value. Value must be an integer.","in":"query","name":"fiscal_year.lte","schema":{"format":"int64","type":"integer"}},{"description":"The fiscal period for which the earnings are reported. Examples include: Q1, Q2, H1, FY.","in":"query","name":"fiscal_period","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"fiscal_period.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"fiscal_period.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"fiscal_period.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"fiscal_period.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"fiscal_period.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'last_updated' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"last_updated.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"actual_eps":-0.19,"actual_revenue":17566000,"benzinga_id":"651bcd8d7e4d6000011f2232","company_name":"Guardforce AI Co","currency":"USD","date":"2029-09-24","date_status":"confirmed","eps_method":"GAAP","fiscal_period":"H1","fiscal_year":2024,"importance":1,"last_updated":"2025-01-07T10:19:50Z","previous_eps":-0.75,"previous_revenue":18413292,"revenue_method":"GAAP","ticker":"GFAI","time":"07:00:00"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"actual_eps":{"description":"The actual earnings per share (EPS) reported by the company for the given period.","format":"double","type":"number"},"actual_revenue":{"description":"The actual revenue reported by the company for the given fiscal period.","format":"double","type":"number"},"benzinga_id":{"description":"The identifer used by Benzinga for this record.","type":"string"},"company_name":{"description":"The name of the company releasing earnings.","type":"string"},"currency":{"description":"The ISO 4217 currency code indicating the denomination in which the figures are reported.","type":"string"},"date":{"description":"The calendar date (formatted as YYYY-MM-DD) when the earnings are scheduled or were reported.","type":"string"},"date_status":{"description":"Indicates whether the date of the earnings report has been confirmed. Possible values include: projected, confirmed.","type":"string"},"eps_method":{"description":"The methodology of the EPS figure. Possible values are gaap (standardized financials under Generally Accepted Accounting Principles), ffo (Funds From Operations, a non-GAAP metric commonly used to assess the operating performance of REITs), and adj (adjusted, non-GAAP).","type":"string"},"eps_surprise":{"description":"The difference between the actual and estimated EPS.","format":"double","type":"number"},"eps_surprise_percent":{"description":"The percentage difference between the actual and estimated EPS.","format":"double","type":"number"},"estimated_eps":{"description":"The analyst consensus estimate for earnings per share (EPS) for the given period.","format":"double","type":"number"},"estimated_revenue":{"description":"The analyst consensus estimate for the company's revenue in the given period.","format":"double","type":"number"},"fiscal_period":{"description":"The fiscal period for which the earnings are reported. Examples include: Q1, Q2, H1, FY.","type":"string"},"fiscal_year":{"description":"The fiscal year in which the earnings period falls.","format":"int64","type":"integer"},"importance":{"description":"A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest).","format":"int64","type":"integer"},"last_updated":{"description":"The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system.","format":"date-time","type":"string"},"notes":{"description":"Additional context, commentary, or clarifying notes related to the earnings event.","type":"string"},"previous_eps":{"description":"The company's reported earnings per share (EPS) for the previous comparable period.","format":"double","type":"number"},"previous_revenue":{"description":"The company's revenue for the previous comparable fiscal period.","format":"double","type":"number"},"revenue_method":{"description":"The methodology of the revenue figure. Possible values are gaap (standardized financials under Generally Accepted Accounting Principles), adj (adjusted, non-GAAP figures that exclude certain items like one-time charges or divestitures), and rental (revenue specifically derived from rental operations, typically used by REITs, leasing companies, or businesses with a rental-based model).","type":"string"},"revenue_surprise":{"description":"The difference between the actual and estimated revenue.","format":"double","type":"number"},"revenue_surprise_percent":{"description":"The percentage difference between the actual and estimated revenue.","format":"double","type":"number"},"ticker":{"description":"The stock symbol of the company reporting earnings.","type":"string"},"time":{"description":"The time (formatted as 24-hour HH:MM:SS EST) when the earnings are scheduled or were reported.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["benzinga"]}},"/benzinga/v1/firms":{"get":{"description":"A comprehensive database of financial firms, tracking unique identifiers, names, and basic metadata for various financial institutions and research firms.","operationId":"get_benzinga_v1_firms","parameters":[{"description":"The identifer used by Benzinga for this record.","in":"query","name":"benzinga_id","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"benzinga_id.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"benzinga_id.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"benzinga_id.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"benzinga_id.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"benzinga_id.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'name' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"name.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"benzinga_id":"5e147c6b7da4190001b287b4","currency":"USD","last_updated":"2020-01-07T12:41:25Z","name":"Piper Sandler"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"benzinga_id":{"description":"The identifer used by Benzinga for this record.","type":"string"},"currency":{"description":"Primary currency used by the financial firm, with some entries having null values.","type":"string"},"last_updated":{"description":"Timestamp indicating when the firm's information was last modified or verified in the database.","type":"string"},"name":{"description":"The name of a research firm or investment bank which issues ratings.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["benzinga"]}},"/benzinga/v1/guidance":{"get":{"description":"A comprehensive database of financial guidance and earnings estimates for various companies, capturing key metrics related to earnings per share (EPS) and revenue projections across different fiscal periods.","operationId":"get_benzinga_v1_guidance","parameters":[{"description":"The calendar date (formatted as YYYY-MM-DD) when the guidance was issued.","in":"query","name":"date","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"date.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"date.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"date.lte","schema":{"type":"string"}},{"description":"The stock symbol of the company issuing guidance.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Indicates how a particular guidance value is presented relative to other figures disclosed by the company. Possible values are 'primary' (the emphasized figure) and 'secondary' (a supporting or alternate figure)","in":"query","name":"positioning","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"positioning.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"positioning.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"positioning.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"positioning.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"positioning.lte","schema":{"type":"string"}},{"description":"A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer.","in":"query","name":"importance","schema":{"format":"int64","type":"integer"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer.","in":"query","name":"importance.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be an integer.","in":"query","name":"importance.gt","schema":{"format":"int64","type":"integer"}},{"description":"Filter greater than or equal to the value. Value must be an integer.","in":"query","name":"importance.gte","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than the value. Value must be an integer.","in":"query","name":"importance.lt","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than or equal to the value. Value must be an integer.","in":"query","name":"importance.lte","schema":{"format":"int64","type":"integer"}},{"description":"The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system.","in":"query","name":"last_updated","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"last_updated.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"last_updated.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"last_updated.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"last_updated.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"last_updated.lte","schema":{"type":"string"}},{"description":"The fiscal year corresponding to the period for which the guidance is issued. Value must be an integer.","in":"query","name":"fiscal_year","schema":{"format":"int64","type":"integer"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer.","in":"query","name":"fiscal_year.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be an integer.","in":"query","name":"fiscal_year.gt","schema":{"format":"int64","type":"integer"}},{"description":"Filter greater than or equal to the value. Value must be an integer.","in":"query","name":"fiscal_year.gte","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than the value. Value must be an integer.","in":"query","name":"fiscal_year.lt","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than or equal to the value. Value must be an integer.","in":"query","name":"fiscal_year.lte","schema":{"format":"int64","type":"integer"}},{"description":"The fiscal quarter to which the guidance applies, such as Q1, Q2, Q3, or Q4.","in":"query","name":"fiscal_period","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"fiscal_period.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"fiscal_period.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"fiscal_period.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"fiscal_period.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"fiscal_period.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"date.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"benzinga_id":"682b28a9c068240001a9fded","company_name":"Bath \u0026 Body Works","currency":"USD","date":"2025-05-19","eps_method":"adj","estimated_eps_guidance":3.52,"estimated_revenue_guidance":7470000000,"fiscal_period":"FY","fiscal_year":2025,"importance":3,"last_updated":"2025-05-19T12:54:04Z","max_eps_guidance":3.6,"max_revenue_guidance":7526000000,"min_eps_guidance":3.25,"min_revenue_guidance":7380000000,"notes":"Revenue for 2025 FY is expected to up by 1 to 3% YoY from $7.307B","positioning":"primary","previous_max_eps_guidance":3.6,"previous_max_revenue_guidance":7526000000,"previous_min_eps_guidance":3.25,"previous_min_revenue_guidance":7380000000,"release_type":"preliminary","revenue_method":"gaap","ticker":"BBWI","time":"08:30:00"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"benzinga_id":{"description":"A unique identifier assigned by Benzinga to the guidance record.","type":"string"},"company_name":{"description":"The name of the company issuing guidance.","type":"string"},"currency":{"description":"The ISO 4217 code representing the currency in which the company issued its guidance figures.","type":"string"},"date":{"description":"The calendar date (formatted as YYYY-MM-DD) when the guidance was issued.","type":"string"},"eps_method":{"description":"The methodology of the EPS figure. Possible values are gaap (standardized financials under Generally Accepted Accounting Principles), ffo (Funds From Operations, a non-GAAP metric commonly used to assess the operating performance of REITs), and adj (adjusted, non-GAAP).","type":"string"},"estimated_eps_guidance":{"description":"The midpoint or central earnings per share (EPS) value the company expects for the given fiscal period.","format":"double","type":"number"},"estimated_revenue_guidance":{"description":"The midpoint or central revenue figure the company expects for the given fiscal period.","format":"double","type":"number"},"fiscal_period":{"description":"The fiscal quarter to which the guidance applies, such as Q1, Q2, Q3, or Q4.","type":"string"},"fiscal_year":{"description":"The fiscal year corresponding to the period for which the guidance is issued.","format":"int64","type":"integer"},"importance":{"description":"A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest).","format":"int64","type":"integer"},"last_updated":{"description":"The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system.","type":"string"},"max_eps_guidance":{"description":"The highest EPS value the company expects for the fiscal period if a range was provided.","format":"double","type":"number"},"max_revenue_guidance":{"description":"The highest revenue figure the company expects for the fiscal period if a range was provided.","format":"double","type":"number"},"min_eps_guidance":{"description":"The lowest EPS value the company expects for the fiscal period if a range was provided.","format":"double","type":"number"},"min_revenue_guidance":{"description":"The lowest revenue figure the company expects for the fiscal period if a range was provided.","format":"double","type":"number"},"notes":{"description":"Additional descriptive text or commentary provided about the guidance record.","type":"string"},"positioning":{"description":"Indicates how a particular guidance value is presented relative to other figures disclosed by the company. Possible values are 'primary' (the emphasized figure) and 'secondary' (a supporting or alternate figure)","type":"string"},"previous_max_eps_guidance":{"description":"The highest EPS value issued in a previous guidance record for the same fiscal period.","format":"double","type":"number"},"previous_max_revenue_guidance":{"description":"The highest revenue value issued in a previous guidance record for the same fiscal period.","format":"double","type":"number"},"previous_min_eps_guidance":{"description":"The lowest EPS value issued in a previous guidance record for the same fiscal period.","format":"double","type":"number"},"previous_min_revenue_guidance":{"description":"The lowest revenue value issued in a previous guidance record for the same fiscal period.","format":"double","type":"number"},"release_type":{"description":"Indicates whether the guidance was issued as part of a scheduled earnings release ('official') or as an unscheduled update ('preliminary').","type":"string"},"revenue_method":{"description":"The methodology of the revenue figure. Possible values are gaap (standardized financials under Generally Accepted Accounting Principles) and adj (adjusted, non-GAAP).","type":"string"},"ticker":{"description":"The stock symbol of the company issuing guidance.","type":"string"},"time":{"description":"The time of day the guidance was announced, in HH:mm:ss format.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["benzinga"]}},"/benzinga/v1/ratings":{"get":{"description":"This table contains analyst ratings and price target data from investment firms, tracking rating changes (upgrades, downgrades, initiates coverage, etc.) and price target adjustments for publicly traded companies. Each record includes the analyst details, company information, current and previous ratings/targets, and metadata like timestamps and Benzinga identifiers.","operationId":"get_benzinga_v1_ratings","parameters":[{"description":"The calendar date (formatted as YYYY-MM-DD) when the rating was issued.","in":"query","name":"date","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"date.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"date.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"date.lte","schema":{"type":"string"}},{"description":"The stock symbol of the company being rated.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"A subjective indicator of the importance of the earnings event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer.","in":"query","name":"importance","schema":{"format":"int64","type":"integer"}},{"description":"Filter greater than the value. Value must be an integer.","in":"query","name":"importance.gt","schema":{"format":"int64","type":"integer"}},{"description":"Filter greater than or equal to the value. Value must be an integer.","in":"query","name":"importance.gte","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than the value. Value must be an integer.","in":"query","name":"importance.lt","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than or equal to the value. Value must be an integer.","in":"query","name":"importance.lte","schema":{"format":"int64","type":"integer"}},{"description":"The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"last_updated.lte","schema":{"type":"string"}},{"description":"The description of the change in rating from the firm's last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved.","in":"query","name":"rating_action","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"rating_action.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"rating_action.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"rating_action.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"rating_action.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"rating_action.lte","schema":{"type":"string"}},{"description":"The description of the directional change in price target. Possible values include: raises, lowers, maintains, announces, sets.","in":"query","name":"price_target_action","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"price_target_action.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"price_target_action.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"price_target_action.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"price_target_action.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"price_target_action.lte","schema":{"type":"string"}},{"description":"The identifer used by Benzinga for this record.","in":"query","name":"benzinga_id","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"benzinga_id.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"benzinga_id.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"benzinga_id.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"benzinga_id.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"benzinga_id.lte","schema":{"type":"string"}},{"description":"The identifer used by Benzinga for this analyst.","in":"query","name":"benzinga_analyst_id","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"benzinga_analyst_id.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"benzinga_analyst_id.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"benzinga_analyst_id.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"benzinga_analyst_id.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"benzinga_analyst_id.lte","schema":{"type":"string"}},{"description":"The identifer used by Benzinga for this firm.","in":"query","name":"benzinga_firm_id","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"benzinga_firm_id.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"benzinga_firm_id.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"benzinga_firm_id.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"benzinga_firm_id.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"benzinga_firm_id.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'last_updated' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"last_updated.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"adjusted_price_target":15,"analyst":"Alexander Potter","benzinga_analyst_id":"58933b2043eaaa0001698f4a","benzinga_calendar_url":"https://www.benzinga.com/quote/RIVN/analyst-ratings","benzinga_firm_id":"5e147c6b7da4190001b287b4","benzinga_id":"682f29b0e5343b000100a619","benzinga_news_url":"https://www.benzinga.com/stock-articles/RIVN/analyst-ratings","company_name":"Rivian Automotive","currency":"USD","date":"2025-05-22","firm":"Piper Sandler","importance":0,"last_updated":"2025-05-22T13:42:30Z","previous_adjusted_price_target":13,"previous_price_target":13,"previous_rating":"neutral","price_percent_change":15.38,"price_target":15,"price_target_action":"raises","rating":"neutral","rating_action":"maintains","ticker":"RIVN","time":"09:42:08"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"adjusted_price_target":{"description":"The current price target adjusted for stock splits and dividends.","format":"double","type":"number"},"analyst":{"description":"The name of the individual analyst who issued the rating.","type":"string"},"benzinga_analyst_id":{"description":"The identifer used by Benzinga for this analyst.","type":"string"},"benzinga_calendar_url":{"description":"A link to the Benzinga calendar page for this ticker","type":"string"},"benzinga_firm_id":{"description":"The identifer used by Benzinga for this firm.","type":"string"},"benzinga_id":{"description":"The identifer used by Benzinga for this record.","type":"string"},"benzinga_news_url":{"description":"A link to the Benzinga articles page for this ticker","type":"string"},"company_name":{"description":"The name of the company being rated.","type":"string"},"currency":{"description":"The ISO 4217 currency code in which the price target is denominated.","type":"string"},"date":{"description":"The calendar date (formatted as YYYY-MM-DD) when the rating was issued.","type":"string"},"firm":{"description":"The name of the research firm or investment bank issuing the rating.","type":"string"},"importance":{"description":"A subjective indicator of the importance of the earnings event, on a scale from 0 (lowest) to 5 (highest).","format":"int64","type":"integer"},"last_updated":{"description":"The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system.","format":"date-time","type":"string"},"notes":{"description":"Additional context or commentary.","type":"string"},"previous_adjusted_price_target":{"description":"The previous price target adjusted for stock splits and dividends.","format":"double","type":"number"},"previous_price_target":{"description":"The previous price target set by the analyst.","format":"double","type":"number"},"previous_rating":{"description":"The previous rating set by the analyst.","type":"string"},"price_percent_change":{"description":"The percentage change in price target if price target and previous price target exists","format":"double","type":"number"},"price_target":{"description":"The current price target set by the analyst.","format":"double","type":"number"},"price_target_action":{"description":"The description of the directional change in price target. Possible values include: raises, lowers, maintains, announces, sets.","type":"string"},"rating":{"description":"The current rating set by the analyst.","type":"string"},"rating_action":{"description":"The description of the change in rating from the firm's last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved.","type":"string"},"ticker":{"description":"The stock symbol of the company being rated.","type":"string"},"time":{"description":"The time (formatted as 24-hour HH:MM:SS UTC) when the rating was issued.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["benzinga"]}},"/benzinga/v2/news":{"get":{"description":"A comprehensive news article database from Benzinga, containing detailed information about financial news articles including metadata, content, and associated financial information.","operationId":"get_benzinga_v2_news","parameters":[{"description":"The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"published","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"published.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"published.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"published.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"published.lte","schema":{"type":"string"}},{"description":"Filter for arrays that contain the value.","in":"query","name":"channels","schema":{"type":"string"}},{"description":"Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"channels.all_of","schema":{"type":"string"}},{"description":"Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"channels.any_of","schema":{"type":"string"}},{"description":"Filter for arrays that contain the value.","in":"query","name":"tags","schema":{"type":"string"}},{"description":"Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"tags.all_of","schema":{"type":"string"}},{"description":"Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"tags.any_of","schema":{"type":"string"}},{"description":"The name of the journalist or entity that authored the news article.","in":"query","name":"author","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"author.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"author.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"author.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"author.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"author.lte","schema":{"type":"string"}},{"description":"Filter for arrays that contain the value.","in":"query","name":"stocks","schema":{"type":"string"}},{"description":"Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"stocks.all_of","schema":{"type":"string"}},{"description":"Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"stocks.any_of","schema":{"type":"string"}},{"description":"Filter for arrays that contain the value.","in":"query","name":"tickers","schema":{"type":"string"}},{"description":"Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"tickers.all_of","schema":{"type":"string"}},{"description":"Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"tickers.any_of","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'published' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"published.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"author":"Adam Eckert","benzinga_id":39046904,"body":"\u003cp\u003e\u003cstrong\u003eCAVA Group Inc\u003c/strong\u003e (NYSE:\u003ca class=\"ticker\" href=\"https://www.benzinga.com/stock/CAVA#NYSE\"\u003eCAVA\u003c/a\u003e) reported financial results for the first quarter of fiscal 2024 after market close on Tuesday. Here\u0026#8217;s a look at the \u003ca href=\"https://www.benzinga.com/pressreleases/24/05/b39046606/cava-group-reports-first-quarter-2024-results\"\u003ekey metrics from the quarter\u003c/a\u003e.\u003c/p\u003e","channels":["earnings","news","restaurants","after-hours center","movers"],"images":["https://cdn.benzinga.com/files/imagecache/250x187xUP/images/story/2024/05/28/CAVA-group.jpeg","https://cdn.benzinga.com/files/imagecache/1024x768xUP/images/story/2024/05/28/CAVA-group.jpeg","https://cdn.benzinga.com/files/imagecache/2048x1536xUP/images/story/2024/05/28/CAVA-group.jpeg"],"last_updated":"2024-05-28T20:27:42Z","published":"2024-05-28T20:27:41Z","tags":["why it's moving"],"teaser":"Cava\u0026#39;s first-quarter revenue increased 30.3% year-over-year to $256.3 million, which beat the consensus estimate of $245.935 million, according to Benzinga Pro.","tickers":["CAVA"],"title":"Cava Group Q1 Earnings: Revenue Beat, EPS Beat, Guidance Raise, Continued Investments In Scalable Infrastructure And More","url":"https://www.benzinga.com/news/earnings/24/05/39046904/cava-group-q1-earnings-revenue-beat-eps-beat-guidance-raise-continued-investments-in-scalable-infra"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"author":{"description":"The name of the journalist or entity that authored the news article.","type":"string"},"benzinga_id":{"description":"The identifer used by Benzinga for this record.","format":"int64","type":"integer"},"body":{"description":"The full text content of the news article.","type":"string"},"channels":{"description":"A list of categories or topics that the article belongs to (e.g., 'News', 'Price Target').","items":{"type":"string"},"type":"array"},"images":{"description":"A list of images associated with the article.","items":{"type":"string"},"type":"array"},"last_updated":{"description":"The timestamp (formatted as an ISO 8601 timestamp) when the news article was last updated in the system.","format":"date-time","type":"string"},"published":{"description":"The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published.","format":"date-time","type":"string"},"tags":{"description":"A list of tags that describe the themes or content of the article.","items":{"type":"string"},"type":"array"},"teaser":{"description":"A short summary or lead-in to the news article's content.","type":"string"},"tickers":{"description":"A list of stock or crypto tickers mentioned in the article.","items":{"type":"string"},"type":"array"},"title":{"description":"The headline of the news article.","type":"string"},"url":{"description":"The direct link to the source of the news article.","type":"string"}},"required":["benzinga_id","author","published","last_updated","title","url"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["benzinga"]}},"/consumer-spending/eu/v1/merchant-aggregates":{"get":{"description":"Aggregated consumer transactions from European credit card panels, structured for flexible analysis and faster access to insights. Each row represents daily credit card, debit card, or open banking transactions (7-day lag from transaction date) at a tagged merchant or payment processor, split across Currency, Country, Online/Offline, and Credit/Debit dimensions. Includes ticker (Bloomberg standard) and industry mapping for ~250 US public companies across 6 European countries (UK, DE, FR, IT, ES, AT). Open banking data achieves \u003e85% fill rate at 7 days. User counts provided across 8 and 28-day windows enable custom normalization. NOTE: Individual accounts have a 30-day minimum lag from transaction_date for licensing compliance. Data returned reflects the latest available values, including any corrections from the data provider.","operationId":"get_consumer-spending_eu_v1_merchant-aggregates","parameters":[{"description":"The calendar date when the consumer transactions occurred. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"transaction_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"transaction_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"transaction_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"transaction_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"transaction_date.lte","schema":{"type":"string"}},{"description":"The merchant or entity name for this aggregate (lowercase). When type is 'merchant', this value can be used as the lookup_name in the merchant-hierarchy endpoint to retrieve full corporate hierarchy details.","in":"query","name":"name","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"name.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"name.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"name.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"name.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"name.lte","schema":{"type":"string"}},{"description":"Country of consumer's residence (ISO codes). Available countries: UK, DE, FR, ES, IT, AT. Values outside these are mapped to 'unknown'.","in":"query","name":"user_country","schema":{"enum":["UK","DE","FR","ES","IT","AT","unknown"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"user_country.any_of","schema":{"enum":["UK","DE","FR","ES","IT","AT","unknown"],"type":"string"}},{"description":"Transaction channel. Possible values: online, offline, bnpl (buy now pay later platforms such as Scala, Klarna, Zilch).","in":"query","name":"channel","schema":{"enum":["online","offline","bnpl"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"channel.any_of","schema":{"enum":["online","offline","bnpl"],"type":"string"}},{"description":"The panel the account is sourced from. Possible values: consumer_credit, consumer_debit, open_banking.","in":"query","name":"consumer_type","schema":{"enum":["consumer_credit","consumer_debit","open_banking"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"consumer_type.any_of","schema":{"enum":["consumer_credit","consumer_debit","open_banking"],"type":"string"}},{"description":"Merchant's parent business name (Title Case). Useful for aggregating transactions across subsidiary brands. Also available in the merchant-hierarchy endpoint for full corporate structure.","in":"query","name":"parent_name","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"parent_name.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"parent_name.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"parent_name.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"parent_name.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"parent_name.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'.","in":"query","name":"limit","schema":{"default":100,"maximum":5001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'transaction_date' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"transaction_date.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"c38af84c88ba484cb8430ba1511b1f24","results":[{"channel":"offline","consumer_type":"open_banking","eight_day_rolling_category_accounts":40346,"eight_day_rolling_total_accounts":463648,"mcc_group":"memberships \u0026 organizations","merchant_industry":"Leisure Clubs \u0026 Facilities","merchant_ticker":"0206472D US","name":"zumba fitness","parent_name":"Zumba Fitness Llc","published_date":"2026-01-25","spend_in_distinct_account_key_count":0,"spend_in_spend":0,"spend_in_transaction_count":0,"spend_out_distinct_account_key_count":1,"spend_out_spend":-3,"spend_out_transaction_count":1,"total_accounts":1,"total_spend":-3,"total_transactions":1,"transaction_currency":"GBP","transaction_date":"2026-01-18","twenty_eight_day_rolling_category_accounts":91642,"twenty_eight_day_rolling_total_accounts":524917,"type":"merchant","user_country":"UK"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"channel":{"description":"Transaction channel. Possible values: online, offline, bnpl (buy now pay later platforms such as Scala, Klarna, Zilch).","type":"string"},"consumer_type":{"description":"The panel the account is sourced from. Possible values: consumer_credit, consumer_debit, open_banking.","type":"string"},"eight_day_rolling_category_accounts":{"description":"The count of unique consumer accounts active for a given country, consumer type, and that transacted in this merchant category (MCC Group) over the prior 8 days. Used for short-term normalization calculations (e.g., spend per 1000 panelists = (total_spend / eight_day_rolling_category_accounts) * 1000).","format":"int64","type":"integer"},"eight_day_rolling_total_accounts":{"description":"The count of unique consumer accounts active for a given country and consumer type that had any transaction activity (across all categories) over the prior 8 days. Provides a baseline for total panel size.","format":"int64","type":"integer"},"mcc_group":{"description":"Merchant category code group associated with the merchant or payment processor.","type":"string"},"merchant_industry":{"description":"Industry name based on GICS/BICS/ICB data classification for the merchant.","type":"string"},"merchant_ticker":{"description":"Stock ticker associated with the merchant (~250 US public companies mapped). Uses Bloomberg tickers and they are point in time.","type":"string"},"name":{"description":"The merchant or entity name for this aggregate (lowercase). When type is 'merchant', this value can be used as the lookup_name in the merchant-hierarchy endpoint to retrieve full corporate hierarchy details.","type":"string"},"parent_name":{"description":"Merchant's parent business name (Title Case). Useful for aggregating transactions across subsidiary brands. Also available in the merchant-hierarchy endpoint for full corporate structure.","type":"string"},"published_date":{"description":"The date when this data version was published. For original data, this is approximately 7 days after transaction_date.","format":"date","type":"string"},"spend_in_distinct_account_key_count":{"description":"The count of distinct account keys (unique consumer accounts) with inbound transactions.","format":"int64","type":"integer"},"spend_in_spend":{"description":"The total inbound transaction amount (refunds, returns, credits) in the specified currency for this aggregation. Values are positive, representing money flowing back into consumer accounts.","format":"double","type":"number"},"spend_in_transaction_count":{"description":"The count of inbound transactions (refunds, returns).","format":"int64","type":"integer"},"spend_out_distinct_account_key_count":{"description":"The count of distinct account keys (unique consumer accounts) with outbound transactions.","format":"int64","type":"integer"},"spend_out_spend":{"description":"The total outbound transaction amount (money spent by consumers) in the specified currency for this aggregation. Values are negative, representing money flowing out of consumer accounts.","format":"double","type":"number"},"spend_out_transaction_count":{"description":"The count of outbound transactions (purchases, payments).","format":"int64","type":"integer"},"total_accounts":{"description":"The total count of distinct consumer accounts with any transaction activity for this aggregation.","format":"int64","type":"integer"},"total_spend":{"description":"Sum of spend_out_spend and spend_in_spend. Typically negative (net outflow). A positive value indicates refunds exceeded new spending for this aggregation.","format":"double","type":"number"},"total_transactions":{"description":"The total count of all transactions (outbound + inbound).","format":"int64","type":"integer"},"transaction_currency":{"description":"ISO currency code for the transaction (base card/account currency). Always EUR or GBP in this dataset. All spend amounts are denominated in this currency.","type":"string"},"transaction_date":{"description":"The calendar date when the consumer transactions occurred.","format":"date","type":"string"},"twenty_eight_day_rolling_category_accounts":{"description":"The count of unique consumer accounts active for a given country, consumer type, and that transacted in this merchant category (MCC Group) over the prior 28 days. Used for longer-term normalization calculations.","format":"int64","type":"integer"},"twenty_eight_day_rolling_total_accounts":{"description":"The count of unique consumer accounts active for a given country and consumer type that had any transaction activity (across all categories) over the prior 28 days. Provides a longer-term baseline for total panel size.","format":"int64","type":"integer"},"type":{"description":"The type of aggregation. Can be 'merchant' or 'payment_processor'.","type":"string"},"user_country":{"description":"Country of consumer's residence (ISO codes). Available countries: UK, DE, FR, ES, IT, AT. Values outside these are mapped to 'unknown'.","type":"string"}},"required":["user_country"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["fable"]}},"/consumer-spending/eu/v1/merchant-hierarchy":{"get":{"description":"Reference data mapping merchants to parent companies, tickers, sectors, and industries across Fable's European consumer transaction panel. Each row represents a single merchant with its corporate hierarchy and classification metadata. Weekly snapshots contain ~3,500 merchants covering ~250 US public companies. Use lookup_name to join with the name field from the merchant-aggregates endpoint, filtering by active_from and active_to to match a specific transaction_date (e.g., active_from.lte=2025-06-15\u0026active_to.gte=2025-06-15).","operationId":"get_consumer-spending_eu_v1_merchant-hierarchy","parameters":[{"description":"Lowercase merchant tag used for joining with the merchant-aggregates endpoint name field (e.g., 'asda', 'amazon').","in":"query","name":"lookup_name","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"lookup_name.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"lookup_name.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"lookup_name.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"lookup_name.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"lookup_name.lte","schema":{"type":"string"}},{"description":"Stock ticker associated with the merchant (~250 US public companies mapped). Uses Bloomberg standard.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Whether the merchant is a publicly listed company or private. Possible values: public, private.","in":"query","name":"listing_status","schema":{"enum":["public","private"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"listing_status.any_of","schema":{"enum":["public","private"],"type":"string"}},{"description":"Date this merchant hierarchy mapping became applicable. A value of 0001-01-01 indicates no known start date. Use with active_to to match against transaction_date from the merchant-aggregates endpoint to perform point-in-time queries. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"active_from","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"active_from.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"active_from.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"active_from.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"active_from.lte","schema":{"type":"string"}},{"description":"Date after which this merchant hierarchy mapping is no longer applicable due to a corporate action. A value of 9999-12-31 indicates the mapping is currently active. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"active_to","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"active_to.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"active_to.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"active_to.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"active_to.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'lookup_name' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"lookup_name.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":"a1b2c3d4e5f6","results":[{"active_from":"0001-01-01","active_to":"9999-12-31","category":"General Merchandise","grandparent_name":"Amazon Inc","grandparent_ticker":"AMZN US","great_grandparent_name":"Amazon Inc","great_grandparent_ticker":"AMZN US","industry":"E-Commerce Discretionary","industry_group":"Retail - Discretionary","listing_status":"public","lookup_name":"amazon","normalized_name":"Amazon Inc","parent_name":"Amazon Inc","parent_ticker":"AMZN US","sector":"Consumer Discretionary","sub_industry":"E-Commerce Discretionary","ticker":"AMZN US"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"active_from":{"description":"Date this merchant hierarchy mapping became applicable. A value of 0001-01-01 indicates no known start date. Use with active_to to match against transaction_date from the merchant-aggregates endpoint to perform point-in-time queries.","format":"date","type":"string"},"active_to":{"description":"Date after which this merchant hierarchy mapping is no longer applicable due to a corporate action. A value of 9999-12-31 indicates the mapping is currently active.","format":"date","type":"string"},"category":{"description":"Merchant category assigned by the data provider (Title Case, e.g., 'Groceries', 'General Merchandise', 'Travel'). Values are managed by the data provider and may expand over time.","type":"string"},"grandparent_name":{"description":"Merchant's grandparent business name (Title Case).","type":"string"},"grandparent_ticker":{"description":"Stock ticker of the merchant's grandparent company. Uses Bloomberg standard.","type":"string"},"great_grandparent_name":{"description":"Merchant's great-grandparent business name (Title Case, top-level corporate entity).","type":"string"},"great_grandparent_ticker":{"description":"Stock ticker of the merchant's great-grandparent company (top-level corporate entity). Uses Bloomberg standard.","type":"string"},"industry":{"description":"Industry classification based on GICS/BICS/ICB standards.","type":"string"},"industry_group":{"description":"Industry group classification based on GICS/BICS/ICB standards.","type":"string"},"listing_status":{"description":"Whether the merchant is a publicly listed company or private. Possible values: public, private.","type":"string"},"lookup_name":{"description":"Lowercase merchant tag used for joining with the merchant-aggregates endpoint name field (e.g., 'asda', 'amazon').","type":"string"},"normalized_name":{"description":"Cleaned, standardized merchant display name (Title Case, e.g., 'Asda', 'Amazon').","type":"string"},"parent_name":{"description":"Merchant's parent business name (Title Case). Useful for aggregating transactions across subsidiary brands.","type":"string"},"parent_ticker":{"description":"Stock ticker of the merchant's parent company. Uses Bloomberg standard.","type":"string"},"sector":{"description":"Sector classification based on GICS/BICS/ICB standards.","type":"string"},"sub_industry":{"description":"Sub-industry classification based on GICS/BICS/ICB standards.","type":"string"},"ticker":{"description":"Stock ticker associated with the merchant (~250 US public companies mapped). Uses Bloomberg standard.","type":"string"}},"required":["listing_status"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["fable"]}},"/crypto/v1/exchanges":{"get":{"description":"Global cryptocurrency exchanges and digital asset trading platforms, including major centralized exchanges (Coinbase, Binance, Bitfinex, etc.) that facilitate trading of cryptocurrencies and digital tokens worldwide.","operationId":"get_crypto_v1_exchanges","parameters":[{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '999'.","in":"query","name":"limit","schema":{"default":100,"maximum":1000,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":2,"request_id":1,"results":[{"id":"1","name":"Coinbase","type":"exchange","url":"https://www.coinbase.com"},{"id":"10","name":"Binance","type":"exchange","url":"https://www.binance.us/"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"id":{"description":"Numeric identifier for the cryptocurrency exchange or trading platform.","type":"string"},"name":{"description":"Full official name of the cryptocurrency exchange or digital asset trading platform.","type":"string"},"type":{"description":"Type of crypto venue - 'exchange' for cryptocurrency exchanges and digital asset trading platforms.","type":"string"},"url":{"description":"Official website URL of the cryptocurrency exchange.","type":"string"}},"required":["id","type","name"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["global_crypto"]}},"/etf-global/v1/analytics":{"get":{"description":"ETF Global analytics data containing risk scores, reward metrics, and quantitative analysis for ETF composite tickers.","operationId":"get_etf-global_v1_analytics","parameters":[{"description":"The stock ticker symbol used to identify this ETF product on exchanges.","in":"query","name":"composite_ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"composite_ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"composite_ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"composite_ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"composite_ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"composite_ticker.lte","schema":{"type":"string"}},{"description":"The date showing when ETF Global received and processed the data. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.lte","schema":{"type":"string"}},{"description":"The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.lte","schema":{"type":"string"}},{"description":"ETF Global's proprietary Red Diamond overall risk assessment score for the ETF. Value must be a floating point number.","in":"query","name":"risk_total_score","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"risk_total_score.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"risk_total_score.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"risk_total_score.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"risk_total_score.lte","schema":{"format":"double","type":"number"}},{"description":"ETF Global's proprietary Green Diamond score measuring the potential reward and return prospects of the ETF. Value must be a floating point number.","in":"query","name":"reward_score","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"reward_score.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"reward_score.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"reward_score.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"reward_score.lte","schema":{"format":"double","type":"number"}},{"description":"ETF Global's comprehensive quantitative analysis score combining all quantitative factors. Value must be a floating point number.","in":"query","name":"quant_total_score","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"quant_total_score.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"quant_total_score.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"quant_total_score.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"quant_total_score.lte","schema":{"format":"double","type":"number"}},{"description":"Letter grade summarizing the ETF's overall quantitative assessment, where A = 71-100, B = 56-70, etc.","in":"query","name":"quant_grade","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"quant_grade.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"quant_grade.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"quant_grade.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"quant_grade.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"quant_grade.lte","schema":{"type":"string"}},{"description":"Combined technical analysis score aggregating short, intermediate, and long-term technical factors. Value must be a floating point number.","in":"query","name":"quant_composite_technical","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"quant_composite_technical.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"quant_composite_technical.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"quant_composite_technical.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"quant_composite_technical.lte","schema":{"format":"double","type":"number"}},{"description":"Overall market sentiment score combining put/call ratios, short interest, and implied volatility. Value must be a floating point number.","in":"query","name":"quant_composite_sentiment","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"quant_composite_sentiment.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"quant_composite_sentiment.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"quant_composite_sentiment.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"quant_composite_sentiment.lte","schema":{"format":"double","type":"number"}},{"description":"Behavioral analysis score measuring investor psychology and market behavior patterns. Value must be a floating point number.","in":"query","name":"quant_composite_behavioral","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"quant_composite_behavioral.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"quant_composite_behavioral.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"quant_composite_behavioral.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"quant_composite_behavioral.lte","schema":{"format":"double","type":"number"}},{"description":"Overall fundamental analysis score combining P/E, P/CF, P/B, and dividend yield metrics. Value must be a floating point number.","in":"query","name":"quant_composite_fundamental","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"quant_composite_fundamental.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"quant_composite_fundamental.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"quant_composite_fundamental.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"quant_composite_fundamental.lte","schema":{"format":"double","type":"number"}},{"description":"Overall global theme score combining sector and country analysis for macro investment views. Value must be a floating point number.","in":"query","name":"quant_composite_global","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"quant_composite_global.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"quant_composite_global.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"quant_composite_global.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"quant_composite_global.lte","schema":{"format":"double","type":"number"}},{"description":"Overall quality assessment score combining liquidity, diversification, and issuing firm factors. Value must be a floating point number.","in":"query","name":"quant_composite_quality","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"quant_composite_quality.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"quant_composite_quality.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"quant_composite_quality.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"quant_composite_quality.lte","schema":{"format":"double","type":"number"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'.","in":"query","name":"limit","schema":{"default":100,"maximum":5001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'composite_ticker' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"composite_ticker.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"composite_ticker":"SPY","effective_date":"2025-09-19","processed_date":"2025-09-19","quant_composite_behavioral":67.1535,"quant_composite_fundamental":1.2,"quant_composite_global":52.9,"quant_composite_quality":75.9,"quant_composite_sentiment":54.6,"quant_composite_technical":79.7,"quant_fundamental_div":4.7,"quant_fundamental_pb":0,"quant_fundamental_pcf":0,"quant_fundamental_pe":0,"quant_global_country":85.4,"quant_global_sector":20.4,"quant_grade":"D","quant_quality_diversification":29.3,"quant_quality_firm":98.3,"quant_quality_liquidity":100,"quant_sentiment_iv":23,"quant_sentiment_pc":88.9,"quant_sentiment_si":51.6,"quant_technical_it":79,"quant_technical_lt":78.7,"quant_technical_st":83.1,"quant_total_score":40.2,"reward_score":3.12,"risk_country":1.46,"risk_deviation":7.68,"risk_efficiency":1.85,"risk_liquidity":2.5,"risk_structure":2.37,"risk_total_score":9.22,"risk_volatility":4.66}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"composite_ticker":{"description":"The stock ticker symbol used to identify this ETF product on exchanges.","type":"string"},"effective_date":{"description":"The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date.","format":"date","type":"string"},"processed_date":{"description":"The date showing when ETF Global received and processed the data.","format":"date","type":"string"},"quant_composite_behavioral":{"description":"Behavioral analysis score measuring investor psychology and market behavior patterns.","format":"double","type":"number"},"quant_composite_fundamental":{"description":"Overall fundamental analysis score combining P/E, P/CF, P/B, and dividend yield metrics.","format":"double","type":"number"},"quant_composite_global":{"description":"Overall global theme score combining sector and country analysis for macro investment views.","format":"double","type":"number"},"quant_composite_quality":{"description":"Overall quality assessment score combining liquidity, diversification, and issuing firm factors.","format":"double","type":"number"},"quant_composite_sentiment":{"description":"Overall market sentiment score combining put/call ratios, short interest, and implied volatility.","format":"double","type":"number"},"quant_composite_technical":{"description":"Combined technical analysis score aggregating short, intermediate, and long-term technical factors.","format":"double","type":"number"},"quant_fundamental_div":{"description":"Fundamental analysis score based on dividend yields of the ETF's underlying securities.","format":"double","type":"number"},"quant_fundamental_pb":{"description":"Fundamental analysis score based on price-to-book value ratios of the ETF's holdings.","format":"double","type":"number"},"quant_fundamental_pcf":{"description":"Fundamental analysis score based on price-to-cash-flow ratios of the ETF's underlying assets.","format":"double","type":"number"},"quant_fundamental_pe":{"description":"Fundamental analysis score based on price-to-earnings ratios of the ETF's underlying holdings.","format":"double","type":"number"},"quant_global_country":{"description":"Quantitative score analyzing global country themes and country-specific market factors.","format":"double","type":"number"},"quant_global_sector":{"description":"Quantitative score analyzing global sector themes and sector-specific performance factors.","format":"double","type":"number"},"quant_grade":{"description":"Letter grade summarizing the ETF's overall quantitative assessment, where A = 71-100, B = 56-70, etc.","type":"string"},"quant_quality_diversification":{"description":"Quality assessment score evaluating the diversification benefits and risk distribution of the ETF.","format":"double","type":"number"},"quant_quality_firm":{"description":"Quality assessment score evaluating the reputation and capabilities of the ETF's issuing firm.","format":"double","type":"number"},"quant_quality_liquidity":{"description":"Quality assessment score measuring the liquidity characteristics and trading ease of the ETF.","format":"double","type":"number"},"quant_sentiment_iv":{"description":"Market sentiment score derived from implied volatility levels in options markets.","format":"double","type":"number"},"quant_sentiment_pc":{"description":"Market sentiment score derived from put/call option ratios and options activity.","format":"double","type":"number"},"quant_sentiment_si":{"description":"Market sentiment score based on short interest levels and short selling activity.","format":"double","type":"number"},"quant_technical_it":{"description":"Intermediate-term technical analysis score evaluating medium-term price trends.","format":"double","type":"number"},"quant_technical_lt":{"description":"Long-term technical analysis score assessing extended price trend patterns.","format":"double","type":"number"},"quant_technical_st":{"description":"Short-term technical analysis score based on recent price movements and trading patterns.","format":"double","type":"number"},"quant_total_score":{"description":"ETF Global's comprehensive quantitative analysis score combining all quantitative factors.","format":"double","type":"number"},"reward_score":{"description":"ETF Global's proprietary Green Diamond score measuring the potential reward and return prospects of the ETF.","format":"double","type":"number"},"risk_country":{"description":"A component score assessing country-specific risks based on the ETF's geographic exposure.","format":"double","type":"number"},"risk_deviation":{"description":"A component score measuring how much the ETF deviates from expected performance.","format":"double","type":"number"},"risk_efficiency":{"description":"A component score assessing the operational efficiency and cost-effectiveness of the ETF.","format":"double","type":"number"},"risk_liquidity":{"description":"A component score measuring the liquidity risk and ease of trading the ETF.","format":"double","type":"number"},"risk_structure":{"description":"A component score evaluating risks related to the ETF's structural design and mechanics.","format":"double","type":"number"},"risk_total_score":{"description":"ETF Global's proprietary Red Diamond overall risk assessment score for the ETF.","format":"double","type":"number"},"risk_volatility":{"description":"A component score measuring the volatility risk of the ETF's price movements.","format":"double","type":"number"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["etfglobal"]}},"/etf-global/v1/constituents":{"get":{"description":"ETF Global constituents data containing detailed information about the securities held within ETFs, including weights, market values, and security identifiers.","operationId":"get_etf-global_v1_constituents","parameters":[{"description":"The stock ticker symbol of the ETF that holds these constituent securities.","in":"query","name":"composite_ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"composite_ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"composite_ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"composite_ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"composite_ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"composite_ticker.lte","schema":{"type":"string"}},{"description":"The stock ticker symbol of the individual security held within the ETF.","in":"query","name":"constituent_ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"constituent_ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"constituent_ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"constituent_ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"constituent_ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"constituent_ticker.lte","schema":{"type":"string"}},{"description":"The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.lte","schema":{"type":"string"}},{"description":"The date showing when ETF Global received and processed the data. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.lte","schema":{"type":"string"}},{"description":"A unique identifier code for the constituent security in US markets.","in":"query","name":"us_code","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"us_code.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"us_code.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"us_code.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"us_code.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"us_code.lte","schema":{"type":"string"}},{"description":"The International Securities Identification Number, a global standard for identifying securities.","in":"query","name":"isin","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"isin.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"isin.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"isin.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"isin.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"isin.lte","schema":{"type":"string"}},{"description":"The Financial Instrument Global Identifier, an open standard for uniquely identifying financial instruments.","in":"query","name":"figi","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"figi.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"figi.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"figi.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"figi.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"figi.lte","schema":{"type":"string"}},{"description":"The Stock Exchange Daily Official List code, primarily used for securities trading in the UK.","in":"query","name":"sedol","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"sedol.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"sedol.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"sedol.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"sedol.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"sedol.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'.","in":"query","name":"limit","schema":{"default":100,"maximum":5001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'composite_ticker' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"composite_ticker.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"asset_class":"Equity","composite_ticker":"SPY","constituent_name":"CAESARS ENTERTAINMENT INC COMMON STOCK","constituent_rank":42,"constituent_ticker":"CZR","country_of_exchange":"US","currency_traded":"USD","effective_date":"2025-09-18","figi":"BBG0074Q3NK6","isin":"US12769G1004","market_value":63308625.6,"processed_date":"2025-09-19","security_type":"Common Stock","sedol":"BMWWGB0","shares_held":2398054,"us_code":"12769G100","weight":0.0000958005}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"asset_class":{"description":"The broad category of asset type, such as Equity, Corporate Bond, Municipal Bond, etc.","type":"string"},"composite_ticker":{"description":"The stock ticker symbol of the ETF that holds these constituent securities.","type":"string"},"constituent_name":{"description":"The full company or security name of the constituent holding.","type":"string"},"constituent_rank":{"description":"The rank of this constituent within the ETF for a given effective_date, ordered by weight (descending), market_value (descending), and constituent_ticker (ascending). A rank of 1 indicates the largest holding.","format":"int64","type":"integer"},"constituent_ticker":{"description":"The stock ticker symbol of the individual security held within the ETF.","type":"string"},"country_of_exchange":{"description":"The country where the exchange that lists this constituent security is located.","type":"string"},"currency_traded":{"description":"The local currency in which this constituent security is denominated and traded.","type":"string"},"effective_date":{"description":"The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date.","format":"date","type":"string"},"exchange":{"description":"The name of the stock exchange where this constituent security is primarily traded.","type":"string"},"figi":{"description":"The Financial Instrument Global Identifier, an open standard for uniquely identifying financial instruments.","type":"string"},"isin":{"description":"The International Securities Identification Number, a global standard for identifying securities.","type":"string"},"market_value":{"description":"The total market value of this constituent position held by the ETF.","format":"double","type":"number"},"processed_date":{"description":"The date showing when ETF Global received and processed the data.","format":"date","type":"string"},"security_type":{"description":"The specific classification of security type using ETF Global's taxonomy, such as Common Equity, Domestic, Global, etc.","type":"string"},"sedol":{"description":"The Stock Exchange Daily Official List code, primarily used for securities trading in the UK.","type":"string"},"shares_held":{"description":"The number of shares of this constituent security that the ETF currently owns.","format":"double","type":"number"},"us_code":{"description":"A unique identifier code for the constituent security in US markets.","type":"string"},"weight":{"description":"The percentage weight of this constituent security within the ETF's total portfolio.","format":"double","type":"number"}},"required":["constituent_rank","effective_date"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["etfglobal"]}},"/etf-global/v1/fund-flows":{"get":{"description":"ETF Global fund flow data containing information about ETF share movements, net asset values, and fund flow metrics.","operationId":"get_etf-global_v1_fund-flows","parameters":[{"description":"The date showing when ETF Global received and processed the data. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.lte","schema":{"type":"string"}},{"description":"The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.lte","schema":{"type":"string"}},{"description":"The stock ticker symbol used to identify this ETF on exchanges.","in":"query","name":"composite_ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"composite_ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"composite_ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"composite_ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"composite_ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"composite_ticker.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'.","in":"query","name":"limit","schema":{"default":100,"maximum":5001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'composite_ticker' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"composite_ticker.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"composite_ticker":"SPY","effective_date":"2025-01-29","fund_flow":-30235124.7,"nav":601.877341,"processed_date":"2025-01-29","shares_outstanding":1047232116},{"composite_ticker":"SPY","effective_date":"2025-01-30","fund_flow":-2798729635.65,"nav":605.0574,"processed_date":"2025-01-30","shares_outstanding":1042582116},{"composite_ticker":"SPY","effective_date":"2025-01-31","fund_flow":-3358068570,"nav":602.044248,"processed_date":"2025-01-31","shares_outstanding":1037032116}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"composite_ticker":{"description":"The stock ticker symbol used to identify this ETF on exchanges.","type":"string"},"effective_date":{"description":"The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date.","format":"date","type":"string"},"fund_flow":{"description":"The net daily capital flow into or out of the ETF through the creation and redemption process, where positive values indicate inflows and negative values indicate outflows.","format":"double","type":"number"},"nav":{"description":"The net asset value per share, representing the per-share value of the ETF's underlying holdings.","format":"double","type":"number"},"processed_date":{"description":"The date showing when ETF Global received and processed the data.","format":"date","type":"string"},"shares_outstanding":{"description":"The total number of ETF shares currently issued and outstanding in the market.","format":"double","type":"number"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["etfglobal"]}},"/etf-global/v1/profiles":{"get":{"description":"ETF Global industry profile data containing comprehensive ETF metadata including financial metrics, operational details, and exposure information.","operationId":"get_etf-global_v1_profiles","parameters":[{"description":"The date showing when ETF Global received and processed the data. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.lte","schema":{"type":"string"}},{"description":"The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.lte","schema":{"type":"string"}},{"description":"The stock ticker symbol used to identify this ETF product on exchanges.","in":"query","name":"composite_ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"composite_ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"composite_ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"composite_ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"composite_ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"composite_ticker.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'.","in":"query","name":"limit","schema":{"default":100,"maximum":5001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'composite_ticker' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"composite_ticker.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"administrator":"State Street Bank and Trust Company","advisor":"SSgA Funds Management, Inc.","asset_class":"Equity","aum":624531939442.66,"avg_daily_trading_volume":51287737.3,"bid_ask_spread":0.000042,"call_volume":4797339,"category":"Size and Style","composite_ticker":"SPY","creation_fee":3000,"creation_unit_size":50000,"currency_exposure":{"usd":1.003},"custodian":"State Street Bank and Trust Company","description":"SPDR S\u0026P 500 ETF Trust","development_class":"Developed Markets","discount_premium":0.136123,"distribution_frequency":"Q","distributor":"ALPS Distributors, Inc.","effective_date":"2025-01-02","fee_waivers":0,"fiscal_year_end":"31-Aug","focus":"Large Cap","geographic_exposure":{"bm":0.001,"ch":0.003,"ie":0.021,"je":0.001,"lr":0.001,"nl":0.001,"pa":0.001,"us":0.967},"inception_date":"1993-01-22","industry_exposure":{"aerospace_and_defense":0.011,"air_freight_and_logistics":0.004,"airlines":0.002,"auto_components":0,"automobiles":0.024,"banks":0.033,"beverages":0.011,"biotechnology":0.047,"building_products":0.002,"capital_markets":0.029,"cash_or_derivatives":0.003,"chemicals":0.007,"commercial_services_and_supplies":0.004,"communications_equipment":0.081,"construction_and_engineering":0.001,"construction_materials":0.001,"consumer_products":0.001,"containers_and_packaging":0.001,"distributors":0.001,"diversified_consumer_services":0.005,"diversified_financial_services":0.029,"diversified_telecommunication_services":0.009,"electrical_equipment":0.009,"electronic_equipment_instruments_and_components":0.001,"entertainment":0.008,"equity_real_estate_investment":0.001,"food_products":0.006,"health_care_equipment_and_supplies":0.031,"health_care_providers_and_services":0.018,"health_care_technology":0.003,"hotels,_restaurants_and_leisure":0.001,"hotels_restaurants_and_leisure":0.014,"household_durables":0.004,"household_products":0.011,"industrial_conglomerates":0.005,"insurance":0.035,"it_services":0.021,"leisure_products":0,"machinery":0.013,"media":0.077,"metals_and_mining":0.003,"oil_gas_and_consumable_fuels":0.031,"real_estate_management_and_development":0.018,"renewable_energy":0.001,"road_and_rail":0.003,"semiconductors_and_semiconductor_equipment":0.115,"software":0.101,"specialty_retail":0.082,"technology_hardware_storage_and_peripherals":0.001,"textiles_apparel_and_luxury_goods":0.003,"tobacco":0.006,"trading_companies_and_distributors":0.002,"transportation_infrastructure":0.006,"utilities":0.022},"industry_group_exposure":{"automobiles_and_components":0.024,"banks":0.033,"capital_goods":0.045,"cash_or_derivatives":0.003,"commercial_and_professional_services":0.005,"consumer_durables_and_apparel":0.007,"consumer_services":0.02,"diversified_financials":0.058,"energy":0.032,"food_and_staples_retailing":0.018,"food_beverage_and_tobacco":0.023,"health_care_equipment_and_services":0.046,"household_and_personal_products":0.011,"insurance":0.035,"materials":0.013,"media_and_entertainment":0.084,"pharmaceuticals_biotechnology_and_life_sciences":0.053,"real_estate":0.02,"retailing":0.065,"semiconductors_and_semiconductor_equipment":0.115,"software_and_services":0.12,"technology_hardware_and_equipment":0.084,"telecommunication_services":0.009,"transportation":0.002,"transportation_and_logistics":0.012,"utilities":0.022},"issuer":"SSgA","lead_market_maker":"None","leverage_style":"unleveraged","levered_amount":0,"listing_exchange":"NYSE Arca, Inc.","management_classification":"passive","management_fee":0.0945,"net_expenses":0.0945,"num_holdings":504,"options_available":1,"options_volume":9346839,"other_expenses":0,"primary_benchmark":"S\u0026P 500 Index","processed_date":"2025-01-02","product_type":"etf","put_call_ratio":0.948338,"put_volume":4549500,"region":"North America","sector_exposure":{"cash_or_derivatives":0.003,"communications":0.094,"consumer_discretionary":0.113,"consumer_staples":0.054,"energy":0.032,"financials":0.131,"health_care":0.099,"industrials":0.068,"materials":0.013,"real_estate":0.02,"technology":0.321,"utilities":0.022},"short_interest":106750000,"subindustry_exposure":{"advertising":0.001,"aerospace_and_defense":0.011,"agricultural_and_farm_machinery":0.002,"agricultural_products":0.001,"air_freight_and_logistics":0.004,"airlines":0.002,"alternative_carriers":0.009,"apparel_accessories_and_luxury":0.003,"apparel_retail":0.005,"application_software":0.024,"asset_management_and_custody_banks":0.006,"auto_parts_and_equipment":0,"automobile_manufacturers":0.024,"automotive_retail":0.004,"biotechnology":0.047,"brewers":0,"building_products":0.002,"cable_and_satellite":0.004,"cash_or_derivatives":0.003,"casinos_and_gaming":0.001,"commodity_chemicals":0.001,"communications_equipment":0.081,"construction_and_engineering":0.001,"construction_machinery_and_heavy_trucks":0.006,"construction_materials":0.001,"consumer_electronics":0.001,"consumer_finance":0.029,"data_processing_and_outsourced_services":0.006,"distillers_and_vintners":0.001,"distributors":0,"diversified_banks":0.033,"diversified_chemicals":0.002,"diversified_metals_and_mining":0.001,"diversified_support_services":0.001,"drug_retail":0,"electric_utilities":0.013,"electrical_components_and_equipment":0.009,"electronic_components":0.001,"electronic_equipment_and_instruments":0,"electronic_manufacturing_services":0,"environmental_and_facilities_services":0.003,"fertilizers_and_agricultural_che":0.001,"financial_exchanges_and_data":0.006,"food_retail":0.002,"gas_utilities":0,"general_merchandise_stores":0.002,"health_care_distributors":0.003,"health_care_equipment":0.014,"health_care_facilities":0.001,"health_care_services":0.004,"health_care_supplies":0.003,"heavy_electrical_equipment":0.001,"highways_and_railtracks":0.005,"home_improvement_retail":0.012,"homebuilding":0.002,"hotels_resorts_and_cruise_lines":0.004,"household_products":0.011,"hypermarkets_and_super_centers":0.016,"independent_power_producers_and_energy_traders":0.001,"industrial_conglomerates":0.005,"industrial_machinery":0.005,"insurance_brokers":0.005,"integrated_oil_and_gas":0.014,"interactive_media_and_services":0.067,"internet_and_direct_marketing_retail":0.043,"internet_services_and_infrastruc":0.004,"investment_banking_and_brokerage":0.01,"it_consulting_and_other_services":0.011,"leisure_facilities":0,"leisure_products":0.001,"life_and_health_insurance":0.003,"life_sciences_tools_and_services":0.014,"managed_health_care":0.013,"metal_and_glass_containers":0.001,"movies_and_entertainment":0.012,"multiutilities":0.006,"oil_and_gas_equipment_and_services":0.002,"oil_and_gas_exploration_and_production":0.007,"oil_and_gas_refining_and_marketing":0.003,"oil_and_gas_storage_and_transporta":0.004,"packaged_foods_and_meats":0.006,"paper_packaging":0.001,"precious_metals_and_minerals":0.001,"property_and_casualty_insurance":0.027,"publishing_and_broadcasting":0,"railroads":0.001,"real_estate_services":0.001,"reinsurance":0,"reit":0.019,"renewable_energy_equipment":0.001,"research_and_consulting_services":0.002,"restaurants":0.009,"security_and_alarm_services":0.004,"semiconductors":0.115,"soft_drinks":0.01,"specialty_chemicals":0.004,"specialty_stores":0.001,"steel":0.001,"systems_software":0.078,"technology_hardware_storage_and_peripherals":0.002,"tobacco":0.006,"trading_companies_and_distributors":0.002,"trucking":0.004,"water_utilities":0},"tax_classification":"Regulated Investment Company","total_expenses":0.0945,"transfer_agent":"State Street Bank and Trust Company","trustee":"State Street Global Advisors Trust Company"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"administrator":{"description":"The administrator of the ETF.","type":"string"},"advisor":{"description":"The investment advisor of the ETF.","type":"string"},"asset_class":{"description":"The primary type of assets held by the ETF, such as equities, bonds, commodities, or other securities.","type":"string"},"aum":{"description":"The total assets under management, representing the current market value of all assets held by the ETF.","format":"double","type":"number"},"avg_daily_trading_volume":{"description":"The average number of shares traded daily over the past month, indicating liquidity and investor interest.","format":"double","type":"number"},"bid_ask_spread":{"description":"The average intraday bid-ask spread as a percentage, calculated by dividing the spread by the lowest ask price sampled during the day.","format":"double","type":"number"},"call_volume":{"description":"Call options volume.","format":"double","type":"number"},"category":{"description":"The broad investment category that describes the ETF's investment focus and strategy.","type":"string"},"composite_ticker":{"description":"The stock ticker symbol used to identify this ETF product on exchanges.","type":"string"},"coupon_exposure":{"description":"Coupon exposure breakdown for fixed income ETFs.","items":{"properties":{"key":{"type":"string"},"value":{"format":"double","type":"number"}},"required":["key","value"],"type":"object"},"type":"array"},"creation_fee":{"description":"The fee for creating new shares of the ETF.","format":"double","type":"number"},"creation_unit_size":{"description":"The size of creation units for the ETF.","format":"double","type":"number"},"currency_exposure":{"description":"Currency exposure breakdown of the ETF.","items":{"properties":{"key":{"type":"string"},"value":{"format":"double","type":"number"}},"required":["key","value"],"type":"object"},"type":"array"},"custodian":{"description":"The custodian of the ETF assets.","type":"string"},"description":{"description":"The official name and description of the ETF product.","type":"string"},"development_class":{"description":"The economic development classification of the markets the ETF invests in, such as developed, emerging, or frontier markets.","type":"string"},"discount_premium":{"description":"Discount or premium to net asset value.","format":"double","type":"number"},"distribution_frequency":{"description":"How frequently the ETF makes distributions.","type":"string"},"distributor":{"description":"The distributor of the ETF.","type":"string"},"effective_date":{"description":"The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date.","format":"date","type":"string"},"fee_waivers":{"description":"Any fee waivers applied to the ETF.","format":"double","type":"number"},"fiscal_year_end":{"description":"The fiscal year end date for the ETF.","type":"string"},"focus":{"description":"The specific investment focus or exposure that the ETF provides, such as sector, geography, or investment style.","type":"string"},"futures_commission_merchant":{"description":"The futures commission merchant, if applicable.","type":"string"},"geographic_exposure":{"description":"Geographic exposure breakdown of the ETF.","items":{"properties":{"key":{"type":"string"},"value":{"format":"double","type":"number"}},"required":["key","value"],"type":"object"},"type":"array"},"inception_date":{"description":"The date when this ETF was first launched and became available for trading.","format":"date","type":"string"},"industry_exposure":{"description":"Industry exposure breakdown of the ETF.","items":{"properties":{"key":{"type":"string"},"value":{"format":"double","type":"number"}},"required":["key","value"],"type":"object"},"type":"array"},"industry_group_exposure":{"description":"Industry group exposure breakdown of the ETF.","items":{"properties":{"key":{"type":"string"},"value":{"format":"double","type":"number"}},"required":["key","value"],"type":"object"},"type":"array"},"issuer":{"description":"The financial institution or fund company that created and sponsors this ETF.","type":"string"},"lead_market_maker":{"description":"The lead market maker for the ETF.","type":"string"},"leverage_style":{"description":"Indicates whether the ETF uses leverage to amplify returns ('leveraged'), or does not use leverage ('unleveraged').","type":"string"},"levered_amount":{"description":"The leverage multiplier applied by the ETF, where positive numbers indicate leveraged exposure and negative numbers indicate inverse exposure.","format":"double","type":"number"},"listing_exchange":{"description":"The primary exchange where the ETF is listed.","type":"string"},"management_classification":{"description":"Defines whether an ETF is considered active under SEC rules, with managers making investment decisions, or passive, tracking an index.","type":"string"},"management_fee":{"description":"The annual fee charged by the fund manager for managing the ETF's portfolio and operations.","format":"double","type":"number"},"maturity_exposure":{"description":"Maturity exposure breakdown for fixed income ETFs.","items":{"properties":{"key":{"type":"string"},"value":{"format":"double","type":"number"}},"required":["key","value"],"type":"object"},"type":"array"},"net_expenses":{"description":"Net expenses after waivers.","format":"double","type":"number"},"num_holdings":{"description":"Number of holdings in the ETF.","format":"double","type":"number"},"options_available":{"description":"Availability of options on the ETF.","format":"int32","type":"integer"},"options_volume":{"description":"Options trading volume for the ETF.","format":"double","type":"number"},"other_expenses":{"description":"Other expenses charged by the ETF.","format":"double","type":"number"},"portfolio_manager":{"description":"The portfolio manager of the ETF.","type":"string"},"primary_benchmark":{"description":"The main index or benchmark that this ETF is designed to track or replicate.","type":"string"},"processed_date":{"description":"The date showing when ETF Global received and processed the data.","format":"date","type":"string"},"product_type":{"description":"Indicates whether the product is an Exchange-Traded Note ('etn') or an Exchange-Traded Fund ('etf').","type":"string"},"put_call_ratio":{"description":"Put/call ratio for options on the ETF.","format":"double","type":"number"},"put_volume":{"description":"Put options volume.","format":"double","type":"number"},"region":{"description":"The geographic region or area of the world where the ETF concentrates its investments.","type":"string"},"sector_exposure":{"description":"Sector exposure breakdown of the ETF.","items":{"properties":{"key":{"type":"string"},"value":{"format":"double","type":"number"}},"required":["key","value"],"type":"object"},"type":"array"},"short_interest":{"description":"Short interest in the ETF.","format":"double","type":"number"},"subadvisor":{"description":"The subadvisor of the ETF, if applicable.","type":"string"},"subindustry_exposure":{"description":"Sub-industry exposure breakdown of the ETF.","items":{"properties":{"key":{"type":"string"},"value":{"format":"double","type":"number"}},"required":["key","value"],"type":"object"},"type":"array"},"tax_classification":{"description":"The tax structure of the ETF, determining whether investors receive 1099 or K1 tax forms (RIC, Partnership, or UIT).","type":"string"},"total_expenses":{"description":"The total annual expense ratio of the ETF, including all fees and costs passed on to investors.","format":"double","type":"number"},"transfer_agent":{"description":"The transfer agent for the ETF.","type":"string"},"trustee":{"description":"The trustee of the ETF.","type":"string"}},"required":["product_type","leverage_style","management_classification"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["etfglobal"]}},"/etf-global/v1/taxonomies":{"get":{"description":"ETF Global taxonomy data containing detailed classification and categorization information for ETFs including investment strategy, methodology, and structural characteristics.","operationId":"get_etf-global_v1_taxonomies","parameters":[{"description":"The date showing when ETF Global received and processed the data. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"processed_date.lte","schema":{"type":"string"}},{"description":"The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"effective_date.lte","schema":{"type":"string"}},{"description":"The stock ticker symbol used to identify this ETF product on exchanges.","in":"query","name":"composite_ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"composite_ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"composite_ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"composite_ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"composite_ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"composite_ticker.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'.","in":"query","name":"limit","schema":{"default":100,"maximum":5001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'composite_ticker' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"composite_ticker.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"asset_class":"Equity","category":"Size and Style","composite_ticker":"SPY","country":"U.S.","description":"SPDR S\u0026P 500 ETF Trust","development_class":"Developed Markets","effective_date":"2025-09-19","exposure_mechanism":"Blended Replication","factor":"Size","focus":"Large Cap","holdings_disclosure_frequency":"Daily","inception_date":"1993-01-22","isin":"US78462F1030","issuer":"SSgA","leverage_style":"unleveraged","levered_amount":0,"management_classification":"passive","management_style":"Passive - Representative Sampling","objective":"Index-Tracking","primary_benchmark":"S\u0026P 500 Index","processed_date":"2025-09-19","product_type":"etf","rebalance_frequency":"Quarterly","reconstitution_frequency":"Quarterly","region":"North America","selection_methodology":"Modified Market Cap, Fundamental Multifactor, Liquidity","selection_universe":"U.S. Large Caps","strategic_focus":"Factor","targeted_focus":"Size","tax_classification":"Regulated Investment Company","us_code":"78462F103","weighting_methodology":"Modified Market Capitalization-Weighted"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"asset_class":{"description":"The primary type of assets held by the ETF, such as equities, bonds, commodities, or other securities.","type":"string"},"category":{"description":"The broad investment category that describes the ETF's investment focus and strategy.","type":"string"},"composite_ticker":{"description":"The stock ticker symbol used to identify this ETF product on exchanges.","type":"string"},"country":{"description":"The specific country focus of the ETF, if applicable.","type":"string"},"credit_quality_rating":{"description":"Credit quality rating for fixed income ETFs.","type":"string"},"description":{"description":"The official name and description of the ETF product.","type":"string"},"development_class":{"description":"The economic development classification of the markets the ETF invests in, such as developed, emerging, or frontier markets.","type":"string"},"duration":{"description":"The duration characteristics for fixed income ETFs.","type":"string"},"effective_date":{"description":"The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date.","format":"date","type":"string"},"esg":{"description":"Environmental, Social, and Governance characteristics.","type":"string"},"exposure_mechanism":{"description":"The mechanism used to achieve exposure.","type":"string"},"factor":{"description":"Factor exposure characteristics of the ETF.","type":"string"},"focus":{"description":"The specific investment focus or exposure that the ETF provides, such as sector, geography, or investment style.","type":"string"},"hedge_reset":{"description":"The frequency of hedge reset, if applicable.","type":"string"},"holdings_disclosure_frequency":{"description":"How frequently holdings are disclosed.","type":"string"},"inception_date":{"description":"The date when this ETF was first launched and became available for trading.","format":"date","type":"string"},"isin":{"description":"The International Securities Identification Number, a global standard code for uniquely identifying this ETF worldwide.","type":"string"},"issuer":{"description":"The financial institution or fund company that created and sponsors this ETF.","type":"string"},"leverage_reset":{"description":"The frequency of leverage reset, if applicable.","type":"string"},"leverage_style":{"description":"Indicates whether the ETF uses leverage to amplify returns ('leveraged'), or does not use leverage ('unleveraged').","type":"string"},"levered_amount":{"description":"The leverage multiplier applied by the ETF, where positive numbers indicate leveraged exposure and negative numbers indicate inverse exposure.","format":"double","type":"number"},"management_classification":{"description":"Defines whether an ETF is considered active under SEC rules, with managers making investment decisions, or passive, tracking an index.","type":"string"},"management_style":{"description":"Indicates whether an ETF is managed actively or passively, and the level of transparency or replication method used.","type":"string"},"maturity":{"description":"The maturity profile for fixed income ETFs.","type":"string"},"objective":{"description":"The primary investment objective of the ETF.","type":"string"},"primary_benchmark":{"description":"The main index or benchmark that this ETF is designed to track or replicate.","type":"string"},"processed_date":{"description":"The date showing when ETF Global received and processed the data.","format":"date","type":"string"},"product_type":{"description":"Indicates whether the product is an Exchange-Traded Note ('etn') or an Exchange-Traded Fund ('etf').","type":"string"},"rebalance_frequency":{"description":"How frequently the ETF rebalances its holdings.","type":"string"},"reconstitution_frequency":{"description":"How frequently the index is reconstituted.","type":"string"},"region":{"description":"The geographic region or area of the world where the ETF concentrates its investments.","type":"string"},"secondary_objective":{"description":"The secondary investment objective, if applicable.","type":"string"},"selection_methodology":{"description":"The methodology used to select securities.","type":"string"},"selection_universe":{"description":"The universe from which securities are selected.","type":"string"},"strategic_focus":{"description":"The strategic investment focus of the ETF.","type":"string"},"targeted_focus":{"description":"The targeted investment focus of the ETF.","type":"string"},"tax_classification":{"description":"The tax structure of the ETF, determining whether investors receive 1099 or K1 tax forms (RIC, Partnership, or UIT).","type":"string"},"us_code":{"description":"A unique identifier code that identifies this ETF in US markets.","type":"string"},"weighting_methodology":{"description":"The methodology used to weight holdings.","type":"string"}},"required":["product_type","leverage_style","management_classification"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["etfglobal"]}},"/fed/v1/inflation":{"get":{"description":"A table tracking inflation and price indices, including Consumer Price Index (CPI) and Personal Consumption Expenditures (PCE) metrics over time.","operationId":"get_fed_v1_inflation","parameters":[{"description":"Calendar date of the observation (YYYY‑MM‑DD).","in":"query","name":"date","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"date.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"date.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"date.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"date.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"cpi":310.45,"cpi_core":320.1,"cpi_year_over_year":3.18,"date":"2025-06-01","pce":132.73,"pce_core":131.9,"pce_spending":20345.6}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"cpi":{"description":"Consumer Price Index (CPI) for All Urban Consumers — a standard measure of headline inflation based on a fixed basket of goods and services, not seasonally adjusted.","format":"float","type":"number"},"cpi_core":{"description":"Core Consumer Price Index — the CPI excluding food and energy, used to understand underlying inflation trends without short-term volatility.","format":"float","type":"number"},"cpi_year_over_year":{"description":"Year-over-year percentage change in the headline CPI — the most commonly cited inflation rate in public discourse and economic policy.","format":"float","type":"number"},"date":{"description":"Calendar date of the observation (YYYY‑MM‑DD).","type":"string"},"pce":{"description":"Personal Consumption Expenditures (PCE) Price Index — a broader measure of inflation used by the Federal Reserve, reflecting actual consumer spending patterns and updated basket weights.","format":"float","type":"number"},"pce_core":{"description":"Core PCE Price Index — excludes food and energy prices from the PCE index, and is the Fed's preferred measure of underlying inflation.","format":"float","type":"number"},"pce_spending":{"description":"Nominal Personal Consumption Expenditures — total dollar value of consumer spending in the U.S. economy, reported in billions of dollars and not adjusted for inflation.","format":"float","type":"number"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["fed"]}},"/fed/v1/inflation-expectations":{"get":{"description":"A table tracking inflation expectations from both market-based and economic model perspectives across different time horizons.","operationId":"get_fed_v1_inflation-expectations","parameters":[{"description":"Calendar date of the observation (YYYY‑MM‑DD).","in":"query","name":"date","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"date.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"date.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"date.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"date.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"date":"2025-06-17","forward_years_5_to_10":2.6,"market_10_year":2.36,"market_5_year":2.12,"model_10_year":2.95,"model_1_year":2.85,"model_30_year":3,"model_5_year":2.91}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"date":{"description":"Calendar date of the observation (YYYY‑MM‑DD).","type":"string"},"forward_years_5_to_10":{"description":"5-Year, 5-Year Forward Inflation Expectation Rate — the market's expectation of average annual inflation for the 5-year period beginning 5 years from now, based on the spread between forward nominal and real yields.","format":"float","type":"number"},"market_10_year":{"description":"10-Year Breakeven Inflation Rate — the market's expectation of average annual inflation over the next 10 years, based on the spread between 10-year nominal Treasury yields and 10-year TIPS yields.","format":"float","type":"number"},"market_5_year":{"description":"5-Year Breakeven Inflation Rate — the market's expectation of average annual inflation over the next 5 years, based on the spread between 5-year nominal Treasury yields and 5-year TIPS yields.","format":"float","type":"number"},"model_10_year":{"description":"The Cleveland Fed’s 10-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys.","format":"float","type":"number"},"model_1_year":{"description":"The Cleveland Fed’s 1-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys.","format":"float","type":"number"},"model_30_year":{"description":"The Cleveland Fed’s 30-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys.","format":"float","type":"number"},"model_5_year":{"description":"The Cleveland Fed’s 5-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys.","format":"float","type":"number"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["fed"]}},"/fed/v1/labor-market":{"get":{"description":"Labor market indicators from the Federal Reserve, including unemployment rate, labor force participation, average hourly earnings, and job openings data.","operationId":"get_fed_v1_labor-market","parameters":[{"description":"Calendar date of the observation (YYYY-MM-DD).","in":"query","name":"date","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"date.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"date.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"date.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"date.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"avg_hourly_earnings":35.06,"date":"2024-12-01","job_openings":8098,"labor_force_participation_rate":62.5,"unemployment_rate":4.2}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"avg_hourly_earnings":{"description":"Average hourly earnings of all employees on private nonfarm payrolls in USD (CES0500000003 series from FRED).","format":"float","type":"number"},"date":{"description":"Calendar date of the observation (YYYY-MM-DD).","type":"string"},"job_openings":{"description":"Total nonfarm job openings in thousands (JTSJOL series from FRED).","format":"float","type":"number"},"labor_force_participation_rate":{"description":"Civilian labor force participation rate as a percentage of the civilian noninstitutional population (CIVPART series from FRED).","format":"float","type":"number"},"unemployment_rate":{"description":"Civilian unemployment rate as a percentage of the labor force (UNRATE series from FRED).","format":"float","type":"number"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["fed"]}},"/fed/v1/treasury-yields":{"get":{"description":"A record of U.S. Treasury bond yields across various maturity periods, tracking historical interest rates from short-term to long-term government securities.","operationId":"get_fed_v1_treasury-yields","parameters":[{"description":"Calendar date of the yield observation (YYYY-MM-DD).","in":"query","name":"date","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"date.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"date.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"date.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"date.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"date":"1962-01-02","yield_10_year":4.06,"yield_1_year":3.22,"yield_5_year":3.88}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"date":{"description":"Calendar date of the yield observation (YYYY-MM-DD).","type":"string"},"yield_10_year":{"description":"Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Quoted on an Investment Basis","format":"float","type":"number"},"yield_1_month":{"description":"Market Yield on U.S. Treasury Securities at 1-Month Constant Maturity, Quoted on an Investment Basis","format":"float","type":"number"},"yield_1_year":{"description":"Market Yield on U.S. Treasury Securities at 1-Year Constant Maturity, Quoted on an Investment Basis","format":"float","type":"number"},"yield_20_year":{"description":"Market Yield on U.S. Treasury Securities at 20-Year Constant Maturity, Quoted on an Investment Basis","format":"float","type":"number"},"yield_2_year":{"description":"Market Yield on U.S. Treasury Securities at 2-Year Constant Maturity, Quoted on an Investment Basis","format":"float","type":"number"},"yield_30_year":{"description":"Market Yield on U.S. Treasury Securities at 30-Year Constant Maturity, Quoted on an Investment Basis","format":"float","type":"number"},"yield_3_month":{"description":"Market Yield on U.S. Treasury Securities at 3-Month Constant Maturity, Quoted on an Investment Basis","format":"float","type":"number"},"yield_3_year":{"description":"Market Yield on U.S. Treasury Securities at 3-Year Constant Maturity, Quoted on an Investment Basis","format":"float","type":"number"},"yield_5_year":{"description":"Market Yield on U.S. Treasury Securities at 5-Year Constant Maturity, Quoted on an Investment Basis","format":"float","type":"number"},"yield_6_month":{"description":"Market Yield on U.S. Treasury Securities at 6-Month Constant Maturity, Quoted on an Investment Basis","format":"float","type":"number"},"yield_7_year":{"description":"Market Yield on U.S. Treasury Securities at 7-Year Constant Maturity, Quoted on an Investment Basis","format":"float","type":"number"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["fed"]}},"/forex/v1/exchanges":{"get":{"description":"Global foreign exchange (FX) trading venues and market infrastructure, including electronic trading platforms, banks, and other institutions facilitating currency pair trading worldwide.","operationId":"get_forex_v1_exchanges","parameters":[{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '999'.","in":"query","name":"limit","schema":{"default":100,"maximum":1000,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"id":"48","name":"Currency Banks 1","type":"exchange"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"id":{"description":"Numeric identifier for the forex trading venue or institution.","type":"string"},"name":{"description":"Full name of the foreign exchange trading venue, platform, or financial institution.","type":"string"},"type":{"description":"Type of forex venue - 'exchange' for electronic trading platforms and institutional trading venues.","type":"string"}},"required":["id","type","name"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["global_forex"]}},"/futures/v1/aggs/{ticker}":{"get":{"description":"Get aggregates for a contract in a given time range.","operationId":"AggregatesV1","parameters":[{"description":"The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).","example":"GCJ5","in":"path","name":"ticker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"The size of each aggregate candle, specified as a number followed by a unit: `sec`, `min`, `hour`, `session`, `week`, `month`, `quarter`, or `year`.\n\nEach unit has a maximum multiplier. For instance, minute candles go up to `59min` — after that, use `1hour`. Requesting an unsupported size returns a `400 Bad Request`.","example":"1min","in":"query","name":"resolution","schema":{"default":"1session","type":"string"}},{"description":"Filter by the start time of each candle. Accepts a `YYYY-MM-DD` date or a nanosecond Unix timestamp. The value is snapped to the start of the matching candle interval.\n\nWhen omitted, the API returns the most recent candles up to `limit`.\n\nUse comparison suffixes to query a range:\n- `window_start.gte` — greater than or equal to\n- `window_start.gt` — greater than\n- `window_start.lte` — less than or equal to\n- `window_start.lt` — less than\n\n**Examples**\n- Most recent minute candles: `/v1/aggs/ESU5?resolution=1min\u0026limit=5`\n- Single daily candle: `/v1/aggs/ESU5?resolution=1session\u0026window_start=2025-08-05`\n- Date range: `/v1/aggs/ESU5?resolution=1session\u0026window_start.gte=2025-07-01\u0026window_start.lte=2025-07-31`\n- After a timestamp: `/v1/aggs/ESU5?resolution=1sec\u0026window_start.gt=1751409877000000000\u0026limit=1000`","in":"query","name":"window_start","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The number of results to return per page (default=1000, maximum=50000, minimum=1).","in":"query","name":"limit","schema":{"default":1000,"maximum":50000,"minimum":1,"type":"integer"}},{"description":"Range by window_start.","in":"query","name":"window_start.gte","schema":{"type":"string"}},{"description":"Range by window_start.","in":"query","name":"window_start.gt","schema":{"type":"string"}},{"description":"Range by window_start.","in":"query","name":"window_start.lte","schema":{"type":"string"}},{"description":"Range by window_start.","in":"query","name":"window_start.lt","schema":{"type":"string"}},{"description":"Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').","in":"query","name":"sort","schema":{"default":"window_start.desc","enum":["window_start.asc","window_start.desc"],"example":"window_start.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"b452e45b7eaad14151c3e1ce5129b558","results":[{"close":2874.2,"dollar_volume":380560636.01,"high":2877.1,"low":2837.4,"open":2849.8,"session_end_date":"2025-02-04","settlement_price":2875.8,"ticker":"GCJ5","transactions":74223,"volume":133072,"window_start":1738627200000000000},{"close":2884.8,"dollar_volume":448429944.1,"high":2906,"low":2870.1,"open":2873.7,"session_end_date":"2025-02-05","settlement_price":2893,"ticker":"GCJ5","transactions":83673,"volume":155170,"window_start":1738713600000000000}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, the URL to the next page of results.","type":"string"},"results":{"items":{"properties":{"close":{"description":"The last price within the timeframe.","format":"double","type":"number"},"dollar_volume":{"description":"The total dollar volume of the transactions that occurred within the timeframe.","format":"double","type":"number"},"high":{"description":"The highest price within the timeframe.","format":"double","type":"number"},"low":{"description":"The lowest price within the timeframe.","format":"double","type":"number"},"open":{"description":"The opening price within the timeframe.","format":"double","type":"number"},"session_end_date":{"description":"Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.","type":"string"},"settlement_price":{"description":"The price the contract would have cost to settle for this session.","format":"double","type":"number"},"ticker":{"description":"The ticker for the contract.","type":"string"},"transactions":{"description":"The number of transactions that occurred within the timeframe.","format":"int64","type":"integer"},"volume":{"description":"The number of contracts that traded within the timeframe.","format":"int64","type":"integer"},"window_start":{"description":"The timestamp of the beginning of the candlestick’s aggregation window.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}}},"required":["ticker","window_start","session_end_date","open","high","low","close","transactions","volume","dollar_volume"],"type":"object"},"type":"array"},"status":{"description":"The status of the response.","type":"string"}},"required":["status","results"],"type":"object"}}},"description":"A list of aggregates."}},"summary":"Aggregates","tags":["futures:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Futures data","name":"futures"}}},"/futures/v1/contracts":{"get":{"description":"The Contracts API provides a single source for discovering all listed futures contracts and retrieving complete contract specifications. You can query the full contract index with filters for product code, trade dates, active status, and date, returning key attributes such as ticker, first and last trade dates, days to maturity, exchange code, and order quantity limits in paginated form. The same API also returns the full specification for a single contract, including settlement dates, tick sizes, and other trading and risk related fields. Point-in-time lookups allow you to reconstruct the exact contract definition that applied on any given day.\n\nUse Cases: Historical research, trading system integration, portfolio workflows, risk management.","operationId":"get_futures_v1_contracts","parameters":[{"description":"A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about contracts for the specified day. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.lte","schema":{"type":"string"}},{"description":"The identifier for the contract's product.","in":"query","name":"product_code","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"product_code.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"product_code.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"product_code.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"product_code.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"product_code.lte","schema":{"type":"string"}},{"description":"The ticker for the contract.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Whether or not a given contract was tradeable at the given point in time. Active is true when (first_trade_date \u003c= date \u003e= last_trade_date) and false otherwise.","in":"query","name":"active","schema":{"type":"boolean"}},{"description":"The type of contract, one of 'single' or 'combo'. Leaving this filter blank will query for contracts where type is 'single', 'combo' or empty. This field only exists on contracts as of 2025-03-12 and later. It will be null when date \u003c 2025-03-12.","in":"query","name":"type","schema":{"enum":["single","combo"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"type.any_of","schema":{"enum":["single","combo"],"type":"string"}},{"description":"The first day on which the contract was tradeable. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"first_trade_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"first_trade_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"first_trade_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"first_trade_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"first_trade_date.lte","schema":{"type":"string"}},{"description":"The last day on which the contract was tradeable. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"last_trade_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"last_trade_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"last_trade_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"last_trade_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"last_trade_date.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '1000'.","in":"query","name":"limit","schema":{"default":100,"maximum":1001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'product_code' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"product_code.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/futures/vX/contracts?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"000a000a0a0a000a0a0aa00a0a0000a0","results":[{"active":true,"date":"2025-02-26","days_to_maturity":138,"first_trade_date":"2025-01-15","group_code":"CN","last_trade_date":"2025-07-14","max_order_quantity":1999,"min_order_quantity":1,"name":"00CN5 Future","product_code":"00C","settlement_date":"2025-07-14","settlement_tick_size":0.0025,"spread_tick_size":0.0025,"ticker":"00CN5","trade_tick_size":0.0025,"trading_venue":"XCBT","type":"single"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"active":{"description":"Whether or not a given contract was tradeable at the given point in time. Active is true when (first_trade_date \u003c= date \u003e= last_trade_date) and false otherwise.","type":"boolean"},"date":{"description":"A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about contracts for the specified day.","format":"date","type":"string"},"days_to_maturity":{"description":"The number of calendar days between the 'date' and the contract's final settlement date.","format":"int64","type":"integer"},"first_trade_date":{"description":"The first day on which the contract was tradeable.","format":"date","type":"string"},"group_code":{"description":"An identifier used to identify logical groups of products. The group_code is only populated for contracts listed for trading on CME Globex.","type":"string"},"last_trade_date":{"description":"The last day on which the contract was tradeable.","format":"date","type":"string"},"max_order_quantity":{"description":"The maximum order quantity.","format":"int64","type":"integer"},"min_order_quantity":{"description":"The minimum order quantity.","format":"int64","type":"integer"},"name":{"description":"The name of this contract.","type":"string"},"product_code":{"description":"The identifier for the contract's product.","type":"string"},"settlement_date":{"description":"The date on which this contract settles.","format":"date","type":"string"},"settlement_tick_size":{"description":"The tick size for settlement.","format":"double","type":"number"},"spread_tick_size":{"description":"The tick size for spreads.","format":"double","type":"number"},"ticker":{"description":"The ticker for the contract.","type":"string"},"trade_tick_size":{"description":"The tick size for trades.","format":"double","type":"number"},"trading_venue":{"description":"The trading venue (MIC) for the exchange on which this contract trades.","type":"string"},"type":{"description":"The type of contract, one of 'single' or 'combo'. Leaving this filter blank will query for contracts where type is 'single', 'combo' or empty. This field only exists on contracts as of 2025-03-12 and later. It will be null when date \u003c 2025-03-12.","type":"string"}},"required":["active","date"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"summary":"futures contracts API","tags":["us_futures"]}},"/futures/v1/exchanges":{"get":{"description":"US futures exchanges and trading venues including major derivatives exchanges (CME, CBOT, NYMEX, COMEX) and other futures market infrastructure for commodity, financial, and other derivative contract trading.","operationId":"get_futures_v1_exchanges","parameters":[{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '999'.","in":"query","name":"limit","schema":{"default":100,"maximum":1000,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"acronym":"CME","id":"4","locale":"US","mic":"XCME","name":"Chicago Mercantile Exchange","operating_mic":"XCME","type":"exchange","url":"https://cmegroup.com"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"acronym":{"description":"Well-known acronym for the exchange (e.g., 'CME', 'NYMEX', 'CBOT', 'COMEX').","type":"string"},"id":{"description":"Numeric identifier for the futures exchange or trading venue.","type":"string"},"locale":{"description":"Geographic location code where the exchange operates.","type":"string"},"mic":{"description":"Market Identifier Code (MIC) - ISO 10383 standard four-character code for the futures market.","type":"string"},"name":{"description":"Full official name of the futures exchange (e.g., 'Chicago Mercantile Exchange', 'New York Mercantile Exchange').","type":"string"},"operating_mic":{"description":"Operating Market Identifier Code for the futures exchange.","type":"string"},"type":{"description":"Type of venue - 'exchange' for futures exchanges and derivatives trading platforms.","type":"string"},"url":{"description":"Official website URL of the futures exchange organization.","type":"string"}},"required":["id","type","name"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["us_futures"]}},"/futures/v1/market-status":{"get":{"description":"Retrieve the current market status for a specific product or products. This endpoint returns real-time indicators, such as open, pause, close, for futures products, along with the corresponding exchange and product codes and an evaluation timestamp. This information enables users to monitor operational conditions and adjust their trading strategies accordingly.\n\nUse Cases: Real-time monitoring, algorithm scheduling, UI updates, operational planning.","operationId":"get_futures_v1_market-status","parameters":[{"description":"The product code of the futures contracts for which you want statuses.","in":"query","name":"product_code","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"product_code.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"product_code.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"product_code.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"product_code.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"product_code.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '99'.","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"445ebfcfe5bb4b688b7971e1600c952d","results":[{"market_event":"open","name":"ERCOT North 345 kV Hub Day-Ahead 5 MW Off-Peak Futures","product_code":"ERL","session_end_date":"2025-12-05","timestamp":"2025-12-04T23:00:00+00:00","trading_venue":"XNYM"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"market_event":{"description":"The current status of the market for the product.","type":"string"},"name":{"description":"The name of the futures product.","type":"string"},"product_code":{"description":"The product code of the futures contracts for which you want statuses.","type":"string"},"session_end_date":{"description":"The trading date for the current session.","format":"date","type":"string"},"timestamp":{"description":"The timestamp for the given market event.","type":"string"},"trading_venue":{"description":"The trading venue (MIC) for the exchange on which the corresponding product trades.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"summary":"Market Status API","tags":["us_futures"]}},"/futures/v1/products":{"get":{"description":"The Products API is a unified source for discovering all supported futures products and retrieving full product specifications. It returns the complete product universe with product codes, names, exchange identifiers, sector and asset class classifications, product type, settlement method, and pricing and quotation details. You can filter by name, exchange, sector, asset class, product type, or date to capture the product set or product definition that existed at a specific point in time. It also retrieves the full specification for a single product, supporting accurate system configuration, analytics, trading workflows, and historical reconciliation.\n\nUse Cases: Product specification, historical product checks, risk management, trading system integration.","operationId":"get_futures_v1_products","parameters":[{"description":"The full name of the product.","in":"query","name":"name","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"name.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"name.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"name.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"name.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"name.lte","schema":{"type":"string"}},{"description":"The identifier for the product.","in":"query","name":"product_code","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"product_code.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"product_code.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"product_code.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"product_code.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"product_code.lte","schema":{"type":"string"}},{"description":"A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.lte","schema":{"type":"string"}},{"description":"The trading venue (MIC) for the exchange on which this product's contracts trade.","in":"query","name":"trading_venue","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"trading_venue.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"trading_venue.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"trading_venue.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"trading_venue.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"trading_venue.lte","schema":{"type":"string"}},{"description":"The sector to which the product belongs.","in":"query","name":"sector","schema":{"enum":["asia","base","biofuels","coal","cross_rates","crude_oil","custom_index","dairy","dj_ubs_ci","electricity","emissions","europe","fertilizer","forestry","grains_and_oilseeds","intl_index","liq_nat_gas_lng","livestock","long_term_gov","long_term_non_gov","majors","minors","nat_gas","nat_gas_liq_petro","precious","refined_products","s_and_p_gsci","sel_sector_index","short_term_gov","short_term_non_gov","softs","us","us_index","wet_bulk"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"sector.any_of","schema":{"enum":["asia","base","biofuels","coal","cross_rates","crude_oil","custom_index","dairy","dj_ubs_ci","electricity","emissions","europe","fertilizer","forestry","grains_and_oilseeds","intl_index","liq_nat_gas_lng","livestock","long_term_gov","long_term_non_gov","majors","minors","nat_gas","nat_gas_liq_petro","precious","refined_products","s_and_p_gsci","sel_sector_index","short_term_gov","short_term_non_gov","softs","us","us_index","wet_bulk"],"type":"string"}},{"description":"The sub-sector to which the product belongs.","in":"query","name":"sub_sector","schema":{"enum":["asian","canadian","cat","cooling_degree_days","ercot","european","gulf","heating_degree_days","iso_ne","large_cap_index","mid_cap_index","miso","north_american","nyiso","pjm","small_cap_index","west","western_power"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"sub_sector.any_of","schema":{"enum":["asian","canadian","cat","cooling_degree_days","ercot","european","gulf","heating_degree_days","iso_ne","large_cap_index","mid_cap_index","miso","north_american","nyiso","pjm","small_cap_index","west","western_power"],"type":"string"}},{"description":"The asset class to which the product belongs.","in":"query","name":"asset_class","schema":{"enum":["alt_investment","commodity","financials"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"asset_class.any_of","schema":{"enum":["alt_investment","commodity","financials"],"type":"string"}},{"description":"The asset sub-class to which the product belongs.","in":"query","name":"asset_sub_class","schema":{"enum":["agricultural","commodity_index","energy","equity","foreign_exchange","freight","housing","interest_rate","metals","weather"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"asset_sub_class.any_of","schema":{"enum":["agricultural","commodity_index","energy","equity","foreign_exchange","freight","housing","interest_rate","metals","weather"],"type":"string"}},{"description":"The type of product, one of 'single' or 'combo'. Leaving this filter blank will query for both 'single' and 'combo' types.","in":"query","name":"type","schema":{"enum":["single","combo"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"type.any_of","schema":{"enum":["single","combo"],"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"date.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/futures/vX/products?cursor=YXA9MTAwJmFzPSZhc19vZj0yMDI1LTA3LTA3JmxpbWl0PTEwMCZzb3J0PW5hbWUuYXNj","request_id":"000a000a0a0a000a0a0aa00a0a0000a0","results":[{"asset_class":"commodity","asset_sub_class":"energy","date":"2025-07-07","last_updated":"2025-02-22","name":"1% Fuel Oil Barges FOB Rdam (Platts) vs. 1% Fuel Oil Cargoes FOB NWE (Platts) BALMO Futures","price_quotation":"U.S. dollars and cents per metric ton","product_code":"EBE","sector":"refined_products","settlement_currency_code":"USD","settlement_method":"financially_settled","settlement_type":"cash","sub_sector":"european","trade_currency_code":"USD","trading_venue":"XNYM","type":"single","unit_of_measure":"MTONS","unit_of_measure_qty":1000}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"asset_class":{"description":"The asset class to which the product belongs.","type":"string"},"asset_sub_class":{"description":"The asset sub-class to which the product belongs.","type":"string"},"date":{"description":"A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day.","format":"date","type":"string"},"last_updated":{"description":"The date and time at which this product was last updated.","format":"date-time","type":"string"},"name":{"description":"The full name of the product.","type":"string"},"price_quotation":{"description":"The quoted price for this product.","type":"string"},"product_code":{"description":"The identifier for the product.","type":"string"},"sector":{"description":"The sector to which the product belongs.","type":"string"},"settlement_currency_code":{"description":"The currency in which this product settles.","type":"string"},"settlement_method":{"description":"The method of settlement for this product (Financially Settled or Deliverable).","type":"string"},"settlement_type":{"description":"The type of settlement for this product.","type":"string"},"sub_sector":{"description":"The sub-sector to which the product belongs.","type":"string"},"trade_currency_code":{"description":"The currency in which this product's contracts trade.","type":"string"},"trading_venue":{"description":"The trading venue (MIC) for the exchange on which this product's contracts trade.","type":"string"},"type":{"description":"The type of product, one of 'single' or 'combo'. Leaving this filter blank will query for both 'single' and 'combo' types.","type":"string"},"unit_of_measure":{"description":"The unit of measure for this product.","type":"string"},"unit_of_measure_qty":{"description":"The quantity of the unit of measure for this product.","format":"double","type":"number"}},"required":["date"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"summary":"Futures Products API","tags":["us_futures"]}},"/futures/v1/quotes/{ticker}":{"get":{"description":"Retrieve quote data for a specified futures contract ticker. Each record includes the best bid and offer prices, sizes, and timestamps, reflecting the prevailing quote environment at each moment. This endpoint supports detailed analysis of price dynamics and liquidity conditions to inform trading decisions and market research.\n\nUse Cases: Liquidity analysis, price discovery, trading strategy refinement, market research.","operationId":"get_futures_v1_quotes","parameters":[{"description":"The time when the quote was generated at the exchange to nanosecond precision. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.","in":"query","name":"session_end_date","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '49999'.","in":"query","name":"limit","schema":{"default":100,"maximum":50000,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'timestamp' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"timestamp.desc","type":"string"}},{"description":"The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).","in":"path","name":"ticker","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/futures/vX/quotes/GCJ5?cursor=YXA9MTczNDQ2MDIzMDcwODEyNjI4MSZhcz0mbGltaXQ9MTAwMCZzZXNzaW9uX2VuZF9kYXRlPTIwMjQtMTItMTcmc29ydD10aW1lc3RhbXAuZGVzYw","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":[{"ask_timestamp":"1734472800076125400,","bid_price":"2660,","bid_size":"1,","bid_timestamp":"1734472800076125400,","report_sequence":"2250337,","sequence_number":15357766,"session_end_date":"2024-12-17,","ticker":"GCJ5,","timestamp":"1734472800076125400,"},{"ask_price":"2685.9,","ask_size":"1,","ask_timestamp":"1734472755134391800,","bid_price":"2684.7,","bid_size":"1,","bid_timestamp":"1734472736352455200,","report_sequence":"2249723,","sequence_number":15354716,"session_end_date":"2024-12-17,","ticker":"GCJ5,","timestamp":"1734472755134391800,"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"ask_price":{"description":"The ask price is expressed per unit of the underlying asset, and you apply the contract multiplier to get the full contract value.","format":"double","type":"number"},"ask_size":{"description":"The quote size represents the number of futures contracts available at the given ask price.","format":"int32","type":"integer"},"ask_timestamp":{"description":"The time when the ask price was submitted to the exchange.","format":"int64","type":"integer"},"bid_price":{"description":"The bid price is expressed per unit of the underlying asset, and you apply the contract multiplier to get the full contract value.","format":"double","type":"number"},"bid_size":{"description":"The quote size represents the number of futures contracts available at the given bid price.","format":"int32","type":"integer"},"bid_timestamp":{"description":"The time when the bid price was submitted to the exchange.","format":"int64","type":"integer"},"channel":{"description":"The CME multicast channel this event was sourced from.","format":"int32","type":"integer"},"report_sequence":{"description":"The reporting sequence number.","format":"int64","type":"integer"},"sequence_number":{"description":"The unique sequence number assigned to this quote by the exchange.","format":"int64","type":"integer"},"session_end_date":{"description":"Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.","type":"string"},"ticker":{"description":"The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).","type":"string"},"timestamp":{"description":"The time when the quote was generated at the exchange to nanosecond precision.","format":"int64","type":"integer"}},"required":["ticker","timestamp","sequence_number","report_sequence","channel"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["us_futures"]}},"/futures/v1/schedules":{"get":{"description":"The Schedules API provides a unified way to retrieve trading schedules for futures markets, returning precise session open and close times, intraday breaks, and any adjustments for holidays or special events. You can filter schedules by session_end_date or retrieve the schedule for a single product using its product code. All times are returned in Coordinated Universal Time (UTC), making it straightforward to align trading, execution, and operational workflows across systems.\n\nUse Cases: Schedule planning, market analysis, strategy alignment, risk and operations management.","operationId":"get_futures_v1_schedules","parameters":[{"description":"The product code of the futures contract.","in":"query","name":"product_code","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"product_code.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"product_code.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"product_code.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"product_code.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"product_code.lte","schema":{"type":"string"}},{"description":"The session end date for the schedules (also known as the trading date). This field is optional and can be used to filter results by a specific session end date. If left blank, schedules for all dates will be returned. Note that trading sessions end at 5 PM Central Time, so a session ending at 5 PM CT on January 1st would have a session_end_date of 2025-01-01. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"session_end_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"session_end_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"session_end_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"session_end_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"session_end_date.lte","schema":{"type":"string"}},{"description":"The trading venue (MIC) for the exchange on which this schedule's product trades.","in":"query","name":"trading_venue","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"trading_venue.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"trading_venue.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"trading_venue.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"trading_venue.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"trading_venue.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '1000'.","in":"query","name":"limit","schema":{"default":10,"maximum":1001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'product_code' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"product_code.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.staging.massive.com/futures/vX/schedules?cursor=AQANA0VSTAIAAAEFAAEBAwACAQ0DRVJMAQ0ZMjAyNC0wNi0xMFQyMTowMDowMCswMDowMA==","request_id":"a83620d1ec6a4cd5b84ea669e377fd47","results":[{"event":"pre_open","product_code":"ERL","product_name":"ERCOT North 345 kV Hub Day-Ahead 5 MW Off-Peak Futures","session_end_date":"2024-06-10","timestamp":"2024-06-09T21:00:00+00:00","trading_venue":"XNYM"},{"event":"open","product_code":"ERL","product_name":"ERCOT North 345 kV Hub Day-Ahead 5 MW Off-Peak Futures","session_end_date":"2024-06-10","timestamp":"2024-06-09T22:00:00+00:00","trading_venue":"XNYM"},{"event":"close","product_code":"ERL","product_name":"ERCOT North 345 kV Hub Day-Ahead 5 MW Off-Peak Futures","session_end_date":"2024-06-10","timestamp":"2024-06-10T21:00:00+00:00","trading_venue":"XNYM"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"event":{"description":"The type of session on the given trading date.","type":"string"},"product_code":{"description":"The product code of the futures contract.","type":"string"},"product_name":{"description":"The name of the futures product to which this schedule applies.","type":"string"},"session_end_date":{"description":"The session end date for the schedules (also known as the trading date). This field is optional and can be used to filter results by a specific session end date. If left blank, schedules for all dates will be returned. Note that trading sessions end at 5 PM Central Time, so a session ending at 5 PM CT on January 1st would have a session_end_date of 2025-01-01.","format":"date","type":"string"},"timestamp":{"description":"The timestamp for the given market event.","type":"string"},"trading_venue":{"description":"The trading venue (MIC) for the exchange on which this schedule's product trades.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"summary":"Futures Schedules API","tags":["us_futures"]}},"/futures/v1/snapshot":{"get":{"description":"Retrieve a snapshot of the most recent futures contract data.","operationId":"get_futures_v1_snapshot","parameters":[{"description":"The code for the contracts' underlying product.","in":"query","name":"product_code","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"product_code.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"product_code.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"product_code.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"product_code.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"product_code.lte","schema":{"type":"string"}},{"description":"The futures contract identifier, including the base symbol and contract expiration (e.g., ESZ24 for the December 2024 S\u0026P 500 E-mini contract).","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'ticker' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"ticker.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"next_url":"https://api.massive.com/v1/futures/vX/snapshot?cursor=AQANAkNCBVNQ","request_id":"c4d50f4801874e30b63e674b844cf51f","results":[{"details":{"open_interest":112,"settlement_date":1753851600000000000},"last_minute":{"close":240.00000000000003,"high":240.00000000000003,"last_updated":1746045300000,"low":240.00000000000003,"open":240.00000000000003,"volume":5},"last_quote":{"ask":240.50000000000003,"ask_size":3,"ask_timestamp":1746036204386194000,"bid":239.50000000000003,"bid_size":2,"bid_timestamp":1746035747932118000,"last_updated":1746046798024234200},"last_trade":{"last_updated":1746045242858242600,"price":240.00000000000003,"size":5},"product_code":"CB","session":{"change":21.11,"change_percent":0.09622134,"close":240.00000000000003,"high":241.00000000000003,"low":240.00000000000003,"open":240.00000000000003,"previous_settlement":219.39,"settlement_price":240.50000000000003,"volume":55},"ticker":"CBN5"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"details":{"properties":{"product_code":{"type":"string"},"settlement_date":{"description":"The day that this contract is settled.","format":"date","type":"string"},"ticker":{"type":"string"}},"type":"object"},"last_minute":{"properties":{"close":{"description":"The price at the end of the minute bar.","format":"double","type":"number"},"high":{"description":"The highest price reached in the minute bar.","format":"double","type":"number"},"last_updated":{"description":"The timestamp indicating the most recent update to the minute bar.","format":"int64","type":"integer"},"low":{"description":"The lowest price reached in the minute bar.","format":"double","type":"number"},"open":{"description":"The opening price at the start of the minute bar.","format":"double","type":"number"},"timeframe":{"description":"The timeliness of the data as determined by your subscription. One of REAL-TIME or DELAYED.","type":"string"},"volume":{"description":"The number of contracts traded in the minute bar.","format":"double","type":"number"}},"type":"object"},"last_quote":{"properties":{"ask":{"description":"The lowest price a seller is willing to accept.","format":"double","type":"number"},"ask_size":{"description":"The number of contracts available at the ask price.","format":"int32","type":"integer"},"ask_timestamp":{"description":"The time when the best ask price was last updated.","format":"int64","type":"integer"},"bid":{"description":"The highest price a buyer is willing to pay.","format":"double","type":"number"},"bid_size":{"description":"The number of contracts available at the bid price.","format":"int32","type":"integer"},"bid_timestamp":{"description":"The time when the best bid price was last updated.","format":"int64","type":"integer"},"last_updated":{"description":"The time when the quote was generated at the exchange to nanosecond precision.","format":"int64","type":"integer"},"timeframe":{"description":"The timeliness of the data as determined by your subscription. One of REAL-TIME or DELAYED.","type":"string"}},"type":"object"},"last_trade":{"properties":{"last_updated":{"description":"The time when the trade was generated at the exchange to nanosecond precision.","format":"int64","type":"integer"},"price":{"description":"The price of the trade. This is the actual dollar value per whole contract of this trade. A trade of 100 contracts with a price of $2.00 would be worth a total dollar value of $200.00.","format":"double","type":"number"},"size":{"description":"The total number of contracts exchanged between buyers and sellers on a given trade.","format":"int64","type":"integer"},"timeframe":{"description":"The timeliness of the data as determined by your subscription. One of REAL-TIME or DELAYED.","type":"string"}},"type":"object"},"session":{"properties":{"change":{"description":"The change in price during this session.","format":"double","type":"number"},"change_percent":{"description":"The percentage change in price during this session.","format":"double","type":"number"},"close":{"description":"The price at the end of the session.","format":"double","type":"number"},"high":{"description":"The highest price reached in the session.","format":"double","type":"number"},"low":{"description":"The lowest price reached in the session.","format":"double","type":"number"},"open":{"description":"The opening price at the start of the session.","format":"double","type":"number"},"previous_settlement":{"description":"The settlement price of the previous session.","format":"double","type":"number"},"settlement_price":{"description":"The final settlement price at the end of the session.","format":"double","type":"number"},"volume":{"description":"The number of contracts traded in the session.","format":"double","type":"number"}},"type":"object"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"summary":"futures_snapshot_v1 API","tags":["us_futures"]}},"/futures/v1/trades/{ticker}":{"get":{"description":"Retrieve comprehensive, tick-level trade data for a specified futures contract ticker over a defined time range. Each record includes the trade price, size, session start date, and precise timestamps, capturing individual trade events throughout the period. This granular data is essential for constructing aggregated bars and performing detailed analyses of intraday price movements, making it a valuable tool for backtesting, algorithmic strategy development, and market research.\n\nUse Cases: Intraday analysis, algorithmic trading, backtesting, market research.","operationId":"get_futures_v1_trades","parameters":[{"description":"The time when the trade was generated at the exchange to nanosecond precision. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.","in":"query","name":"session_end_date","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '49999'.","in":"query","name":"limit","schema":{"default":10,"maximum":50000,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'timestamp' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"timestamp.desc","type":"string"}},{"description":"The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).","in":"path","name":"ticker","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/futures/vX/trades/ESZ4?cursor=YXA9MTczNDQ3MDk3MDAwODU5OTI2MSZhcz0yNzIzNTI4MyZsaW1pdD0xMDAwJnNlc3Npb25fZW5kX2RhdGU9MjAyNC0xMi0xNyZzb3J0PXRpbWVzdGFtcC5kZXNj","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":[{"price":6052,"report_sequence":12033289,"sequence_number":27317882,"session_end_date":"2024-12-17","size":3,"ticker":"ESZ4","timestamp":1734472799000509200},{"price":6051.75,"report_sequence":12033276,"sequence_number":27317863,"session_end_date":"2024-12-17","size":1,"ticker":"ESZ4","timestamp":1734472798789679900},{"price":6052,"report_sequence":12033255,"sequence_number":27317826,"session_end_date":"2024-12-17","size":2,"ticker":"ESZ4","timestamp":1734472797000893000}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"channel":{"description":"The CME multicast channel this event was sourced from.","format":"int32","type":"integer"},"price":{"description":"The price of the trade. This is the actual dollar value per whole contract of this trade. A trade of 100 contracts with a price of $2.00 would be worth a total dollar value of $200.00.","format":"double","type":"number"},"report_sequence":{"description":"The reporting sequence number.","format":"int64","type":"integer"},"sequence_number":{"description":"The unique sequence number assigned to this trade.","format":"int64","type":"integer"},"session_end_date":{"description":"Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.","type":"string"},"size":{"description":"The total number of contracts exchanged between buyers and sellers on a given trade.","format":"int64","type":"integer"},"ticker":{"description":"The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).","type":"string"},"timestamp":{"description":"The time when the trade was generated at the exchange to nanosecond precision.","format":"int64","type":"integer"}},"required":["ticker","timestamp","sequence_number","report_sequence","channel"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["us_futures"]}},"/futures/vX/aggs/{ticker}":{"get":{"description":"Get aggregates for a contract in a given time range.","operationId":"Aggregates","parameters":[{"description":"The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).","example":"GCJ5","in":"path","name":"ticker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"The size of each aggregate candle, specified as a number followed by a unit: `sec`, `min`, `hour`, `session`, `week`, `month`, `quarter`, or `year`. \n\nEach unit has a maximum multiplier. For instance, minute candles go up to `59min` — after that, use `1hour`. Requesting an unsupported size returns a `400 Bad Request`.","example":"1min","in":"query","name":"resolution","schema":{"default":"1session","type":"string"}},{"description":"Filter by the start time of each candle. Accepts a `YYYY-MM-DD` date or a nanosecond Unix timestamp. The value is snapped to the start of the matching candle interval.\n\nWhen omitted, the API returns the most recent candles up to `limit`.\n\nUse comparison suffixes to query a range:\n- `window_start.gte` — greater than or equal to\n- `window_start.gt` — greater than\n- `window_start.lte` — less than or equal to\n- `window_start.lt` — less than\n\n**Examples**\n- Most recent minute candles: `/vX/aggs/ESU5?resolution=1min\u0026limit=5`\n- Single daily candle: `/vX/aggs/ESU5?resolution=1session\u0026window_start=2025-08-05`\n- Date range: `/vX/aggs/ESU5?resolution=1session\u0026window_start.gte=2025-07-01\u0026window_start.lte=2025-07-31`\n- After a timestamp: `/vX/aggs/ESU5?resolution=1sec\u0026window_start.gt=1751409877000000000\u0026limit=1000`","in":"query","name":"window_start","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The number of results to return per page (default=1000, maximum=50000, minimum=1).","in":"query","name":"limit","schema":{"default":1000,"maximum":50000,"minimum":1,"type":"integer"}},{"description":"Range by window_start.","in":"query","name":"window_start.gte","schema":{"type":"string"}},{"description":"Range by window_start.","in":"query","name":"window_start.gt","schema":{"type":"string"}},{"description":"Range by window_start.","in":"query","name":"window_start.lte","schema":{"type":"string"}},{"description":"Range by window_start.","in":"query","name":"window_start.lt","schema":{"type":"string"}},{"description":"Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').","in":"query","name":"sort","schema":{"default":"window_start.desc","enum":["window_start.asc","window_start.desc"],"example":"window_start.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"b452e45b7eaad14151c3e1ce5129b558","results":[{"close":2874.2,"dollar_volume":380560636.01,"high":2877.1,"low":2837.4,"open":2849.8,"session_end_date":"2025-02-04","settlement_price":2875.8,"ticker":"GCJ5","transactions":74223,"volume":133072,"window_start":1738627200000000000},{"close":2884.8,"dollar_volume":448429944.1,"high":2906,"low":2870.1,"open":2873.7,"session_end_date":"2025-02-05","settlement_price":2893,"ticker":"GCJ5","transactions":83673,"volume":155170,"window_start":1738713600000000000}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, the URL to the next page of results.","type":"string"},"results":{"items":{"properties":{"close":{"description":"The last price within the timeframe.","format":"double","type":"number"},"dollar_volume":{"description":"The total dollar volume of the transactions that occurred within the timeframe.","format":"double","type":"number"},"high":{"description":"The highest price within the timeframe.","format":"double","type":"number"},"low":{"description":"The lowest price within the timeframe.","format":"double","type":"number"},"open":{"description":"The opening price within the timeframe.","format":"double","type":"number"},"session_end_date":{"description":"Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.","type":"string"},"settlement_price":{"description":"The price the contract would have cost to settle for this session.","format":"double","type":"number"},"ticker":{"description":"The ticker for the contract.","type":"string"},"transactions":{"description":"The number of transactions that occurred within the timeframe.","format":"int64","type":"integer"},"volume":{"description":"The number of contracts that traded within the timeframe.","format":"int64","type":"integer"},"window_start":{"description":"The timestamp of the beginning of the candlestick’s aggregation window.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}}},"required":["ticker","window_start","session_end_date","open","high","low","close","transactions","volume","dollar_volume"],"type":"object"},"type":"array"},"status":{"description":"The status of the response.","type":"string"}},"required":["status","results"],"type":"object"}}},"description":"A list of aggregates."}},"summary":"Aggregates","tags":["futures:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Futures data","name":"futures"}}},"/futures/vX/contracts":{"get":{"description":"The Contracts API provides a single source for discovering all listed futures contracts and retrieving complete contract specifications. You can query the full contract index with filters for product code, trade dates, active status, and date, returning key attributes such as ticker, first and last trade dates, days to maturity, exchange code, and order quantity limits in paginated form. The same API also returns the full specification for a single contract, including settlement dates, tick sizes, and other trading and risk related fields. Point-in-time lookups allow you to reconstruct the exact contract definition that applied on any given day.\n\nUse Cases: Historical research, trading system integration, portfolio workflows, risk management.","operationId":"get_futures_vX_contracts","parameters":[{"description":"A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about contracts for the specified day. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.lte","schema":{"type":"string"}},{"description":"The identifier for the contract's product.","in":"query","name":"product_code","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"product_code.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"product_code.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"product_code.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"product_code.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"product_code.lte","schema":{"type":"string"}},{"description":"The ticker for the contract.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Whether or not a given contract was tradeable at the given point in time. Active is true when (first_trade_date \u003c= date \u003e= last_trade_date) and false otherwise.","in":"query","name":"active","schema":{"type":"boolean"}},{"description":"The type of contract, one of 'single' or 'combo'. Leaving this filter blank will query for contracts where type is 'single', 'combo' or empty. This field only exists on contracts as of 2025-03-12 and later. It will be null when date \u003c 2025-03-12.","in":"query","name":"type","schema":{"enum":["single","combo"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"type.any_of","schema":{"enum":["single","combo"],"type":"string"}},{"description":"The first day on which the contract was tradeable. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"first_trade_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"first_trade_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"first_trade_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"first_trade_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"first_trade_date.lte","schema":{"type":"string"}},{"description":"The last day on which the contract was tradeable. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"last_trade_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"last_trade_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"last_trade_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"last_trade_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"last_trade_date.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '1000'.","in":"query","name":"limit","schema":{"default":100,"maximum":1001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'product_code' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"product_code.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/futures/vX/contracts?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"000a000a0a0a000a0a0aa00a0a0000a0","results":[{"active":true,"date":"2025-02-26","days_to_maturity":138,"first_trade_date":"2025-01-15","group_code":"CN","last_trade_date":"2025-07-14","max_order_quantity":1999,"min_order_quantity":1,"name":"00CN5 Future","product_code":"00C","settlement_date":"2025-07-14","settlement_tick_size":0.0025,"spread_tick_size":0.0025,"ticker":"00CN5","trade_tick_size":0.0025,"trading_venue":"XCBT","type":"single"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"active":{"description":"Whether or not a given contract was tradeable at the given point in time. Active is true when (first_trade_date \u003c= date \u003e= last_trade_date) and false otherwise.","type":"boolean"},"date":{"description":"A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about contracts for the specified day.","format":"date","type":"string"},"days_to_maturity":{"description":"The number of calendar days between the 'date' and the contract's final settlement date.","format":"int64","type":"integer"},"first_trade_date":{"description":"The first day on which the contract was tradeable.","format":"date","type":"string"},"group_code":{"description":"An identifier used to identify logical groups of products. The group_code is only populated for contracts listed for trading on CME Globex.","type":"string"},"last_trade_date":{"description":"The last day on which the contract was tradeable.","format":"date","type":"string"},"max_order_quantity":{"description":"The maximum order quantity.","format":"int64","type":"integer"},"min_order_quantity":{"description":"The minimum order quantity.","format":"int64","type":"integer"},"name":{"description":"The name of this contract.","type":"string"},"product_code":{"description":"The identifier for the contract's product.","type":"string"},"settlement_date":{"description":"The date on which this contract settles.","format":"date","type":"string"},"settlement_tick_size":{"description":"The tick size for settlement.","format":"double","type":"number"},"spread_tick_size":{"description":"The tick size for spreads.","format":"double","type":"number"},"ticker":{"description":"The ticker for the contract.","type":"string"},"trade_tick_size":{"description":"The tick size for trades.","format":"double","type":"number"},"trading_venue":{"description":"The trading venue (MIC) for the exchange on which this contract trades.","type":"string"},"type":{"description":"The type of contract, one of 'single' or 'combo'. Leaving this filter blank will query for contracts where type is 'single', 'combo' or empty. This field only exists on contracts as of 2025-03-12 and later. It will be null when date \u003c 2025-03-12.","type":"string"}},"required":["active","date"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"summary":"futures contracts API","tags":["us_futures"]}},"/futures/vX/exchanges":{"get":{"description":"US futures exchanges and trading venues including major derivatives exchanges (CME, CBOT, NYMEX, COMEX) and other futures market infrastructure for commodity, financial, and other derivative contract trading.","operationId":"get_futures_vX_exchanges","parameters":[{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '999'.","in":"query","name":"limit","schema":{"default":100,"maximum":1000,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"acronym":"CME","id":"4","locale":"US","mic":"XCME","name":"Chicago Mercantile Exchange","operating_mic":"XCME","type":"exchange","url":"https://cmegroup.com"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"acronym":{"description":"Well-known acronym for the exchange (e.g., 'CME', 'NYMEX', 'CBOT', 'COMEX').","type":"string"},"id":{"description":"Numeric identifier for the futures exchange or trading venue.","type":"string"},"locale":{"description":"Geographic location code where the exchange operates.","type":"string"},"mic":{"description":"Market Identifier Code (MIC) - ISO 10383 standard four-character code for the futures market.","type":"string"},"name":{"description":"Full official name of the futures exchange (e.g., 'Chicago Mercantile Exchange', 'New York Mercantile Exchange').","type":"string"},"operating_mic":{"description":"Operating Market Identifier Code for the futures exchange.","type":"string"},"type":{"description":"Type of venue - 'exchange' for futures exchanges and derivatives trading platforms.","type":"string"},"url":{"description":"Official website URL of the futures exchange organization.","type":"string"}},"required":["id","type","name"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["us_futures"]}},"/futures/vX/market-status":{"get":{"description":"Retrieve the current market status for a specific product or products. This endpoint returns real-time indicators, such as open, pause, close, for futures products, along with the corresponding exchange and product codes and an evaluation timestamp. This information enables users to monitor operational conditions and adjust their trading strategies accordingly.\n\nUse Cases: Real-time monitoring, algorithm scheduling, UI updates, operational planning.","operationId":"get_futures_vX_market-status","parameters":[{"description":"The product code of the futures contracts for which you want statuses.","in":"query","name":"product_code","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"product_code.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"product_code.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"product_code.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"product_code.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"product_code.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '99'.","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"445ebfcfe5bb4b688b7971e1600c952d","results":[{"market_event":"open","name":"ERCOT North 345 kV Hub Day-Ahead 5 MW Off-Peak Futures","product_code":"ERL","session_end_date":"2025-12-05","timestamp":"2025-12-04T23:00:00+00:00","trading_venue":"XNYM"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"market_event":{"description":"The current status of the market for the product.","type":"string"},"name":{"description":"The name of the futures product.","type":"string"},"product_code":{"description":"The product code of the futures contracts for which you want statuses.","type":"string"},"session_end_date":{"description":"The trading date for the current session.","format":"date","type":"string"},"timestamp":{"description":"The timestamp for the given market event.","type":"string"},"trading_venue":{"description":"The trading venue (MIC) for the exchange on which the corresponding product trades.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"summary":"Market Status API","tags":["us_futures"]}},"/futures/vX/products":{"get":{"description":"The Products API is a unified source for discovering all supported futures products and retrieving full product specifications. It returns the complete product universe with product codes, names, exchange identifiers, sector and asset class classifications, product type, settlement method, and pricing and quotation details. You can filter by name, exchange, sector, asset class, product type, or date to capture the product set or product definition that existed at a specific point in time. It also retrieves the full specification for a single product, supporting accurate system configuration, analytics, trading workflows, and historical reconciliation.\n\nUse Cases: Product specification, historical product checks, risk management, trading system integration.","operationId":"get_futures_vX_products","parameters":[{"description":"The full name of the product.","in":"query","name":"name","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"name.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"name.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"name.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"name.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"name.lte","schema":{"type":"string"}},{"description":"The identifier for the product.","in":"query","name":"product_code","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"product_code.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"product_code.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"product_code.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"product_code.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"product_code.lte","schema":{"type":"string"}},{"description":"A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"date.lte","schema":{"type":"string"}},{"description":"The trading venue (MIC) for the exchange on which this product's contracts trade.","in":"query","name":"trading_venue","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"trading_venue.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"trading_venue.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"trading_venue.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"trading_venue.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"trading_venue.lte","schema":{"type":"string"}},{"description":"The sector to which the product belongs.","in":"query","name":"sector","schema":{"enum":["asia","base","biofuels","coal","cross_rates","crude_oil","custom_index","dairy","dj_ubs_ci","electricity","emissions","europe","fertilizer","forestry","grains_and_oilseeds","intl_index","liq_nat_gas_lng","livestock","long_term_gov","long_term_non_gov","majors","minors","nat_gas","nat_gas_liq_petro","precious","refined_products","s_and_p_gsci","sel_sector_index","short_term_gov","short_term_non_gov","softs","us","us_index","wet_bulk"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"sector.any_of","schema":{"enum":["asia","base","biofuels","coal","cross_rates","crude_oil","custom_index","dairy","dj_ubs_ci","electricity","emissions","europe","fertilizer","forestry","grains_and_oilseeds","intl_index","liq_nat_gas_lng","livestock","long_term_gov","long_term_non_gov","majors","minors","nat_gas","nat_gas_liq_petro","precious","refined_products","s_and_p_gsci","sel_sector_index","short_term_gov","short_term_non_gov","softs","us","us_index","wet_bulk"],"type":"string"}},{"description":"The sub-sector to which the product belongs.","in":"query","name":"sub_sector","schema":{"enum":["asian","canadian","cat","cooling_degree_days","ercot","european","gulf","heating_degree_days","iso_ne","large_cap_index","mid_cap_index","miso","north_american","nyiso","pjm","small_cap_index","west","western_power"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"sub_sector.any_of","schema":{"enum":["asian","canadian","cat","cooling_degree_days","ercot","european","gulf","heating_degree_days","iso_ne","large_cap_index","mid_cap_index","miso","north_american","nyiso","pjm","small_cap_index","west","western_power"],"type":"string"}},{"description":"The asset class to which the product belongs.","in":"query","name":"asset_class","schema":{"enum":["alt_investment","commodity","financials"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"asset_class.any_of","schema":{"enum":["alt_investment","commodity","financials"],"type":"string"}},{"description":"The asset sub-class to which the product belongs.","in":"query","name":"asset_sub_class","schema":{"enum":["agricultural","commodity_index","energy","equity","foreign_exchange","freight","housing","interest_rate","metals","weather"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"asset_sub_class.any_of","schema":{"enum":["agricultural","commodity_index","energy","equity","foreign_exchange","freight","housing","interest_rate","metals","weather"],"type":"string"}},{"description":"The type of product, one of 'single' or 'combo'. Leaving this filter blank will query for both 'single' and 'combo' types.","in":"query","name":"type","schema":{"enum":["single","combo"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"type.any_of","schema":{"enum":["single","combo"],"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"date.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/futures/vX/products?cursor=YXA9MTAwJmFzPSZhc19vZj0yMDI1LTA3LTA3JmxpbWl0PTEwMCZzb3J0PW5hbWUuYXNj","request_id":"000a000a0a0a000a0a0aa00a0a0000a0","results":[{"asset_class":"commodity","asset_sub_class":"energy","date":"2025-07-07","last_updated":"2025-02-22","name":"1% Fuel Oil Barges FOB Rdam (Platts) vs. 1% Fuel Oil Cargoes FOB NWE (Platts) BALMO Futures","price_quotation":"U.S. dollars and cents per metric ton","product_code":"EBE","sector":"refined_products","settlement_currency_code":"USD","settlement_method":"financially_settled","settlement_type":"cash","sub_sector":"european","trade_currency_code":"USD","trading_venue":"XNYM","type":"single","unit_of_measure":"MTONS","unit_of_measure_qty":1000}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"asset_class":{"description":"The asset class to which the product belongs.","type":"string"},"asset_sub_class":{"description":"The asset sub-class to which the product belongs.","type":"string"},"date":{"description":"A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day.","format":"date","type":"string"},"last_updated":{"description":"The date and time at which this product was last updated.","format":"date-time","type":"string"},"name":{"description":"The full name of the product.","type":"string"},"price_quotation":{"description":"The quoted price for this product.","type":"string"},"product_code":{"description":"The identifier for the product.","type":"string"},"sector":{"description":"The sector to which the product belongs.","type":"string"},"settlement_currency_code":{"description":"The currency in which this product settles.","type":"string"},"settlement_method":{"description":"The method of settlement for this product (Financially Settled or Deliverable).","type":"string"},"settlement_type":{"description":"The type of settlement for this product.","type":"string"},"sub_sector":{"description":"The sub-sector to which the product belongs.","type":"string"},"trade_currency_code":{"description":"The currency in which this product's contracts trade.","type":"string"},"trading_venue":{"description":"The trading venue (MIC) for the exchange on which this product's contracts trade.","type":"string"},"type":{"description":"The type of product, one of 'single' or 'combo'. Leaving this filter blank will query for both 'single' and 'combo' types.","type":"string"},"unit_of_measure":{"description":"The unit of measure for this product.","type":"string"},"unit_of_measure_qty":{"description":"The quantity of the unit of measure for this product.","format":"double","type":"number"}},"required":["date"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"summary":"Futures Products API","tags":["us_futures"]}},"/futures/vX/quotes/{ticker}":{"get":{"description":"Retrieve quote data for a specified futures contract ticker. Each record includes the best bid and offer prices, sizes, and timestamps, reflecting the prevailing quote environment at each moment. This endpoint supports detailed analysis of price dynamics and liquidity conditions to inform trading decisions and market research.\n\nUse Cases: Liquidity analysis, price discovery, trading strategy refinement, market research.","operationId":"get_futures_vX_quotes","parameters":[{"description":"The time when the quote was generated at the exchange to nanosecond precision. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.","in":"query","name":"session_end_date","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '49999'.","in":"query","name":"limit","schema":{"default":100,"maximum":50000,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'timestamp' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"timestamp.desc","type":"string"}},{"description":"The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).","in":"path","name":"ticker","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/futures/vX/quotes/GCJ5?cursor=YXA9MTczNDQ2MDIzMDcwODEyNjI4MSZhcz0mbGltaXQ9MTAwMCZzZXNzaW9uX2VuZF9kYXRlPTIwMjQtMTItMTcmc29ydD10aW1lc3RhbXAuZGVzYw","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":[{"ask_timestamp":"1734472800076125400,","bid_price":"2660,","bid_size":"1,","bid_timestamp":"1734472800076125400,","report_sequence":"2250337,","sequence_number":15357766,"session_end_date":"2024-12-17,","ticker":"GCJ5,","timestamp":"1734472800076125400,"},{"ask_price":"2685.9,","ask_size":"1,","ask_timestamp":"1734472755134391800,","bid_price":"2684.7,","bid_size":"1,","bid_timestamp":"1734472736352455200,","report_sequence":"2249723,","sequence_number":15354716,"session_end_date":"2024-12-17,","ticker":"GCJ5,","timestamp":"1734472755134391800,"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"ask_price":{"description":"The ask price is expressed per unit of the underlying asset, and you apply the contract multiplier to get the full contract value.","format":"double","type":"number"},"ask_size":{"description":"The quote size represents the number of futures contracts available at the given ask price.","format":"int32","type":"integer"},"ask_timestamp":{"description":"The time when the ask price was submitted to the exchange.","format":"int64","type":"integer"},"bid_price":{"description":"The bid price is expressed per unit of the underlying asset, and you apply the contract multiplier to get the full contract value.","format":"double","type":"number"},"bid_size":{"description":"The quote size represents the number of futures contracts available at the given bid price.","format":"int32","type":"integer"},"bid_timestamp":{"description":"The time when the bid price was submitted to the exchange.","format":"int64","type":"integer"},"channel":{"description":"The CME multicast channel this event was sourced from.","format":"int32","type":"integer"},"report_sequence":{"description":"The reporting sequence number.","format":"int64","type":"integer"},"sequence_number":{"description":"The unique sequence number assigned to this quote by the exchange.","format":"int64","type":"integer"},"session_end_date":{"description":"Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.","type":"string"},"ticker":{"description":"The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).","type":"string"},"timestamp":{"description":"The time when the quote was generated at the exchange to nanosecond precision.","format":"int64","type":"integer"}},"required":["ticker","timestamp","sequence_number","report_sequence","channel"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["us_futures"]}},"/futures/vX/schedules":{"get":{"description":"The Schedules API provides a unified way to retrieve trading schedules for futures markets, returning precise session open and close times, intraday breaks, and any adjustments for holidays or special events. You can filter schedules by session_end_date or retrieve the schedule for a single product using its product code. All times are returned in Coordinated Universal Time (UTC), making it straightforward to align trading, execution, and operational workflows across systems.\n\nUse Cases: Schedule planning, market analysis, strategy alignment, risk and operations management.","operationId":"get_futures_vX_schedules","parameters":[{"description":"The product code of the futures contract.","in":"query","name":"product_code","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"product_code.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"product_code.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"product_code.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"product_code.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"product_code.lte","schema":{"type":"string"}},{"description":"The session end date for the schedules (also known as the trading date). This field is optional and can be used to filter results by a specific session end date. If left blank, schedules for all dates will be returned. Note that trading sessions end at 5 PM Central Time, so a session ending at 5 PM CT on January 1st would have a session_end_date of 2025-01-01. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"session_end_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"session_end_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"session_end_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"session_end_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"session_end_date.lte","schema":{"type":"string"}},{"description":"The trading venue (MIC) for the exchange on which this schedule's product trades.","in":"query","name":"trading_venue","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"trading_venue.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"trading_venue.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"trading_venue.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"trading_venue.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"trading_venue.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '1000'.","in":"query","name":"limit","schema":{"default":10,"maximum":1001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'product_code' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"product_code.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.staging.massive.com/futures/vX/schedules?cursor=AQANA0VSTAIAAAEFAAEBAwACAQ0DRVJMAQ0ZMjAyNC0wNi0xMFQyMTowMDowMCswMDowMA==","request_id":"a83620d1ec6a4cd5b84ea669e377fd47","results":[{"event":"pre_open","product_code":"ERL","product_name":"ERCOT North 345 kV Hub Day-Ahead 5 MW Off-Peak Futures","session_end_date":"2024-06-10","timestamp":"2024-06-09T21:00:00+00:00","trading_venue":"XNYM"},{"event":"open","product_code":"ERL","product_name":"ERCOT North 345 kV Hub Day-Ahead 5 MW Off-Peak Futures","session_end_date":"2024-06-10","timestamp":"2024-06-09T22:00:00+00:00","trading_venue":"XNYM"},{"event":"close","product_code":"ERL","product_name":"ERCOT North 345 kV Hub Day-Ahead 5 MW Off-Peak Futures","session_end_date":"2024-06-10","timestamp":"2024-06-10T21:00:00+00:00","trading_venue":"XNYM"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"event":{"description":"The type of session on the given trading date.","type":"string"},"product_code":{"description":"The product code of the futures contract.","type":"string"},"product_name":{"description":"The name of the futures product to which this schedule applies.","type":"string"},"session_end_date":{"description":"The session end date for the schedules (also known as the trading date). This field is optional and can be used to filter results by a specific session end date. If left blank, schedules for all dates will be returned. Note that trading sessions end at 5 PM Central Time, so a session ending at 5 PM CT on January 1st would have a session_end_date of 2025-01-01.","format":"date","type":"string"},"timestamp":{"description":"The timestamp for the given market event.","type":"string"},"trading_venue":{"description":"The trading venue (MIC) for the exchange on which this schedule's product trades.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"summary":"Futures Schedules API","tags":["us_futures"]}},"/futures/vX/snapshot":{"get":{"description":"Retrieve a snapshot of the most recent futures contract data.","operationId":"get_futures_vX_snapshot","parameters":[{"description":"The code for the contracts' underlying product.","in":"query","name":"product_code","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"product_code.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"product_code.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"product_code.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"product_code.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"product_code.lte","schema":{"type":"string"}},{"description":"The futures contract identifier, including the base symbol and contract expiration (e.g., ESZ24 for the December 2024 S\u0026P 500 E-mini contract).","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'ticker' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"ticker.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"next_url":"https://api.massive.com/v1/futures/vX/snapshot?cursor=AQANAkNCBVNQ","request_id":"c4d50f4801874e30b63e674b844cf51f","results":[{"details":{"open_interest":112,"settlement_date":1753851600000000000},"last_minute":{"close":240.00000000000003,"high":240.00000000000003,"last_updated":1746045300000,"low":240.00000000000003,"open":240.00000000000003,"volume":5},"last_quote":{"ask":240.50000000000003,"ask_size":3,"ask_timestamp":1746036204386194000,"bid":239.50000000000003,"bid_size":2,"bid_timestamp":1746035747932118000,"last_updated":1746046798024234200},"last_trade":{"last_updated":1746045242858242600,"price":240.00000000000003,"size":5},"product_code":"CB","session":{"change":21.11,"change_percent":0.09622134,"close":240.00000000000003,"high":241.00000000000003,"low":240.00000000000003,"open":240.00000000000003,"previous_settlement":219.39,"settlement_price":240.50000000000003,"volume":55},"ticker":"CBN5"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"details":{"properties":{"product_code":{"type":"string"},"settlement_date":{"description":"The day that this contract is settled.","format":"date","type":"string"},"ticker":{"type":"string"}},"type":"object"},"last_minute":{"properties":{"close":{"description":"The price at the end of the minute bar.","format":"double","type":"number"},"high":{"description":"The highest price reached in the minute bar.","format":"double","type":"number"},"last_updated":{"description":"The timestamp indicating the most recent update to the minute bar.","format":"int64","type":"integer"},"low":{"description":"The lowest price reached in the minute bar.","format":"double","type":"number"},"open":{"description":"The opening price at the start of the minute bar.","format":"double","type":"number"},"timeframe":{"description":"The timeliness of the data as determined by your subscription. One of REAL-TIME or DELAYED.","type":"string"},"volume":{"description":"The number of contracts traded in the minute bar.","format":"double","type":"number"}},"type":"object"},"last_quote":{"properties":{"ask":{"description":"The lowest price a seller is willing to accept.","format":"double","type":"number"},"ask_size":{"description":"The number of contracts available at the ask price.","format":"int32","type":"integer"},"ask_timestamp":{"description":"The time when the best ask price was last updated.","format":"int64","type":"integer"},"bid":{"description":"The highest price a buyer is willing to pay.","format":"double","type":"number"},"bid_size":{"description":"The number of contracts available at the bid price.","format":"int32","type":"integer"},"bid_timestamp":{"description":"The time when the best bid price was last updated.","format":"int64","type":"integer"},"last_updated":{"description":"The time when the quote was generated at the exchange to nanosecond precision.","format":"int64","type":"integer"},"timeframe":{"description":"The timeliness of the data as determined by your subscription. One of REAL-TIME or DELAYED.","type":"string"}},"type":"object"},"last_trade":{"properties":{"last_updated":{"description":"The time when the trade was generated at the exchange to nanosecond precision.","format":"int64","type":"integer"},"price":{"description":"The price of the trade. This is the actual dollar value per whole contract of this trade. A trade of 100 contracts with a price of $2.00 would be worth a total dollar value of $200.00.","format":"double","type":"number"},"size":{"description":"The total number of contracts exchanged between buyers and sellers on a given trade.","format":"int64","type":"integer"},"timeframe":{"description":"The timeliness of the data as determined by your subscription. One of REAL-TIME or DELAYED.","type":"string"}},"type":"object"},"session":{"properties":{"change":{"description":"The change in price during this session.","format":"double","type":"number"},"change_percent":{"description":"The percentage change in price during this session.","format":"double","type":"number"},"close":{"description":"The price at the end of the session.","format":"double","type":"number"},"high":{"description":"The highest price reached in the session.","format":"double","type":"number"},"low":{"description":"The lowest price reached in the session.","format":"double","type":"number"},"open":{"description":"The opening price at the start of the session.","format":"double","type":"number"},"previous_settlement":{"description":"The settlement price of the previous session.","format":"double","type":"number"},"settlement_price":{"description":"The final settlement price at the end of the session.","format":"double","type":"number"},"volume":{"description":"The number of contracts traded in the session.","format":"double","type":"number"}},"type":"object"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"summary":"futures_snapshot_v1 API","tags":["us_futures"]}},"/futures/vX/trades/{ticker}":{"get":{"description":"Retrieve comprehensive, tick-level trade data for a specified futures contract ticker over a defined time range. Each record includes the trade price, size, session start date, and precise timestamps, capturing individual trade events throughout the period. This granular data is essential for constructing aggregated bars and performing detailed analyses of intraday price movements, making it a valuable tool for backtesting, algorithmic strategy development, and market research.\n\nUse Cases: Intraday analysis, algorithmic trading, backtesting, market research.","operationId":"get_futures_vX_trades","parameters":[{"description":"The time when the trade was generated at the exchange to nanosecond precision. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.","in":"query","name":"session_end_date","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '49999'.","in":"query","name":"limit","schema":{"default":10,"maximum":50000,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'timestamp' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"timestamp.desc","type":"string"}},{"description":"The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).","in":"path","name":"ticker","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/futures/vX/trades/ESZ4?cursor=YXA9MTczNDQ3MDk3MDAwODU5OTI2MSZhcz0yNzIzNTI4MyZsaW1pdD0xMDAwJnNlc3Npb25fZW5kX2RhdGU9MjAyNC0xMi0xNyZzb3J0PXRpbWVzdGFtcC5kZXNj","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":[{"price":6052,"report_sequence":12033289,"sequence_number":27317882,"session_end_date":"2024-12-17","size":3,"ticker":"ESZ4","timestamp":1734472799000509200},{"price":6051.75,"report_sequence":12033276,"sequence_number":27317863,"session_end_date":"2024-12-17","size":1,"ticker":"ESZ4","timestamp":1734472798789679900},{"price":6052,"report_sequence":12033255,"sequence_number":27317826,"session_end_date":"2024-12-17","size":2,"ticker":"ESZ4","timestamp":1734472797000893000}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"channel":{"description":"The CME multicast channel this event was sourced from.","format":"int32","type":"integer"},"price":{"description":"The price of the trade. This is the actual dollar value per whole contract of this trade. A trade of 100 contracts with a price of $2.00 would be worth a total dollar value of $200.00.","format":"double","type":"number"},"report_sequence":{"description":"The reporting sequence number.","format":"int64","type":"integer"},"sequence_number":{"description":"The unique sequence number assigned to this trade.","format":"int64","type":"integer"},"session_end_date":{"description":"Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.","type":"string"},"size":{"description":"The total number of contracts exchanged between buyers and sellers on a given trade.","format":"int64","type":"integer"},"ticker":{"description":"The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).","type":"string"},"timestamp":{"description":"The time when the trade was generated at the exchange to nanosecond precision.","format":"int64","type":"integer"}},"required":["ticker","timestamp","sequence_number","report_sequence","channel"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["us_futures"]}},"/options/v1/exchanges":{"get":{"description":"US options exchanges and trading venues including traditional options exchanges (CBOE, ISE, etc.), Securities Information Processors (SIP), and other options market infrastructure for derivatives trading.","operationId":"get_options_v1_exchanges","parameters":[{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '999'.","in":"query","name":"limit","schema":{"default":100,"maximum":1000,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":2,"request_id":1,"results":[{"id":"302","locale":"US","mic":"XCBO","name":"Chicago Board Options Exchange","operating_mic":"XCBO","participant_id":"C","type":"exchange","url":"https://www.cboe.com"},{"acronym":"ISE","id":"308","locale":"US","mic":"XISX","name":"International Securities Exchange, LLC","operating_mic":"XISX","participant_id":"I","type":"exchange","url":"https://www.nasdaq.com/solutions/nasdaq-ise"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"acronym":{"description":"Exchange acronym or short name (e.g., 'ISE', 'GEMX') - may be null for some venues.","type":"string"},"id":{"description":"Numeric identifier for the options trading venue or exchange.","type":"string"},"locale":{"description":"Geographic location code.","type":"string"},"mic":{"description":"Market Identifier Code (MIC) - ISO 10383 standard four-character code identifying the specific options market.","type":"string"},"name":{"description":"Full official name of the options exchange or trading venue.","type":"string"},"operating_mic":{"description":"Operating Market Identifier Code - identifies the parent organization or operating entity.","type":"string"},"participant_id":{"description":"Single-character participant identifier used in consolidator market data feeds and options trade reporting.","type":"string"},"type":{"description":"Type of venue: 'exchange' for options exchanges, 'SIP' for Securities Information Processors like OPRA (Options Price Reporting Authority).","type":"string"},"url":{"description":"Official website URL of the organization operating the options exchange.","type":"string"}},"required":["id","type","name"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["us_options"]}},"/stocks/filings/10-K/vX/sections":{"get":{"description":"SEC document text sections providing raw text content from specific sections of SEC filings (10-K, 10-Q, etc.).","operationId":"get_stocks_filings_10-K_vX_sections","parameters":[{"description":"SEC Central Index Key (10 digits, zero-padded).","in":"query","name":"cik","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"cik.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"cik.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"cik.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"cik.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"cik.lte","schema":{"type":"string"}},{"description":"Stock ticker symbol for the company.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Standardized section identifier from the filing (e.g. 'business', 'risk_factors', etc.).","in":"query","name":"section","schema":{"enum":["business","risk_factors"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"section.any_of","schema":{"enum":["business","risk_factors"],"type":"string"}},{"description":"Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.lte","schema":{"type":"string"}},{"description":"Period end date that the filing relates to (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '99'.","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'period_end' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"period_end.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":2,"next_url":"https://api.massive.com/stocks/filings/10-K/vX/sections?cursor=eyJsaW1pd...","request_id":"a3f8b2c1d4e5f6g7","results":[{"cik":"0000320193","filing_date":"2023-11-03","filing_url":"https://www.sec.gov/Archives/edgar/data/320193/0000320193-23-000106.txt","period_end":"2023-09-30","section":"risk_factors","text":"Item 1A. Risk Factors\n\nInvesting in our stock involves risk. In addition to the other information in this Annual Report on Form 10-K, the following risk factors should be carefully considered...","ticker":"AAPL"},{"cik":"0000789019","filing_date":"2023-07-27","filing_url":"https://www.sec.gov/Archives/edgar/data/789019/0000950170-23-035122.txt","period_end":"2023-06-30","section":"risk_factors","text":"Item 1A. RISK FACTORS\n\nOur operations and financial results are subject to various risks and uncertainties...","ticker":"MSFT"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"cik":{"description":"SEC Central Index Key (10 digits, zero-padded).","type":"string"},"filing_date":{"description":"Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD).","format":"date","type":"string"},"filing_url":{"description":"SEC URL source for the full filing.","type":"string"},"period_end":{"description":"Period end date that the filing relates to (formatted as YYYY-MM-DD).","format":"date","type":"string"},"section":{"description":"Standardized section identifier from the filing (e.g. 'business', 'risk_factors', etc.).","type":"string"},"text":{"description":"Full raw text content of the section, including headers and formatting.","type":"string"},"ticker":{"description":"Stock ticker symbol for the company.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["reference"]}},"/stocks/filings/8-K/vX/text":{"get":{"description":"SEC 8-K filings text providing parsed content from current report filings. 8-K forms report material events such as earnings, acquisitions, executive changes, and other significant corporate events.","operationId":"get_stocks_filings_8-K_vX_text","parameters":[{"description":"SEC Central Index Key (10 digits, zero-padded).","in":"query","name":"cik","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"cik.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"cik.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"cik.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"cik.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"cik.lte","schema":{"type":"string"}},{"description":"Stock ticker symbol for the company.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"SEC form type (e.g., '8-K', '8-K/A' for amendments).","in":"query","name":"form_type","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"form_type.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"form_type.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"form_type.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"form_type.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"form_type.lte","schema":{"type":"string"}},{"description":"Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '99'.","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'filing_date' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"filing_date.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":2,"next_url":"https://api.massive.com/stocks/filings/8-K/vX/text?cursor=eyJsaW1pd...","request_id":"a3f8b2c1d4e5f6g7","results":[{"accession_number":"0000004962-25-000002","cik":"0000004962","filing_date":"2025-01-15","filing_url":"https://www.sec.gov/Archives/edgar/data/4962/0000004962-25-000002.txt","form_type":"8-K","items_text":"Item 7.01\tRegulation FD Disclosure\n\nAmerican Express Company is hereby furnishing below delinquency and write-off statistics...","ticker":"AXP"},{"accession_number":"0000320193-25-000010","cik":"0000320193","filing_date":"2025-01-14","filing_url":"https://www.sec.gov/Archives/edgar/data/320193/0000320193-25-000010.txt","form_type":"8-K","items_text":"Item 2.02\tResults of Operations and Financial Condition\n\nOn January 14, 2025, Apple Inc. announced financial results...","ticker":"AAPL"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"accession_number":{"description":"SEC accession number uniquely identifying the filing (e.g., '0000004962-25-000002').","type":"string"},"cik":{"description":"SEC Central Index Key (10 digits, zero-padded).","type":"string"},"filing_date":{"description":"Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD).","format":"date","type":"string"},"filing_url":{"description":"SEC URL source for the full filing.","type":"string"},"form_type":{"description":"SEC form type (e.g., '8-K', '8-K/A' for amendments).","type":"string"},"items_text":{"description":"Parsed text content from the 8-K filing, including item numbers and descriptions.","type":"string"},"ticker":{"description":"Stock ticker symbol for the company.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["reference"]}},"/stocks/filings/vX/13-F":{"get":{"description":"SEC Form 13F filings data showing institutional investment manager holdings. Form 13F is required to be filed quarterly by institutional investment managers with at least $100 million in qualifying assets under management.","operationId":"get_stocks_filings_vX_13-F","parameters":[{"description":"SEC Central Index Key (10 digits, zero-padded) of the filing entity.","in":"query","name":"filer_cik","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"filer_cik.any_of","schema":{"type":"string"}},{"description":"Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '1000'.","in":"query","name":"limit","schema":{"default":100,"maximum":1001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'filing_date' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"filing_date.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/stocks/filings/vX/13-F?cursor=eyJsaW1pd...","request_id":"a3f8b2c1d4e5f6g7","results":[{"accession_number":"0000950123-24-011775","cusip":"023135106","file_number":"028-04545","filer_cik":"0001067983","filing_date":"2024-11-14","filing_url":"https://www.sec.gov/Archives/edgar/data/1067983/0000950123-24-011775.txt","film_number":"241461756","form_type":"13F-HR","investment_discretion":"DFND","issuer_name":"AMAZON COM INC","market_value":1439212920,"other_managers":["Buffett Warren E"],"period":"2024-09-30","put_call":null,"shares_or_principal_amount":7724000,"shares_or_principal_type":"SH","tickers":["BRK.A","BRK.B"],"title_of_class":"COM","voting_authority_none":0,"voting_authority_shared":0,"voting_authority_sole":7724000},{"accession_number":"0000950123-24-011775","cusip":"025816109","file_number":"028-04545","filer_cik":"0001067983","filing_date":"2024-11-14","filing_url":"https://www.sec.gov/Archives/edgar/data/1067983/0000950123-24-011775.txt","film_number":"241461756","form_type":"13F-HR","investment_discretion":"DFND","issuer_name":"AMERICAN EXPRESS CO","market_value":311864270,"other_managers":["Buffett Warren E"],"period":"2024-09-30","put_call":null,"shares_or_principal_amount":1149942,"shares_or_principal_type":"SH","tickers":["BRK.A","BRK.B"],"title_of_class":"COM","voting_authority_none":0,"voting_authority_shared":0,"voting_authority_sole":1149942}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"accession_number":{"description":"Unique SEC accession number for the filing (e.g., '0000950123-24-011775').","type":"string"},"cusip":{"description":"The CUSIP identifier for the held security.","type":"string"},"file_number":{"description":"The 13F-specific file number assigned to the filer.","type":"string"},"filer_cik":{"description":"SEC Central Index Key (10 digits, zero-padded) of the filing entity.","type":"string"},"filing_date":{"description":"Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD).","format":"date","type":"string"},"filing_url":{"description":"Direct URL to the filing on the SEC EDGAR website.","type":"string"},"film_number":{"description":"SEC EDGAR film number for the filing.","type":"string"},"form_type":{"description":"SEC form type (e.g., '13F-HR' for holdings report, '13F-HR/A' for amended report).","type":"string"},"investment_discretion":{"description":"Type of investment discretion. Possible values: SOLE, SHARED, DFND (defined).","type":"string"},"issuer_name":{"description":"Name of the company whose securities are held.","type":"string"},"market_value":{"description":"Market value of the holding in USD.","format":"int64","type":"integer"},"other_managers":{"description":"List of names of other manager(s) sharing investment discretion over the reported holdings, if applicable.","items":{"type":"string"},"type":"array"},"period":{"description":"The quarter end date that the filing covers (formatted as YYYY-MM-DD).","format":"date","type":"string"},"put_call":{"description":"Indicates if the holding is a put or call option. Possible values: PUT, CALL, or empty for common stock.","type":"string"},"shares_or_principal_amount":{"description":"Number of shares or principal amount held.","format":"int64","type":"integer"},"shares_or_principal_type":{"description":"Type of amount reported. Possible values: SH (shares), PRN (principal amount).","type":"string"},"tickers":{"description":"A list of ticker symbols for the filing entity. Multiple symbols may indicate different share classes (e.g., BRK.A and BRK.B for Berkshire Hathaway).","items":{"type":"string"},"type":"array"},"title_of_class":{"description":"Description of the class of securities held (e.g., 'COM', 'CL A').","type":"string"},"voting_authority_none":{"description":"Number of shares with no voting authority.","format":"int64","type":"integer"},"voting_authority_shared":{"description":"Number of shares with shared voting authority.","format":"int64","type":"integer"},"voting_authority_sole":{"description":"Number of shares with sole voting authority.","format":"int64","type":"integer"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["reference"]}},"/stocks/filings/vX/index":{"get":{"description":"SEC EDGAR master index providing metadata for all SEC filings including form types, filing dates, and direct links to source documents.","operationId":"get_stocks_filings_vX_index","parameters":[{"description":"SEC Central Index Key (CIK) identifying the filing entity.","in":"query","name":"cik","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"cik.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"cik.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"cik.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"cik.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"cik.lte","schema":{"type":"string"}},{"description":"Stock ticker symbol for the filing entity, if available.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"SEC form type (e.g., '10-K', '10-Q', '8-K', 'S-1', '4', etc.).","in":"query","name":"form_type","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"form_type.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"form_type.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"form_type.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"form_type.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"form_type.lte","schema":{"type":"string"}},{"description":"Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '1000' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":1000,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'filing_date' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"filing_date.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/stocks/filings/vX/index?cursor=eyJsaW1pd...","request_id":"1daccfd9794e482e96d104dee6ed432b","results":[{"accession_number":"0000320193-25-000079","cik":"0000320193","filing_date":"2025-10-31","filing_url":"https://www.sec.gov/Archives/edgar/data/320193/0000320193-25-000079.txt","form_type":"10-K","issuer_name":"Apple Inc.","ticker":"AAPL"},{"accession_number":"0000950170-25-010491","cik":"0000789019","filing_date":"2025-01-29","filing_url":"https://www.sec.gov/Archives/edgar/data/789019/0000950170-25-010491.txt","form_type":"10-Q","issuer_name":"MICROSOFT CORP","ticker":"MSFT"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"accession_number":{"description":"SEC accession number uniquely identifying the filing (e.g., '0000320193-24-000123').","type":"string"},"cik":{"description":"SEC Central Index Key (CIK) identifying the filing entity.","type":"string"},"filing_date":{"description":"Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD).","format":"date","type":"string"},"filing_url":{"description":"Direct URL to the filing on the SEC EDGAR website.","type":"string"},"form_type":{"description":"SEC form type (e.g., '10-K', '10-Q', '8-K', 'S-1', '4', etc.).","type":"string"},"issuer_name":{"description":"Name of the company or entity that submitted the filing.","type":"string"},"ticker":{"description":"Stock ticker symbol for the filing entity, if available.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["reference"]}},"/stocks/filings/vX/risk-factors":{"get":{"description":"The risk factors identified in companies' 10K filings.","operationId":"get_stocks_filings_vX_risk-factors","parameters":[{"description":"Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD).","in":"query","name":"filing_date","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"filing_date.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"filing_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"filing_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"filing_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"filing_date.lte","schema":{"type":"string"}},{"description":"Stock ticker symbol for the company.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"SEC Central Index Key (10 digits, zero-padded).","in":"query","name":"cik","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"cik.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"cik.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"cik.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"cik.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"cik.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '49999'.","in":"query","name":"limit","schema":{"default":100,"maximum":50000,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'filing_date' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"filing_date.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"c7856101f86c20d855b0ea1c5a6d6efa","results":[{"cik":"0001005101","filing_date":"2025-09-19","primary_category":"financial_and_market","secondary_category":"credit_and_liquidity","supporting_text":"In addition to the net proceeds we received from our recent equity and debt financings, we may need to raise additional equity or debt financing to continue the development and marketing of our Fintech app, to fund ongoing operations, invest in acquisitions, and for working capital purposes. Our inability to raise such additional financing may limit our ability to continue the development of our Fintech app.","tertiary_category":"access_to_capital_and_financing","ticker":"MGLD"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"cik":{"description":"SEC Central Index Key (10 digits, zero-padded).","type":"string"},"filing_date":{"description":"Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD).","type":"string"},"primary_category":{"description":"Top-level risk category","type":"string"},"secondary_category":{"description":"Mid-level risk category","type":"string"},"supporting_text":{"description":"Snippet of text to support the given label","type":"string"},"tertiary_category":{"description":"Most specific risk classification","type":"string"},"ticker":{"description":"Stock ticker symbol for the company.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["reference"]}},"/stocks/financials/v1/balance-sheets":{"get":{"description":"A comprehensive financial dataset containing quarterly and annual balance sheet data for public companies. Includes detailed asset, liability, and equity positions representing the company's financial position at specific points in time. Balance sheet data represents point-in-time snapshots rather than cumulative flows, showing what the company owns, owes, and shareholders' equity as of each period end date.","operationId":"get_stocks_financials_v1_balance-sheets","parameters":[{"description":"The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company's CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup).","in":"query","name":"cik","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"cik.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"cik.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"cik.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"cik.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"cik.lte","schema":{"type":"string"}},{"description":"Filter for arrays that contain the value.","in":"query","name":"tickers","schema":{"type":"string"}},{"description":"Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"tickers.all_of","schema":{"type":"string"}},{"description":"Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"tickers.any_of","schema":{"type":"string"}},{"description":"The last date of the reporting period, representing the specific point in time when the balance sheet snapshot was taken. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.lte","schema":{"type":"string"}},{"description":"The date when the financial statement was filed with the SEC. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.lte","schema":{"type":"string"}},{"description":"The fiscal year for the reporting period. Value must be a floating point number.","in":"query","name":"fiscal_year","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"fiscal_year.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"fiscal_year.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"fiscal_year.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"fiscal_year.lte","schema":{"format":"double","type":"number"}},{"description":"The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number.","in":"query","name":"fiscal_quarter","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"fiscal_quarter.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"fiscal_quarter.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"fiscal_quarter.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"fiscal_quarter.lte","schema":{"format":"double","type":"number"}},{"description":"The reporting period type. Possible values include: quarterly, annual.","in":"query","name":"timeframe","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"timeframe.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"timeframe.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"timeframe.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"timeframe.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"timeframe.lte","schema":{"type":"string"}},{"description":"Filter equal to the value.","in":"query","name":"max_ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"max_ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"max_ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"max_ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"max_ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"max_ticker.lte","schema":{"type":"string"}},{"description":"Filter equal to the value.","in":"query","name":"min_ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"min_ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"min_ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"min_ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"min_ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"min_ticker.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'period_end' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"period_end.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"d9f86384d43845a4a3d7b79098fb08dd","results":[{"accounts_payable":50374000000,"accrued_and_other_current_liabilities":62499000000,"accumulated_other_comprehensive_income":-6369000000,"cash_and_equivalents":36269000000,"cik":"0000320193","common_stock":89806000000,"debt_current":19268000000,"deferred_revenue_current":8979000000,"filing_date":"2025-08-01","fiscal_quarter":3,"fiscal_year":2025,"inventories":5925000000,"long_term_debt_and_capital_lease_obligations":82430000000,"other_assets":160496000000,"other_current_assets":14359000000,"other_equity":0,"other_noncurrent_liabilities":42115000000,"period_end":"2025-06-28","property_plant_equipment_net":48508000000,"receivables":46835000000,"retained_earnings_deficit":-17607000000,"tickers":["AAPL"],"timeframe":"quarterly","total_assets":331495000000,"total_current_assets":103388000000,"total_current_liabilities":141120000000,"total_equity":65830000000,"total_equity_attributable_to_parent":65830000000,"total_liabilities":265665000000,"total_liabilities_and_equity":331495000000}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"accounts_payable":{"description":"Amounts owed to suppliers and vendors for goods and services purchased on credit.","format":"double","type":"number"},"accrued_and_other_current_liabilities":{"description":"Current liabilities not classified elsewhere, including accrued expenses, taxes payable, and other obligations due within one year.","format":"double","type":"number"},"accumulated_other_comprehensive_income":{"description":"Cumulative gains and losses that bypass the income statement, including foreign currency translation adjustments and unrealized gains/losses on securities.","format":"double","type":"number"},"additional_paid_in_capital":{"description":"Amount received from shareholders in excess of the par or stated value of shares issued.","format":"double","type":"number"},"cash_and_equivalents":{"description":"Cash on hand and short-term, highly liquid investments that are readily convertible to known amounts of cash.","format":"double","type":"number"},"cik":{"description":"The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company's CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup).","type":"string"},"commitments_and_contingencies":{"description":"Disclosed amount related to contractual commitments and potential liabilities that may arise from uncertain future events.","format":"double","type":"number"},"common_stock":{"description":"Par or stated value of common shares outstanding representing basic ownership in the company.","format":"double","type":"number"},"debt_current":{"description":"Short-term borrowings and the current portion of long-term debt due within one year.","format":"double","type":"number"},"deferred_revenue_current":{"description":"Customer payments received in advance for goods or services to be delivered within one year.","format":"double","type":"number"},"filing_date":{"description":"The date when the financial statement was filed with the SEC.","format":"date","type":"string"},"fiscal_quarter":{"description":"The fiscal quarter number (1, 2, 3, or 4) for the reporting period.","format":"double","type":"number"},"fiscal_year":{"description":"The fiscal year for the reporting period.","format":"double","type":"number"},"goodwill":{"description":"Intangible asset representing the excess of purchase price over fair value of net assets acquired in business combinations.","format":"double","type":"number"},"intangible_assets_net":{"description":"Intangible assets other than goodwill, including patents, trademarks, and customer relationships, net of accumulated amortization.","format":"double","type":"number"},"inventories":{"description":"Raw materials, work-in-process, and finished goods held for sale in the ordinary course of business.","format":"double","type":"number"},"long_term_debt_and_capital_lease_obligations":{"description":"Long-term borrowings and capital lease obligations with maturities greater than one year.","format":"double","type":"number"},"noncontrolling_interest":{"description":"Equity in consolidated subsidiaries not owned by the parent company, representing minority shareholders' ownership.","format":"double","type":"number"},"other_assets":{"description":"Non-current assets not classified elsewhere, including long-term investments, deferred tax assets, and other long-term assets.","format":"double","type":"number"},"other_current_assets":{"description":"Current assets not classified elsewhere, including prepaid expenses, taxes receivable, and other assets expected to be converted to cash within one year.","format":"double","type":"number"},"other_equity":{"description":"Equity components not classified elsewhere in shareholders' equity.","format":"double","type":"number"},"other_noncurrent_liabilities":{"description":"Non-current liabilities not classified elsewhere, including deferred tax liabilities, pension obligations, and other long-term liabilities.","format":"double","type":"number"},"period_end":{"description":"The last date of the reporting period, representing the specific point in time when the balance sheet snapshot was taken.","format":"date","type":"string"},"preferred_stock":{"description":"Par or stated value of preferred shares outstanding with preferential rights over common stock.","format":"double","type":"number"},"property_plant_equipment_net":{"description":"Tangible fixed assets used in operations, reported net of accumulated depreciation.","format":"double","type":"number"},"receivables":{"description":"Amounts owed to the company by customers and other parties, primarily accounts receivable, net of allowances for doubtful accounts.","format":"double","type":"number"},"retained_earnings_deficit":{"description":"Cumulative net income earned by the company less dividends paid to shareholders since inception.","format":"double","type":"number"},"short_term_investments":{"description":"Marketable securities and other investments with maturities of one year or less that are not classified as cash equivalents.","format":"double","type":"number"},"tickers":{"description":"A list of ticker symbols under which the company is listed. Multiple symbols may indicate different share classes for the same company.","items":{"type":"string"},"type":"array"},"timeframe":{"description":"The reporting period type. Possible values include: quarterly, annual.","type":"string"},"total_assets":{"description":"Sum of all current and non-current assets representing everything the company owns or controls.","format":"double","type":"number"},"total_current_assets":{"description":"Sum of all current assets expected to be converted to cash, sold, or consumed within one year.","format":"double","type":"number"},"total_current_liabilities":{"description":"Sum of all liabilities expected to be settled within one year.","format":"double","type":"number"},"total_equity":{"description":"Sum of all equity components representing shareholders' total ownership interest in the company.","format":"double","type":"number"},"total_equity_attributable_to_parent":{"description":"Total shareholders' equity attributable to the parent company, excluding noncontrolling interests.","format":"double","type":"number"},"total_liabilities":{"description":"Sum of all current and non-current liabilities representing everything the company owes.","format":"double","type":"number"},"total_liabilities_and_equity":{"description":"Sum of total liabilities and total equity, which should equal total assets per the fundamental accounting equation.","format":"double","type":"number"},"treasury_stock":{"description":"Cost of the company's own shares that have been repurchased and are held in treasury, typically reported as a negative value.","format":"double","type":"number"}},"required":["timeframe"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["financials"]}},"/stocks/financials/v1/cash-flow-statements":{"get":{"description":"A comprehensive financial dataset containing quarterly, annual, and trailing twelve-month cash flow statement data for public companies. Includes detailed operating, investing, and financing cash flows with proper TTM calculations that sum all cash flow components over four quarters. TTM records are validated to ensure exactly four distinct quarters spanning 250-400 days for accurate trailing twelve-month cash flow analysis.","operationId":"get_stocks_financials_v1_cash-flow-statements","parameters":[{"description":"The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup).","in":"query","name":"cik","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"cik.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"cik.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"cik.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"cik.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"cik.lte","schema":{"type":"string"}},{"description":"The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.lte","schema":{"type":"string"}},{"description":"The date when the financial statement was filed with the SEC. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.lte","schema":{"type":"string"}},{"description":"Filter for arrays that contain the value.","in":"query","name":"tickers","schema":{"type":"string"}},{"description":"Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"tickers.all_of","schema":{"type":"string"}},{"description":"Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"tickers.any_of","schema":{"type":"string"}},{"description":"The fiscal year for the reporting period. Value must be a floating point number.","in":"query","name":"fiscal_year","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"fiscal_year.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"fiscal_year.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"fiscal_year.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"fiscal_year.lte","schema":{"format":"double","type":"number"}},{"description":"The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number.","in":"query","name":"fiscal_quarter","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"fiscal_quarter.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"fiscal_quarter.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"fiscal_quarter.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"fiscal_quarter.lte","schema":{"format":"double","type":"number"}},{"description":"The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months.","in":"query","name":"timeframe","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"timeframe.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"timeframe.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"timeframe.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"timeframe.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"timeframe.lte","schema":{"type":"string"}},{"description":"Filter equal to the value.","in":"query","name":"max_ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"max_ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"max_ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"max_ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"max_ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"max_ticker.lte","schema":{"type":"string"}},{"description":"Filter equal to the value.","in":"query","name":"min_ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"min_ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"min_ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"min_ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"min_ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"min_ticker.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'period_end' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"period_end.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"d6d389ca03a0450d93c4ecb13ff26dae","results":[{"cash_from_operating_activities_continuing_operations":27867000000,"change_in_cash_and_equivalents":8107000000,"change_in_other_operating_assets_and_liabilities_net":-2034000000,"cik":"0000320193","depreciation_depletion_and_amortization":2830000000,"dividends":-3945000000,"filing_date":"2025-08-01","fiscal_quarter":3,"fiscal_year":2025,"long_term_debt_issuances_repayments":-1192000000,"net_cash_from_financing_activities":-24833000000,"net_cash_from_financing_activities_continuing_operations":-24833000000,"net_cash_from_investing_activities":5073000000,"net_cash_from_investing_activities_continuing_operations":5073000000,"net_cash_from_operating_activities":27867000000,"net_income":23434000000,"other_financing_activities":-23599000000,"other_investing_activities":8535000000,"other_operating_activities":3637000000,"period_end":"2025-06-28","purchase_of_property_plant_and_equipment":-3462000000,"short_term_debt_issuances_repayments":3903000000,"tickers":["AAPL"],"timeframe":"quarterly"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"cash_from_operating_activities_continuing_operations":{"description":"Cash generated from continuing business operations before discontinued operations.","format":"double","type":"number"},"change_in_cash_and_equivalents":{"description":"Net change in cash and cash equivalents during the period, representing the sum of operating, investing, and financing cash flows plus currency effects.","format":"double","type":"number"},"change_in_other_operating_assets_and_liabilities_net":{"description":"Net change in working capital components including accounts receivable, inventory, accounts payable, and other operating items.","format":"double","type":"number"},"cik":{"description":"The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup).","type":"string"},"depreciation_depletion_and_amortization":{"description":"Non-cash charges for the reduction in value of tangible and intangible assets over time.","format":"double","type":"number"},"dividends":{"description":"Cash payments to shareholders in the form of dividends, typically reported as negative values.","format":"double","type":"number"},"effect_of_currency_exchange_rate":{"description":"Impact of foreign exchange rate changes on cash and cash equivalents denominated in foreign currencies.","format":"double","type":"number"},"filing_date":{"description":"The date when the financial statement was filed with the SEC.","format":"date","type":"string"},"fiscal_quarter":{"description":"The fiscal quarter number (1, 2, 3, or 4) for the reporting period.","format":"double","type":"number"},"fiscal_year":{"description":"The fiscal year for the reporting period.","format":"double","type":"number"},"income_loss_from_discontinued_operations":{"description":"After-tax income or loss from business operations that have been discontinued.","format":"double","type":"number"},"long_term_debt_issuances_repayments":{"description":"Net cash flows from issuing or repaying long-term debt obligations.","format":"double","type":"number"},"net_cash_from_financing_activities":{"description":"Total cash generated or used by financing activities, including debt issuance, debt repayment, dividends, and share transactions.","format":"double","type":"number"},"net_cash_from_financing_activities_continuing_operations":{"description":"Cash flows from financing activities of continuing operations before discontinued operations.","format":"double","type":"number"},"net_cash_from_financing_activities_discontinued_operations":{"description":"Cash flows from financing activities of discontinued business segments.","format":"double","type":"number"},"net_cash_from_investing_activities":{"description":"Total cash generated or used by investing activities, including capital expenditures, acquisitions, and asset sales.","format":"double","type":"number"},"net_cash_from_investing_activities_continuing_operations":{"description":"Cash flows from investing activities of continuing operations before discontinued operations.","format":"double","type":"number"},"net_cash_from_investing_activities_discontinued_operations":{"description":"Cash flows from investing activities of discontinued business segments.","format":"double","type":"number"},"net_cash_from_operating_activities":{"description":"Total cash generated or used by operating activities, representing cash flow from core business operations.","format":"double","type":"number"},"net_cash_from_operating_activities_discontinued_operations":{"description":"Cash flows from operating activities of discontinued business segments.","format":"double","type":"number"},"net_income":{"description":"Net income used as the starting point for operating cash flow calculations.","format":"double","type":"number"},"noncontrolling_interests":{"description":"Cash flows related to minority shareholders in consolidated subsidiaries.","format":"double","type":"number"},"other_cash_adjustments":{"description":"Other miscellaneous adjustments to cash flows not classified elsewhere.","format":"double","type":"number"},"other_financing_activities":{"description":"Cash flows from financing activities not classified elsewhere, including share repurchases and other equity transactions.","format":"double","type":"number"},"other_investing_activities":{"description":"Cash flows from investing activities not classified elsewhere, including acquisitions, divestitures, and investments.","format":"double","type":"number"},"other_operating_activities":{"description":"Other adjustments to reconcile net income to operating cash flow not classified elsewhere.","format":"double","type":"number"},"period_end":{"description":"The last date of the reporting period (formatted as YYYY-MM-DD).","format":"date","type":"string"},"purchase_of_property_plant_and_equipment":{"description":"Cash outflows for capital expenditures on fixed assets, typically reported as negative values.","format":"double","type":"number"},"sale_of_property_plant_and_equipment":{"description":"Cash inflows from disposing of fixed assets, typically reported as positive values.","format":"double","type":"number"},"short_term_debt_issuances_repayments":{"description":"Net cash flows from issuing or repaying short-term debt obligations.","format":"double","type":"number"},"tickers":{"description":"A list of ticker symbols under which the company is listed. Multiple symbols may indicate different share classes for the same company.","items":{"type":"string"},"type":"array"},"timeframe":{"description":"The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["financials"]}},"/stocks/financials/v1/income-statements":{"get":{"description":"A comprehensive database of income statement financial data for public companies, including key metrics such as revenue, expenses, and net income for various reporting periods.","operationId":"get_stocks_financials_v1_income-statements","parameters":[{"description":"The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup).","in":"query","name":"cik","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"cik.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"cik.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"cik.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"cik.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"cik.lte","schema":{"type":"string"}},{"description":"Filter for arrays that contain the value.","in":"query","name":"tickers","schema":{"type":"string"}},{"description":"Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"tickers.all_of","schema":{"type":"string"}},{"description":"Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"tickers.any_of","schema":{"type":"string"}},{"description":"The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"period_end.lte","schema":{"type":"string"}},{"description":"The date when the financial statement was filed with the SEC. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"filing_date.lte","schema":{"type":"string"}},{"description":"The fiscal year for the reporting period. Value must be a floating point number.","in":"query","name":"fiscal_year","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"fiscal_year.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"fiscal_year.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"fiscal_year.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"fiscal_year.lte","schema":{"format":"double","type":"number"}},{"description":"The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number.","in":"query","name":"fiscal_quarter","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"fiscal_quarter.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"fiscal_quarter.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"fiscal_quarter.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"fiscal_quarter.lte","schema":{"format":"double","type":"number"}},{"description":"The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months.","in":"query","name":"timeframe","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"timeframe.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"timeframe.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"timeframe.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"timeframe.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"timeframe.lte","schema":{"type":"string"}},{"description":"Filter equal to the value.","in":"query","name":"max_ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"max_ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"max_ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"max_ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"max_ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"max_ticker.lte","schema":{"type":"string"}},{"description":"Filter equal to the value.","in":"query","name":"min_ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"min_ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"min_ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"min_ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"min_ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"min_ticker.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'period_end' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"period_end.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"5b3cc7c674b34fdd89034b74500bfab5","results":[{"basic_earnings_per_share":1.57,"basic_shares_outstanding":14902886000,"cik":"0000320193","consolidated_net_income_loss":23434000000,"cost_of_revenue":50318000000,"diluted_earnings_per_share":1.57,"diluted_shares_outstanding":14948179000,"ebitda":31032000000,"filing_date":"2025-08-01","fiscal_quarter":3,"fiscal_year":2025,"gross_profit":43718000000,"income_before_income_taxes":28031000000,"income_taxes":4597000000,"net_income_loss_attributable_common_shareholders":23434000000,"operating_income":28202000000,"other_income_expense":-171000000,"other_operating_expenses":0,"period_end":"2025-06-28","research_development":8866000000,"revenue":94036000000,"selling_general_administrative":6650000000,"tickers":["AAPL"],"timeframe":"quarterly","total_operating_expenses":15516000000,"total_other_income_expense":-171000000}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"basic_earnings_per_share":{"description":"Earnings per share calculated using the weighted average number of basic shares outstanding. For TTM records, recalculated as TTM net income divided by average basic shares outstanding over the four quarters.","format":"double","type":"number"},"basic_shares_outstanding":{"description":"Weighted average number of common shares outstanding during the period, used in basic EPS calculation. For TTM records, represents the average over the four most recent quarters.","format":"double","type":"number"},"cik":{"description":"The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup).","type":"string"},"consolidated_net_income_loss":{"description":"Total net income or loss for the consolidated entity including all subsidiaries.","format":"double","type":"number"},"cost_of_revenue":{"description":"Direct costs attributable to the production of goods or services sold, also known as cost of goods sold (COGS).","format":"double","type":"number"},"depreciation_depletion_amortization":{"description":"Non-cash expenses representing the allocation of asset costs over their useful lives.","format":"double","type":"number"},"diluted_earnings_per_share":{"description":"Earnings per share calculated using diluted shares outstanding, including the effect of potentially dilutive securities. For TTM records, recalculated as TTM net income divided by average diluted shares outstanding over the four quarters.","format":"double","type":"number"},"diluted_shares_outstanding":{"description":"Weighted average number of shares outstanding including the dilutive effect of stock options, warrants, and convertible securities. For TTM records, represents the average over the four most recent quarters.","format":"double","type":"number"},"discontinued_operations":{"description":"After-tax results from business segments that have been or will be disposed of.","format":"double","type":"number"},"ebitda":{"description":"Earnings before interest, taxes, depreciation, and amortization, a measure of operating performance.","format":"double","type":"number"},"equity_in_affiliates":{"description":"The company's share of income or losses from equity method investments in affiliated companies.","format":"double","type":"number"},"extraordinary_items":{"description":"Unusual and infrequent gains or losses that are both unusual in nature and infrequent in occurrence.","format":"double","type":"number"},"filing_date":{"description":"The date when the financial statement was filed with the SEC.","format":"date","type":"string"},"fiscal_quarter":{"description":"The fiscal quarter number (1, 2, 3, or 4) for the reporting period.","format":"double","type":"number"},"fiscal_year":{"description":"The fiscal year for the reporting period.","format":"double","type":"number"},"gross_profit":{"description":"Revenue minus cost of revenue, representing profit before operating expenses.","format":"double","type":"number"},"income_before_income_taxes":{"description":"Pre-tax income calculated as operating income plus total other income/expense.","format":"double","type":"number"},"income_taxes":{"description":"Income tax expense or benefit for the period.","format":"double","type":"number"},"interest_expense":{"description":"Cost of borrowed funds, including interest on debt and other financing obligations.","format":"double","type":"number"},"interest_income":{"description":"Income earned from interest-bearing investments and cash equivalents.","format":"double","type":"number"},"net_income_loss_attributable_common_shareholders":{"description":"Net income or loss available to common shareholders after preferred dividends and noncontrolling interests.","format":"double","type":"number"},"noncontrolling_interest":{"description":"The portion of net income attributable to minority shareholders in consolidated subsidiaries.","format":"double","type":"number"},"operating_income":{"description":"Income from operations calculated as gross profit minus total operating expenses, excluding non-operating items.","format":"double","type":"number"},"other_income_expense":{"description":"Non-operating income and expenses not related to the company's core business operations.","format":"double","type":"number"},"other_operating_expenses":{"description":"Operating expenses not classified in the main expense categories.","format":"double","type":"number"},"period_end":{"description":"The last date of the reporting period (formatted as YYYY-MM-DD).","format":"date","type":"string"},"preferred_stock_dividends_declared":{"description":"Dividends declared on preferred stock during the period.","format":"double","type":"number"},"research_development":{"description":"Expenses incurred for research and development activities to create new products or improve existing ones.","format":"double","type":"number"},"revenue":{"description":"Total revenue or net sales for the period, representing the company's gross income from operations.","format":"double","type":"number"},"selling_general_administrative":{"description":"Expenses related to selling products and general administrative costs not directly tied to production.","format":"double","type":"number"},"tickers":{"description":"A list of ticker symbols under which the company is listed. Multiple symbols may indicate different share classes for the same company.","items":{"type":"string"},"type":"array"},"timeframe":{"description":"The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months.","type":"string"},"total_operating_expenses":{"description":"Sum of all operating expenses including cost of revenue, SG\u0026A, R\u0026D, depreciation, and other operating expenses.","format":"double","type":"number"},"total_other_income_expense":{"description":"Net total of all non-operating income and expenses including interest income, interest expense, and other items.","format":"double","type":"number"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["financials"]}},"/stocks/financials/v1/ratios":{"get":{"description":"A comprehensive financial ratios dataset providing key valuation, profitability, liquidity, and leverage metrics for public companies. Combines data from income statements, balance sheets, and cash flow statements with daily stock prices to calculate ratios on a daily basis. Uses trailing twelve months (TTM) data for income/cash flow metrics and quarterly data for balance sheet items. Fundamental data updates are applied starting from each filing's period end date. Market cap calculations use point-in-time shares outstanding for historical accuracy.","operationId":"get_stocks_financials_v1_ratios","parameters":[{"description":"Stock ticker symbol for the company.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Central Index Key (CIK) number assigned by the SEC to identify the company.","in":"query","name":"cik","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"cik.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"cik.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"cik.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"cik.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"cik.lte","schema":{"type":"string"}},{"description":"Stock price used in ratio calculations, typically the closing price for the given date. Value must be a floating point number.","in":"query","name":"price","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"price.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"price.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"price.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"price.lte","schema":{"format":"double","type":"number"}},{"description":"Average trading volume over the last 30 trading days, providing context for liquidity. Value must be a floating point number.","in":"query","name":"average_volume","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"average_volume.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"average_volume.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"average_volume.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"average_volume.lte","schema":{"format":"double","type":"number"}},{"description":"Market capitalization, calculated as stock price multiplied by total shares outstanding. Value must be a floating point number.","in":"query","name":"market_cap","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"market_cap.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"market_cap.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"market_cap.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"market_cap.lte","schema":{"format":"double","type":"number"}},{"description":"Earnings per share, calculated as net income available to common shareholders divided by weighted shares outstanding. Value must be a floating point number.","in":"query","name":"earnings_per_share","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"earnings_per_share.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"earnings_per_share.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"earnings_per_share.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"earnings_per_share.lte","schema":{"format":"double","type":"number"}},{"description":"Price-to-earnings ratio, calculated as stock price divided by earnings per share. Only calculated when earnings per share is positive. Value must be a floating point number.","in":"query","name":"price_to_earnings","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"price_to_earnings.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"price_to_earnings.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"price_to_earnings.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"price_to_earnings.lte","schema":{"format":"double","type":"number"}},{"description":"Price-to-book ratio, calculated as stock price divided by book value per share, comparing market value to book value. Value must be a floating point number.","in":"query","name":"price_to_book","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"price_to_book.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"price_to_book.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"price_to_book.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"price_to_book.lte","schema":{"format":"double","type":"number"}},{"description":"Price-to-sales ratio, calculated as stock price divided by revenue per share, measuring valuation relative to sales. Value must be a floating point number.","in":"query","name":"price_to_sales","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"price_to_sales.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"price_to_sales.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"price_to_sales.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"price_to_sales.lte","schema":{"format":"double","type":"number"}},{"description":"Price-to-cash-flow ratio, calculated as stock price divided by operating cash flow per share. Only calculated when operating cash flow per share is positive. Value must be a floating point number.","in":"query","name":"price_to_cash_flow","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"price_to_cash_flow.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"price_to_cash_flow.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"price_to_cash_flow.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"price_to_cash_flow.lte","schema":{"format":"double","type":"number"}},{"description":"Price-to-free-cash-flow ratio, calculated as stock price divided by free cash flow per share. Only calculated when free cash flow per share is positive. Value must be a floating point number.","in":"query","name":"price_to_free_cash_flow","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"price_to_free_cash_flow.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"price_to_free_cash_flow.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"price_to_free_cash_flow.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"price_to_free_cash_flow.lte","schema":{"format":"double","type":"number"}},{"description":"Dividend yield, calculated as annual dividends per share divided by stock price, measuring the income return on investment. Value must be a floating point number.","in":"query","name":"dividend_yield","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"dividend_yield.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"dividend_yield.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"dividend_yield.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"dividend_yield.lte","schema":{"format":"double","type":"number"}},{"description":"Return on assets ratio, calculated as net income divided by total assets, measuring how efficiently a company uses its assets to generate profit. Value must be a floating point number.","in":"query","name":"return_on_assets","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"return_on_assets.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"return_on_assets.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"return_on_assets.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"return_on_assets.lte","schema":{"format":"double","type":"number"}},{"description":"Return on equity ratio, calculated as net income divided by total shareholders' equity, measuring profitability relative to shareholders' equity. Value must be a floating point number.","in":"query","name":"return_on_equity","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"return_on_equity.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"return_on_equity.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"return_on_equity.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"return_on_equity.lte","schema":{"format":"double","type":"number"}},{"description":"Debt-to-equity ratio, calculated as total debt (current debt plus long-term debt) divided by total shareholders' equity, measuring financial leverage. Value must be a floating point number.","in":"query","name":"debt_to_equity","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"debt_to_equity.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"debt_to_equity.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"debt_to_equity.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"debt_to_equity.lte","schema":{"format":"double","type":"number"}},{"description":"Current ratio, calculated as total current assets divided by total current liabilities, measuring short-term liquidity. Value must be a floating point number.","in":"query","name":"current","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"current.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"current.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"current.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"current.lte","schema":{"format":"double","type":"number"}},{"description":"Quick ratio (acid-test ratio), calculated as (current assets minus inventories) divided by current liabilities, measuring immediate liquidity. Value must be a floating point number.","in":"query","name":"quick","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"quick.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"quick.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"quick.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"quick.lte","schema":{"format":"double","type":"number"}},{"description":"Cash ratio, calculated as cash and cash equivalents divided by current liabilities, measuring the most liquid form of liquidity coverage. Value must be a floating point number.","in":"query","name":"cash","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"cash.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"cash.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"cash.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"cash.lte","schema":{"format":"double","type":"number"}},{"description":"Enterprise value to sales ratio, calculated as enterprise value divided by revenue, measuring company valuation relative to sales. Value must be a floating point number.","in":"query","name":"ev_to_sales","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"ev_to_sales.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"ev_to_sales.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"ev_to_sales.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"ev_to_sales.lte","schema":{"format":"double","type":"number"}},{"description":"Enterprise value to EBITDA ratio, calculated as enterprise value divided by EBITDA, measuring company valuation relative to earnings before interest, taxes, depreciation, and amortization. Value must be a floating point number.","in":"query","name":"ev_to_ebitda","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"ev_to_ebitda.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"ev_to_ebitda.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"ev_to_ebitda.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"ev_to_ebitda.lte","schema":{"format":"double","type":"number"}},{"description":"Enterprise value, calculated as market capitalization plus total debt minus cash and cash equivalents, representing total company value. Value must be a floating point number.","in":"query","name":"enterprise_value","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"enterprise_value.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"enterprise_value.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"enterprise_value.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"enterprise_value.lte","schema":{"format":"double","type":"number"}},{"description":"Free cash flow, calculated as operating cash flow minus capital expenditures (purchase of property, plant, and equipment). Value must be a floating point number.","in":"query","name":"free_cash_flow","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"free_cash_flow.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"free_cash_flow.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"free_cash_flow.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"free_cash_flow.lte","schema":{"format":"double","type":"number"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'ticker' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"ticker.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":"8f5374516fec4a819070e53609f47fab","results":[{"average_volume":47500000,"cash":0.19,"cik":"320193","current":0.68,"date":"2024-09-19","debt_to_equity":1.52,"dividend_yield":0.0044,"earnings_per_share":6.57,"enterprise_value":3555509835190,"ev_to_ebitda":26.98,"ev_to_sales":9.22,"free_cash_flow":104339000000,"market_cap":3479770835190,"price":228.87,"price_to_book":52.16,"price_to_cash_flow":30.78,"price_to_earnings":34.84,"price_to_free_cash_flow":33.35,"price_to_sales":9.02,"quick":0.63,"return_on_assets":0.3075,"return_on_equity":1.5284,"ticker":"AAPL"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"average_volume":{"description":"Average trading volume over the last 30 trading days, providing context for liquidity.","format":"double","type":"number"},"cash":{"description":"Cash ratio, calculated as cash and cash equivalents divided by current liabilities, measuring the most liquid form of liquidity coverage.","format":"double","type":"number"},"cik":{"description":"Central Index Key (CIK) number assigned by the SEC to identify the company.","type":"string"},"current":{"description":"Current ratio, calculated as total current assets divided by total current liabilities, measuring short-term liquidity.","format":"double","type":"number"},"date":{"description":"Date for which the ratios are calculated, representing the trading date with available price data.","type":"string"},"debt_to_equity":{"description":"Debt-to-equity ratio, calculated as total debt (current debt plus long-term debt) divided by total shareholders' equity, measuring financial leverage.","format":"double","type":"number"},"dividend_yield":{"description":"Dividend yield, calculated as annual dividends per share divided by stock price, measuring the income return on investment.","format":"double","type":"number"},"earnings_per_share":{"description":"Earnings per share, calculated as net income available to common shareholders divided by weighted shares outstanding.","format":"double","type":"number"},"enterprise_value":{"description":"Enterprise value, calculated as market capitalization plus total debt minus cash and cash equivalents, representing total company value.","format":"double","type":"number"},"ev_to_ebitda":{"description":"Enterprise value to EBITDA ratio, calculated as enterprise value divided by EBITDA, measuring company valuation relative to earnings before interest, taxes, depreciation, and amortization.","format":"double","type":"number"},"ev_to_sales":{"description":"Enterprise value to sales ratio, calculated as enterprise value divided by revenue, measuring company valuation relative to sales.","format":"double","type":"number"},"free_cash_flow":{"description":"Free cash flow, calculated as operating cash flow minus capital expenditures (purchase of property, plant, and equipment).","format":"double","type":"number"},"market_cap":{"description":"Market capitalization, calculated as stock price multiplied by total shares outstanding.","format":"double","type":"number"},"price":{"description":"Stock price used in ratio calculations, typically the closing price for the given date.","format":"double","type":"number"},"price_to_book":{"description":"Price-to-book ratio, calculated as stock price divided by book value per share, comparing market value to book value.","format":"double","type":"number"},"price_to_cash_flow":{"description":"Price-to-cash-flow ratio, calculated as stock price divided by operating cash flow per share. Only calculated when operating cash flow per share is positive.","format":"double","type":"number"},"price_to_earnings":{"description":"Price-to-earnings ratio, calculated as stock price divided by earnings per share. Only calculated when earnings per share is positive.","format":"double","type":"number"},"price_to_free_cash_flow":{"description":"Price-to-free-cash-flow ratio, calculated as stock price divided by free cash flow per share. Only calculated when free cash flow per share is positive.","format":"double","type":"number"},"price_to_sales":{"description":"Price-to-sales ratio, calculated as stock price divided by revenue per share, measuring valuation relative to sales.","format":"double","type":"number"},"quick":{"description":"Quick ratio (acid-test ratio), calculated as (current assets minus inventories) divided by current liabilities, measuring immediate liquidity.","format":"double","type":"number"},"return_on_assets":{"description":"Return on assets ratio, calculated as net income divided by total assets, measuring how efficiently a company uses its assets to generate profit.","format":"double","type":"number"},"return_on_equity":{"description":"Return on equity ratio, calculated as net income divided by total shareholders' equity, measuring profitability relative to shareholders' equity.","format":"double","type":"number"},"ticker":{"description":"Stock ticker symbol for the company.","type":"string"}},"required":["ticker","date"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["financials"]}},"/stocks/taxonomies/vX/risk-factors":{"get":{"description":"The complete list of risk factor classifications used in the risk factors endpoint.","operationId":"get_stocks_taxonomies_vX_risk-factors","parameters":[{"description":"Version identifier (e.g., '1.0', '1.1') for the taxonomy Value must be a floating point number.","in":"query","name":"taxonomy","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"taxonomy.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"taxonomy.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"taxonomy.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"taxonomy.lte","schema":{"format":"double","type":"number"}},{"description":"Top-level risk category","in":"query","name":"primary_category","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"primary_category.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"primary_category.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"primary_category.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"primary_category.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"primary_category.lte","schema":{"type":"string"}},{"description":"Mid-level risk category","in":"query","name":"secondary_category","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"secondary_category.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"secondary_category.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"secondary_category.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"secondary_category.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"secondary_category.lte","schema":{"type":"string"}},{"description":"Most specific risk classification","in":"query","name":"tertiary_category","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"tertiary_category.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"tertiary_category.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"tertiary_category.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"tertiary_category.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"tertiary_category.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '200' if not specified. The maximum allowed limit is '999'.","in":"query","name":"limit","schema":{"default":200,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'taxonomy' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"taxonomy.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"daac836f71724420b66011d55d88b30b","results":[{"description":"Risk from inadequate performance management systems, unclear accountability structures, or ineffective measurement and incentive systems that could affect employee performance, goal achievement, and organizational effectiveness.","primary_category":"Governance \u0026 Stakeholder","secondary_category":"Organizational \u0026 Management","taxonomy":"1.0","tertiary_category":"Performance management and accountability"},{"description":"Risk from requirements to monitor, document, and report on compliance with privacy and data protection regulations including risks from compliance program effectiveness, record-keeping requirements, and breach notification obligations.","primary_category":"Regulatory \u0026 Compliance","secondary_category":"Data \u0026 Privacy","taxonomy":"1.0","tertiary_category":"Compliance monitoring and reporting"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"description":{"description":"Detailed explanation of what this risk category encompasses, including specific examples and potential impacts","type":"string"},"primary_category":{"description":"Top-level risk category","type":"string"},"secondary_category":{"description":"Mid-level risk category","type":"string"},"taxonomy":{"description":"Version identifier (e.g., '1.0', '1.1') for the taxonomy","format":"double","type":"number"},"tertiary_category":{"description":"Most specific risk classification","type":"string"}},"required":["taxonomy"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["reference"]}},"/stocks/v1/dividends":{"get":{"description":"Contains historical dividend payment records for US stocks with split-adjusted amounts and historical adjustment factors for price normalization.","operationId":"get_stocks_v1_dividends","parameters":[{"description":"Stock symbol for the company issuing the dividend","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Date when the stock begins trading without the dividend value Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"ex_dividend_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"ex_dividend_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"ex_dividend_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"ex_dividend_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"ex_dividend_date.lte","schema":{"type":"string"}},{"description":"How many times per year this dividend is expected to occur. A value of 0 means the distribution is non-recurring or irregular (e.g., special, supplemental, or a one-off dividend). Other possible values include 1 (annual), 2 (semi-annual), 3 (trimester), 4 (quarterly), 12 (monthly), 24 (bi-monthly), 52 (weekly), 104 (bi-weekly), and 365 (daily) depending on the issuer's declared or inferred payout cadence. Value must be an integer.","in":"query","name":"frequency","schema":{"format":"int64","type":"integer"}},{"description":"Filter greater than the value. Value must be an integer.","in":"query","name":"frequency.gt","schema":{"format":"int64","type":"integer"}},{"description":"Filter greater than or equal to the value. Value must be an integer.","in":"query","name":"frequency.gte","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than the value. Value must be an integer.","in":"query","name":"frequency.lt","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than or equal to the value. Value must be an integer.","in":"query","name":"frequency.lte","schema":{"format":"int64","type":"integer"}},{"description":"Classification describing the nature of this dividend's recurrence pattern: recurring (paid on a regular schedule), special (one-time or commemorative), supplemental (extra beyond the regular schedule), irregular (unpredictable or non-recurring), unknown (cannot be classified from available data)","in":"query","name":"distribution_type","schema":{"enum":["recurring","special","supplemental","irregular","unknown"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"distribution_type.any_of","schema":{"enum":["recurring","special","supplemental","irregular","unknown"],"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'.","in":"query","name":"limit","schema":{"default":100,"maximum":5001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'ticker' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"ticker.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":1,"results":[{"cash_amount":0.26,"currency":"USD","declaration_date":"2025-07-31","distribution_type":"recurring","ex_dividend_date":"2025-08-11","frequency":4,"historical_adjustment_factor":0.997899,"id":"Ed2c9da60abda1e3f0e99a43f6465863c137b671e1f5cd3f833d1fcb4f4eb27fe","pay_date":"2025-08-14","record_date":"2025-08-11","split_adjusted_cash_amount":0.26,"ticker":"AAPL"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"cash_amount":{"description":"Original dividend amount per share in the specified currency","format":"double","type":"number"},"currency":{"description":"Currency code for the dividend payment (e.g., USD, CAD)","type":"string"},"declaration_date":{"description":"Date when the company officially announced the dividend","format":"date","type":"string"},"distribution_type":{"description":"Classification describing the nature of this dividend's recurrence pattern: recurring (paid on a regular schedule), special (one-time or commemorative), supplemental (extra beyond the regular schedule), irregular (unpredictable or non-recurring), unknown (cannot be classified from available data)","type":"string"},"ex_dividend_date":{"description":"Date when the stock begins trading without the dividend value","format":"date","type":"string"},"frequency":{"description":"How many times per year this dividend is expected to occur. A value of 0 means the distribution is non-recurring or irregular (e.g., special, supplemental, or a one-off dividend). Other possible values include 1 (annual), 2 (semi-annual), 3 (trimester), 4 (quarterly), 12 (monthly), 24 (bi-monthly), 52 (weekly), 104 (bi-weekly), and 365 (daily) depending on the issuer's declared or inferred payout cadence.","format":"int64","type":"integer"},"historical_adjustment_factor":{"description":"Cumulative adjustment factor used to offset dividend effects on historical prices. To adjust a historical price for dividends: for a price on date D, find the first dividend whose `ex_dividend_date` is after date D and multiply the price by that dividend's `historical_adjustment_factor`.","format":"double","type":"number"},"id":{"description":"Unique identifier for each dividend record","type":"string"},"pay_date":{"description":"Date when the dividend payment is distributed to shareholders","format":"date","type":"string"},"record_date":{"description":"Date when shareholders must be on record to be eligible for the dividend payment","format":"date","type":"string"},"split_adjusted_cash_amount":{"description":"Dividend amount adjusted for stock splits that occurred after the dividend was paid, expressed on a current share basis","format":"double","type":"number"},"ticker":{"description":"Stock symbol for the company issuing the dividend","type":"string"}},"required":["distribution_type"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["us_stocks_reference"]}},"/stocks/v1/exchanges":{"get":{"description":"US stock exchanges, trading venues, and reporting facilities including exchanges (NYSE, Nasdaq), Trade Reporting Facilities (TRF), Securities Information Processors (SIP), and OTC Reporting Facilities (ORF) for equity trading.","operationId":"get_stocks_v1_exchanges","parameters":[{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '999'.","in":"query","name":"limit","schema":{"default":100,"maximum":1000,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":2,"request_id":1,"results":[{"id":"10","locale":"US","mic":"XNYS","name":"New York Stock Exchange","operating_mic":"XNYS","participant_id":"N","type":"exchange","url":"https://www.nyse.com"},{"id":"12","locale":"US","mic":"XNAS","name":"Nasdaq","operating_mic":"XNAS","participant_id":"T","type":"exchange","url":"https://www.nasdaq.com"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"acronym":{"description":"Short acronym or abbreviation (may be null for some venues).","type":"string"},"id":{"description":"Numeric identifier for the trading venue or exchange.","type":"string"},"locale":{"description":"Geographic location code.","type":"string"},"mic":{"description":"Market Identifier Code (MIC) - ISO 10383 standard four-character code for the market (may be empty for some venues).","type":"string"},"name":{"description":"Full official name of the exchange, trading venue, or reporting facility.","type":"string"},"operating_mic":{"description":"Operating Market Identifier Code - identifies the specific operating entity or parent organization.","type":"string"},"participant_id":{"description":"Single-character participant identifier used in market data feeds and trade reporting.","type":"string"},"type":{"description":"Type of trading venue: 'exchange' for stock exchanges, 'TRF' for Trade Reporting Facilities, 'SIP' for Securities Information Processors, 'ORF' for OTC Reporting Facility.","type":"string"},"url":{"description":"Official website URL of the organization operating the venue.","type":"string"}},"required":["id","type","name"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["us_stocks_all"]}},"/stocks/v1/short-interest":{"get":{"description":"Comprehensive FINRA short interest data that tracks the short selling metrics for securities on a specific settlement date.","operationId":"get_stocks_v1_short-interest","parameters":[{"description":"The primary ticker symbol for the stock.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Calculated as short_interest divided by avg_daily_volume, representing the estimated number of days it would take to cover all short positions based on average trading volume. Value must be a floating point number.","in":"query","name":"days_to_cover","schema":{"format":"double","type":"number"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number.","in":"query","name":"days_to_cover.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"days_to_cover.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"days_to_cover.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"days_to_cover.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"days_to_cover.lte","schema":{"format":"double","type":"number"}},{"description":"The date (formatted as YYYY-MM-DD) on which the short interest data is considered settled, typically based on exchange reporting schedules.","in":"query","name":"settlement_date","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"settlement_date.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"settlement_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"settlement_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"settlement_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"settlement_date.lte","schema":{"type":"string"}},{"description":"The average daily trading volume for the stock over a specified period, typically used to contextualize short interest. Value must be an integer.","in":"query","name":"avg_daily_volume","schema":{"format":"int64","type":"integer"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer.","in":"query","name":"avg_daily_volume.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be an integer.","in":"query","name":"avg_daily_volume.gt","schema":{"format":"int64","type":"integer"}},{"description":"Filter greater than or equal to the value. Value must be an integer.","in":"query","name":"avg_daily_volume.gte","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than the value. Value must be an integer.","in":"query","name":"avg_daily_volume.lt","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than or equal to the value. Value must be an integer.","in":"query","name":"avg_daily_volume.lte","schema":{"format":"int64","type":"integer"}},{"description":"Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":10,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'ticker' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"ticker.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"avg_daily_volume":2340158,"days_to_cover":1.67,"settlement_date":"2025-03-14","short_interest":3906231,"ticker":"A"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"avg_daily_volume":{"description":"The average daily trading volume for the stock over a specified period, typically used to contextualize short interest.","format":"int64","type":"integer"},"days_to_cover":{"description":"Calculated as short_interest divided by avg_daily_volume, representing the estimated number of days it would take to cover all short positions based on average trading volume.","format":"double","type":"number"},"settlement_date":{"description":"The date (formatted as YYYY-MM-DD) on which the short interest data is considered settled, typically based on exchange reporting schedules.","type":"string"},"short_interest":{"description":"The total number of shares that have been sold short but have not yet been covered or closed out.","format":"int64","type":"integer"},"ticker":{"description":"The primary ticker symbol for the stock.","type":"string"}},"required":["settlement_date","avg_daily_volume","days_to_cover"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["reference"]}},"/stocks/v1/short-volume":{"get":{"description":"Contains short selling volume for different stock tickers, capturing total trading volume, short sale details, and breakdown by different trading platforms.","operationId":"get_stocks_v1_short-volume","parameters":[{"description":"The primary ticker symbol for the stock.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"The date of trade activity reported in the format YYYY-MM-DD","in":"query","name":"date","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"date.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"date.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"date.lte","schema":{"type":"string"}},{"description":"The percentage of total volume that was sold short. Calculated as (short_volume / total_volume) * 100. Value must be a floating point number.","in":"query","name":"short_volume_ratio","schema":{"format":"double","type":"number"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number.","in":"query","name":"short_volume_ratio.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"short_volume_ratio.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"short_volume_ratio.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"short_volume_ratio.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"short_volume_ratio.lte","schema":{"format":"double","type":"number"}},{"description":"Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":10,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'ticker' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"ticker.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"adf_short_volume":0,"adf_short_volume_exempt":0,"date":"2025-03-25","exempt_volume":1,"nasdaq_carteret_short_volume":179943,"nasdaq_carteret_short_volume_exempt":1,"nasdaq_chicago_short_volume":1,"nasdaq_chicago_short_volume_exempt":0,"non_exempt_volume":181218,"nyse_short_volume":1275,"nyse_short_volume_exempt":0,"short_volume":181219,"short_volume_ratio":31.57,"ticker":"A","total_volume":574084}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"adf_short_volume":{"description":"Short volume reported via the Alternative Display Facility (ADF), excluding exempt volume.","format":"int64","type":"integer"},"adf_short_volume_exempt":{"description":"Short volume reported via ADF that was marked as exempt.","format":"int64","type":"integer"},"date":{"description":"The date of trade activity reported in the format YYYY-MM-DD","type":"string"},"exempt_volume":{"description":"Portion of short volume that was marked as exempt from regulation SHO.","format":"double","type":"number"},"nasdaq_carteret_short_volume":{"description":"Short volume reported from Nasdaq's Carteret facility, excluding exempt volume.","format":"int64","type":"integer"},"nasdaq_carteret_short_volume_exempt":{"description":"Short volume from Nasdaq Carteret that was marked as exempt.","format":"int64","type":"integer"},"nasdaq_chicago_short_volume":{"description":"Short volume reported from Nasdaq's Chicago facility, excluding exempt volume.","format":"int64","type":"integer"},"nasdaq_chicago_short_volume_exempt":{"description":"Short volume from Nasdaq Chicago that was marked as exempt.","format":"int64","type":"integer"},"non_exempt_volume":{"description":"Portion of short volume that was not exempt from regulation SHO (i.e., short_volume - exempt_volume).","format":"double","type":"number"},"nyse_short_volume":{"description":"Short volume reported from NYSE facilities, excluding exempt volume.","format":"int64","type":"integer"},"nyse_short_volume_exempt":{"description":"Short volume from NYSE facilities that was marked as exempt.","format":"int64","type":"integer"},"short_volume":{"description":"Total number of shares sold short across all venues for the ticker on the given date.","format":"double","type":"number"},"short_volume_ratio":{"description":"The percentage of total volume that was sold short. Calculated as (short_volume / total_volume) * 100.","format":"float","type":"number"},"ticker":{"description":"The primary ticker symbol for the stock.","type":"string"},"total_volume":{"description":"Total reported volume across all venues for the ticker on the given date.","format":"double","type":"number"}},"required":["date"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["reference"]}},"/stocks/v1/splits":{"get":{"description":"Contains historical stock split and reverse split events for US equities with historical adjustment factors for price normalization.","operationId":"get_stocks_v1_splits","parameters":[{"description":"Stock symbol for the company that executed the split","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Date when the stock split was applied and shares adjusted Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"execution_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"execution_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"execution_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"execution_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.","in":"query","name":"execution_date.lte","schema":{"type":"string"}},{"description":"Classification of the share-change event. Possible values include: forward_split (share count increases), reverse_split (share count decreases), stock_dividend (shares issued as a dividend)","in":"query","name":"adjustment_type","schema":{"enum":["forward_split","reverse_split","stock_dividend"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"adjustment_type.any_of","schema":{"enum":["forward_split","reverse_split","stock_dividend"],"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'.","in":"query","name":"limit","schema":{"default":100,"maximum":5001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'execution_date' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"execution_date.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":1,"results":[{"adjustment_type":"forward_split","execution_date":"2005-02-28","historical_adjustment_factor":0.017857,"id":"E90a77bdf742661741ed7c8fc086415f0457c2816c45899d73aaa88bdc8ff6025","split_from":1,"split_to":2,"ticker":"AAPL"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"adjustment_type":{"description":"Classification of the share-change event. Possible values include: forward_split (share count increases), reverse_split (share count decreases), stock_dividend (shares issued as a dividend)","type":"string"},"execution_date":{"description":"Date when the stock split was applied and shares adjusted","format":"date","type":"string"},"historical_adjustment_factor":{"description":"Cumulative adjustment factor used to offset split effects on historical prices. To adjust a historical price for splits: for a price on date D, find the first split whose `execution_date` is after date D and multiply the unadjusted price by the `historical_adjustment_factor`.","format":"double","type":"number"},"id":{"description":"Unique identifier for each stock split event","type":"string"},"split_from":{"description":"Denominator of the split ratio (old shares)","format":"double","type":"number"},"split_to":{"description":"Numerator of the split ratio (new shares)","format":"double","type":"number"},"ticker":{"description":"Stock symbol for the company that executed the split","type":"string"}},"required":["adjustment_type"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["us_stocks_reference"]}},"/stocks/vX/float":{"get":{"description":"Contains free float data for US-listed securities, showing the most recent available number of shares available for public trading and the percentage of total shares outstanding.","operationId":"get_stocks_vX_float","parameters":[{"description":"The primary ticker symbol for the stock.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Percentage of total shares outstanding that are available for public trading, rounded to two decimal places. Value must be a floating point number.","in":"query","name":"free_float_percent","schema":{"format":"double","type":"number"}},{"description":"Filter greater than the value. Value must be a floating point number.","in":"query","name":"free_float_percent.gt","schema":{"format":"double","type":"number"}},{"description":"Filter greater than or equal to the value. Value must be a floating point number.","in":"query","name":"free_float_percent.gte","schema":{"format":"double","type":"number"}},{"description":"Filter less than the value. Value must be a floating point number.","in":"query","name":"free_float_percent.lt","schema":{"format":"double","type":"number"}},{"description":"Filter less than or equal to the value. Value must be a floating point number.","in":"query","name":"free_float_percent.lte","schema":{"format":"double","type":"number"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'.","in":"query","name":"limit","schema":{"default":100,"maximum":5001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'ticker' if not specified. The sort order defaults to 'asc' if not specified.","in":"query","name":"sort","schema":{"default":"ticker.asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":1,"results":[{"effective_date":"2025-11-01","free_float":15000000000,"free_float_percent":98.5,"ticker":"AAPL"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"effective_date":{"description":"The effective date of the free float measurement.","format":"date","type":"string"},"free_float":{"description":"Number of shares freely tradable in the market. Free float shares represent the portion of a company's outstanding shares that is freely tradable in the market, excluding any holdings considered strategic, controlling, or long term. This excludes insiders, directors, founders, 5 percent plus shareholders, cross holdings, government stakes except pensions, restricted or locked up shares, employee plans, and any entities with board influence, leaving only shares that are genuinely available for public trading.","format":"int64","type":"integer"},"free_float_percent":{"description":"Percentage of total shares outstanding that are available for public trading, rounded to two decimal places.","format":"double","type":"number"},"ticker":{"description":"The primary ticker symbol for the stock.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["reference"]}},"/tmx/v1/corporate-events":{"get":{"description":"Contains corporate events and announcements for publicly traded companies, including earnings releases, conferences, dividends, and business updates sourced from TMX.","operationId":"get_tmx_v1_corporate-events","parameters":[{"description":"Scheduled date of the corporate event, formatted as YYYY-MM-DD.","in":"query","name":"date","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"date.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"date.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"date.lte","schema":{"type":"string"}},{"description":"The normalized type of corporate event. Possible values include: analyst_day, business_update, capital_markets_day, conference, dividend, earnings_announcement_date, earnings_conference_call, earnings_results_announcement, forum, interim_statement, other_interim_announcement, production_update, research_and_development_day, seminar, shareholder_meeting, sales_update, stock_split, summit, service_level_update, tradeshow, company_travel, and workshop.","in":"query","name":"type","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"type.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"type.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"type.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"type.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"type.lte","schema":{"type":"string"}},{"description":"The current status of the event. Possible values include: approved, canceled, confirmed, historical, pending_approval, postponed, and unconfirmed.","in":"query","name":"status","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"status.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"status.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"status.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"status.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"status.lte","schema":{"type":"string"}},{"description":"The company's stock symbol.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Standard international identifier for the company's common stock.","in":"query","name":"isin","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"isin.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"isin.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"isin.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"isin.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"isin.lte","schema":{"type":"string"}},{"description":"MIC (Market Identifier Code) of the exchange where the company's stock is listed.","in":"query","name":"trading_venue","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"trading_venue.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"trading_venue.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"trading_venue.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"trading_venue.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"trading_venue.lte","schema":{"type":"string"}},{"description":"Unique numeric identifier for the company used by TMX. Value must be an integer.","in":"query","name":"tmx_company_id","schema":{"format":"int64","type":"integer"}},{"description":"Filter greater than the value. Value must be an integer.","in":"query","name":"tmx_company_id.gt","schema":{"format":"int64","type":"integer"}},{"description":"Filter greater than or equal to the value. Value must be an integer.","in":"query","name":"tmx_company_id.gte","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than the value. Value must be an integer.","in":"query","name":"tmx_company_id.lt","schema":{"format":"int64","type":"integer"}},{"description":"Filter less than or equal to the value. Value must be an integer.","in":"query","name":"tmx_company_id.lte","schema":{"format":"int64","type":"integer"}},{"description":"The unique alphanumeric identifier for the event record used by TMX.","in":"query","name":"tmx_record_id","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"tmx_record_id.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"tmx_record_id.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"tmx_record_id.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"tmx_record_id.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"tmx_record_id.lte","schema":{"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.","in":"query","name":"limit","schema":{"default":100,"maximum":50001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"date.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"request_id":1,"results":[{"company_name":"Rollins Inc.","date":"2025-07-23","isin":"US7757111049","name":"Q2 2025 Earnings Announcement-After Mkt","status":"unconfirmed","ticker":"ROL","tmx_company_id":"2208","tmx_record_id":"4XMW4E9G","trading_venue":"XNYS","type":"earnings_announcement_date"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"company_name":{"description":"Full name of the company.","type":"string"},"date":{"description":"Scheduled date of the corporate event, formatted as YYYY-MM-DD.","type":"string"},"isin":{"description":"Standard international identifier for the company's common stock.","type":"string"},"name":{"description":"Name or title of the event.","type":"string"},"status":{"description":"The current status of the event. Possible values include: approved, canceled, confirmed, historical, pending_approval, postponed, and unconfirmed.","type":"string"},"ticker":{"description":"The company's stock symbol.","type":"string"},"tmx_company_id":{"description":"Unique numeric identifier for the company used by TMX.","format":"int64","type":"integer"},"tmx_record_id":{"description":"The unique alphanumeric identifier for the event record used by TMX.","type":"string"},"trading_venue":{"description":"MIC (Market Identifier Code) of the exchange where the company's stock is listed.","type":"string"},"type":{"description":"The normalized type of corporate event. Possible values include: analyst_day, business_update, capital_markets_day, conference, dividend, earnings_announcement_date, earnings_conference_call, earnings_results_announcement, forum, interim_statement, other_interim_announcement, production_update, research_and_development_day, seminar, shareholder_meeting, sales_update, stock_split, summit, service_level_update, tradeshow, company_travel, and workshop.","type":"string"},"url":{"description":"URL linking to the primary public source of the event announcement, if available.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["tmx"]}},"/v1/conversion/{from}/{to}":{"get":{"description":"Get currency conversions using the latest market conversion rates. Note than you can convert in both directions. For example USD to CAD or CAD to USD.","operationId":"RealTimeCurrencyConversion","parameters":[{"description":"The \"from\" symbol of the pair.","example":"AUD","in":"path","name":"from","required":true,"schema":{"type":"string"}},{"description":"The \"to\" symbol of the pair.","example":"USD","in":"path","name":"to","required":true,"schema":{"type":"string"}},{"description":"The amount to convert, with a decimal.","example":100,"in":"query","name":"amount","schema":{"default":1,"type":"number"}},{"description":"The decimal precision of the conversion. Defaults to 2 which is 2 decimal places accuracy.","example":2,"in":"query","name":"precision","schema":{"default":2,"enum":[0,1,2,3,4],"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"converted":73.14,"from":"AUD","initialAmount":100,"last":{"ask":1.3673344,"bid":1.3672596,"exchange":48,"timestamp":1605555313000},"request_id":"a73a29dbcab4613eeaf48583d3baacf0","status":"success","symbol":"AUD/USD","to":"USD"},"schema":{"properties":{"converted":{"description":"The result of the conversion.","format":"double","type":"number"},"from":{"description":"The \"from\" currency symbol.","type":"string"},"initialAmount":{"description":"The amount to convert.","format":"double","type":"number","x-polygon-go-type":{"name":"*float64"}},"last":{"description":"Contains the requested quote data for the specified forex currency pair.","properties":{"ask":{"description":"The ask price.","format":"double","type":"number"},"bid":{"description":"The bid price.","format":"double","type":"number"},"exchange":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/forex/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"timestamp":{"description":"The Unix millisecond timestamp.","type":"integer","x-polygon-go-type":{"name":"IMilliseconds","path":"github.com/polygon-io/ptime"}}},"required":["exchange","timestamp","ask","bid"],"type":"object","x-polygon-go-type":{"name":"LastQuoteCurrencies"}},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","type":"string"},"symbol":{"description":"The symbol pair that was evaluated from the request.","type":"string"},"to":{"description":"The \"to\" currency symbol.","type":"string"}},"required":["status","request_id","from","to","symbol","initialAmount","converted"],"type":"object"}},"text/csv":{"example":"ask,bid,exchange,timestamp\n1.3673344,1.3672596,48,1605555313000\n","schema":{"type":"string"}}},"description":"The last tick for this currency pair, plus the converted amount for the requested amount."},"default":{"description":"Unexpected error"}},"summary":"Real-time Currency Conversion","tags":["fx:conversion"],"x-polygon-entitlement-data-type":{"description":"NBBO data","name":"nbbo"},"x-polygon-entitlement-market-type":{"description":"Forex data","name":"fx"}}},"/v1/historic/crypto/{from}/{to}/{date}":{"get":{"description":"Get historic trade ticks for a cryptocurrency pair.\n","operationId":"DeprecatedGetHistoricCryptoTrades","parameters":[{"description":"The \"from\" symbol of the crypto pair.","example":"BTC","in":"path","name":"from","required":true,"schema":{"type":"string"}},{"description":"The \"to\" symbol of the crypto pair.","example":"USD","in":"path","name":"to","required":true,"schema":{"type":"string"}},{"description":"The date/day of the historic ticks to retrieve.","example":"2020-10-14","in":"path","name":"date","required":true,"schema":{"format":"date","type":"string"}},{"description":"The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results.\n","in":"query","name":"offset","schema":{"type":"integer"}},{"description":"Limit the size of the response, max 10000.","example":100,"in":"query","name":"limit","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"day":"2020-10-14T00:00:00.000Z","map":{"c":"conditions","p":"price","s":"size","t":"timestamp","x":"exchange"},"msLatency":1,"status":"success","symbol":"BTC-USD","ticks":[{"c":[2],"p":15482.89,"s":0.00188217,"t":1604880000067,"x":1},{"c":[2],"p":15482.11,"s":0.00161739,"t":1604880000167,"x":1}],"type":"crypto"},"schema":{"allOf":[{"description":"The status of this request's response.","type":"string"},{"properties":{"day":{"description":"The date that was evaluated from the request.","format":"date","type":"string"},"map":{"description":"A map for shortened result keys.","type":"object"},"msLatency":{"description":"The milliseconds of latency for the query results.","type":"integer"},"symbol":{"description":"The symbol pair that was evaluated from the request.","type":"string"},"ticks":{"items":{"properties":{"c":{"description":"A list of condition codes.\n","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.\n","type":"integer"},"type":"array"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size of a trade (also known as volume).\n","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"x":{"description":"The exchange that this crypto trade happened on.  \nSee \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\"\u003eExchanges\u003c/a\u003e for a mapping of exchanges to IDs.\n","type":"integer"}},"required":["p","s","x","c","t","i"],"type":"object"},"type":"array"}},"required":["day","map","msLatency","symbol","ticks"],"type":"object"}]}}},"description":"An array of crypto trade ticks."},"default":{"description":"Unexpected error"}},"summary":"Historic Crypto Trades","tags":["crypto:trades"],"x-polygon-deprecation":{"date":1654056060000,"replaces":{"name":"Trades v3","path":"get_v3_trades__cryptoticker"}},"x-polygon-entitlement-data-type":{"description":"Trade data","name":"trades"},"x-polygon-entitlement-market-type":{"description":"Crypto data","name":"crypto"}}},"/v1/historic/forex/{from}/{to}/{date}":{"get":{"description":"Get historic ticks for a forex currency pair.\n","operationId":"DeprecatedGetHistoricForexQuotes","parameters":[{"description":"The \"from\" symbol of the currency pair.\n\nExample: For **USD/JPY** the `from` would be **USD**.\n","example":"AUD","in":"path","name":"from","required":true,"schema":{"type":"string"}},{"description":"The \"to\" symbol of the currency pair.\n\nExample: For **USD/JPY** the `to` would be **JPY**.\n","example":"USD","in":"path","name":"to","required":true,"schema":{"type":"string"}},{"description":"The date/day of the historic ticks to retrieve.","example":"2020-10-14","in":"path","name":"date","required":true,"schema":{"format":"date","type":"string"}},{"description":"The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results.\n","in":"query","name":"offset","schema":{"type":"integer"}},{"description":"Limit the size of the response, max 10000.","example":100,"in":"query","name":"limit","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"day":"2020-10-14","map":{"ap":"ask","bp":"bid","t":"timestamp"},"msLatency":"0","pair":"AUD/USD","status":"success","ticks":[{"ap":0.71703,"bp":0.71701,"t":1602633600000,"x":48},{"ap":0.71703,"bp":0.717,"t":1602633600000,"x":48},{"ap":0.71702,"bp":0.717,"t":1602633600000,"x":48}],"type":"forex"},"schema":{"allOf":[{"properties":{"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"},{"properties":{"day":{"description":"The date that was evaluated from the request.","format":"date","type":"string"},"map":{"description":"A map for shortened result keys.","type":"object"},"msLatency":{"description":"The milliseconds of latency for the query results.","type":"integer"},"pair":{"description":"The currency pair that was evaluated from the request.","type":"string"},"ticks":{"items":{"properties":{"a":{"description":"The ask price.","format":"double","type":"number"},"b":{"description":"The bid price.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"x":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/forex/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"}},"required":["a","b","x","t"],"type":"object"},"type":"array"}},"required":["day","map","msLatency","pair","ticks"],"type":"object"}]}}},"description":"An array of forex ticks"},"default":{"description":"Unexpected error"}},"summary":"Historic Forex Ticks","tags":["fx:trades"],"x-polygon-deprecation":{"date":1654056060000,"replaces":{"name":"Quotes (BBO) v3","path":"get_v3_quotes__fxticker"}},"x-polygon-entitlement-data-type":{"description":"NBBO data","name":"nbbo"},"x-polygon-entitlement-market-type":{"description":"Forex data","name":"fx"}}},"/v1/indicators/ema/{cryptoTicker}":{"get":{"description":"Get the exponential moving average (EMA) for a ticker symbol over a given time range.","operationId":"CryptoEMA","parameters":[{"description":"The ticker symbol for which to get exponential moving average (EMA) data.","example":"X:BTCUSD","in":"path","name":"cryptoTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.","example":50,"in":"query","name":"window","schema":{"default":50,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate the exponential moving average. i.e. 'close' will result in using close prices to \ncalculate the exponential moving average (EMA).","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/ema/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25"},"values":[{"timestamp":1517562000016,"value":140.139}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the EMA indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Timestamp or indicator value.","items":{"properties":{"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"EMAResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value\nX:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664164800000,297389,,0,,0,0,0,0,0,false,1664164800000,19846.01135387188\nX:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664078400000,78936,,0,,0,0,0,0,0,false,1664078400000,19902.65703099573\nX:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664064000000,78936,,0,,0,0,0,0,0,false,1664064000000,19948.29976695474\nX:BTCUSD,15457.24362826,19317.486,0,19529.04,19475.84,19651.2772302,18846.67,1664409600000,191936,,0,,0,0,0,0,0,false,1664409600000,19751.714760699124\nX:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664337600000,225076,,0,,0,0,0,0,0,false,1664337600000,19762.974955013375\nX:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664251200000,183075,,0,,0,0,0,0,0,false,1664251200000,19791.86053850303\nX:BTCUSD,2868.09828007,19069.8521,0,19210.31,18925.87,19400,18805.1,1663992000000,58721,,0,,0,0,0,0,0,false,1663992000000,19995.805471728403\nX:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664323200000,225076,,0,,0,0,0,0,0,false,1664323200000,19777.128890923308\nX:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664236800000,183075,,0,,0,0,0,0,0,false,1664236800000,19818.394438033767\nX:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664150400000,297389,,0,,0,0,0,0,0,false,1664150400000,19873.767735662568\n","schema":{"type":"string"}}},"description":"Exponential Moving Average (EMA) data for each period."}},"summary":"Exponential Moving Average (EMA)","tags":["crypto:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Crypto data","name":"crypto"}},"x-polygon-ignore":true},"/v1/indicators/ema/{fxTicker}":{"get":{"description":"Get the exponential moving average (EMA) for a ticker symbol over a given time range.","operationId":"ForexEMA","parameters":[{"description":"The ticker symbol for which to get exponential moving average (EMA) data.","example":"C:EURUSD","in":"path","name":"fxTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.","example":50,"in":"query","name":"window","schema":{"default":50,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate the exponential moving average. i.e. 'close' will result in using close prices to \ncalculate the exponential moving average (EMA).","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/ema/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25"},"values":[{"timestamp":1517562000016,"value":140.139}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the EMA indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Timestamp or indicator value.","items":{"properties":{"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"EMAResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value\nC:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664323200000,685,,0,,0,0,0,0,0,false,1664323200000,1.4915199239999994\nC:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664164800000,550,,0,,0,0,0,0,0,false,1664164800000,1.4863299679999997\nC:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664078400000,10,,0,,0,0,0,0,0,false,1664078400000,1.4826388699999997\nC:USDAUD,686,1.5442,0,1.53763,1.5404,1.5526022,1.537279,1664409600000,686,,0,,0,0,0,0,0,false,1664409600000,1.4942168479999998\nC:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664251200000,536,,0,,0,0,0,0,0,false,1664251200000,1.4900704799999993\nC:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664236800000,536,,0,,0,0,0,0,0,false,1664236800000,1.4882634499999994\nC:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664150400000,550,,0,,0,0,0,0,0,false,1664150400000,1.4845906159999998\nC:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664064000000,10,,0,,0,0,0,0,0,false,1664064000000,1.4809719239999999\nC:USDAUD,1,1.5314,0,1.5313936,1.5313936,1.5313936,1.5313936,1663977600000,1,,0,,0,0,0,0,0,false,1663977600000,1.4794745239999998\nC:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664337600000,685,,0,,0,0,0,0,0,false,1664337600000,1.4928357579999996\n","schema":{"type":"string"}}},"description":"Exponential Moving Average (EMA) data for each period."}},"summary":"Exponential Moving Average (EMA)","tags":["fx:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Forex data","name":"fx"}},"x-polygon-ignore":true},"/v1/indicators/ema/{indicesTicker}":{"get":{"description":"Get the exponential moving average (EMA) for a ticker symbol over a given time range.","operationId":"IndicesEMA","parameters":[{"description":"The ticker symbol for which to get exponential moving average (EMA) data.","example":"I:NDX","in":"path","name":"indicesTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.","example":50,"in":"query","name":"window","schema":{"default":50,"type":"integer"}},{"description":"The value in the aggregate which will be used to calculate the exponential moving average. i.e. 'close' will result in using close values to \ncalculate the exponential moving average (EMA).","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/ema/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz01MA","request_id":"b9201816341441eed663a90443c0623a","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366449650?limit=226\u0026sort=desc"},"values":[{"timestamp":1687237200000,"value":14452.002555459003}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the EMA indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Timestamp or indicator value.","items":{"properties":{"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"EMAResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}}},"description":"Exponential Moving Average (EMA) data for each period."}},"summary":"Exponential Moving Average (EMA)","tags":["indices:aggregates"],"x-polygon-entitlement-allowed-limited-tickers":true,"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Indices data","name":"indices"}},"x-polygon-ignore":true},"/v1/indicators/ema/{optionsTicker}":{"get":{"description":"Get the exponential moving average (EMA) for a ticker symbol over a given time range.","operationId":"OptionsEMA","parameters":[{"description":"The ticker symbol for which to get exponential moving average (EMA) data.","example":"O:SPY241220P00720000","in":"path","name":"optionsTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.","example":50,"in":"query","name":"window","schema":{"default":50,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate the exponential moving average. i.e. 'close' will result in using close prices to \ncalculate the exponential moving average (EMA).","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/ema/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25"},"values":[{"timestamp":1517562000016,"value":140.139}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the EMA indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Timestamp or indicator value.","items":{"properties":{"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"EMAResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649217600000,1,,0,,0,0,0,0,0,false,1649217600000,286.1730473491824 O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649131200000,1,,0,,0,0,0,0,0,false,1649131200000,285.60990642465924 O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649044800000,1,,0,,0,0,0,0,0,false,1649044800000,285.023780156278 O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648785600000,1,,0,,0,0,0,0,0,false,1648785600000,284.4137303667383 O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648526400000,1,,0,,0,0,0,0,0,false,1648526400000,282.43007426223943 O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649304000000,1,,0,,0,0,0,0,0,false,1649304000000,286.7141043158811 O:SPY241220P00720000,2,270.49,0,270.49,270.49,270.49,270.49,1649390400000,1,,0,,0,0,0,0,0,false,1649390400000,286.0778649309446 O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648699200000,1,,0,,0,0,0,0,0,false,1648699200000,283.77878058578887 O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648612800000,1,,0,,0,0,0,0,0,false,1648612800000,283.11791448724966 O:SPY241220P00720000,3,277.8267,0,277.82,277.83,277.83,277.82,1649649600000,2,,0,,0,0,0,0,0,false,1649649600000,285.7544192473781","schema":{"type":"string"}}},"description":"Exponential Moving Average (EMA) data for each period."}},"summary":"Exponential Moving Average (EMA)","tags":["options:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Options data","name":"options"}},"x-polygon-ignore":true},"/v1/indicators/ema/{stockTicker}":{"get":{"description":"Get the exponential moving average (EMA) for a ticker symbol over a given time range.","operationId":"EMA","parameters":[{"description":"Specify a case-sensitive ticker symbol for which to get exponential moving average (EMA) data. For example, AAPL represents Apple Inc.","example":"AAPL","in":"path","name":"stockTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.","example":50,"in":"query","name":"window","schema":{"default":50,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate the exponential moving average. i.e. 'close' will result in using close prices to \ncalculate the exponential moving average (EMA).","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/ema/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25"},"values":[{"timestamp":1517562000016,"value":140.139}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the EMA indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Timestamp or indicator value.","items":{"properties":{"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"EMAResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value\nAAPL,8.1599225E+07,152.5505,0,149.31,154.48,154.56,149.1,1663560000000,671961,,0,,0,0,0,0,0,false,1663560000000,163.17972071441582\nAAPL,8.4461761E+07,152.1354,0,152.74,151.76,154.72,149.945,1664251200000,683781,,0,,0,0,0,0,0,false,1664251200000,160.92194334973746\nAAPL,9.3308449E+07,156.1877,0,157.34,153.72,158.61,153.6,1663732800000,712645,,0,,0,0,0,0,0,false,1663732800000,162.5721451116157\nAAPL,1.07691097E+08,156.1317,0,153.4,156.9,158.08,153.08,1663646400000,792177,,0,,0,0,0,0,0,false,1663646400000,162.93345715698777\nAAPL,9.6031641E+07,150.0222,0,151.19,150.43,151.47,148.56,1663905600000,766888,,0,,0,0,0,0,0,false,1663905600000,161.72552880161066\nAAPL,8.6651514E+07,152.5709,0,152.38,152.74,154.47,150.91,1663819200000,686866,,0,,0,0,0,0,0,false,1663819200000,162.18657079351314\nAAPL,1.64879031E+08,150.2387,0,151.21,150.7,151.35,148.37,1663300800000,850358,,0,,0,0,0,0,0,false,1663300800000,163.53481135582055\nAAPL,1.27842348E+08,142.9013,0,146.1,142.48,146.72,140.68,1664424000000,1061605,,0,,0,0,0,0,0,false,1664424000000,159.78118646009983\nAAPL,1.46755122E+08,147.599,0,147.64,149.84,150.6414,144.84,1664337600000,1140818,,0,,0,0,0,0,0,false,1664337600000,160.48735733602226\nAAPL,9.3339409E+07,151.5222,0,149.66,150.77,153.7701,149.64,1664164800000,747666,,0,,0,0,0,0,0,false,1664164800000,161.29590022115534\n","schema":{"type":"string"}}},"description":"Exponential Moving Average (EMA) data for each period."}},"summary":"Exponential Moving Average (EMA)","tags":["stocks:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v1/indicators/macd/{cryptoTicker}":{"get":{"description":"Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range.","operationId":"CryptoMACD","parameters":[{"description":"The ticker symbol for which to get MACD data.","example":"X:BTCUSD","in":"path","name":"cryptoTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"The short window size used to calculate MACD data.","example":12,"in":"query","name":"short_window","schema":{"default":12,"type":"integer"}},{"description":"The long window size used to calculate MACD data.","example":26,"in":"query","name":"long_window","schema":{"default":26,"type":"integer"}},{"description":"The window size used to calculate the MACD signal line.","example":9,"in":"query","name":"signal_window","schema":{"default":9,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate MACD data. i.e. 'close' will result in using close prices to \ncalculate the MACD.","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/macd/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25"},"values":[{"histogram":38.3801666667,"signal":106.9811666667,"timestamp":1517562000016,"value":145.3613333333},{"histogram":41.098859136,"signal":102.7386283473,"timestamp":1517562001016,"value":143.8374874833}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the MACD indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Each entry in the values array represents MACD indicator data for a specific timestamp and includes:","items":{"properties":{"histogram":{"description":"The difference between the MACD line (value) and the signal line (signal). Positive histogram values indicate upward (bullish) momentum, while negative histogram values indicate downward (bearish) momentum.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}},"signal":{"description":"The signal line value, calculated as the exponential moving average (EMA) of the MACD line (value) over the signal period defined in the request parameters. Traders typically use crossovers between the MACD and signal lines as trading signals.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}},"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"MACDResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value,signal,histogram\nX:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664323200000,225076,,0,,0,0,0,0,0,false,1664323200000,-200.79662915774315,-281.5009533935604,80.70432423581724\nX:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664236800000,183075,,0,,0,0,0,0,0,false,1664236800000,-264.55324270273195,-316.4388906203941,51.88564791766214\nX:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664150400000,297389,,0,,0,0,0,0,0,false,1664150400000,-317.75700272815084,-339.5909474061525,21.83394467800167\nX:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664078400000,78936,,0,,0,0,0,0,0,false,1664078400000,-350.23805379084297,-345.0494335756529,-5.188620215190042\nX:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664064000000,78936,,0,,0,0,0,0,0,false,1664064000000,-347.75055091027025,-343.7522785218554,-3.9982723884148754\nX:BTCUSD,2868.09828007,19069.8521,0,19210.31,18925.87,19400,18805.1,1663992000000,58721,,0,,0,0,0,0,0,false,1663992000000,-339.51740285673077,-342.7527104247516,3.2353075680208576\nX:BTCUSD,11337.77105153,19346.509,0,19527.23,19487.24,19640,18846.95,1664409600000,142239,,0,,0,0,0,0,0,false,1664409600000,-130.70646519456568,-232.81921860513586,102.11275341057018\nX:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664337600000,225076,,0,,0,0,0,0,0,false,1664337600000,-165.73322121465026,-258.3474069577784,92.61418574312813\nX:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664251200000,183075,,0,,0,0,0,0,0,false,1664251200000,-242.62960978099727,-301.6770344525147,59.04742467151743\nX:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664164800000,297389,,0,,0,0,0,0,0,false,1664164800000,-288.68772337443806,-329.4103025998096,40.72257922537153\n","schema":{"type":"string"}}},"description":"Moving Average Convergence/Divergence (MACD) data for each period."}},"summary":"Moving Average Convergence/Divergence (MACD)","tags":["crypto:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Crypto data","name":"crypto"}},"x-polygon-ignore":true},"/v1/indicators/macd/{fxTicker}":{"get":{"description":"Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range.","operationId":"ForexMACD","parameters":[{"description":"The ticker symbol for which to get MACD data.","example":"C:EURUSD","in":"path","name":"fxTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The short window size used to calculate MACD data.","example":12,"in":"query","name":"short_window","schema":{"default":12,"type":"integer"}},{"description":"The long window size used to calculate MACD data.","example":26,"in":"query","name":"long_window","schema":{"default":26,"type":"integer"}},{"description":"The window size used to calculate the MACD signal line.","example":9,"in":"query","name":"signal_window","schema":{"default":9,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate the MACD. i.e. 'close' will result in using close prices to \ncalculate the MACD.","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/macd/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25"},"values":[{"histogram":38.3801666667,"signal":106.9811666667,"timestamp":1517562000016,"value":145.3613333333},{"histogram":41.098859136,"signal":102.7386283473,"timestamp":1517562001016,"value":143.8374874833}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the MACD indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Each entry in the values array represents MACD indicator data for a specific timestamp and includes:","items":{"properties":{"histogram":{"description":"The difference between the MACD line (value) and the signal line (signal). Positive histogram values indicate upward (bullish) momentum, while negative histogram values indicate downward (bearish) momentum.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}},"signal":{"description":"The signal line value, calculated as the exponential moving average (EMA) of the MACD line (value) over the signal period defined in the request parameters. Traders typically use crossovers between the MACD and signal lines as trading signals.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}},"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"MACDResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value,signal,histogram\nC:USDAUD,687,1.5442,0,1.53763,1.5386983,1.5526022,1.537279,1664409600000,687,,0,,0,0,0,0,0,false,1664409600000,0.0160095063995076,0.016240853664654657,-0.0002313472651470569\nC:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664251200000,536,,0,,0,0,0,0,0,false,1664251200000,0.019060448457087098,0.015690709670065223,0.0033697387870218753\nC:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664164800000,550,,0,,0,0,0,0,0,false,1664164800000,0.017190795754692623,0.013971241529748895,0.003219554224943728\nC:USDAUD,1,1.5314,0,1.5313936,1.5313936,1.5313936,1.5313936,1663977600000,1,,0,,0,0,0,0,0,false,1663977600000,0.014349509127189686,0.010792069356789809,0.0035574397703998766\nC:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664337600000,685,,0,,0,0,0,0,0,false,1664337600000,0.0169083298713677,0.016298690480941423,0.0006096393904262767\nC:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664323200000,685,,0,,0,0,0,0,0,false,1664323200000,0.017968564486413374,0.016146280633334852,0.001822283853078522\nC:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664236800000,536,,0,,0,0,0,0,0,false,1664236800000,0.018356408747553177,0.014848274973309752,0.0035081337742434247\nC:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664150400000,550,,0,,0,0,0,0,0,false,1664150400000,0.016441299960100686,0.01316635297351296,0.0032749469865877255\nC:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664078400000,10,,0,,0,0,0,0,0,false,1664078400000,0.015245524601038118,0.012347616226866026,0.002897908374172092\nC:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664064000000,10,,0,,0,0,0,0,0,false,1664064000000,0.014947418239455779,0.011623139133323003,0.0033242791061327756\n","schema":{"type":"string"}}},"description":"Moving Average Convergence/Divergence (MACD) data for each period."}},"summary":"Moving Average Convergence/Divergence (MACD)","tags":["fx:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Forex data","name":"fx"}},"x-polygon-ignore":true},"/v1/indicators/macd/{indicesTicker}":{"get":{"description":"Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range.","operationId":"IndicesMACD","parameters":[{"description":"The ticker symbol for which to get MACD data.","example":"I:NDX","in":"path","name":"indicesTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The short window size used to calculate MACD data.","example":12,"in":"query","name":"short_window","schema":{"default":12,"type":"integer"}},{"description":"The long window size used to calculate MACD data.","example":26,"in":"query","name":"long_window","schema":{"default":26,"type":"integer"}},{"description":"The window size used to calculate the MACD signal line.","example":9,"in":"query","name":"signal_window","schema":{"default":9,"type":"integer"}},{"description":"The value in the aggregate which will be used to calculate the MACD. i.e. 'close' will result in using close values to \ncalculate the MACD.","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/macd/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MTUwODAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0yJmxvbmdfd2luZG93PTI2Jm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2Umc2hvcnRfd2luZG93PTEyJnNpZ25hbF93aW5kb3c9OSZ0aW1lc3Bhbj1kYXkmdGltZXN0YW1wLmx0PTE2ODcyMTkyMDAwMDA","request_id":"2eeda0be57e83cbc64cc8d1a74e84dbd","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366537196?limit=121\u0026sort=desc"},"values":[{"histogram":-4.7646219788108795,"signal":220.7596784587801,"timestamp":1687237200000,"value":215.9950564799692},{"histogram":3.4518937661882205,"signal":221.9508339534828,"timestamp":1687219200000,"value":225.40272771967102}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the MACD indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Each entry in the values array represents MACD indicator data for a specific timestamp and includes:","items":{"properties":{"histogram":{"description":"The difference between the MACD line (value) and the signal line (signal). Positive histogram values indicate upward (bullish) momentum, while negative histogram values indicate downward (bearish) momentum.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}},"signal":{"description":"The signal line value, calculated as the exponential moving average (EMA) of the MACD line (value) over the signal period defined in the request parameters. Traders typically use crossovers between the MACD and signal lines as trading signals.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}},"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"MACDResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}}},"description":"Moving Average Convergence/Divergence (MACD) data for each period."}},"summary":"Moving Average Convergence/Divergence (MACD)","tags":["indices:aggregates"],"x-polygon-entitlement-allowed-limited-tickers":true,"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Indices data","name":"indices"}},"x-polygon-ignore":true},"/v1/indicators/macd/{optionsTicker}":{"get":{"description":"Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range.","operationId":"OptionsMACD","parameters":[{"description":"The ticker symbol for which to get MACD data.","example":"O:SPY241220P00720000","in":"path","name":"optionsTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The short window size used to calculate MACD data.","example":12,"in":"query","name":"short_window","schema":{"default":12,"type":"integer"}},{"description":"The long window size used to calculate MACD data.","example":26,"in":"query","name":"long_window","schema":{"default":26,"type":"integer"}},{"description":"The window size used to calculate the MACD signal line.","example":9,"in":"query","name":"signal_window","schema":{"default":9,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate the MACD. i.e. 'close' will result in using close prices to \ncalculate the MACD.","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/macd/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25"},"values":[{"histogram":38.3801666667,"signal":106.9811666667,"timestamp":1517562000016,"value":145.3613333333},{"histogram":41.098859136,"signal":102.7386283473,"timestamp":1517562001016,"value":143.8374874833}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the MACD indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Each entry in the values array represents MACD indicator data for a specific timestamp and includes:","items":{"properties":{"histogram":{"description":"The difference between the MACD line (value) and the signal line (signal). Positive histogram values indicate upward (bullish) momentum, while negative histogram values indicate downward (bearish) momentum.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}},"signal":{"description":"The signal line value, calculated as the exponential moving average (EMA) of the MACD line (value) over the signal period defined in the request parameters. Traders typically use crossovers between the MACD and signal lines as trading signals.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}},"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"MACDResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value,signal,histogram\nO:SPY241220P00720000,3,277.8267,0,277.82,277.83,277.83,277.82,1649649600000,2,,0,,0,0,0,0,0,false,1649649600000,-0.05105556065990413,3.5771695836806834,-3.6282251443405875\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649304000000,1,,0,,0,0,0,0,0,false,1649304000000,4.047960862047148,5.247666286053219,-1.199705424006071\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648785600000,1,,0,,0,0,0,0,0,false,1648785600000,5.255380647906861,6.466477305754766,-1.2110966578479045\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648699200000,1,,0,,0,0,0,0,0,false,1648699200000,5.591072756938104,6.769251470216741,-1.178178713278637\nO:SPY241220P00720000,2,270.49,0,270.49,270.49,270.49,270.49,1649390400000,1,,0,,0,0,0,0,0,false,1649390400000,1.4304642046162712,4.48422586976583,-3.053761665149559\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649217600000,1,,0,,0,0,0,0,0,false,1649217600000,4.32835898317461,5.547592642054737,-1.2192336588801274\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649131200000,1,,0,,0,0,0,0,0,false,1649131200000,4.623290999840208,5.852401056774768,-1.2291100569345605\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649044800000,1,,0,,0,0,0,0,0,false,1649044800000,4.932483632022979,6.159678571008409,-1.2271949389854298\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648612800000,1,,0,,0,0,0,0,0,false,1648612800000,5.93821326327344,7.063796148536399,-1.1255828852629595\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648526400000,1,,0,,0,0,0,0,0,false,1648526400000,6.294916771166584,7.345191869852139,-1.050275098685555\n","schema":{"type":"string"}}},"description":"Moving Average Convergence/Divergence (MACD) data for each period."}},"summary":"Moving Average Convergence/Divergence (MACD)","tags":["options:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Options data","name":"options"}},"x-polygon-ignore":true},"/v1/indicators/macd/{stockTicker}":{"get":{"description":"Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range.","operationId":"MACD","parameters":[{"description":"Specify a case-sensitive ticker symbol for which to get moving average convergence/divergence (MACD) data. For example, AAPL represents Apple Inc.","example":"AAPL","in":"path","name":"stockTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The short window size used to calculate MACD data.","example":12,"in":"query","name":"short_window","schema":{"default":12,"type":"integer"}},{"description":"The long window size used to calculate MACD data.","example":26,"in":"query","name":"long_window","schema":{"default":26,"type":"integer"}},{"description":"The window size used to calculate the MACD signal line.","example":9,"in":"query","name":"signal_window","schema":{"default":9,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate the MACD. i.e. 'close' will result in using close prices to \ncalculate the MACD.","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/macd/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25"},"values":[{"histogram":38.3801666667,"signal":106.9811666667,"timestamp":1517562000016,"value":145.3613333333},{"histogram":41.098859136,"signal":102.7386283473,"timestamp":1517562001016,"value":143.8374874833}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the MACD indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Each entry in the values array represents MACD indicator data for a specific timestamp and includes:","items":{"properties":{"histogram":{"description":"The difference between the MACD line (value) and the signal line (signal). Positive histogram values indicate upward (bullish) momentum, while negative histogram values indicate downward (bearish) momentum.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}},"signal":{"description":"The signal line value, calculated as the exponential moving average (EMA) of the MACD line (value) over the signal period defined in the request parameters. Traders typically use crossovers between the MACD and signal lines as trading signals.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}},"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"MACDResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value,signal,histogram\nAAPL,1.27842348E+08,142.9013,0,146.1,142.48,146.72,140.68,1664424000000,1061605,,0,,0,0,0,0,0,false,1664424000000,-5.413804946923619,-3.8291158739479005,-1.5846890729757188\nAAPL,8.4461761E+07,152.1354,0,152.74,151.76,154.72,149.945,1664251200000,683781,,0,,0,0,0,0,0,false,1664251200000,-4.63165683097526,-3.098305244715017,-1.5333515862602427\nAAPL,9.3339409E+07,151.5222,0,149.66,150.77,153.7701,149.64,1664164800000,747666,,0,,0,0,0,0,0,false,1664164800000,-4.581291216131007,-2.7149673481499565,-1.86632386798105\nAAPL,9.3308449E+07,156.1877,0,157.34,153.72,158.61,153.6,1663732800000,712645,,0,,0,0,0,0,0,false,1663732800000,-3.6311474313744156,-1.1648824074663984,-2.4662650239080173\nAAPL,1.64879031E+08,150.2387,0,151.21,150.7,151.35,148.37,1663300800000,850358,,0,,0,0,0,0,0,false,1663300800000,-2.533545758578896,0.9308104167079131,-3.464356175286809\nAAPL,1.46755122E+08,147.599,0,147.64,149.84,150.6414,144.84,1664337600000,1140818,,0,,0,0,0,0,0,false,1664337600000,-4.771497049659786,-3.432943605703971,-1.3385534439558149\nAAPL,9.6031641E+07,150.0222,0,151.19,150.43,151.47,148.56,1663905600000,766888,,0,,0,0,0,0,0,false,1663905600000,-4.349569413677017,-2.2483863811546936,-2.1011830325223233\nAAPL,8.6651514E+07,152.5709,0,152.38,152.74,154.47,150.91,1663819200000,686866,,0,,0,0,0,0,0,false,1663819200000,-3.9559234852549707,-1.7230906230241128,-2.232832862230858\nAAPL,1.07691097E+08,156.1317,0,153.4,156.9,158.08,153.08,1663646400000,792177,,0,,0,0,0,0,0,false,1663646400000,-3.2635802145105117,-0.548316151489394,-2.7152640630211176\nAAPL,8.1599225E+07,152.5505,0,149.31,154.48,154.56,149.1,1663560000000,671961,,0,,0,0,0,0,0,false,1663560000000,-3.070742345502225,0.13049986426588545,-3.2012422097681106\n","schema":{"type":"string"}}},"description":"Moving Average Convergence/Divergence (MACD) data for each period."}},"summary":"Moving Average Convergence/Divergence (MACD)","tags":["stocks:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v1/indicators/rsi/{cryptoTicker}":{"get":{"description":"Get the relative strength index (RSI) for a ticker symbol over a given time range.","operationId":"CryptoRSI","parameters":[{"description":"The ticker symbol for which to get relative strength index (RSI) data.","example":"X:BTCUSD","in":"path","name":"cryptoTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"The window size used to calculate the relative strength index (RSI). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.","example":14,"in":"query","name":"window","schema":{"default":14,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate the relative strength index. i.e. 'close' will result in using close prices to \ncalculate the relative strength index (RSI).","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/rsi/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25"},"values":[{"timestamp":1517562000016,"value":82.19}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the RSI indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Timestamp or indicator value.","items":{"properties":{"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"RSIResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value\nX:BTCUSD,15457.24362826,19317.486,0,19529.04,19475.84,19651.2772302,18846.67,1664409600000,191936,,0,,0,0,0,0,0,false,1664409600000,52.040915721136884\nX:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664251200000,183075,,0,,0,0,0,0,0,false,1664251200000,44.813590401722564\nX:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664236800000,183075,,0,,0,0,0,0,0,false,1664236800000,44.813590401722564\nX:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664164800000,297389,,0,,0,0,0,0,0,false,1664164800000,45.22751170711286\nX:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664150400000,297389,,0,,0,0,0,0,0,false,1664150400000,45.22751170711286\nX:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664078400000,78936,,0,,0,0,0,0,0,false,1664078400000,37.361825384231004\nX:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664064000000,78936,,0,,0,0,0,0,0,false,1664064000000,37.361825384231004\nX:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664337600000,225076,,0,,0,0,0,0,0,false,1664337600000,50.74235333598462\nX:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664323200000,225076,,0,,0,0,0,0,0,false,1664323200000,50.74235333598462\nX:BTCUSD,2868.09828007,19069.8521,0,19210.31,18925.87,19400,18805.1,1663992000000,58721,,0,,0,0,0,0,0,false,1663992000000,39.159457782344376\n","schema":{"type":"string"}}},"description":"Relative strength index data for each period."}},"summary":"Relative Strength Index (RSI)","tags":["crypto:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Crypto data","name":"crypto"}},"x-polygon-ignore":true},"/v1/indicators/rsi/{fxTicker}":{"get":{"description":"Get the relative strength index (RSI) for a ticker symbol over a given time range.","operationId":"ForexRSI","parameters":[{"description":"The ticker symbol for which to get relative strength index (RSI) data.","example":"C:EURUSD","in":"path","name":"fxTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The window size used to calculate the relative strength index (RSI).","example":14,"in":"query","name":"window","schema":{"default":14,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate the relative strength index. i.e. 'close' will result in using close prices to \ncalculate the relative strength index (RSI).","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/rsi/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25"},"values":[{"timestamp":1517562000016,"value":82.19}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the RSI indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Timestamp or indicator value.","items":{"properties":{"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"RSIResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value\nC:USDAUD,686,1.5442,0,1.53763,1.5404,1.5526022,1.537279,1664409600000,686,,0,,0,0,0,0,0,false,1664409600000,65.97230488287764\nC:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664164800000,550,,0,,0,0,0,0,0,false,1664164800000,79.3273623194404\nC:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664150400000,550,,0,,0,0,0,0,0,false,1664150400000,79.32736231944038\nC:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664064000000,10,,0,,0,0,0,0,0,false,1664064000000,74.64770184023104\nC:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664337600000,685,,0,,0,0,0,0,0,false,1664337600000,64.43214811875563\nC:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664323200000,685,,0,,0,0,0,0,0,false,1664323200000,64.43214811875563\nC:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664251200000,536,,0,,0,0,0,0,0,false,1664251200000,81.95981214984681\nC:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664236800000,536,,0,,0,0,0,0,0,false,1664236800000,81.95981214984683\nC:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664078400000,10,,0,,0,0,0,0,0,false,1664078400000,74.64770184023104\nC:USDAUD,1,1.5314,0,1.5313936,1.5313936,1.5313936,1.5313936,1663977600000,1,,0,,0,0,0,0,0,false,1663977600000,74.98028072374902\n","schema":{"type":"string"}}},"description":"Relative strength index data for each period."}},"summary":"Relative Strength Index (RSI)","tags":["fx:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Forex data","name":"fx"}},"x-polygon-ignore":true},"/v1/indicators/rsi/{indicesTicker}":{"get":{"description":"Get the relative strength index (RSI) for a ticker symbol over a given time range.","operationId":"IndicesRSI","parameters":[{"description":"The ticker symbol for which to get relative strength index (RSI) data.","example":"I:NDX","in":"path","name":"indicesTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The window size used to calculate the relative strength index (RSI).","example":14,"in":"query","name":"window","schema":{"default":14,"type":"integer"}},{"description":"The value in the aggregate which will be used to calculate the relative strength index. i.e. 'close' will result in using close values to \ncalculate the relative strength index (RSI).","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/rsi/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz0xNA","request_id":"28a8417f521f98e1d08f6ed7d1fbcad3","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366658253?limit=66\u0026sort=desc"},"values":[{"timestamp":1687237200000,"value":73.98019439047955}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the RSI indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Timestamp or indicator value.","items":{"properties":{"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"RSIResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}}},"description":"Relative Strength Index (RSI) data for each period."}},"summary":"Relative Strength Index (RSI)","tags":["indices:aggregates"],"x-polygon-entitlement-allowed-limited-tickers":true,"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Indices data","name":"indices"}},"x-polygon-ignore":true},"/v1/indicators/rsi/{optionsTicker}":{"get":{"description":"Get the relative strength index (RSI) for a ticker symbol over a given time range.","operationId":"OptionsRSI","parameters":[{"description":"The ticker symbol for which to get relative strength index (RSI) data.","example":"O:SPY241220P00720000","in":"path","name":"optionsTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The window size used to calculate the relative strength index (RSI).","example":14,"in":"query","name":"window","schema":{"default":14,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate the relative strength index. i.e. 'close' will result in using close prices to \ncalculate the relative strength index (RSI).","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/rsi/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25"},"values":[{"timestamp":1517562000016,"value":82.19}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the RSI indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Timestamp or indicator value.","items":{"properties":{"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"RSIResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value\nO:SPY241220P00720000,3,277.8267,0,277.82,277.83,277.83,277.82,1649649600000,2,,0,,0,0,0,0,0,false,1649649600000,30.837887188419387\nO:SPY241220P00720000,2,270.49,0,270.49,270.49,270.49,270.49,1649390400000,1,,0,,0,0,0,0,0,false,1649390400000,15.546598157051605\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648785600000,1,,0,,0,0,0,0,0,false,1648785600000,88.61520575036505\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648699200000,1,,0,,0,0,0,0,0,false,1648699200000,88.61520575036505\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648612800000,1,,0,,0,0,0,0,0,false,1648612800000,88.61520575036505\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648526400000,1,,0,,0,0,0,0,0,false,1648526400000,88.61520575036505\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649304000000,1,,0,,0,0,0,0,0,false,1649304000000,88.61520575036505\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649217600000,1,,0,,0,0,0,0,0,false,1649217600000,88.61520575036505\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649131200000,1,,0,,0,0,0,0,0,false,1649131200000,88.61520575036505\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649044800000,1,,0,,0,0,0,0,0,false,1649044800000,88.61520575036505\n","schema":{"type":"string"}}},"description":"Relative Strength Index (RSI) data for each period."}},"summary":"Relative Strength Index (RSI)","tags":["options:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Options data","name":"options"}},"x-polygon-ignore":true},"/v1/indicators/rsi/{stockTicker}":{"get":{"description":"Get the relative strength index (RSI) for a ticker symbol over a given time range.","operationId":"RSI","parameters":[{"description":"Specify a case-sensitive ticker symbol for which to get relative strength index (RSI) data. For example, AAPL represents Apple Inc.","example":"AAPL","in":"path","name":"stockTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The window size used to calculate the relative strength index (RSI).","example":14,"in":"query","name":"window","schema":{"default":14,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate the relative strength index. i.e. 'close' will result in using close prices to \ncalculate the relative strength index (RSI).","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/rsi/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25"},"values":[{"timestamp":1517562000016,"value":82.19}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the RSI indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Timestamp or indicator value.","items":{"properties":{"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"RSIResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value\nAAPL,1.27849501E+08,142.9012,0,146.1,142.48,146.72,140.68,1664424000000,1061692,,0,,0,0,0,0,0,false,1664424000000,23.065352237561996\nAAPL,1.46755122E+08,147.599,0,147.64,149.84,150.6414,144.84,1664337600000,1140818,,0,,0,0,0,0,0,false,1664337600000,29.877761913419718\nAAPL,9.3339409E+07,151.5222,0,149.66,150.77,153.7701,149.64,1664164800000,747666,,0,,0,0,0,0,0,false,1664164800000,29.58201330468151\nAAPL,8.1599225E+07,152.5505,0,149.31,154.48,154.56,149.1,1663560000000,671961,,0,,0,0,0,0,0,false,1663560000000,30.233508748331047\nAAPL,1.64879031E+08,150.2387,0,151.21,150.7,151.35,148.37,1663300800000,850358,,0,,0,0,0,0,0,false,1663300800000,19.857312489527956\nAAPL,8.4461761E+07,152.1354,0,152.74,151.76,154.72,149.945,1664251200000,683781,,0,,0,0,0,0,0,false,1664251200000,32.18008680069761\nAAPL,9.6031641E+07,150.0222,0,151.19,150.43,151.47,148.56,1663905600000,766888,,0,,0,0,0,0,0,false,1663905600000,28.71109953239781\nAAPL,8.6651514E+07,152.5709,0,152.38,152.74,154.47,150.91,1663819200000,686866,,0,,0,0,0,0,0,false,1663819200000,31.140902927103383\nAAPL,9.3308449E+07,156.1877,0,157.34,153.72,158.61,153.6,1663732800000,712645,,0,,0,0,0,0,0,false,1663732800000,32.21491128713248\nAAPL,1.07691097E+08,156.1317,0,153.4,156.9,158.08,153.08,1663646400000,792177,,0,,0,0,0,0,0,false,1663646400000,35.950871523070575\n","schema":{"type":"string"}}},"description":"Relative strength Index data for each period."}},"summary":"Relative Strength Index (RSI)","tags":["stocks:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v1/indicators/sma/{cryptoTicker}":{"get":{"description":"Get the simple moving average (SMA) for a ticker symbol over a given time range.","operationId":"CryptoSMA","parameters":[{"description":"The ticker symbol for which to get simple moving average (SMA) data.","example":"X:BTCUSD","in":"path","name":"cryptoTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.","example":50,"in":"query","name":"window","schema":{"default":50,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate the simple moving average. i.e. 'close' will result in using close prices to \ncalculate the simple moving average (SMA).","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/sma/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"aggregates":[{"c":75.0875,"h":75.15,"l":73.7975,"n":1,"o":74.06,"t":1577941200000,"v":135647456,"vw":74.6099},{"c":74.3575,"h":75.145,"l":74.125,"n":1,"o":74.2875,"t":1578027600000,"v":146535512,"vw":74.7026}],"url":"https://api.massive.com/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25"},"values":[{"timestamp":1517562000016,"value":140.139}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the SMA indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Timestamp or indicator value.","items":{"properties":{"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"SMAResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value\nX:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664164800000,297389,,0,,0,0,0,0,0,false,1664164800000,19846.01135387188\nX:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664078400000,78936,,0,,0,0,0,0,0,false,1664078400000,19902.65703099573\nX:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664064000000,78936,,0,,0,0,0,0,0,false,1664064000000,19948.29976695474\nX:BTCUSD,15457.24362826,19317.486,0,19529.04,19475.84,19651.2772302,18846.67,1664409600000,191936,,0,,0,0,0,0,0,false,1664409600000,19751.714760699124\nX:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664337600000,225076,,0,,0,0,0,0,0,false,1664337600000,19762.974955013375\nX:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664251200000,183075,,0,,0,0,0,0,0,false,1664251200000,19791.86053850303\nX:BTCUSD,2868.09828007,19069.8521,0,19210.31,18925.87,19400,18805.1,1663992000000,58721,,0,,0,0,0,0,0,false,1663992000000,19995.805471728403\nX:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664323200000,225076,,0,,0,0,0,0,0,false,1664323200000,19777.128890923308\nX:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664236800000,183075,,0,,0,0,0,0,0,false,1664236800000,19818.394438033767\nX:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664150400000,297389,,0,,0,0,0,0,0,false,1664150400000,19873.767735662568\n","schema":{"type":"string"}}},"description":"Simple Moving Average (SMA) data for each period."}},"summary":"Simple Moving Average (SMA)","tags":["crypto:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Crypto data","name":"crypto"}},"x-polygon-ignore":true},"/v1/indicators/sma/{fxTicker}":{"get":{"description":"Get the simple moving average (SMA) for a ticker symbol over a given time range.","operationId":"ForexSMA","parameters":[{"description":"The ticker symbol for which to get simple moving average (SMA) data.","example":"C:EURUSD","in":"path","name":"fxTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.","example":50,"in":"query","name":"window","schema":{"default":50,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate the simple moving average. i.e. 'close' will result in using close prices to \ncalculate the simple moving average (SMA).","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/sma/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"aggregates":[{"c":75.0875,"h":75.15,"l":73.7975,"n":1,"o":74.06,"t":1577941200000,"v":135647456,"vw":74.6099},{"c":74.3575,"h":75.145,"l":74.125,"n":1,"o":74.2875,"t":1578027600000,"v":146535512,"vw":74.7026}],"url":"https://api.massive.com/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25"},"values":[{"timestamp":1517562000016,"value":140.139}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the SMA indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Timestamp or indicator value.","items":{"properties":{"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"SMAResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value\nC:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664323200000,685,,0,,0,0,0,0,0,false,1664323200000,1.4915199239999994\nC:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664164800000,550,,0,,0,0,0,0,0,false,1664164800000,1.4863299679999997\nC:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664078400000,10,,0,,0,0,0,0,0,false,1664078400000,1.4826388699999997\nC:USDAUD,686,1.5442,0,1.53763,1.5404,1.5526022,1.537279,1664409600000,686,,0,,0,0,0,0,0,false,1664409600000,1.4942168479999998\nC:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664251200000,536,,0,,0,0,0,0,0,false,1664251200000,1.4900704799999993\nC:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664236800000,536,,0,,0,0,0,0,0,false,1664236800000,1.4882634499999994\nC:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664150400000,550,,0,,0,0,0,0,0,false,1664150400000,1.4845906159999998\nC:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664064000000,10,,0,,0,0,0,0,0,false,1664064000000,1.4809719239999999\nC:USDAUD,1,1.5314,0,1.5313936,1.5313936,1.5313936,1.5313936,1663977600000,1,,0,,0,0,0,0,0,false,1663977600000,1.4794745239999998\nC:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664337600000,685,,0,,0,0,0,0,0,false,1664337600000,1.4928357579999996\n","schema":{"type":"string"}}},"description":"Simple Moving Average (SMA) data for each period."}},"summary":"Simple Moving Average (SMA)","tags":["fx:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Forex data","name":"fx"}},"x-polygon-ignore":true},"/v1/indicators/sma/{indicesTicker}":{"get":{"description":"Get the simple moving average (SMA) for a ticker symbol over a given time range.","operationId":"IndicesSMA","parameters":[{"description":"The ticker symbol for which to get simple moving average (SMA) data.","example":"I:NDX","in":"path","name":"indicesTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.","example":50,"in":"query","name":"window","schema":{"default":50,"type":"integer"}},{"description":"The value in the aggregate which will be used to calculate the simple moving average. i.e. 'close' will result in using close values to \ncalculate the simple moving average (SMA).","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/sma/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz01Mw","request_id":"4cae270008cb3f947e3f92c206e3888a","results":{"underlying":{"url":"https://api.massive.com/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366378997?limit=240\u0026sort=desc"},"values":[{"timestamp":1687237200000,"value":14362.676417589264}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the SMA indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Timestamp or indicator value.","items":{"properties":{"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"SMAResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}}},"description":"Simple Moving Average (SMA) data for each period."}},"summary":"Simple Moving Average (SMA)","tags":["indices:aggregates"],"x-polygon-entitlement-allowed-limited-tickers":true,"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Indices data","name":"indices"}},"x-polygon-ignore":true},"/v1/indicators/sma/{optionsTicker}":{"get":{"description":"Get the simple moving average (SMA) for a ticker symbol over a given time range.","operationId":"OptionsSMA","parameters":[{"description":"The ticker symbol for which to get simple moving average (SMA) data.","example":"O:SPY241220P00720000","in":"path","name":"optionsTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.","example":50,"in":"query","name":"window","schema":{"default":50,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate the simple moving average. i.e. 'close' will result in using close prices to \ncalculate the simple moving average (SMA).","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/sma/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"aggregates":[{"c":75.0875,"h":75.15,"l":73.7975,"n":1,"o":74.06,"t":1577941200000,"v":135647456,"vw":74.6099},{"c":74.3575,"h":75.145,"l":74.125,"n":1,"o":74.2875,"t":1578027600000,"v":146535512,"vw":74.7026}],"url":"https://api.massive.com/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25"},"values":[{"timestamp":1517562000016,"value":140.139}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the SMA indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Timestamp or indicator value.","items":{"properties":{"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"SMAResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649304000000,1,,0,,0,0,0,0,0,false,1649304000000,286.0121999999996\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649131200000,1,,0,,0,0,0,0,0,false,1649131200000,284.61099999999965\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648699200000,1,,0,,0,0,0,0,0,false,1648699200000,282.50919999999974\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648612800000,1,,0,,0,0,0,0,0,false,1648612800000,281.80859999999973\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648526400000,1,,0,,0,0,0,0,0,false,1648526400000,281.1079999999998\nO:SPY241220P00720000,3,277.8267,0,277.82,277.83,277.83,277.82,1649649600000,2,,0,,0,0,0,0,0,false,1649649600000,285.4949999999996\nO:SPY241220P00720000,2,270.49,0,270.49,270.49,270.49,270.49,1649390400000,1,,0,,0,0,0,0,0,false,1649390400000,285.6801999999996\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649217600000,1,,0,,0,0,0,0,0,false,1649217600000,285.31159999999966\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649044800000,1,,0,,0,0,0,0,0,false,1649044800000,283.9103999999997\nO:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648785600000,1,,0,,0,0,0,0,0,false,1648785600000,283.2097999999997\n","schema":{"type":"string"}}},"description":"Simple Moving Average (SMA) data for each period."}},"summary":"Simple Moving Average (SMA)","tags":["options:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Options data","name":"options"}},"x-polygon-ignore":true},"/v1/indicators/sma/{stockTicker}":{"get":{"description":"Get the simple moving average (SMA) for a ticker symbol over a given time range.","operationId":"SMA","parameters":[{"description":"Specify a case-sensitive ticker symbol for which to get simple moving average (SMA) data. For example, AAPL represents Apple Inc.","example":"AAPL","in":"path","name":"stockTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The size of the aggregate time window.","example":"day","in":"query","name":"timespan","schema":{"default":"day","enum":["minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits.","example":true,"in":"query","name":"adjusted","schema":{"default":true,"type":"boolean"}},{"description":"The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.","example":50,"in":"query","name":"window","schema":{"default":50,"type":"integer"}},{"description":"The price in the aggregate which will be used to calculate the simple moving average. i.e. 'close' will result in using close prices to \ncalculate the simple moving average (SMA).","example":"close","in":"query","name":"series_type","schema":{"default":"close","enum":["open","high","low","close"],"type":"string"}},{"description":"Whether or not to include the aggregates used to calculate this indicator in the response.","in":"query","name":"expand_underlying","schema":{"default":false,"type":"boolean"}},{"description":"The order in which to return the results, ordered by timestamp.","example":"desc","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 5000","in":"query","name":"limit","schema":{"default":10,"maximum":5000,"type":"integer"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v1/indicators/sma/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":{"underlying":{"aggregates":[{"c":75.0875,"h":75.15,"l":73.7975,"n":1,"o":74.06,"t":1577941200000,"v":135647456,"vw":74.6099},{"c":74.3575,"h":75.145,"l":74.125,"n":1,"o":74.2875,"t":1578027600000,"v":146535512,"vw":74.7026}],"url":"https://api.massive.com/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25"},"values":[{"timestamp":1517562000016,"value":140.139}]},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results of the SMA indicator calculation.","properties":{"underlying":{"description":"The underlying aggregates used.","properties":{"aggregates":{"description":"The array of aggregates used in the calculation of this indicator.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"float","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"float","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"float","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"float","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix Msec timestamp for the start of the aggregate window.","format":"float","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"float","type":"number"},"vw":{"description":"The volume weighted average price.","format":"float","type":"number"}},"required":["v","vw","o","c","h","l","t","n"],"type":"object","x-polygon-go-type":{"name":"Aggregate","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"url":{"description":"The URL which can be used to request the underlying aggregates used in this request.","type":"string"}},"type":"object"},"values":{"description":"Timestamp or indicator value.","items":{"properties":{"timestamp":{"description":"The Unix Msec timestamp from the last aggregate used in this calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"IMicroseconds","path":"github.com/polygon-io/ptime"}},"value":{"description":"The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.","format":"float","type":"number","x-polygon-go-type":{"name":"*float64"}}},"type":"object"},"type":"array"}},"type":"object","x-polygon-go-type":{"name":"SMAResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id","status","results"],"type":"object"}},"text/csv":{"example":"aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value\nAAPL,1.27849501E+08,142.9012,0,146.1,142.48,146.72,140.68,1664424000000,1061692,,0,,0,0,0,0,0,false,1664424000000,164.19240000000005\nAAPL,1.46755122E+08,147.599,0,147.64,149.84,150.6414,144.84,1664337600000,1140818,,0,,0,0,0,0,0,false,1664337600000,164.40360000000007\nAAPL,8.4461761E+07,152.1354,0,152.74,151.76,154.72,149.945,1664251200000,683781,,0,,0,0,0,0,0,false,1664251200000,164.42680000000007\nAAPL,9.3339409E+07,151.5222,0,149.66,150.77,153.7701,149.64,1664164800000,747666,,0,,0,0,0,0,0,false,1664164800000,164.33300000000006\nAAPL,9.3308449E+07,156.1877,0,157.34,153.72,158.61,153.6,1663732800000,712645,,0,,0,0,0,0,0,false,1663732800000,164.13680000000005\nAAPL,9.6031641E+07,150.0222,0,151.19,150.43,151.47,148.56,1663905600000,766888,,0,,0,0,0,0,0,false,1663905600000,164.32100000000005\nAAPL,8.6651514E+07,152.5709,0,152.38,152.74,154.47,150.91,1663819200000,686866,,0,,0,0,0,0,0,false,1663819200000,164.28180000000003\nAAPL,1.07691097E+08,156.1317,0,153.4,156.9,158.08,153.08,1663646400000,792177,,0,,0,0,0,0,0,false,1663646400000,163.97960000000006\nAAPL,8.1599225E+07,152.5505,0,149.31,154.48,154.56,149.1,1663560000000,671961,,0,,0,0,0,0,0,false,1663560000000,163.73900000000006\nAAPL,1.64879031E+08,150.2387,0,151.21,150.7,151.35,148.37,1663300800000,850358,,0,,0,0,0,0,0,false,1663300800000,163.59020000000007\n","schema":{"type":"string"}}},"description":"Simple Moving Average (SMA) data for each period."}},"summary":"Simple Moving Average (SMA)","tags":["stocks:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v1/last/crypto/{from}/{to}":{"get":{"description":"Get the last trade tick for a cryptocurrency pair.","operationId":"LastTradeCrypto","parameters":[{"description":"The \"from\" symbol of the pair.","example":"BTC","in":"path","name":"from","required":true,"schema":{"type":"string"}},{"description":"The \"to\" symbol of the pair.","example":"USD","in":"path","name":"to","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"last":{"conditions":[1],"exchange":4,"price":16835.42,"size":0.006909,"timestamp":1605560885027},"request_id":"d2d779df015fe2b7fbb8e58366610ef7","status":"success","symbol":"BTC-USD"},"schema":{"properties":{"last":{"description":"Contains the requested trade data for the specified cryptocurrency pair.","properties":{"conditions":{"description":"A list of condition codes.","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.","format":"int32","type":"integer"},"type":"array","x-polygon-go-type":{"name":"Int32Array"}},"exchange":{"description":"The exchange that this crypto trade happened on.  \nSee \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\"\u003eExchanges\u003c/a\u003e for a mapping of exchanges to IDs.","type":"integer"},"price":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.","format":"double","type":"number"},"size":{"description":"The size of a trade (also known as volume).","format":"double","type":"number"},"timestamp":{"description":"The Unix millisecond timestamp.","type":"integer","x-polygon-go-type":{"name":"IMilliseconds","path":"github.com/polygon-io/ptime"}}},"required":["exchange","price","size","timestamp"],"type":"object","x-polygon-go-type":{"name":"LastTradeCrypto"}},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","type":"string"},"symbol":{"description":"The symbol pair that was evaluated from the request.","type":"string"}},"required":["status","request_id","symbol"],"type":"object"}},"text/csv":{"example":"conditions,exchange,price,size,timestamp\n1,4,16835.42,0.006909,1605560885027\n","schema":{"type":"string"}}},"description":"The last tick for this currency pair."},"default":{"description":"Unexpected error"}},"summary":"Last Trade for a Crypto Pair","tags":["crypto:last:trade"],"x-polygon-entitlement-data-type":{"description":"Trade data","name":"trades"},"x-polygon-entitlement-market-type":{"description":"Crypto data","name":"crypto"}}},"/v1/last_quote/currencies/{from}/{to}":{"get":{"description":"Get the last quote tick for a forex currency pair.","operationId":"LastQuoteCurrencies","parameters":[{"description":"The \"from\" symbol of the pair.","example":"AUD","in":"path","name":"from","required":true,"schema":{"type":"string"}},{"description":"The \"to\" symbol of the pair.","example":"USD","in":"path","name":"to","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"last":{"ask":0.73124,"bid":0.73122,"exchange":48,"timestamp":1605557756000},"request_id":"a73a29dbcab4613eeaf48583d3baacf0","status":"success","symbol":"AUD/USD"},"schema":{"properties":{"last":{"description":"Contains the requested quote data for the specified forex currency pair.","properties":{"ask":{"description":"The ask price.","format":"double","type":"number"},"bid":{"description":"The bid price.","format":"double","type":"number"},"exchange":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/forex/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"timestamp":{"description":"The Unix millisecond timestamp.","type":"integer","x-polygon-go-type":{"name":"IMilliseconds","path":"github.com/polygon-io/ptime"}}},"required":["ask","bid","exchange","timestamp"],"type":"object","x-polygon-go-type":{"name":"LastQuoteCurrencies"}},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","type":"string"},"symbol":{"description":"The symbol pair that was evaluated from the request.","type":"string"}},"required":["status","request_id","symbol"],"type":"object"}},"text/csv":{"example":"ask,bid,exchange,timestamp\n0.73124,0.73122,48,1605557756000\n","schema":{"type":"string"}}},"description":"The last quote tick for this currency pair."},"default":{"description":"Unexpected error"}},"summary":"Last Quote for a Currency Pair","tags":["fx:last:quote"],"x-polygon-entitlement-data-type":{"description":"NBBO data","name":"nbbo"},"x-polygon-entitlement-market-type":{"description":"Forex data","name":"fx"}}},"/v1/marketstatus/now":{"get":{"description":"Get the current trading status of the exchanges and overall financial markets.","operationId":"GetMarketStatus","responses":{"200":{"content":{"application/json":{"example":{"afterHours":true,"currencies":{"crypto":"open","fx":"open"},"earlyHours":false,"exchanges":{"nasdaq":"extended-hours","nyse":"extended-hours","otc":"closed"},"market":"extended-hours","serverTime":"2020-11-10T17:37:37-05:00"},"schema":{"properties":{"afterHours":{"description":"Whether or not the market is in post-market hours.","type":"boolean","x-polygon-go-type":{"name":"*bool"}},"currencies":{"description":"Contains the status of various currency markets.","properties":{"crypto":{"description":"The status of the crypto market.","type":"string"},"fx":{"description":"The status of the forex market.","type":"string"}},"type":"object","x-polygon-go-type":{"name":"Currencies"}},"earlyHours":{"description":"Whether or not the market is in pre-market hours.","type":"boolean","x-polygon-go-type":{"name":"*bool"}},"exchanges":{"description":"Contains the status of different US stock exchanges (e.g., Nasdaq, NYSE).","properties":{"nasdaq":{"description":"The status of the Nasdaq market.","type":"string"},"nyse":{"description":"The status of the NYSE market.","type":"string"},"otc":{"description":"The status of the OTC market.","type":"string"}},"type":"object","x-polygon-go-type":{"name":"Exchanges"}},"indicesGroups":{"description":"Contains the status of various index groups (e.g., MSCI, FTSE Russell).","properties":{"cccy":{"description":"The status of Cboe Streaming Market Indices Cryptocurrency (\"CCCY\") indices trading hours.","type":"string"},"cgi":{"description":"The status of Cboe Global Indices (\"CGI\") trading hours.","type":"string"},"dow_jones":{"description":"The status of Dow Jones indices trading hours","type":"string"},"ftse_russell":{"description":"The status of Financial Times Stock Exchange Group (\"FTSE\") Russell indices trading hours.","type":"string"},"msci":{"description":"The status of Morgan Stanley Capital International (\"MSCI\") indices trading hours.","type":"string"},"mstar":{"description":"The status of Morningstar (\"MSTAR\") indices trading hours.","type":"string"},"mstarc":{"description":"The status of Morningstar Customer (\"MSTARC\") indices trading hours.","type":"string"},"nasdaq":{"description":"The status of National Association of Securities Dealers Automated Quotations (\"Nasdaq\") indices trading hours.","type":"string"},"s_and_p":{"description":"The status of Standard \u0026 Poor's (\"S\u0026P\") indices trading hours.","type":"string"},"societe_generale":{"description":"The status of Societe Generale indices trading hours.","type":"string"}},"type":"object","x-polygon-go-type":{"name":"IndicesGroups"}},"market":{"description":"The status of the market as a whole.","type":"string"},"serverTime":{"description":"The current time of the server, returned as a date-time in RFC3339 format.","type":"string"}},"type":"object"}}},"description":"OK"}},"summary":"Market Status","tags":["reference:stocks:market"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"}}},"/v1/marketstatus/upcoming":{"get":{"description":"Get upcoming market holidays and their open/close times.","operationId":"GetMarketHolidays","responses":{"200":{"content":{"application/json":{"example":[{"date":"2020-11-26","exchange":"NYSE","name":"Thanksgiving","status":"closed"},{"date":"2020-11-26","exchange":"NASDAQ","name":"Thanksgiving","status":"closed"},{"date":"2020-11-26","exchange":"OTC","name":"Thanksgiving","status":"closed"},{"close":"2020-11-27T18:00:00.000Z","date":"2020-11-27","exchange":"NASDAQ","name":"Thanksgiving","open":"2020-11-27T14:30:00.000Z","status":"early-close"},{"close":"2020-11-27T18:00:00.000Z","date":"2020-11-27","exchange":"NYSE","name":"Thanksgiving","open":"2020-11-27T14:30:00.000Z","status":"early-close"}],"schema":{"items":{"properties":{"close":{"description":"The market close time on the holiday (if it's not closed).","type":"string"},"date":{"description":"The date of the holiday.","type":"string"},"exchange":{"description":"Which market the record is for.","type":"string"},"name":{"description":"The name of the holiday.","type":"string"},"open":{"description":"The market open time on the holiday (if it's not closed).","type":"string"},"status":{"description":"The status of the market on the holiday.","type":"string"}},"type":"object","x-polygon-go-type":{"name":"MarketHoliday"}},"type":"array"}}},"description":"OK"}},"summary":"Market Holidays","tags":["reference:stocks:market"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"}}},"/v1/open-close/crypto/{from}/{to}/{date}":{"get":{"description":"Get the open, close prices of a cryptocurrency symbol on a certain day.\n","operationId":"GetCryptoOpenClose","parameters":[{"description":"The \"from\" symbol of the pair.","example":"BTC","in":"path","name":"from","required":true,"schema":{"type":"string"}},{"description":"The \"to\" symbol of the pair.","example":"USD","in":"path","name":"to","required":true,"schema":{"type":"string"}},{"description":"The date of the requested open/close in the format YYYY-MM-DD.","example":"2023-01-09","in":"path","name":"date","required":true,"schema":{"format":"date","type":"string"}},{"description":"Whether or not the results are adjusted for splits.  By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n","example":true,"in":"query","name":"adjusted","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"close":11050.64,"closingTrades":[{"c":[2],"i":"973323250","p":11050.64,"s":0.006128,"t":1602287999795,"x":4},{"c":[1],"i":"105717893","p":11049.4,"s":0.014,"t":1602287999659,"x":17}],"day":"2020-10-09T00:00:00.000Z","isUTC":true,"open":10932.44,"openTrades":[{"c":[2],"i":"511235746","p":10932.44,"s":0.002,"t":1602201600056,"x":1},{"c":[2],"i":"511235751","p":10923.76,"s":0.02,"t":1602201600141,"x":4}],"symbol":"BTC-USD"},"schema":{"properties":{"close":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"closingTrades":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"A list of condition codes.\n","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.\n","type":"integer"},"type":"array"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size of a trade (also known as volume).\n","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"x":{"description":"The exchange that this crypto trade happened on.  \nSee \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\"\u003eExchanges\u003c/a\u003e for a mapping of exchanges to IDs.\n","type":"integer"}},"required":["p","s","x","c","t","i"],"type":"object"},"type":"array"},"day":{"description":"The date requested.","format":"date","type":"string"},"isUTC":{"description":"Whether or not the timestamps are in UTC timezone.","type":"boolean"},"open":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"openTrades":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"A list of condition codes.\n","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.\n","type":"integer"},"type":"array"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size of a trade (also known as volume).\n","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"x":{"description":"The exchange that this crypto trade happened on.  \nSee \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\"\u003eExchanges\u003c/a\u003e for a mapping of exchanges to IDs.\n","type":"integer"}},"required":["p","s","x","c","t","i"],"type":"object"},"type":"array"},"symbol":{"description":"The symbol pair that was evaluated from the request.","type":"string"}},"required":["symbol","isUTC","day","open","close","openTrades","closingTrades"],"type":"object"}},"text/csv":{"example":"isUTC,day,open,close,openTrades,closingTrades\ntrue,2020-10-09,10932.44,11050.64,\"[{\\\"s\\\":0.002,\\\"p\\\":10932.44,\\\"x\\\":1,\\\"t\\\":1602201600056,\\\"c\\\":[2],\\\"i\\\":\\\"511235746\\\"},{\\\"s\\\":0.02,\\\"p\\\":10923.76,\\\"x\\\":4,\\\"t\\\":1602201600141,\\\"c\\\":[2],\\\"i\\\":\\\"511235751\\\"}]\",\"[{\\\"s\\\":0.006128,\\\"p\\\":11050.64,\\\"x\\\":4,\\\"t\\\":1602287999795,\\\"c\\\":[2],\\\"i\\\":\\\"973323250\\\"},{\\\"s\\\":0.014,\\\"p\\\":11049.4,\\\"x\\\":17,\\\"t\\\":1602287999659,\\\"c\\\":[1],\\\"i\\\":\\\"105717893\\\"}]\"\n","schema":{"type":"string"}}},"description":"The open/close of this symbol."},"default":{"description":"Unexpected error"}},"summary":"Daily Open/Close","tags":["crypto:open-close"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Crypto data","name":"crypto"}}},"/v1/open-close/{indicesTicker}/{date}":{"get":{"description":"Get the open, close and afterhours values of a index symbol on a certain date.\n","operationId":"GetIndicesOpenClose","parameters":[{"description":"The ticker symbol of Index.","example":"I:NDX","in":"path","name":"indicesTicker","required":true,"schema":{"type":"string"}},{"description":"The date of the requested open/close in the format YYYY-MM-DD.","example":"2023-03-10","in":"path","name":"date","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"afterHours":11830.43006295237,"close":11830.28178808306,"from":"2023-03-10T00:00:00.000Z","high":12069.62262033557,"low":11789.85923449393,"open":12001.69552583921,"preMarket":12001.69552583921,"status":"OK","symbol":"I:NDX"},"schema":{"properties":{"afterHours":{"description":"The close value of the ticker symbol in after hours trading.","format":"double","type":"number"},"close":{"description":"The close value for the symbol in the given time period.","format":"double","type":"number"},"from":{"description":"The requested date.","format":"date","type":"string"},"high":{"description":"The highest value for the symbol in the given time period.","format":"double","type":"number"},"low":{"description":"The lowest value for the symbol in the given time period.","format":"double","type":"number"},"open":{"description":"The open value for the symbol in the given time period.","format":"double","type":"number"},"preMarket":{"description":"The open value of the ticker symbol in pre-market trading.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"},"symbol":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"required":["status","from","symbol","open","high","low","close"],"type":"object"}},"text/csv":{"example":"from,open,high,low,close,afterHours,preMarket\n2023-01-10,12001.69552583921,12069.62262033557,11789.85923449393,11830.28178808306,26122646,11830.43006295237,12001.69552583921\n","schema":{"type":"string"}}},"description":"The open/close of this stock symbol."},"default":{"description":"Unexpected error"}},"summary":"Daily Open/Close","tags":["stocks:open-close"],"x-polygon-entitlement-allowed-limited-tickers":true,"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Indices data","name":"indices"}}},"/v1/open-close/{optionsTicker}/{date}":{"get":{"description":"Get the open, close and afterhours prices of an options contract on a certain date.\n","operationId":"GetOptionsOpenClose","parameters":[{"description":"The ticker symbol of the options contract.","example":"O:SPY251219C00650000","in":"path","name":"optionsTicker","required":true,"schema":{"type":"string"}},{"description":"The date of the requested open/close in the format YYYY-MM-DD.","example":"2023-01-09","in":"path","name":"date","required":true,"schema":{"format":"date","type":"string"}},{"description":"Whether or not the results are adjusted for splits.  By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n","example":true,"in":"query","name":"adjusted","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"afterHours":26.35,"close":26.35,"from":"2023-01-09","high":26.35,"low":25,"open":25,"preMarket":25,"status":"OK","symbol":"O:TSLA210903C00700000","volume":2},"schema":{"properties":{"afterHours":{"description":"The close price of the ticker symbol in after hours trading.","format":"double","type":"number"},"close":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"from":{"description":"The requested date.","format":"date","type":"string"},"high":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"low":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"open":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"preMarket":{"description":"The open price of the ticker symbol in pre-market trading.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"},"symbol":{"description":"The exchange symbol that this item is traded under.","type":"string"},"volume":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"}},"required":["status","from","symbol","open","high","low","close","volume"],"type":"object"}},"text/csv":{"example":"from,open,high,low,close,volume,afterHours,preMarket\n2023-01-09,25,26.35,25,26.35,2,26.35,25\n","schema":{"type":"string"}}},"description":"The open/close of this stock symbol."},"default":{"description":"Unexpected error"}},"summary":"Daily Open/Close","tags":["options:open-close"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Options data","name":"options"}}},"/v1/open-close/{stocksTicker}/{date}":{"get":{"description":"Get the open, close and afterhours prices of a stock symbol on a certain date.\n","operationId":"GetStocksOpenClose","parameters":[{"description":"Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.","example":"AAPL","in":"path","name":"stocksTicker","required":true,"schema":{"type":"string"}},{"description":"The date of the requested open/close in the format YYYY-MM-DD.","example":"2023-01-09","in":"path","name":"date","required":true,"schema":{"format":"date","type":"string"}},{"description":"Whether or not the results are adjusted for splits.  By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n","example":true,"in":"query","name":"adjusted","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"afterHours":322.1,"close":325.12,"from":"2023-01-09","high":326.2,"low":322.3,"open":324.66,"preMarket":324.5,"status":"OK","symbol":"AAPL","volume":26122646},"schema":{"properties":{"afterHours":{"description":"The close price of the ticker symbol in after hours trading.","format":"double","type":"number"},"close":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"from":{"description":"The requested date.","format":"date","type":"string"},"high":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"low":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"open":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"preMarket":{"description":"The open price of the ticker symbol in pre-market trading.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"},"symbol":{"description":"The exchange symbol that this item is traded under.","type":"string"},"volume":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"}},"required":["status","from","symbol","open","high","low","close","volume"],"type":"object"}},"text/csv":{"example":"from,open,high,low,close,volume,afterHours,preMarket\n2023-01-09,324.66,326.2,322.3,325.12,26122646,322.1,324.5\n","schema":{"type":"string"}}},"description":"The open/close of this stock symbol."},"default":{"description":"Unexpected error"}},"summary":"Daily Open/Close","tags":["stocks:open-close"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v1/reference/ipos":{"get":{"description":"Contains comprehensive data about Initial Public Offerings (IPOs) and direct listings for US stocks, tracking both historical and pending offerings with detailed pricing, share, and timing information.","operationId":"get_v1_reference_ipos","parameters":[{"description":"The ticker symbol of the IPO event.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Nine-character alphanumeric code that uniquely identifies a financial security in North America.","in":"query","name":"us_code","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"us_code.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"us_code.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"us_code.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"us_code.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"us_code.lte","schema":{"type":"string"}},{"description":"International Securities Identification Number. This is a unique twelve-digit code that is assigned to every security issuance in the world.","in":"query","name":"isin","schema":{"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"isin.any_of","schema":{"type":"string"}},{"description":"Filter greater than the value.","in":"query","name":"isin.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value.","in":"query","name":"isin.gte","schema":{"type":"string"}},{"description":"Filter less than the value.","in":"query","name":"isin.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value.","in":"query","name":"isin.lte","schema":{"type":"string"}},{"description":"First trading date for the newly listed entity. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"listing_date","schema":{"type":"string"}},{"description":"Filter greater than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"listing_date.gt","schema":{"type":"string"}},{"description":"Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"listing_date.gte","schema":{"type":"string"}},{"description":"Filter less than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"listing_date.lt","schema":{"type":"string"}},{"description":"Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z').","in":"query","name":"listing_date.lte","schema":{"type":"string"}},{"description":"The status of the IPO.","in":"query","name":"ipo_status","schema":{"enum":["direct_listing_process","history","new","pending","postponed","rumor","withdrawn"],"type":"string"}},{"description":"Filter equal to any of the values. Multiple values can be specified by using a comma separated list.","in":"query","name":"ipo_status.any_of","schema":{"enum":["direct_listing_process","history","new","pending","postponed","rumor","withdrawn"],"type":"string"}},{"description":"Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '1000'.","in":"query","name":"limit","schema":{"default":10,"maximum":1001,"minimum":1,"type":"integer"}},{"description":"A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'listing_date' if not specified. The sort order defaults to 'desc' if not specified.","in":"query","name":"sort","schema":{"default":"listing_date.desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"6a7e466379af0a71039d60cc78e72282","results":[{"announced_date":"2024-06-01","currency_code":"USD","final_issue_price":17,"highest_offer_price":17,"ipo_status":"history","isin":"US75383L1026","issuer_name":"Rapport Therapeutics Inc.","last_updated":"2024-06-27","listing_date":"2024-06-07","lot_size":100,"lowest_offer_price":17,"max_shares_offered":8000000,"min_shares_offered":1000000,"primary_exchange":"XNAS","security_description":"Ordinary Shares","security_type":"CS","shares_outstanding":35376457,"ticker":"RAPP","total_offer_size":136000000,"us_code":"75383L102"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"The results for this request.","items":{"properties":{"announced_date":{"description":"The date when the IPO event was announced.","format":"int64","type":"integer"},"currency_code":{"description":"Underlying currency of the security.","type":"string"},"final_issue_price":{"description":"The price set by the company and its underwriters before the IPO goes live.","format":"double","type":"number"},"highest_offer_price":{"description":"The highest price within the IPO price range that the company might use to price the shares.","format":"double","type":"number"},"ipo_status":{"description":"The status of the IPO.","type":"string"},"isin":{"description":"International Securities Identification Number. This is a unique twelve-digit code that is assigned to every security issuance in the world.","type":"string"},"issuer_name":{"description":"Name of issuer.","type":"string"},"last_updated":{"description":"The date when the IPO event was last modified.","format":"int64","type":"integer"},"listing_date":{"description":"First trading date for the newly listed entity.","format":"int64","type":"integer"},"lot_size":{"description":"The minimum number of shares that an investor may apply for during an IPO.","format":"int64","type":"integer"},"lowest_offer_price":{"description":"The lowest price within the IPO price range that the company is willing to offer its shares to investors.","format":"double","type":"number"},"max_shares_offered":{"description":"The upper limit of the shares that the company is offering to investors.","format":"int64","type":"integer"},"min_shares_offered":{"description":"The lower limit of shares that the company is willing to sell in the IPO.","format":"int64","type":"integer"},"primary_exchange":{"description":"Market Identifier Code (MIC) of the primary exchange where the security is listed. The Market Identifier Code (MIC) (ISO 10383) is a unique identification code used to identify securities trading exchanges, regulated and non-regulated trading markets.","type":"string"},"security_description":{"description":"A brief description of the security. e.g. Class A Shares","type":"string"},"security_type":{"description":"The classification of the stock. For example, CS stands for Common Stock.","type":"string"},"shares_outstanding":{"description":"The total number of shares that the company has issued and are held by investors.","format":"int64","type":"integer"},"ticker":{"description":"The ticker symbol of the IPO event.","type":"string"},"total_offer_size":{"description":"The total amount raised by the company for IPO.","format":"double","type":"number"},"us_code":{"description":"Nine-character alphanumeric code that uniquely identifies a financial security in North America.","type":"string"}},"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","enum":["OK"],"type":"string"}},"required":["status","request_id","results"],"type":"object"}}},"description":"A list of results."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A message describing the source of the error.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"status":{"description":"The status of this request's response.","enum":["ERROR"],"type":"string"}},"required":["status","request_id","error"],"type":"object"}}},"description":"An error message."}},"tags":["us_stocks_reference"]}},"/v1/reference/sec/filings":{"get":{"description":"List filings","operationId":"ListFilings","parameters":[{"description":"Query by filing type.","in":"query","name":"type","schema":{"description":"Filing Type","enum":["10-K","10-Q"],"type":"string"}},{"description":"Query by filing date.","in":"query","name":"filing_date","schema":{"description":"The date when the filing was filed in YYYYMMDD format.","example":"20210101","pattern":"^[0-9]{8}$","type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"Query by period of report.","in":"query","name":"period_of_report_date","schema":{"description":"The period of report for the filing in YYYYMMDD format.","example":"20210101","pattern":"^[0-9]{8}$","type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"If true, query only for filings with an XBRL instance file.\nIf false, query for filings without an XBRL instance file.\nIf this parameter is not provided, query for filings with or without XBRL instance files.","in":"query","name":"has_xbrl","schema":{"nullable":true,"type":"boolean"},"x-polygon-go-id":"HasXBRL"},{"description":"Query by entity company name.","in":"query","name":"entities.company_data.name","schema":{"example":"Facebook Inc","type":"string"},"x-polygon-filter-field":{"search":true}},{"description":"Query by entity company CIK.","in":"query","name":"entities.company_data.cik","schema":{"description":"Central Index Key (CIK) Number","type":"string"}},{"description":"Query by entity company ticker.","in":"query","name":"entities.company_data.ticker","schema":{"description":"Ticker","type":"string"}},{"description":"Query by entity company SIC.","in":"query","name":"entities.company_data.sic","schema":{"description":"Standard Industrial Classification (SIC)","type":"string"}},{"description":"Search by filing_date.","in":"query","name":"filing_date.gte","schema":{"description":"The date when the filing was filed in YYYYMMDD format.","example":"20210101","pattern":"^[0-9]{8}$","type":"string"}},{"description":"Search by filing_date.","in":"query","name":"filing_date.gt","schema":{"description":"The date when the filing was filed in YYYYMMDD format.","example":"20210101","pattern":"^[0-9]{8}$","type":"string"}},{"description":"Search by filing_date.","in":"query","name":"filing_date.lte","schema":{"description":"The date when the filing was filed in YYYYMMDD format.","example":"20210101","pattern":"^[0-9]{8}$","type":"string"}},{"description":"Search by filing_date.","in":"query","name":"filing_date.lt","schema":{"description":"The date when the filing was filed in YYYYMMDD format.","example":"20210101","pattern":"^[0-9]{8}$","type":"string"}},{"description":"Search by period_of_report_date.","in":"query","name":"period_of_report_date.gte","schema":{"description":"The period of report for the filing in YYYYMMDD format.","example":"20210101","pattern":"^[0-9]{8}$","type":"string"}},{"description":"Search by period_of_report_date.","in":"query","name":"period_of_report_date.gt","schema":{"description":"The period of report for the filing in YYYYMMDD format.","example":"20210101","pattern":"^[0-9]{8}$","type":"string"}},{"description":"Search by period_of_report_date.","in":"query","name":"period_of_report_date.lte","schema":{"description":"The period of report for the filing in YYYYMMDD format.","example":"20210101","pattern":"^[0-9]{8}$","type":"string"}},{"description":"Search by period_of_report_date.","in":"query","name":"period_of_report_date.lt","schema":{"description":"The period of report for the filing in YYYYMMDD format.","example":"20210101","pattern":"^[0-9]{8}$","type":"string"}},{"description":"Search by entities.company_data.name.","in":"query","name":"entities.company_data.name.search","schema":{"type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 1000.","in":"query","name":"limit","schema":{"default":10,"example":10,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"filing_date","enum":["filing_date","period_of_report_date"],"example":"filing_date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"description":"FIXME","example":{},"schema":{"properties":{"count":{"type":"integer"},"next_url":{"type":"string"},"request_id":{"type":"string"},"results":{"items":{"properties":{"acceptance_datetime":{"description":"The datetime when the filing was accepted by EDGAR in EST (format: YYYYMMDDHHMMSS)","type":"string"},"accession_number":{"description":"Filing Accession Number","type":"string"},"entities":{"description":"Entities related to the filing (e.g. the document filers).","items":{"description":"A filing entity (e.g. the document filer).","properties":{"company_data":{"properties":{"cik":{"description":"Central Index Key (CIK) Number","type":"string"},"name":{"example":"Facebook Inc","type":"string"},"sic":{"description":"Standard Industrial Classification (SIC)","type":"string"},"ticker":{"description":"Ticker","type":"string"}},"required":["name","cik","sic"],"type":"object","x-polygon-go-type":{"name":"SECCompanyData","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"relation":{"description":"Relationship of this entity to the filing.","enum":["filer"],"type":"string"}},"required":["relation"],"type":"object","x-polygon-go-type":{"name":"SECFilingEntity","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"files_count":{"description":"The number of files associated with the filing.","format":"int64","type":"integer"},"filing_date":{"description":"The date when the filing was filed in YYYYMMDD format.","example":"20210101","pattern":"^[0-9]{8}$","type":"string"},"id":{"description":"Unique identifier for the filing.","type":"string"},"period_of_report_date":{"description":"The period of report for the filing in YYYYMMDD format.","example":"20210101","pattern":"^[0-9]{8}$","type":"string"},"source_url":{"description":"The source URL is a link back to the upstream source for this filing\ndocument.","example":"https://www.sec.gov/Archives/edgar/data/0001326801/000132680119000037/0001326801-19-000037-index.html","format":"uri","type":"string"},"type":{"description":"Filing Type","enum":["10-K","10-Q"],"type":"string"}},"required":["id","accession_number","type","filing_date","period_of_report_date","files_count","source_url","download_url","entities"],"type":"object","x-polygon-go-type":{"name":"SECFiling","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"status":{"type":"string"}},"required":["status","request_id","count","results"],"type":"object"}}},"description":"FIXME"}},"summary":"SEC Filings","tags":["reference:sec:filings"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"},"x-polygon-paginate":{"sort":{"default":"filing_date","enum":["filing_date","period_of_report_date"]}}},"x-polygon-draft":true},"/v1/reference/sec/filings/{filing_id}":{"get":{"description":"Get filing","operationId":"GetFiling","parameters":[{"description":"Select by filing id.","in":"path","name":"filing_id","schema":{"description":"Unique identifier for the filing.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"description":"FIXME","example":{},"schema":{"properties":{"results":{"properties":{"acceptance_datetime":{"description":"The datetime when the filing was accepted by EDGAR in EST (format: YYYYMMDDHHMMSS)","type":"string"},"accession_number":{"description":"Filing Accession Number","type":"string"},"entities":{"description":"Entities related to the filing (e.g. the document filers).","items":{"description":"A filing entity (e.g. the document filer).","properties":{"company_data":{"properties":{"cik":{"description":"Central Index Key (CIK) Number","type":"string"},"name":{"example":"Facebook Inc","type":"string"},"sic":{"description":"Standard Industrial Classification (SIC)","type":"string"},"ticker":{"description":"Ticker","type":"string"}},"required":["name","cik","sic"],"type":"object","x-polygon-go-type":{"name":"SECCompanyData","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"relation":{"description":"Relationship of this entity to the filing.","enum":["filer"],"type":"string"}},"required":["relation"],"type":"object","x-polygon-go-type":{"name":"SECFilingEntity","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"files_count":{"description":"The number of files associated with the filing.","format":"int64","type":"integer"},"filing_date":{"description":"The date when the filing was filed in YYYYMMDD format.","example":"20210101","pattern":"^[0-9]{8}$","type":"string"},"id":{"description":"Unique identifier for the filing.","type":"string"},"period_of_report_date":{"description":"The period of report for the filing in YYYYMMDD format.","example":"20210101","pattern":"^[0-9]{8}$","type":"string"},"source_url":{"description":"The source URL is a link back to the upstream source for this filing\ndocument.","example":"https://www.sec.gov/Archives/edgar/data/0001326801/000132680119000037/0001326801-19-000037-index.html","format":"uri","type":"string"},"type":{"description":"Filing Type","enum":["10-K","10-Q"],"type":"string"}},"required":["id","accession_number","type","filing_date","period_of_report_date","files_count","source_url","download_url","entities"],"type":"object","x-polygon-go-type":{"name":"SECFiling","path":"github.com/polygon-io/go-lib-models/v2/globals"}}},"type":"object"}}},"description":"FIXME"}},"summary":"SEC Filing","tags":["reference:sec:filing"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"}},"x-polygon-draft":true},"/v1/reference/sec/filings/{filing_id}/files":{"get":{"description":"List filing files","operationId":"ListFilingFiles","parameters":[{"description":"Select by filing id.","in":"path","name":"filing_id","schema":{"description":"Unique identifier for the filing.","type":"string"}},{"description":"Query by file sequence number.","in":"query","name":"sequence","schema":{"description":"File Sequence Number","format":"int64","max":999,"min":1,"type":"integer"},"x-polygon-filter-field":{"range":true}},{"description":"Query by file name.","in":"query","name":"filename","schema":{"description":"The name for the file.","type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"Search by sequence.","in":"query","name":"sequence.gte","schema":{"description":"File Sequence Number","format":"int64","max":999,"min":1,"type":"integer"}},{"description":"Search by sequence.","in":"query","name":"sequence.gt","schema":{"description":"File Sequence Number","format":"int64","max":999,"min":1,"type":"integer"}},{"description":"Search by sequence.","in":"query","name":"sequence.lte","schema":{"description":"File Sequence Number","format":"int64","max":999,"min":1,"type":"integer"}},{"description":"Search by sequence.","in":"query","name":"sequence.lt","schema":{"description":"File Sequence Number","format":"int64","max":999,"min":1,"type":"integer"}},{"description":"Search by filename.","in":"query","name":"filename.gte","schema":{"description":"The name for the file.","type":"string"}},{"description":"Search by filename.","in":"query","name":"filename.gt","schema":{"description":"The name for the file.","type":"string"}},{"description":"Search by filename.","in":"query","name":"filename.lte","schema":{"description":"The name for the file.","type":"string"}},{"description":"Search by filename.","in":"query","name":"filename.lt","schema":{"description":"The name for the file.","type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 1000.","in":"query","name":"limit","schema":{"default":10,"example":10,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"sequence","enum":["sequence","filename"],"example":"sequence","type":"string"}}],"responses":{"200":{"content":{"application/json":{"description":"FIXME","example":{},"schema":{"properties":{"count":{"type":"integer"},"next_url":{"type":"string"},"request_id":{"type":"string"},"results":{"items":{"description":"File associated with the filing.\n\nThis provides information to uniquly identify the additional data and a URL\nwhere the file may be downloaded.","properties":{"description":{"description":"A description for the contents of the file.","type":"string"},"filename":{"description":"The name for the file.","type":"string"},"id":{"description":"An identifier unique to the filing for this data entry.","example":"1","type":"string"},"sequence":{"description":"File Sequence Number","format":"int64","max":999,"min":1,"type":"integer"},"size_bytes":{"description":"The size of the file in bytes.","format":"int64","type":"integer"},"source_url":{"description":"The source URL is a link back to the upstream source for this file.","format":"uri","type":"string"},"type":{"description":"The type of document contained in the file.","type":"string"}},"required":["id","file","description","type","size_bytes","sequence","source_url"],"type":"object","x-polygon-go-type":{"name":"SECFilingFile","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"status":{"type":"string"}},"required":["status","request_id","count","results"],"type":"object"}}},"description":"FIXME"}},"summary":"SEC Filing Files","tags":["reference:sec:filing:files"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"},"x-polygon-paginate":{"sort":{"default":"sequence","enum":["sequence","filename"]}}},"x-polygon-draft":true},"/v1/reference/sec/filings/{filing_id}/files/{file_id}":{"get":{"description":"Get filing file","operationId":"GetFilingFile","parameters":[{"description":"Select by filing id.","in":"path","name":"filing_id","schema":{"description":"Unique identifier for the filing.","type":"string"}},{"description":"Select by file id.","in":"path","name":"file_id","schema":{"description":"An identifier unique to the filing for this data entry.","example":"1","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"File associated with the filing.\n\nThis provides information to uniquly identify the additional data and a URL\nwhere the file may be downloaded.","properties":{"description":{"description":"A description for the contents of the file.","type":"string"},"filename":{"description":"The name for the file.","type":"string"},"id":{"description":"An identifier unique to the filing for this data entry.","example":"1","type":"string"},"sequence":{"description":"File Sequence Number","format":"int64","max":999,"min":1,"type":"integer"},"size_bytes":{"description":"The size of the file in bytes.","format":"int64","type":"integer"},"source_url":{"description":"The source URL is a link back to the upstream source for this file.","format":"uri","type":"string"},"type":{"description":"The type of document contained in the file.","type":"string"}},"required":["id","file","description","type","size_bytes","sequence","source_url"],"type":"object","x-polygon-go-type":{"name":"SECFilingFile","path":"github.com/polygon-io/go-lib-models/v2/globals"}}}},"description":"The file data."}},"summary":"SEC Filing File","tags":["reference:sec:filing:file"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"}},"x-polygon-draft":true},"/v1/related-companies/{ticker}":{"get":{"description":"Get a list of tickers related to the queried ticker based on News and Returns data.","operationId":"GetRelatedCompanies","parameters":[{"description":"The ticker symbol to search.","example":"AAPL","in":"path","name":"ticker","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"31d59dda-80e5-4721-8496-d0d32a654afe","results":[{"ticker":"MSFT"},{"ticker":"GOOGL"},{"ticker":"AMZN"},{"ticker":"FB"},{"ticker":"TSLA"},{"ticker":"NVDA"},{"ticker":"INTC"},{"ticker":"ADBE"},{"ticker":"NFLX"},{"ticker":"PYPL"}],"status":"OK","stock_symbol":"AAPL"},"schema":{"properties":{"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"description":"The tickers related to the requested ticker.","properties":{"ticker":{"description":"A ticker related to the requested ticker.","type":"string"}},"required":["ticker"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"},"ticker":{"description":"The ticker being queried.","type":"string"}},"type":"object"}}},"description":"Related Companies."},"401":{"description":"Unauthorized - Check our API Key and account status"}},"summary":"Related Companies","tags":["reference:related:companies"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"}}},"/v1/summaries":{"get":{"description":"Get everything needed to visualize the tick-by-tick movement of a list of tickers.","operationId":"SnapshotSummary","parameters":[{"description":"Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/docs/rest/stocks/tickers/all-tickers\"\u003ethe tickers endpoint\u003c/a\u003e for more details on supported tickers. If no tickers are passed then no results will be returned.\n\nWarning: The maximum number of characters allowed in a URL are subject to your technology stack.","example":"NCLH,O:SPY250321C00380000,C:EURUSD,X:BTCUSD","in":"query","name":"ticker.any_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"abc123","results":[{"branding":{"icon_url":"https://api.massive.com/icon.png","logo_url":"https://api.massive.com/logo.svg"},"last_updated":1679597116344223500,"market_status":"closed","name":"Norwegian Cruise Lines","price":22.3,"session":{"change":-1.05,"change_percent":-4.67,"close":21.4,"decimal_volume":"37.0","early_trading_change":-0.39,"early_trading_change_percent":-0.07,"high":22.49,"late_trading_change":1.2,"late_trading_change_percent":3.92,"low":21.35,"open":22.49,"previous_close":22.45,"volume":37},"ticker":"NCLH","type":"stocks"},{"last_updated":1679597116344223500,"market_status":"closed","name":"NCLH $5 Call","options":{"contract_type":"call","exercise_style":"american","expiration_date":"2022-10-14","shares_per_contract":100,"strike_price":5,"underlying_ticker":"NCLH"},"price":6.6,"session":{"change":-0.05,"change_percent":-1.07,"close":6.65,"early_trading_change":-0.01,"early_trading_change_percent":-0.03,"high":7.01,"late_trading_change":-0.4,"late_trading_change_percent":-0.02,"low":5.42,"open":6.7,"previous_close":6.71,"volume":67},"ticker":"O:NCLH221014C00005000","type":"options"},{"last_updated":1679597116344223500,"market_status":"open","name":"Euro - United States Dollar","price":0.97989,"session":{"change":-0.0001,"change_percent":-0.67,"close":0.97989,"high":0.98999,"low":0.96689,"open":0.97889,"previous_close":0.98001},"ticker":"C:EURUSD","type":"fx"},{"branding":{"icon_url":"https://api.massive.com/icon.png","logo_url":"https://api.massive.com/logo.svg"},"last_updated":1679597116344223500,"market_status":"open","name":"Bitcoin - United States Dollar","price":32154.68,"session":{"change":-201.23,"change_percent":-0.77,"close":32154.68,"high":33124.28,"low":28182.88,"open":31129.32,"previous_close":33362.18},"ticker":"X:BTCUSD","type":"crypto"},{"error":"NOT_FOUND","message":"Ticker not found.","ticker":"APx"}],"status":"OK"},"schema":{"properties":{"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"properties":{"branding":{"properties":{"icon_url":{"description":"A link to this ticker's company's icon. Icon's are generally smaller, square images that represent the company at a glance.\nNote that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details.","type":"string"},"logo_url":{"description":"A link to this ticker's company's logo.\nNote that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details.","type":"string"}},"type":"object","x-polygon-go-type":{"name":"Branding"}},"error":{"description":"The error while looking for this ticker.","type":"string"},"last_updated":{"description":"The nanosecond timestamp of when this information was updated.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"market_status":{"description":"The market status for the market that trades this ticker.","type":"string"},"message":{"description":"The error message while looking for this ticker.","type":"string"},"name":{"description":"Name of ticker, forex, or crypto asset.","type":"string"},"options":{"properties":{"contract_type":{"description":"The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\".","enum":["put","call","other"],"type":"string"},"exercise_style":{"description":"The exercise style of this contract. See \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Option_style\"\u003ethis link\u003c/a\u003e for more details on exercise styles.","enum":["american","european","bermudan"],"type":"string"},"expiration_date":{"description":"The contract's expiration date in YYYY-MM-DD format.","format":"date","type":"string","x-polygon-go-type":{"name":"IDaysPolygonDateString","path":"github.com/polygon-io/ptime"}},"shares_per_contract":{"description":"The number of shares per contract for this contract.","format":"double","type":"number"},"strike_price":{"description":"The strike price of the option contract.","format":"double","type":"number"},"underlying_ticker":{"description":"The ticker for the option contract.","type":"string"}},"required":["contract_type","expiration_date","exercise_style","shares_per_contract","strike_price","underlying_ticker"],"type":"object","x-polygon-go-type":{"name":"Options"}},"price":{"description":"The most up to date ticker price.","format":"double","type":"number"},"session":{"description":"Comprehensive trading session metrics, detailing price changes, trading volume, and key price points (open, close, high, low) for the asset within the current trading day. Includes specific changes during early, regular, and late trading periods to enable detailed performance analysis and trend tracking.","properties":{"change":{"description":"The value of the price change for the asset from the previous trading day.","format":"double","type":"number"},"change_percent":{"description":"The percent of the price change for the asset from the previous trading day.","format":"double","type":"number"},"close":{"description":"The closing price of the asset for the day.","format":"double","type":"number"},"decimal_volume":{"description":"The trading volume for the asset for the day with decimal precision. This field provides support for fractional shares, representing volume as a decimal string. This field is only returned for stocks snapshots.","type":"string"},"early_trading_change":{"description":"Today's early trading change amount, difference between price and previous close if in early trading hours, otherwise difference between last price during early trading and previous close.","format":"double","type":"number"},"early_trading_change_percent":{"description":"Today's early trading change as a percentage.","format":"double","type":"number"},"high":{"description":"The highest price of the asset for the day.","format":"double","type":"number"},"late_trading_change":{"description":"Today's late trading change amount, difference between price and today's close if in late trading hours, otherwise difference between last price during late trading and today's close.","format":"double","type":"number"},"late_trading_change_percent":{"description":"Today's late trading change as a percentage.","format":"double","type":"number"},"low":{"description":"The lowest price of the asset for the day.","format":"double","type":"number"},"open":{"description":"The open price of the asset for the day.","format":"double","type":"number"},"previous_close":{"description":"The closing price of the asset for the previous trading day.","format":"double","type":"number"},"price":{"description":"The price of the most recent trade or bid price for this asset.","format":"double","type":"number"},"regular_trading_change":{"description":"Today's change in regular trading hours, difference between current price and previous trading day's close, otherwise difference between today's close and previous day's close.","format":"double","type":"number"},"regular_trading_change_percent":{"description":"Today's regular trading change as a percentage.","format":"double","type":"number"},"volume":{"description":"The trading volume for the asset for the day.","format":"double","type":"number"}},"required":["change","change_percent","close","high","low","open","previous_close"],"type":"object","x-polygon-go-type":{"name":"Session"}},"ticker":{"description":"Ticker of asset queried.","type":"string"},"type":{"description":"The market for this ticker of stock, crypto, fx, option.","enum":["stocks","crypto","options","fx"],"type":"string"}},"required":["ticker"],"type":"object","x-polygon-go-type":{"name":"SummaryResult"}},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","request_id"],"type":"object"}}},"description":"Snapshot Summary for ticker list"}},"summary":"Summaries","x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v2/aggs/grouped/locale/global/market/crypto/{date}":{"get":{"description":"Get the daily open, high, low, and close (OHLC) for the entire cryptocurrency markets.\n","operationId":"GetGroupedCryptoAggregates","parameters":[{"description":"The beginning date for the aggregate window.","example":"2025-11-03","in":"path","name":"date","required":true,"schema":{"type":"string"}},{"description":"Whether or not the results are adjusted for splits.  By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n","example":true,"in":"query","name":"adjusted","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"adjusted":true,"queryCount":3,"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":[{"T":"X:ARDRUSD","c":0.0550762,"h":0.0550762,"l":0.0550762,"n":18388,"o":0.0550762,"t":1580676480000,"v":2,"vw":0.0551},{"T":"X:NGCUSD","c":0.0272983,"h":0.0273733,"l":0.0272983,"n":18,"o":0.0273733,"t":1580674080000,"v":4734,"vw":0.0273},{"T":"X:ZSCUSD","c":0.00028531,"h":0.00028531,"l":0.00028531,"n":151,"o":0.00028531,"t":1580671080000,"v":390,"vw":0.0003}],"resultsCount":3,"status":"OK"},"schema":{"allOf":[{"properties":{"adjusted":{"description":"Whether or not this response was adjusted for splits.","type":"boolean"},"queryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"resultsCount":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","adjusted","queryCount","resultsCount","request_id"],"type":"object"},{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the end of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","t","T"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"T,c,h,l,n,o,t,v,vw\nX:ARDRUSD,0.0550762,0.0550762,0.0550762,18388,0.0550762,1580676480000,2,0.0551\nX:NGCUSD,0.0272983,0.0273733,0.0272983,18,0.0273733,1580674080000,4734,0.0273\nX:ZSCUSD,0.00028531,0.00028531,0.00028531,151,0.00028531,1580671080000,390,0.0003\n","schema":{"type":"string"}}},"description":"The previous day OHLC for the ticker."},"default":{"description":"Unexpected error"}},"summary":"Grouped Daily (Bars)","tags":["crypto:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Crypto data","name":"crypto"}}},"/v2/aggs/grouped/locale/global/market/fx/{date}":{"get":{"description":"Get the daily open, high, low, and close (OHLC) for the entire forex markets.\n","operationId":"GetGroupedForexAggregates","parameters":[{"description":"The beginning date for the aggregate window.","example":"2025-11-03","in":"path","name":"date","required":true,"schema":{"type":"string"}},{"description":"Whether or not the results are adjusted for splits.  By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n","example":true,"in":"query","name":"adjusted","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"adjusted":true,"queryCount":3,"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":[{"T":"C:ILSCHF","c":0.2704,"h":0.2706,"l":0.2693,"n":689,"o":0.2698,"t":1602719999999,"v":689,"vw":0.2702},{"T":"C:GBPCAD","c":1.71103,"h":1.71642,"l":1.69064,"n":407324,"o":1.69955,"t":1602719999999,"v":407324,"vw":1.7062},{"T":"C:DKKAUD","c":0.2214,"h":0.2214,"l":0.2195,"n":10639,"o":0.22,"t":1602719999999,"v":10639,"vw":0.2202}],"resultsCount":3,"status":"OK"},"schema":{"allOf":[{"properties":{"adjusted":{"description":"Whether or not this response was adjusted for splits.","type":"boolean"},"queryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"resultsCount":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","adjusted","queryCount","resultsCount","request_id"],"type":"object"},{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the end of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","t","T"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"T,c,h,l,n,o,t,v,vw\nC:ILSCHF,0.2704,0.2706,0.2693,689,0.2698,1602719999999,689,0.2702\nC:GBPCAD,1.71103,1.71642,1.69064,407324,1.69955,1602719999999,407324,1.7062\nC:DKKAUD,0.2214,0.2214,0.2195,10639,0.22,1602719999999,10639,0.2202\n","schema":{"type":"string"}}},"description":"Previous day OHLC for ticker"},"default":{"description":"Unexpected error"}},"summary":"Grouped Daily (Bars)","tags":["fx:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Forex data","name":"fx"}}},"/v2/aggs/grouped/locale/us/market/stocks/{date}":{"get":{"description":"Get the daily open, high, low, and close (OHLC) for the entire stocks/equities markets.\n","operationId":"GetGroupedStocksAggregates","parameters":[{"description":"The beginning date for the aggregate window.","example":"2025-11-03","in":"path","name":"date","required":true,"schema":{"type":"string"}},{"description":"Whether or not the results are adjusted for splits.  By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n","example":true,"in":"query","name":"adjusted","schema":{"type":"boolean"}},{"description":"Include OTC securities in the response. Default is false (don't include OTC securities).\n","in":"query","name":"include_otc","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"adjusted":true,"queryCount":3,"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":[{"T":"KIMpL","c":25.9102,"h":26.25,"l":25.91,"n":74,"o":26.07,"t":1602705600000,"v":4369,"vw":26.0407},{"T":"TANH","c":23.4,"h":24.763,"l":22.65,"n":1096,"o":24.5,"t":1602705600000,"v":25933.6,"vw":23.493},{"T":"VSAT","c":34.24,"h":35.47,"l":34.21,"n":4966,"o":34.9,"t":1602705600000,"v":312583,"vw":34.4736}],"resultsCount":3,"status":"OK"},"schema":{"allOf":[{"properties":{"adjusted":{"description":"Whether or not this response was adjusted for splits.","type":"boolean"},"queryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"resultsCount":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","adjusted","queryCount","resultsCount","request_id"],"type":"object"},{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix millisecond timestamp for the end of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","t","v","T"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"T,c,h,l,n,o,t,v,vw\nKIMpL,25.9102,26.25,25.91,74,26.07,1602705600000,4369,26.0407\nTANH,23.4,24.763,22.65,1096,24.5,1602705600000,25933.6,23.493\nVSAT,34.24,35.47,34.21,4966,34.9,1602705600000,312583,34.4736\n","schema":{"type":"string"}}},"description":"Previous day OHLC for ticker"},"default":{"description":"Unexpected error"}},"summary":"Grouped Daily (Bars)","tags":["stocks:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v2/aggs/ticker/{cryptoTicker}/prev":{"get":{"description":"Get the previous day's open, high, low, and close (OHLC) for the specified cryptocurrency pair.\n","operationId":"GetPreviousCryptoAggregates","parameters":[{"description":"The ticker symbol of the currency pair.","example":"X:BTCUSD","in":"path","name":"cryptoTicker","required":true,"schema":{"type":"string"}},{"description":"Whether or not the results are adjusted for splits.  By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n","example":true,"in":"query","name":"adjusted","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"adjusted":true,"queryCount":1,"request_id":"b2170df985474b6d21a6eeccfb6bee67","results":[{"T":"X:BTCUSD","c":16035.9,"h":16180,"l":15639.2,"o":15937.1,"t":1605416400000,"v":95045.16897951,"vw":15954.2111}],"resultsCount":1,"status":"OK","ticker":"X:BTCUSD"},"schema":{"allOf":[{"properties":{"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"required":["ticker"],"type":"object"},{"properties":{"adjusted":{"description":"Whether or not this response was adjusted for splits.","type":"boolean"},"queryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"resultsCount":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","adjusted","queryCount","resultsCount","request_id"],"type":"object"},{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the end of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","t","T"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"T,c,h,l,o,t,v,vw\nX:BTCUSD,16035.9,16180,15639.2,15937.1,1605416400000,95045.16897951,15954.2111\n","schema":{"type":"string"}}},"description":"The previous day OHLC for a ticker."},"default":{"description":"Unexpected error"}},"summary":"Previous Close","tags":["crypto:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Crypto data","name":"crypto"}}},"/v2/aggs/ticker/{cryptoTicker}/range/{multiplier}/{timespan}/{from}/{to}":{"get":{"description":"Get aggregate bars for a cryptocurrency pair over a given date range in custom time window sizes.\n\u003cbr /\u003e\n\u003cbr /\u003e\nFor example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned.\n","operationId":"GetCryptoAggregates","parameters":[{"description":"The ticker symbol of the currency pair.","example":"X:BTCUSD","in":"path","name":"cryptoTicker","required":true,"schema":{"type":"string"}},{"description":"The size of the timespan multiplier.","example":1,"in":"path","name":"multiplier","required":true,"schema":{"type":"integer"}},{"description":"The size of the time window.","example":"day","in":"path","name":"timespan","required":true,"schema":{"enum":["second","minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","example":"2025-11-03","in":"path","name":"from","required":true,"schema":{"type":"string"}},{"description":"The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","example":"2025-11-28","in":"path","name":"to","required":true,"schema":{"type":"string"}},{"description":"Whether or not the results are adjusted for splits.  By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n","example":true,"in":"query","name":"adjusted","schema":{"type":"boolean"}},{"description":"Sort the results by timestamp.\n`asc` will return results in ascending order (oldest at the top),\n`desc` will return results in descending order (newest at the top).\n","example":"asc","in":"query","name":"sort","schema":{"enum":["asc","desc"]}},{"description":"Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\n\u003ca href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\"\u003eAggregate Data API Improvements\u003c/a\u003e.\n","example":120,"in":"query","name":"limit","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"adjusted":true,"queryCount":2,"request_id":"0cf72b6da685bcd386548ffe2895904a","results":[{"c":10094.75,"h":10429.26,"l":9490,"n":1,"o":9557.9,"t":1590984000000,"v":303067.6562332156,"vw":9874.5529},{"c":9492.62,"h":10222.72,"l":9135.68,"n":1,"o":10096.87,"t":1591070400000,"v":323339.6922892879,"vw":9729.5701}],"resultsCount":2,"status":"OK","ticker":"X:BTCUSD"},"schema":{"allOf":[{"properties":{"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"required":["ticker"],"type":"object"},{"properties":{"adjusted":{"description":"Whether or not this response was adjusted for splits.","type":"boolean"},"queryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"resultsCount":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","adjusted","queryCount","resultsCount","request_id"],"type":"object"},{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","t"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"c,h,l,n,o,t,v,vw\n10094.75,10429.26,9490,1,9557.9,1590984000000,303067.6562332156,9874.5529\n9492.62,10222.72,9135.68,1,10096.87,1591070400000,323339.6922892879,9729.5701\n","schema":{"type":"string"}}},"description":"Cryptocurrency Aggregates."},"default":{"description":"Unexpected error"}},"summary":"Aggregates (Bars)","tags":["crypto:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Crypto data","name":"crypto"}}},"/v2/aggs/ticker/{forexTicker}/prev":{"get":{"description":"Get the previous day's open, high, low, and close (OHLC) for the specified forex pair.\n","operationId":"GetPreviousForexAggregates","parameters":[{"description":"The ticker symbol of the currency pair.","example":"C:EURUSD","in":"path","name":"forexTicker","required":true,"schema":{"type":"string"}},{"description":"Whether or not the results are adjusted for splits.  By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n","example":true,"in":"query","name":"adjusted","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"adjusted":true,"queryCount":1,"request_id":"08ec061fb85115678d68452c0a609cb7","results":[{"T":"C:EURUSD","c":1.06206,"h":1.0631,"l":1.0505,"n":180300,"o":1.05252,"t":1651708799999,"v":180300,"vw":1.055}],"resultsCount":1,"status":"OK","ticker":"C:EURUSD"},"schema":{"allOf":[{"properties":{"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"required":["ticker"],"type":"object"},{"properties":{"adjusted":{"description":"Whether or not this response was adjusted for splits.","type":"boolean"},"queryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"resultsCount":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","adjusted","queryCount","resultsCount","request_id"],"type":"object"},{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["T","v","o","c","h","l","t"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"T,c,h,l,n,o,t,v,vw\nC:EURUSD,1.06206,1.0631,1.0505,180300,1.05252,1651708799999,180300,1.055\n","schema":{"type":"string"}}},"description":"The previous day OHLC for the ticker."},"default":{"description":"Unexpected error"}},"summary":"Previous Close","tags":["fx:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Forex data","name":"fx"}}},"/v2/aggs/ticker/{forexTicker}/range/{multiplier}/{timespan}/{from}/{to}":{"get":{"description":"Get aggregate bars for a forex pair over a given date range in custom time window sizes.\n\u003cbr /\u003e\n\u003cbr /\u003e\nFor example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned.\n","operationId":"GetForexAggregates","parameters":[{"description":"The ticker symbol of the currency pair.","example":"C:EURUSD","in":"path","name":"forexTicker","required":true,"schema":{"type":"string"}},{"description":"The size of the timespan multiplier.","example":1,"in":"path","name":"multiplier","required":true,"schema":{"type":"integer"}},{"description":"The size of the time window.","example":"day","in":"path","name":"timespan","required":true,"schema":{"enum":["second","minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","example":"2025-11-03","in":"path","name":"from","required":true,"schema":{"type":"string"}},{"description":"The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","example":"2025-11-28","in":"path","name":"to","required":true,"schema":{"type":"string"}},{"description":"Whether or not the results are adjusted for splits.  By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n","example":true,"in":"query","name":"adjusted","schema":{"type":"boolean"}},{"description":"Sort the results by timestamp.\n`asc` will return results in ascending order (oldest at the top),\n`desc` will return results in descending order (newest at the top).\n","example":"asc","in":"query","name":"sort","schema":{"enum":["asc","desc"]}},{"description":"Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\n\u003ca href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\"\u003eAggregate Data API Improvements\u003c/a\u003e.\n","example":120,"in":"query","name":"limit","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"adjusted":true,"queryCount":1,"request_id":"79c061995d8b627b736170bc9653f15d","results":[{"c":1.17721,"h":1.18305,"l":1.1756,"n":125329,"o":1.17921,"t":1626912000000,"v":125329,"vw":1.1789}],"resultsCount":1,"status":"OK","ticker":"C:EURUSD"},"schema":{"allOf":[{"properties":{"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"required":["ticker"],"type":"object"},{"properties":{"adjusted":{"description":"Whether or not this response was adjusted for splits.","type":"boolean"},"queryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"resultsCount":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","adjusted","queryCount","resultsCount","request_id"],"type":"object"},{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","t"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"c,h,l,n,o,t,v,vw\n1.17721,1.18305,1.1756,125329,1.17921,1626912000000,125329,1.1789\n","schema":{"type":"string"}}},"description":"Forex Aggregates."},"default":{"description":"Unexpected error"}},"summary":"Aggregates (Bars)","tags":["fx:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Forex data","name":"fx"}}},"/v2/aggs/ticker/{indicesTicker}/prev":{"get":{"description":"Get the previous day's open, high, low, and close (OHLC) for the specified index.\n","operationId":"GetPreviousIndicesAggregates","parameters":[{"description":"The ticker symbol of Index.","example":"I:NDX","in":"path","name":"indicesTicker","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"queryCount":1,"request_id":"b2170df985474b6d21a6eeccfb6bee67","results":[{"T":"I:NDX","c":15070.14948566977,"h":15127.4195807999,"l":14946.7243781848,"o":15036.48391066877,"t":1687291200000}],"resultsCount":1,"status":"OK","ticker":"I:NDX"},"schema":{"allOf":[{"properties":{"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"required":["ticker"],"type":"object"},{"properties":{"queryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"resultsCount":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","queryCount","resultsCount","request_id"],"type":"object"},{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"The close value for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest value for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest value for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open value for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"}},"required":["o","h","l","c","t"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"T,c,h,l,o,t,v,vw\nI:NDX,15036.48391066877,15070.14948566977,15127.4195807999,14946.7243781848,1687291200000\n","schema":{"type":"string"}}},"description":"The previous day OHLC for a index."},"default":{"description":"Unexpected error"}},"summary":"Previous Close","tags":["indices:aggregates"],"x-polygon-entitlement-allowed-limited-tickers":true,"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Indices data","name":"indices"}}},"/v2/aggs/ticker/{indicesTicker}/range/{multiplier}/{timespan}/{from}/{to}":{"get":{"description":"Get aggregate bars for an index over a given date range in custom time window sizes.\n\u003cbr /\u003e\n\u003cbr /\u003e\nFor example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned.\n","operationId":"GetIndicesAggregates","parameters":[{"description":"The ticker symbol of Index.","example":"I:NDX","in":"path","name":"indicesTicker","required":true,"schema":{"type":"string"}},{"description":"The size of the timespan multiplier.","example":1,"in":"path","name":"multiplier","required":true,"schema":{"type":"integer"}},{"description":"The size of the time window.","example":"day","in":"path","name":"timespan","required":true,"schema":{"enum":["second","minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","example":"2025-11-03","in":"path","name":"from","required":true,"schema":{"type":"string"}},{"description":"The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","example":"2025-11-28","in":"path","name":"to","required":true,"schema":{"type":"string"}},{"description":"Sort the results by timestamp.\n`asc` will return results in ascending order (oldest at the top),\n`desc` will return results in descending order (newest at the top).\n","example":"asc","in":"query","name":"sort","schema":{"enum":["asc","desc"]}},{"description":"Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\n\u003ca href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\"\u003eAggregate Data API Improvements\u003c/a\u003e.\n","example":120,"in":"query","name":"limit","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":2,"queryCount":2,"request_id":"0cf72b6da685bcd386548ffe2895904a","results":[{"c":11995.88235998666,"h":12340.44936267155,"l":11970.34221717375,"o":12230.83658266843,"t":1678341600000},{"c":11830.28178808306,"h":12069.62262033557,"l":11789.85923449393,"o":12001.69552583921,"t":1678428000000}],"status":"OK","ticker":"I:NDX"},"schema":{"allOf":[{"properties":{"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"required":["ticker"],"type":"object"},{"properties":{"queryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"resultsCount":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","queryCount","resultsCount","request_id"],"type":"object"},{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"The close value for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest value for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest value for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open value for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"}},"required":["o","h","l","c","t"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"c,h,l,n,o,t\n11995.88235998666,12340.44936267155,11970.34221717375,12230.83658266843,1678341600000\n11830.28178808306,12069.62262033557,11789.85923449393,12001.69552583921,1678341600000\n","schema":{"type":"string"}}},"description":"Index Aggregates."},"default":{"description":"Unexpected error"}},"summary":"Aggregates (Bars)","tags":["indices:aggregates"],"x-polygon-entitlement-allowed-limited-tickers":true,"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Indices data","name":"indices"}}},"/v2/aggs/ticker/{optionsTicker}/prev":{"get":{"description":"Get the previous day's open, high, low, and close (OHLC) for the specified option contract.\n","operationId":"GetPreviousOptionsAggregates","parameters":[{"description":"The ticker symbol of the options contract.","example":"O:SPY251219C00650000","in":"path","name":"optionsTicker","required":true,"schema":{"type":"string"}},{"description":"Whether or not the results are adjusted for splits.  By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n","example":true,"in":"query","name":"adjusted","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"adjusted":true,"queryCount":1,"request_id":"6a7e466379af0a71039d60cc78e72282","results":[{"T":"O:TSLA210903C00700000","c":115.97,"h":117.59,"l":114.13,"n":2,"o":115.55,"t":1605042000000,"v":131704427,"vw":116.3058}],"resultsCount":1,"status":"OK","ticker":"O:TSLA210903C00700000"},"schema":{"allOf":[{"properties":{"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"required":["ticker"],"type":"object"},{"properties":{"adjusted":{"description":"Whether or not this response was adjusted for splits.","type":"boolean"},"queryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"resultsCount":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","adjusted","queryCount","resultsCount","request_id"],"type":"object"},{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","t"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"T,c,h,l,n,o,t,v,vw\nO:TSLA210903C00700000,115.97,117.59,114.13,2,115.55,1605042000000,131704427.0,116.3058\n","schema":{"type":"string"}}},"description":"The previous day OHLC for the options contract."},"default":{"description":"Unexpected error"}},"summary":"Previous Close","tags":["options:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Options data","name":"options"}}},"/v2/aggs/ticker/{optionsTicker}/range/{multiplier}/{timespan}/{from}/{to}":{"get":{"description":"Get aggregate bars for an option contract over a given date range in custom time window sizes.\n\u003cbr /\u003e\n\u003cbr /\u003e\nFor example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned.\n","operationId":"GetOptionsAggregates","parameters":[{"description":"The ticker symbol of the options contract.","example":"O:SPY251219C00650000","in":"path","name":"optionsTicker","required":true,"schema":{"type":"string"}},{"description":"The size of the timespan multiplier.","example":1,"in":"path","name":"multiplier","required":true,"schema":{"type":"integer"}},{"description":"The size of the time window.","example":"day","in":"path","name":"timespan","required":true,"schema":{"enum":["second","minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","example":"2025-11-03","in":"path","name":"from","required":true,"schema":{"type":"string"}},{"description":"The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","example":"2025-11-28","in":"path","name":"to","required":true,"schema":{"type":"string"}},{"description":"Whether or not the results are adjusted for splits.  By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n","example":true,"in":"query","name":"adjusted","schema":{"type":"boolean"}},{"description":"Sort the results by timestamp.\n`asc` will return results in ascending order (oldest at the top),\n`desc` will return results in descending order (newest at the top).\n","example":"asc","in":"query","name":"sort","schema":{"enum":["asc","desc"]}},{"description":"Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\n\u003ca href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\"\u003eAggregate Data API Improvements\u003c/a\u003e.\n","example":120,"in":"query","name":"limit","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"adjusted":true,"count":2,"queryCount":2,"request_id":"5585acde-5085-42d6-95b2-2e388a28370a","results":[{"c":26.2,"h":26.2,"l":26.2,"n":1,"o":26.2,"t":1632369600000,"v":2,"vw":26.2},{"c":28.3,"h":28.3,"l":28.3,"n":1,"o":28.3,"t":1632456000000,"v":2,"vw":28.3}],"resultsCount":2,"status":"OK","ticker":"O:RDFN211119C00025000"},"schema":{"allOf":[{"properties":{"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"required":["ticker"],"type":"object"},{"properties":{"adjusted":{"description":"Whether or not this response was adjusted for splits.","type":"boolean"},"queryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"resultsCount":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","adjusted","queryCount","resultsCount","request_id"],"type":"object"},{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","t"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"c,h,l,n,o,t,v,vw\n26.2,26.2,26.2,1,26.2,1632369600000,2,26.2\n28.3,28.3,28.3,1,28.3,1632456000000,2,28.3\n","schema":{"type":"string"}}},"description":"Options Aggregates."},"default":{"description":"Unexpected error"}},"summary":"Aggregates (Bars)","tags":["options:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Options data","name":"options"}}},"/v2/aggs/ticker/{stocksTicker}/prev":{"get":{"description":"Get the previous day's open, high, low, and close (OHLC) for the specified stock ticker.\n","operationId":"GetPreviousStocksAggregates","parameters":[{"description":"Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.","example":"AAPL","in":"path","name":"stocksTicker","required":true,"schema":{"type":"string"}},{"description":"Whether or not the results are adjusted for splits.  By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n","example":true,"in":"query","name":"adjusted","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"adjusted":true,"queryCount":1,"request_id":"6a7e466379af0a71039d60cc78e72282","results":[{"T":"AAPL","c":115.97,"h":117.59,"l":114.13,"o":115.55,"t":1605042000000,"v":131704427,"vw":116.3058}],"resultsCount":1,"status":"OK","ticker":"AAPL"},"schema":{"allOf":[{"properties":{"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"required":["ticker"],"type":"object"},{"properties":{"adjusted":{"description":"Whether or not this response was adjusted for splits.","type":"boolean"},"queryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"resultsCount":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","adjusted","queryCount","resultsCount","request_id"],"type":"object"},{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","t"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"T,c,h,l,o,t,v,vw\nAAPL,115.97,117.59,114.13,115.55,1605042000000,131704427.0,116.3058\n","schema":{"type":"string"}}},"description":"The previous day OHLC for the ticker."},"default":{"description":"Unexpected error"}},"summary":"Previous Close","tags":["stocks:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v2/aggs/ticker/{stocksTicker}/range/{multiplier}/{timespan}/{from}/{to}":{"get":{"description":"Get aggregate bars for a stock over a given date range in custom time window sizes.\n\u003cbr /\u003e\n\u003cbr /\u003e\nFor example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned.\n","operationId":"GetStocksAggregates","parameters":[{"description":"Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.","example":"AAPL","in":"path","name":"stocksTicker","required":true,"schema":{"type":"string"}},{"description":"The size of the timespan multiplier.","example":1,"in":"path","name":"multiplier","required":true,"schema":{"type":"integer"}},{"description":"The size of the time window.","example":"day","in":"path","name":"timespan","required":true,"schema":{"enum":["second","minute","hour","day","week","month","quarter","year"],"type":"string"}},{"description":"The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","example":"2025-11-03","in":"path","name":"from","required":true,"schema":{"type":"string"}},{"description":"The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.","example":"2025-11-28","in":"path","name":"to","required":true,"schema":{"type":"string"}},{"description":"Whether or not the results are adjusted for splits.  By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n","example":true,"in":"query","name":"adjusted","schema":{"type":"boolean"}},{"description":"Sort the results by timestamp.\n`asc` will return results in ascending order (oldest at the top),\n`desc` will return results in descending order (newest at the top).\n","example":"asc","in":"query","name":"sort","schema":{"enum":["asc","desc"]}},{"description":"Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\n\u003ca href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\"\u003eAggregate Data API Improvements\u003c/a\u003e.\n","example":120,"in":"query","name":"limit","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"adjusted":true,"next_url":"https://api.massive.com/v2/aggs/ticker/AAPL/range/1/day/1578114000000/2020-01-10?cursor=bGltaXQ9MiZzb3J0PWFzYw","queryCount":2,"request_id":"6a7e466379af0a71039d60cc78e72282","results":[{"c":75.0875,"h":75.15,"l":73.7975,"n":1,"o":74.06,"t":1577941200000,"v":135647456,"vw":74.6099},{"c":74.3575,"h":75.145,"l":74.125,"n":1,"o":74.2875,"t":1578027600000,"v":146535512,"vw":74.7026}],"resultsCount":2,"status":"OK","ticker":"AAPL"},"schema":{"allOf":[{"properties":{"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"required":["ticker"],"type":"object"},{"properties":{"adjusted":{"description":"Whether or not this response was adjusted for splits.","type":"boolean"},"queryCount":{"description":"The number of aggregates (minute or day) used to generate the response.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"resultsCount":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","adjusted","queryCount","resultsCount","request_id"],"type":"object"},{"properties":{"results":{"description":"An array of results containing the requested data.","items":{"properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","t"],"type":"object"},"type":"array"}},"type":"object"},{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"}},"type":"object"}]}},"text/csv":{"example":"c,h,l,n,o,t,v,vw\n75.0875,75.15,73.7975,1,74.06,1577941200000,135647456.0,74.6099\n74.3575,75.145,74.125,1,74.2875,1578027600000,146535512.0,74.7026\n","schema":{"type":"string"}}},"description":"Stock Aggregates."},"default":{"description":"Unexpected error"}},"summary":"Aggregates (Bars)","tags":["stocks:aggregates"],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v2/last/nbbo/{stocksTicker}":{"get":{"description":"Get the most recent NBBO (Quote) tick for a given stock.","operationId":"LastQuote","parameters":[{"description":"Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.","example":"AAPL","in":"path","name":"stocksTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"b84e24636301f19f88e0dfbf9a45ed5c","results":{"P":127.98,"S":7,"T":"AAPL","X":19,"p":127.96,"q":83480742,"s":1,"t":1617827221349730300,"x":11,"y":1617827221349366000,"z":3},"status":"OK"},"schema":{"properties":{"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"properties":{"P":{"description":"The ask price.","format":"double","type":"number"},"S":{"description":"The total number of shares available for sale at the current ask price.","type":"integer"},"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"X":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"c":{"description":"A list of condition codes.","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.","format":"int32","type":"integer"},"type":"array","x-polygon-go-type":{"name":"Int32Array"}},"f":{"description":"The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.","type":"integer"},"i":{"description":"A list of indicator codes.","items":{"description":"The indicator codes. For more information, see our glossary of [Conditions and\nIndicators](https://massive.com/glossary/conditions-indicators).","format":"int32","type":"integer"},"type":"array","x-polygon-go-type":{"name":"Int32Array"}},"p":{"description":"The bid price.","format":"double","type":"number"},"q":{"description":"The sequence number represents the sequence in which message events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).","format":"int64","type":"integer"},"s":{"description":"The total number of shares that buyers want to purchase at the current bid price.","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"x":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"y":{"description":"The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.","type":"integer"},"z":{"description":"There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C.\n* Tape A is NYSE listed securities\n* Tape B is NYSE ARCA / NYSE American\n* Tape C is NASDAQ","type":"integer"}},"required":["T","t","y","q"],"type":"object","x-polygon-go-type":{"name":"LastQuoteResult"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","request_id"],"type":"object"}},"text/csv":{"example":"P,S,T,X,p,q,s,t,x,y,z\n127.98,7,AAPL,19,127.96,83480742,1,1617827221349730300,11,1617827221349366000,3\n","schema":{"type":"string"}}},"description":"The last NBBO tick for this stock."},"401":{"description":"Unauthorized - Check our API Key and account status"},"404":{"description":"The specified resource was not found"}},"summary":"Last Quote","tags":["stocks:last:quote"],"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"NBBO data","name":"nbbo"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v2/last/trade/{optionsTicker}":{"get":{"description":"Get the most recent trade for a given options contract.","operationId":"LastTradeOptions","parameters":[{"description":"The ticker symbol of the options contract.","example":"O:TSLA210903C00700000","in":"path","name":"optionsTicker","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"f05562305bd26ced64b98ed68b3c5d96","results":{"T":"O:TSLA210903C00700000","c":[227],"f":1617901342969796400,"i":"","p":115.55,"q":1325541950,"r":202,"s":25,"t":1617901342969834000,"x":312,"y":1617901342969834000},"status":"OK"},"schema":{"properties":{"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"c":{"description":"A list of condition codes.","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.","format":"int32","type":"integer"},"type":"array","x-polygon-go-type":{"name":"Int32Array"}},"e":{"description":"The trade correction indicator.","type":"integer"},"f":{"description":"The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.","type":"integer"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.","format":"double","type":"number"},"q":{"description":"The sequence number represents the sequence in which message events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).","format":"int64","type":"integer"},"r":{"description":"The ID for the Trade Reporting Facility where the trade took place.","type":"integer"},"s":{"description":"The size of a trade (also known as volume).","format":"double","type":"number"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"x":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"y":{"description":"The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.","type":"integer"},"z":{"description":"There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C.\n* Tape A is NYSE listed securities\n* Tape B is NYSE ARCA / NYSE American\n* Tape C is NASDAQ","type":"integer"}},"required":["T","t","y","q","i","p","x"],"type":"object","x-polygon-go-type":{"name":"LastTradeResult"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","request_id"],"type":"object"}},"text/csv":{"example":"T,c,f,i,p,q,r,s,t,x\nO:TSLA210903C00700000,227,1617901342969796400,,115.55,1325541950,202,25,1617901342969834000,312\n","schema":{"type":"string"}}},"description":"The last trade for this options contract."},"401":{"description":"Unauthorized - Check our API Key and account status"},"404":{"description":"The specified resource was not found"}},"summary":"Last Trade","tags":["options:last:trade"],"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Trade data","name":"trades"},"x-polygon-entitlement-market-type":{"description":"Options data","name":"options"}},"x-polygon-ignore":true},"/v2/last/trade/{stocksTicker}":{"get":{"description":"Get the most recent trade for a given stock.","operationId":"LastTrade","parameters":[{"description":"Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.","example":"AAPL","in":"path","name":"stocksTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"f05562305bd26ced64b98ed68b3c5d96","results":{"T":"AAPL","c":[37],"ds":"25.0","f":1617901342969796400,"i":"118749","p":129.8473,"q":3135876,"r":202,"s":25,"t":1617901342969834000,"x":4,"y":1617901342968000000,"z":3},"status":"OK"},"schema":{"properties":{"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"c":{"description":"A list of condition codes.","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.","format":"int32","type":"integer"},"type":"array","x-polygon-go-type":{"name":"Int32Array"}},"ds":{"description":"The size of the trade including the fractional component. This is represented as a decimal string.","type":"string"},"e":{"description":"The trade correction indicator.","type":"integer"},"f":{"description":"The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.","type":"integer"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.","format":"double","type":"number"},"q":{"description":"The sequence number represents the sequence in which message events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).","format":"int64","type":"integer"},"r":{"description":"The ID for the Trade Reporting Facility where the trade took place.","type":"integer"},"s":{"description":"The size of a trade (also known as volume).","format":"double","type":"number"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"x":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"y":{"description":"The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.","type":"integer"},"z":{"description":"There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C.\n* Tape A is NYSE listed securities\n* Tape B is NYSE ARCA / NYSE American\n* Tape C is NASDAQ","type":"integer"}},"required":["T","t","y","q","i","p","x","ds"],"type":"object","x-polygon-go-type":{"name":"LastTradeResult"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","request_id"],"type":"object"}},"text/csv":{"example":"T,c,f,i,p,q,r,s,t,x,y,z,ds\nAAPL,37,1617901342969796400,118749,129.8473,3135876,202,25,1617901342969834000,4,1617901342968000000,3,25.0\n","schema":{"type":"string"}}},"description":"The last trade for this stock."},"401":{"description":"Unauthorized - Check our API Key and account status"},"404":{"description":"The specified resource was not found"}},"summary":"Last Trade","tags":["stocks:last:trade"],"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Trade data","name":"trades"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v2/reference/news":{"get":{"description":"Get the most recent news articles relating to a stock ticker symbol, including a summary of the article and a link to the original source.","operationId":"ListNews","parameters":[{"description":"Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.","in":"query","name":"ticker","schema":{"description":"The exchange symbol that this item is traded under.","type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"Return results published on, before, or after this date.","in":"query","name":"published_utc","schema":{"oneOf":[{"format":"date-time","type":"string"},{"format":"date","type":"string"}]},"x-polygon-filter-field":{"range":true}},{"description":"Search by ticker.","in":"query","name":"ticker.gte","schema":{"description":"The exchange symbol that this item is traded under.","type":"string"}},{"description":"Search by ticker.","in":"query","name":"ticker.gt","schema":{"description":"The exchange symbol that this item is traded under.","type":"string"}},{"description":"Search by ticker.","in":"query","name":"ticker.lte","schema":{"description":"The exchange symbol that this item is traded under.","type":"string"}},{"description":"Search by ticker.","in":"query","name":"ticker.lt","schema":{"description":"The exchange symbol that this item is traded under.","type":"string"}},{"description":"Search by published_utc.","in":"query","name":"published_utc.gte","schema":{"oneOf":[{"format":"date-time","type":"string"},{"format":"date","type":"string"}]}},{"description":"Search by published_utc.","in":"query","name":"published_utc.gt","schema":{"oneOf":[{"format":"date-time","type":"string"},{"format":"date","type":"string"}]}},{"description":"Search by published_utc.","in":"query","name":"published_utc.lte","schema":{"oneOf":[{"format":"date-time","type":"string"},{"format":"date","type":"string"}]}},{"description":"Search by published_utc.","in":"query","name":"published_utc.lt","schema":{"oneOf":[{"format":"date-time","type":"string"},{"format":"date","type":"string"}]}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 1000.","in":"query","name":"limit","schema":{"default":10,"example":10,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"published_utc","enum":["published_utc"],"example":"published_utc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"next_url":"https://api.massive.com:443/v2/reference/news?cursor=eyJsaW1pdCI6MSwic29ydCI6InB1Ymxpc2hlZF91dGMiLCJvcmRlciI6ImFzY2VuZGluZyIsInRpY2tlciI6e30sInB1Ymxpc2hlZF91dGMiOnsiZ3RlIjoiMjAyMS0wNC0yNiJ9LCJzZWFyY2hfYWZ0ZXIiOlsxNjE5NDA0Mzk3MDAwLG51bGxdfQ","request_id":"831afdb0b8078549fed053476984947a","results":[{"amp_url":"https://m.uk.investing.com/news/stock-market-news/markets-are-underestimating-fed-cuts-ubs-3559968?ampMode=1","article_url":"https://uk.investing.com/news/stock-market-news/markets-are-underestimating-fed-cuts-ubs-3559968","author":"Sam Boughedda","description":"UBS analysts warn that markets are underestimating the extent of future interest rate cuts by the Federal Reserve, as the weakening economy is likely to justify more cuts than currently anticipated.","id":"8ec638777ca03b553ae516761c2a22ba2fdd2f37befae3ab6fdab74e9e5193eb","image_url":"https://i-invdn-com.investing.com/news/LYNXNPEC4I0AL_L.jpg","insights":[{"sentiment":"positive","sentiment_reasoning":"UBS analysts are providing a bullish outlook on the extent of future Federal Reserve rate cuts, suggesting that markets are underestimating the number of cuts that will occur.","ticker":"UBS"}],"keywords":["Federal Reserve","interest rates","economic data"],"published_utc":"2024-06-24T18:33:53Z","publisher":{"favicon_url":"https://s3.massive.com/public/assets/news/favicons/investing.ico","homepage_url":"https://www.investing.com/","logo_url":"https://s3.massive.com/public/assets/news/logos/investing.png","name":"Investing.com"},"tickers":["UBS"],"title":"Markets are underestimating Fed cuts: UBS By Investing.com - Investing.com UK"}],"status":"OK"},"schema":{"properties":{"count":{"description":"The total number of results for this request.","type":"integer"},"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"properties":{"amp_url":{"description":"The mobile friendly Accelerated Mobile Page (AMP) URL.","type":"string"},"article_url":{"description":"A link to the news article.","type":"string"},"author":{"description":"The article's author.","type":"string"},"description":{"description":"A description of the article.","type":"string"},"id":{"description":"Unique identifier for the article.","type":"string"},"image_url":{"description":"The article's image URL.","type":"string"},"insights":{"description":"The insights related to the article.","items":{"properties":{"sentiment":{"description":"The sentiment of the insight.","enum":["positive","neutral","negative"],"type":"string"},"sentiment_reasoning":{"description":"The reasoning behind the sentiment.","type":"string"},"ticker":{"description":"The ticker symbol associated with the insight.","type":"string"}},"required":["ticker","sentiment","sentiment_reasoning"],"type":"object"},"type":"array"},"keywords":{"description":"The keywords associated with the article (which will vary depending on\nthe publishing source).","items":{"type":"string"},"type":"array"},"published_utc":{"description":"The UTC date and time when the article was published, formatted in RFC3339 standard (e.g. YYYY-MM-DDTHH:MM:SSZ).","format":"date-time","type":"string"},"publisher":{"description":"Details the source of the news article, including the publisher's name, logo, and homepage URLs. This information helps users identify and access the original source of news content.","properties":{"favicon_url":{"description":"The publisher's homepage favicon URL.","type":"string"},"homepage_url":{"description":"The publisher's homepage URL.","type":"string"},"logo_url":{"description":"The publisher's logo URL.","type":"string"},"name":{"description":"The publisher's name.","type":"string"}},"required":["name","logo_url","homepage_url"],"type":"object"},"tickers":{"description":"The ticker symbols associated with the article.","items":{"description":"The exchange symbol that this item is traded under.","type":"string"},"type":"array"},"title":{"description":"The title of the news article.","type":"string"}},"required":["id","publisher","title","author","published_utc","article_url","tickers"],"type":"object","x-polygon-go-type":{"name":"NewsArticleMetadata","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array","x-polygon-go-type":{"name":"ListNewsArticlesResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"type":"object"}},"text/csv":{"example":"id,publisher_name,publisher_homepage_url,publisher_logo_url,publisher_favicon_url,title,author,published_utc,article_url,ticker,amp_url,image_url,description,keywords,sentiment,sentiment_reasoning\n8ec638777ca03b553ae516761c2a22ba2fdd2f37befae3ab6fdab74e9e5193eb,Investing.com,https://www.investing.com/,https://s3.massive.com/public/assets/news/logos/investing.png,https://s3.massive.com/public/assets/news/favicons/investing.ico,Markets are underestimating Fed cuts: UBS By Investing.com - Investing.com UK,Sam Boughedda,1719254033000000000,https://uk.investing.com/news/stock-market-news/markets-are-underestimating-fed-cuts-ubs-3559968,UBS,https://m.uk.investing.com/news/stock-market-news/markets-are-underestimating-fed-cuts-ubs-3559968?ampMode=1,https://i-invdn-com.investing.com/news/LYNXNPEC4I0AL_L.jpg,\"UBS analysts warn that markets are underestimating the extent of future interest rate cuts by the Federal Reserve, as the weakening economy is likely to justify more cuts than currently anticipated.\",\"Federal Reserve,interest rates,economic data\",positive,\"UBS analysts are providing a bullish outlook on the extent of future Federal Reserve rate cuts, suggesting that markets are underestimating the number of cuts that will occur.\"\n","schema":{"type":"string"}}},"description":"An array of news articles."},"401":{"description":"Unauthorized - Check our API Key and account status"},"404":{"description":"The specified resource was not found"}},"summary":"Ticker News","tags":["reference:news"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"},"x-polygon-paginate":{"order":{"example":"desc"},"sort":{"default":"published_utc","enum":["published_utc"],"limit":{"default":10,"maximum":1000,"minimum":1}}}}},"/v2/snapshot/locale/global/markets/crypto/tickers":{"get":{"description":"Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded cryptocurrency symbols.\n\u003cbr /\u003e\n\u003cbr /\u003e\nNote: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.\n","operationId":"GetCryptoSnapshotTickers","parameters":[{"description":"A case-sensitive comma separated list of tickers to get snapshots for. For example, X:BTCUSD, X:ETHBTC, and X:BOBAUSD. Empty string defaults to querying all tickers.","in":"query","name":"tickers","schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"example":{"status":"OK","tickers":[{"day":{"c":0.296,"h":0.59714,"l":0.23706,"o":0.28,"v":4097699.5691991993,"vw":0},"lastTrade":{"c":[1],"i":413131,"p":0.293,"s":13.6191,"t":1605292686010,"x":17},"min":{"c":0.296,"h":0.296,"l":0.294,"n":2,"o":0.296,"t":1684427880000,"v":123.4866,"vw":0},"prevDay":{"c":0.281,"h":0.59714,"l":0.23706,"o":0.27,"v":6070178.786154971,"vw":0.4076},"ticker":"X:FSNUSD","todaysChange":0.012,"todaysChangePerc":4.270463,"updated":1605330008999}]},"schema":{"allOf":[{"properties":{"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"},{"properties":{"tickers":{"description":"An array of snapshot data for the specified tickers.","items":{"properties":{"day":{"description":"The most recent daily bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"lastTrade":{"description":"The most recent trade for this ticker.","properties":{"c":{"description":"The trade conditions.","items":{"type":"integer"},"type":"array"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size (volume) of the trade.","type":"number"},"t":{"description":"The millisecond accuracy timestamp. This is the timestamp of when the trade was generated at the exchange.","type":"integer"},"x":{"description":"The exchange that this crypto trade happened on.  \nSee \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\"\u003eExchanges\u003c/a\u003e for a mapping of exchanges to IDs.\n","type":"integer"}},"required":["c","i","p","s","t","x"],"type":"object"},"min":{"description":"The most recent minute bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw","t","n"],"type":"object"},"prevDay":{"description":"The previous day's bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"todaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"todaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"required":["day","lastTrade","min","prevDay","ticker","todaysChange","todaysChangePerc","updated"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"day_c,day_h,day_l,day_o,day_v,lastTrade_c,lastTrade_i,lastTrade_p,lastTrade_s,lastTrade_t,lastTrade_x,min_c,min_h,min_l,min_o,min_v,prevDay_c,prevDay_h,prevDay_l,prevDay_o,prevDay_v,prevDay_vw\n16260.85,16428.4,15830.4,16418.07,105008.84231068,0,\"[2]\",464569520,16242.31,0.001933,1605294230780,4,16235.1,16264.29,16129.3,16257.51,19.30791925,0,16399.24,16418.07,16399.24,16418.07,0.99167108,16402.6893\n","schema":{"type":"string"}}},"description":"Get current state for all tickers"},"default":{"description":"Unexpected error"}},"summary":"All Tickers","tags":["crypto:snapshot"],"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Crypto data","name":"crypto"}}},"/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}":{"get":{"description":"Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded cryptocurrency symbol.\n\u003cbr /\u003e\n\u003cbr /\u003e\nNote: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.\n","operationId":"GetCryptoSnapshotTicker","parameters":[{"description":"Ticker of the snapshot","example":"X:BTCUSD","in":"path","name":"ticker","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"ad92e92ce183112c593717f00dfebd2c","status":"OK","ticker":{"day":{"c":16260.85,"h":16428.4,"l":15830.4,"o":16418.07,"v":105008.84231068,"vw":0},"lastTrade":{"c":[2],"i":"464569520","p":16242.31,"s":0.001933,"t":1605294230780,"x":4},"min":{"c":16235.1,"h":16264.29,"l":16129.3,"n":558,"o":16257.51,"t":1684428960000,"v":19.30791925,"vw":0},"prevDay":{"c":16399.24,"h":16418.07,"l":16399.24,"o":16418.07,"v":0.99167108,"vw":16402.6893},"ticker":"X:BTCUSD","todaysChange":-156.93,"todaysChangePerc":-0.956935,"updated":1605330008999}},"schema":{"allOf":[{"properties":{"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"},{"properties":{"request_id":{"description":"A request id assigned by the server.","type":"string"}},"required":["request_id"],"type":"object"},{"properties":{"ticker":{"description":"Contains the requested snapshot data for the specified ticker.","properties":{"day":{"description":"The most recent daily bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"lastTrade":{"description":"The most recent trade for this ticker.","properties":{"c":{"description":"The trade conditions.","items":{"type":"integer"},"type":"array"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size (volume) of the trade.","type":"number"},"t":{"description":"The millisecond accuracy timestamp. This is the timestamp of when the trade was generated at the exchange.","type":"integer"},"x":{"description":"The exchange that this crypto trade happened on.  \nSee \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\"\u003eExchanges\u003c/a\u003e for a mapping of exchanges to IDs.\n","type":"integer"}},"required":["c","i","p","s","t","x"],"type":"object"},"min":{"description":"The most recent minute bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw","t","n"],"type":"object"},"prevDay":{"description":"The previous day's bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"todaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"todaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"required":["day","lastTrade","min","prevDay","ticker","todaysChange","todaysChangePerc","updated"],"type":"object"}},"type":"object"}]}},"text/csv":{"example":"day_c,day_h,day_l,day_o,day_v,lastTrade_c,lastTrade_i,lastTrade_p,lastTrade_s,lastTrade_t,lastTrade_x,min_c,min_h,min_l,min_o,min_v,prevDay_c,prevDay_h,prevDay_l,prevDay_o,prevDay_v,prevDay_vw\n16260.85,16428.4,15830.4,16418.07,105008.84231068,0,\"[2]\",464569520,16242.31,0.001933,1605294230780,4,16235.1,16264.29,16129.3,16257.51,19.30791925,0,16399.24,16418.07,16399.24,16418.07,0.99167108,16402.6893\n","schema":{"type":"string"}}},"description":"Get current state for a ticker"},"default":{"description":"Unexpected error"}},"summary":"Ticker","tags":["crypto:snapshot"],"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Crypto data","name":"crypto"}}},"/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}/book":{"get":{"description":"Get the current level 2 book of a single ticker. This is the combined book from all of the exchanges.\n\u003cbr /\u003e\n\u003cbr /\u003e\nNote: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.\n","operationId":"DeprecatedGetCryptoSnapshotTickerBook","parameters":[{"description":"The cryptocurrency ticker.","example":"X:BTCUSD","in":"path","name":"ticker","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"askCount":593.1412981600005,"asks":[{"p":11454,"x":{"2":1}},{"p":11455,"x":{"2":1}}],"bidCount":694.951789670001,"bids":[{"p":16303.17,"x":{"1":2}},{"p":16302.94,"x":{"1":0.02859424,"6":0.023455}}],"spread":-4849.17,"ticker":"X:BTCUSD","updated":1605295074162},"status":"OK"},"schema":{"allOf":[{"description":"The status of this request's response.","type":"string"},{"properties":{"data":{"properties":{"askCount":{"description":"The combined total number of asks in the book.","format":"double","type":"number"},"asks":{"items":{"properties":{"p":{"description":"The price of this book level.","format":"double","type":"number"},"x":{"description":"A map of the exchange ID to number of shares at this price level.\n\u003cbr /\u003e\n\u003cbr /\u003e\n**Example:**\n\u003cbr /\u003e\n`{\n  \"p\": 16302.94,\n  \"x\": {\n    \"1\": 0.02859424,\n    \"6\": 0.023455\n  }\n}`\n\u003cbr /\u003e\n\u003cbr /\u003e\nIn this example, exchange ID 1 has 0.02859424 shares available at $16,302.94,\nand exchange ID 6 has 0.023455 shares at the same price level.\n","type":"object"}},"required":["p","x"],"type":"object"},"type":"array"},"bidCount":{"description":"The combined total number of bids in the book.","format":"double","type":"number"},"bids":{"items":{"properties":{"p":{"description":"The price of this book level.","format":"double","type":"number"},"x":{"description":"A map of the exchange ID to number of shares at this price level.\n\u003cbr /\u003e\n\u003cbr /\u003e\n**Example:**\n\u003cbr /\u003e\n`{\n  \"p\": 16302.94,\n  \"x\": {\n    \"1\": 0.02859424,\n    \"6\": 0.023455\n  }\n}`\n\u003cbr /\u003e\n\u003cbr /\u003e\nIn this example, exchange ID 1 has 0.02859424 shares available at $16,302.94,\nand exchange ID 6 has 0.023455 shares at the same price level.\n","type":"object"}},"required":["p","x"],"type":"object"},"type":"array"},"spread":{"description":"The difference between the best bid and the best ask price across exchanges.","format":"double","type":"number"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"required":["ticker","bids","asks","bidCount","askCount","spread","updated"],"type":"object"}},"type":"object"}]}},"text/csv":{"example":"side,price,size,exchange\nbid,20292.97,0.01501,1\nbid,20291.93,0.00218483,1\nask,18445.61,0.22,1\nask,18463.07,0.00234104,1\nask,18464.83,0.04159475,1\n","schema":{"type":"string"}}},"description":"Get current level 2 book for a ticker"},"default":{"description":"Unexpected error"}},"summary":"Ticker Full Book (L2)","tags":["crypto:snapshot"],"x-polygon-deprecation":{"date":1719838800000},"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Crypto data","name":"crypto"}}},"/v2/snapshot/locale/global/markets/crypto/{direction}":{"get":{"description":"Get the current top 20 gainers or losers of the day in cryptocurrency markets.\n\u003cbr /\u003e\n\u003cbr /\u003e\nTop gainers are those tickers whose price has increased by the highest percentage since the previous day's close.\nTop losers are those tickers whose price has decreased by the highest percentage since the previous day's close.\n\u003cbr /\u003e\n\u003cbr /\u003e\nNote: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.\n","operationId":"GetCryptoSnapshotDirection","parameters":[{"description":"The direction of the snapshot results to return.\n","example":"gainers","in":"path","name":"direction","required":true,"schema":{"enum":["gainers","losers"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"status":"OK","tickers":[{"day":{"c":0.0374,"h":0.062377,"l":0.01162,"o":0.044834,"v":27313165.159427017,"vw":0},"lastTrade":{"c":[2],"i":"517478762","p":0.0374,"s":499,"t":1604409649544,"x":2},"min":{"c":0.062377,"h":0.062377,"l":0.062377,"n":2,"o":0.062377,"t":1684426740000,"v":35420,"vw":0},"prevDay":{"c":0.01162,"h":0.044834,"l":0.01162,"o":0.044834,"v":53616273.36827199,"vw":0.0296},"ticker":"X:DRNUSD","todaysChange":0.02578,"todaysChangePerc":221.858864,"updated":1605330008999}]},"schema":{"allOf":[{"description":"The status of this request's response.","type":"string"},{"properties":{"tickers":{"description":"An array of snapshot data for the specified tickers.","items":{"properties":{"day":{"description":"The most recent daily bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"lastTrade":{"description":"The most recent trade for this ticker.","properties":{"c":{"description":"The trade conditions.","items":{"type":"integer"},"type":"array"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size (volume) of the trade.","type":"number"},"t":{"description":"The millisecond accuracy timestamp. This is the timestamp of when the trade was generated at the exchange.","type":"integer"},"x":{"description":"The exchange that this crypto trade happened on.  \nSee \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\"\u003eExchanges\u003c/a\u003e for a mapping of exchanges to IDs.\n","type":"integer"}},"required":["c","i","p","s","t","x"],"type":"object"},"min":{"description":"The most recent minute bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw","t","n"],"type":"object"},"prevDay":{"description":"The previous day's bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"todaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"todaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"required":["day","lastTrade","min","prevDay","ticker","todaysChange","todaysChangePerc","updated"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"day_c,day_h,day_l,day_o,day_v,day_vw,lastTrade_c,lastTrade_i,lastTrade_p,lastTrade_s,lastTrade_t,lastTrade_x,day_c,day_h,day_l,day_o,day_v,day_vw,prevDay_c,prevDay_h,prevDay_l,prevDay_o,prevDay_v,prevDay_vw\n0.0374,0.062377,0.01162,0.044834,27313165.159427017,0,\"[2]\",517478762,0.0374,499,1604409649544,2,0.062377,0.062377,0.062377,0.062377,35420,0,0.01162,0.044834,0.01162,0.044834,53616273.36827199,0.0296\n","schema":{"type":"string"}}},"description":"Get the current gainers / losers of the day"},"default":{"description":"Unexpected error"}},"summary":"Gainers/Losers","tags":["crypto:snapshot"],"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Crypto data","name":"crypto"}}},"/v2/snapshot/locale/global/markets/forex/tickers":{"get":{"description":"Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded forex symbols.\n\u003cbr /\u003e\n\u003cbr /\u003e\nNote: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.\n","operationId":"GetForexSnapshotTickers","parameters":[{"description":"A case-sensitive comma separated list of tickers to get snapshots for. For example, C:EURUSD, C:GBPCAD, and C:AUDINR. Empty string defaults to querying all tickers.","in":"query","name":"tickers","schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"example":{"status":"OK","tickers":[{"day":{"c":0.11778221,"h":0.11812263,"l":0.11766631,"o":0.11797149,"v":77794},"lastQuote":{"a":0.11780678,"b":0.11777952,"t":1605280919000,"x":48},"min":{"c":0.117769,"h":0.11779633,"l":0.11773698,"n":1,"o":0.11778,"t":1684422000000,"v":202},"prevDay":{"c":0.11797258,"h":0.11797258,"l":0.11797149,"o":0.11797149,"v":2,"vw":0},"ticker":"C:HKDCHF","todaysChange":-0.00019306,"todaysChangePerc":-0.1636482,"updated":1605280919000}]},"schema":{"allOf":[{"properties":{"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"},{"properties":{"tickers":{"description":"An array of snapshot data for the specified tickers.","items":{"properties":{"day":{"description":"The most recent daily bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"}},"required":["o","h","l","c","v"],"type":"object"},"fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"lastQuote":{"description":"The most recent quote for this ticker.","properties":{"a":{"description":"The ask price.","format":"double","type":"number"},"b":{"description":"The bid price.","format":"double","type":"number"},"t":{"description":"The millisecond accuracy timestamp of the quote.","type":"integer"},"x":{"description":"The exchange ID on which this quote happened.","type":"integer"}},"required":["a","b","t","x"],"type":"object"},"min":{"description":"The most recent minute bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"}},"type":"object"},"prevDay":{"description":"The previous day's bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"todaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"todaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"required":["day","lastQuote","min","prevDay","ticker","todaysChange","todaysChangePerc","updated"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"day_c,day_h,day_l,day_o,day_v,lastQuote_a,lastQuote_b,lastQuote_i,lastQuote_t,lastQuote_x,min_c,min_h,min_l,min_o,min_v,prevDay_c,prevDay_h,prevDay_l,prevDay_o,prevDay_v,prevDay_vw\n1.18403,1.1906,1.18001,1.18725,83578,1.18403,1.18398,0,1606163759000,48,1.18396,1.18423,1.1838,1.18404,41,1.18724,1.18727,1.18725,1.18725,5,0\n","schema":{"type":"string"}}},"description":"Get current state for all tickers"},"default":{"description":"Unexpected error"}},"summary":"All Tickers","tags":["fx:snapshot"],"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Forex data","name":"fx"}}},"/v2/snapshot/locale/global/markets/forex/tickers/{ticker}":{"get":{"description":"Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded currency symbol.\n\u003cbr /\u003e\n\u003cbr /\u003e\nNote: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.\n","operationId":"GetForexSnapshotTicker","parameters":[{"description":"The forex ticker.","example":"C:EURUSD","in":"path","name":"ticker","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"ad76e76ce183002c5937a7f02dfebde4","status":"OK","ticker":{"day":{"c":1.18403,"h":1.1906,"l":1.18001,"o":1.18725,"v":83578},"lastQuote":{"a":1.18403,"b":1.18398,"i":0,"t":1606163759000,"x":48},"min":{"c":1.18396,"h":1.18423,"l":1.1838,"n":85,"o":1.18404,"t":1684422000000,"v":41},"prevDay":{"c":1.18724,"h":1.18727,"l":1.18725,"o":1.18725,"v":5,"vw":0},"ticker":"C:EURUSD","todaysChange":-0.00316,"todaysChangePerc":-0.27458312,"updated":1606163759000}},"schema":{"allOf":[{"properties":{"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"},{"properties":{"request_id":{"description":"A request id assigned by the server.","type":"string"}},"required":["request_id"],"type":"object"},{"properties":{"ticker":{"description":"Contains the requested snapshot data for the specified ticker.","properties":{"day":{"description":"The most recent daily bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"}},"required":["o","h","l","c","v"],"type":"object"},"fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"lastQuote":{"description":"The most recent quote for this ticker.","properties":{"a":{"description":"The ask price.","format":"double","type":"number"},"b":{"description":"The bid price.","format":"double","type":"number"},"t":{"description":"The millisecond accuracy timestamp of the quote.","type":"integer"},"x":{"description":"The exchange ID on which this quote happened.","type":"integer"}},"required":["a","b","t","x"],"type":"object"},"min":{"description":"The most recent minute bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"}},"type":"object"},"prevDay":{"description":"The previous day's bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"todaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"todaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"required":["day","lastQuote","min","prevDay","ticker","todaysChange","todaysChangePerc","updated"],"type":"object"}},"type":"object"}]}},"text/csv":{"example":"day_c,day_h,day_l,day_o,day_v,lastQuote_a,lastQuote_b,lastQuote_i,lastQuote_t,lastQuote_x,min_c,min_h,min_l,min_o,min_v,prevDay_c,prevDay_h,prevDay_l,prevDay_o,prevDay_v,prevDay_vw\n1.18403,1.1906,1.18001,1.18725,83578,1.18403,1.18398,0,1606163759000,48,1.18396,1.18423,1.1838,1.18404,41,1.18724,1.18727,1.18725,1.18725,5,0\n","schema":{"type":"string"}}},"description":"Get current state for a ticker"},"default":{"description":"Unexpected error"}},"summary":"Ticker","tags":["fx:snapshot"],"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Forex data","name":"fx"}}},"/v2/snapshot/locale/global/markets/forex/{direction}":{"get":{"description":"Get the current top 20 gainers or losers of the day in forex markets.\n\u003cbr /\u003e\n\u003cbr /\u003e\nTop gainers are those tickers whose price has increased by the highest percentage since the previous day's close.\nTop losers are those tickers whose price has decreased by the highest percentage since the previous day's close.\n\u003cbr /\u003e\n\u003cbr /\u003e\nNote: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.\n","operationId":"GetForexSnapshotDirection","parameters":[{"description":"The direction of the snapshot results to return.\n","example":"gainers","in":"path","name":"direction","required":true,"schema":{"enum":["gainers","losers"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"status":"OK","tickers":[{"day":{"c":0.886156,"h":0.887111,"l":0.8825327,"o":0.8844732,"v":1041},"lastQuote":{"a":0.8879606,"b":0.886156,"t":1605283204000,"x":48},"min":{"c":0.886156,"h":0.886156,"l":0.886156,"n":1,"o":0.886156,"t":1684422000000,"v":1},"prevDay":{"c":0.8428527,"h":0.889773,"l":0.8428527,"o":0.8848539,"v":1078,"vw":0},"ticker":"C:PLNILS","todaysChange":0.0433033,"todaysChangePerc":5.13770674,"updated":1605330008999}]},"schema":{"allOf":[{"properties":{"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"},{"properties":{"tickers":{"description":"An array of snapshot data for the specified tickers.","items":{"properties":{"day":{"description":"The most recent daily bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"}},"required":["o","h","l","c","v"],"type":"object"},"fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"lastQuote":{"description":"The most recent quote for this ticker.","properties":{"a":{"description":"The ask price.","format":"double","type":"number"},"b":{"description":"The bid price.","format":"double","type":"number"},"t":{"description":"The millisecond accuracy timestamp of the quote.","type":"integer"},"x":{"description":"The exchange ID on which this quote happened.","type":"integer"}},"required":["a","b","t","x"],"type":"object"},"min":{"description":"The most recent minute bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"}},"type":"object"},"prevDay":{"description":"The previous day's bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"todaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"todaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"required":["day","lastQuote","min","prevDay","ticker","todaysChange","todaysChangePerc","updated"],"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":{"tickers":"day_c,day_h,day_l,day_o,day_v,lastQuote_a,lastQuote_b,lastQuote_t,lastQuote_x,min_c,min_h,min_l,min_o,min_v,prevDay_c,prevDay_h,prevDay_l,prevDay_o,prevDay_v,prevDay_vw\n0.886156,0.887111,0.8825327,0.8844732,1041,0.8879606,0.886156,1605283204000,48,0.886156,0.886156,0.886156,0.886156,1,0.8428527,0.889773,0.8428527,0.8848539,1078,0\n"},"schema":{"type":"string"}}},"description":"Get the current gainers / losers of the day"},"default":{"description":"Unexpected error"}},"summary":"Gainers/Losers","tags":["fx:snapshot"],"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Forex data","name":"fx"}}},"/v2/snapshot/locale/us/markets/stocks/tickers":{"get":{"description":"Get the most up-to-date market data for all traded stock symbols.\n\u003cbr /\u003e\n\u003cbr /\u003e\nNote: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.\n","operationId":"GetStocksSnapshotTickers","parameters":[{"description":"A case-sensitive comma separated list of tickers to get snapshots for. For example, AAPL,TSLA,GOOG. Empty string defaults to querying all tickers.","in":"query","name":"tickers","schema":{"items":{"type":"string"},"type":"array"}},{"description":"Include OTC securities in the response. Default is false (don't include OTC securities).\n","in":"query","name":"include_otc","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"status":"OK","tickers":[{"day":{"c":20.506,"dv":"37216.0","h":20.64,"l":20.506,"o":20.64,"v":37216,"vw":20.616},"lastQuote":{"P":20.6,"S":22,"p":20.5,"s":13,"t":1605192959994246100},"lastTrade":{"c":[14,41],"ds":"2416.0","i":"71675577320245","p":20.506,"s":2416,"t":1605192894630916600,"x":4},"min":{"av":37216,"c":20.506,"dav":"37216.0","dv":"5000.0","h":20.506,"l":20.506,"n":1,"o":20.506,"t":1684428600000,"v":5000,"vw":20.5105},"prevDay":{"c":20.63,"h":21,"l":20.5,"o":20.79,"v":292738,"vw":20.6939},"ticker":"BCAT","todaysChange":-0.124,"todaysChangePerc":-0.601,"updated":1605192894630916600}]},"schema":{"allOf":[{"properties":{"count":{"description":"The total number of results for this request.","type":"integer"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"},{"properties":{"tickers":{"description":"An array of snapshot data for the specified tickers.","items":{"properties":{"day":{"description":"The most recent daily bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"dv":{"description":"The volume including fractional shares, respresented as a string.","type":"string"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"lastQuote":{"description":"The most recent quote for this ticker.  This is only returned if your current plan includes quotes.","properties":{"P":{"description":"The ask price.","format":"double","type":"number"},"S":{"description":"The ask size in lots.","type":"integer"},"p":{"description":"The bid price.","format":"double","type":"number"},"s":{"description":"The bid size in lots.","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"}},"required":["p","s","P","S","t"],"type":"object"},"lastTrade":{"description":"The most recent trade for this ticker.  This is only returned if your current plan includes trades.","properties":{"c":{"description":"The trade conditions.","items":{"type":"integer"},"type":"array"},"ds":{"description":"The size of the trade including fractional shares, respresented as a string.","type":"string"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size (volume) of the trade.","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"x":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"}},"required":["c","i","p","s","t","x","ds"],"type":"object"},"min":{"description":"The most recent minute bar for this ticker.","properties":{"av":{"description":"The accumulated volume.","type":"integer"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"dav":{"description":"The accumulated volume including fractional shares, respresented as a string.","type":"string"},"dv":{"description":"The volume including fractional shares, respresented as a string.","type":"string"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["av","dav","o","h","l","c","v","vw","t","n"],"type":"object"},"prevDay":{"description":"The previous day's bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"todaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"todaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"day_o,day_h,day_l,day_c,day_v,day_vw,day_dv,quoteResponse_P,quoteResponse_S,quoteResponse_p,quoteResponse_s,quoteResponse_t,lastTrade_c,lastTrade_i,lastTrade_p,lastTrade_s,lastTrade_t,lastTrade_x,lastTrade_ds,min_o,min_h,min_l,min_c,min_v,min_vw,min_av,min_t,min_n,min_dv,min_dav,prevDay_o,prevDay_h,prevDay_l,prevDay_c,prevDay_v,prevDay_vw\n20.64,20.64,20.506,20.506,37216,20.616,\"37216.0\",20.6,22,20.5,13,1605192959994246144,\"[14,41]\",71675577320245,20.506,2416,1605192894630916608,4,\"2416.0\",20.506,20.506,20.506,20.506,5000,20.5105,37216,1684428600000,1,\"5000.0\",\"37216.0\",20.79,21,20.5,20.63,292738,20.6939\n","schema":{"type":"string"}}},"description":"Get current state for all tickers"},"default":{"description":"Unexpected error"}},"summary":"All Tickers","tags":["stocks:snapshot"],"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v2/snapshot/locale/us/markets/stocks/tickers/{stocksTicker}":{"get":{"description":"Get the most up-to-date market data for a single traded stock ticker.\n\u003cbr /\u003e\n\u003cbr /\u003e\nNote: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.\n","operationId":"GetStocksSnapshotTicker","parameters":[{"description":"Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.","example":"AAPL","in":"path","name":"stocksTicker","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"657e430f1ae768891f018e08e03598d8","status":"OK","ticker":{"day":{"c":120.4229,"dv":"28727868.0","h":120.53,"l":118.81,"o":119.62,"v":28727868,"vw":119.725},"lastQuote":{"P":120.47,"S":4,"p":120.46,"s":8,"t":1605195918507251700},"lastTrade":{"c":[14,41],"ds":"236.0","i":"4046","p":120.47,"s":236,"t":1605195918306274000,"x":10},"min":{"av":28724441,"c":120.4201,"dav":"28724441.0","dv":"270796.0","h":120.468,"l":120.37,"n":762,"o":120.435,"t":1684428720000,"v":270796,"vw":120.4129},"prevDay":{"c":119.49,"h":119.63,"l":116.44,"o":117.19,"v":110597265,"vw":118.4998},"ticker":"AAPL","todaysChange":0.98,"todaysChangePerc":0.82,"updated":1605195918306274000}},"schema":{"allOf":[{"properties":{"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"},{"properties":{"request_id":{"description":"A request id assigned by the server.","type":"string"}},"required":["request_id"],"type":"object"},{"properties":{"ticker":{"description":"Contains the requested snapshot data for the specified ticker.","properties":{"day":{"description":"The most recent daily bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"dv":{"description":"The volume including fractional shares, respresented as a string.","type":"string"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"lastQuote":{"description":"The most recent quote for this ticker.  This is only returned if your current plan includes quotes.","properties":{"P":{"description":"The ask price.","format":"double","type":"number"},"S":{"description":"The ask size in lots.","type":"integer"},"p":{"description":"The bid price.","format":"double","type":"number"},"s":{"description":"The bid size in lots.","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"}},"required":["p","s","P","S","t"],"type":"object"},"lastTrade":{"description":"The most recent trade for this ticker.  This is only returned if your current plan includes trades.","properties":{"c":{"description":"The trade conditions.","items":{"type":"integer"},"type":"array"},"ds":{"description":"The size of the trade including fractional shares, respresented as a string.","type":"string"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size (volume) of the trade.","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"x":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"}},"required":["c","i","p","s","t","x","ds"],"type":"object"},"min":{"description":"The most recent minute bar for this ticker.","properties":{"av":{"description":"The accumulated volume.","type":"integer"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"dav":{"description":"The accumulated volume including fractional shares, respresented as a string.","type":"string"},"dv":{"description":"The volume including fractional shares, respresented as a string.","type":"string"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["av","dav","o","h","l","c","v","vw","t","n"],"type":"object"},"prevDay":{"description":"The previous day's bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"todaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"todaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"type":"object"}},"type":"object"}]}},"text/csv":{"example":"day_o,day_h,day_l,day_c,day_v,day_vw,day_dv,quoteResponse_P,quoteResponse_S,quoteResponse_p,quoteResponse_s,quoteResponse_t,lastTrade_c,lastTrade_i,lastTrade_p,lastTrade_s,lastTrade_t,lastTrade_x,lastTrade_ds,min_o,min_h,min_l,min_c,min_v,min_vw,min_av,min_t,min_n,min_dv,min_dav,prevDay_o,prevDay_h,prevDay_l,prevDay_c,prevDay_v,prevDay_vw\n119.62,120.53,118.81,120.4229,28727868,119.725,\"28727868.0\",120.47,4,120.46,8,1605195918507251817,\"[14,41]\",4046,120.47,236,1605195918306274031,10,\"236.0\",120.435,120.468,120.37,120.4201,270796,120.4129,28724441,1684428720000,762,\"270796.0\",\"28724441.0\",117.19,119.63,116.44,119.49,110597265,118.4998\n","schema":{"type":"string"}}},"description":"Get current state for a ticker"},"default":{"description":"Unexpected error"}},"summary":"Ticker","tags":["stocks:snapshot"],"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v2/snapshot/locale/us/markets/stocks/{direction}":{"get":{"description":"Get the most up-to-date market data for the current top 20 gainers or losers of the day in the stocks/equities markets.\n\u003cbr /\u003e\n\u003cbr /\u003e\nTop gainers are those tickers whose price has increased by the highest percentage since the previous day's close.\nTop losers are those tickers whose price has decreased by the highest percentage since the previous day's close.\nThis output will only include tickers with a trading volume of 10,000 or more.\n\u003cbr /\u003e\n\u003cbr /\u003e\nNote: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges.\n","operationId":"GetStocksSnapshotDirection","parameters":[{"description":"The direction of the snapshot results to return.\n","example":"gainers","in":"path","name":"direction","required":true,"schema":{"enum":["gainers","losers"],"type":"string"}},{"description":"Include OTC securities in the response. Default is false (don't include OTC securities).\n","in":"query","name":"include_otc","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"status":"OK","tickers":[{"day":{"c":14.2284,"dv":"133963.0","h":15.09,"l":14.2,"o":14.33,"v":133963,"vw":14.5311},"lastQuote":{"P":14.44,"S":11,"p":14.2,"s":25,"t":1605195929997325600},"lastTrade":{"c":[63],"ds":"536.0","i":"79372124707124","p":14.2284,"s":536,"t":1605195848258266000,"x":4},"min":{"av":133963,"c":14.2284,"dav":"133963.0","dv":"6108.0","h":14.325,"l":14.2,"n":5,"o":14.28,"t":1684428600000,"v":6108,"vw":14.2426},"prevDay":{"c":0.73,"h":0.799,"l":0.73,"o":0.75,"v":1568097,"vw":0.7721},"ticker":"PDS","todaysChange":13.498,"todaysChangePerc":1849.096,"updated":1605195848258266000}]},"schema":{"allOf":[{"properties":{"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"},{"properties":{"tickers":{"description":"An array of snapshot data for the specified tickers.","items":{"properties":{"day":{"description":"The most recent daily bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"dv":{"description":"The volume including fractional shares, respresented as a string.","type":"string"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"fmv":{"description":"Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","format":"double","type":"number"},"lastQuote":{"description":"The most recent quote for this ticker.  This is only returned if your current plan includes quotes.","properties":{"P":{"description":"The ask price.","format":"double","type":"number"},"S":{"description":"The ask size in lots.","type":"integer"},"p":{"description":"The bid price.","format":"double","type":"number"},"s":{"description":"The bid size in lots.","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"}},"required":["p","s","P","S","t"],"type":"object"},"lastTrade":{"description":"The most recent trade for this ticker.  This is only returned if your current plan includes trades.","properties":{"c":{"description":"The trade conditions.","items":{"type":"integer"},"type":"array"},"ds":{"description":"The size of the trade including fractional shares, respresented as a string.","type":"string"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"s":{"description":"The size (volume) of the trade.","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"x":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"}},"required":["c","i","p","s","t","x","ds"],"type":"object"},"min":{"description":"The most recent minute bar for this ticker.","properties":{"av":{"description":"The accumulated volume.","type":"integer"},"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"dav":{"description":"The accumulated volume including fractional shares, respresented as a string.","type":"string"},"dv":{"description":"The volume including fractional shares, respresented as a string.","type":"string"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"n":{"description":"The number of transactions in the aggregate window.","type":"integer"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"t":{"description":"The Unix millisecond timestamp for the start of the aggregate window.","type":"integer"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["av","dav","o","h","l","c","v","vw","t","n"],"type":"object"},"prevDay":{"description":"The previous day's bar for this ticker.","properties":{"c":{"description":"The close price for the symbol in the given time period.","format":"double","type":"number"},"h":{"description":"The highest price for the symbol in the given time period.","format":"double","type":"number"},"l":{"description":"The lowest price for the symbol in the given time period.","format":"double","type":"number"},"o":{"description":"The open price for the symbol in the given time period.","format":"double","type":"number"},"otc":{"description":"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.","type":"boolean"},"v":{"description":"The trading volume of the symbol in the given time period.","format":"double","type":"number"},"vw":{"description":"The volume weighted average price.","format":"double","type":"number"}},"required":["o","h","l","c","v","vw"],"type":"object"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"todaysChange":{"description":"The value of the change from the previous day.","format":"double","type":"number"},"todaysChangePerc":{"description":"The percentage change since the previous day.","format":"double","type":"number"},"updated":{"description":"The last updated timestamp.","type":"integer"}},"type":"object"},"type":"array"}},"type":"object"}]}},"text/csv":{"example":"day_o,day_h,day_l,day_c,day_v,day_vw,day_dv,quoteResponse_P,quoteResponse_S,quoteResponse_p,quoteResponse_s,quoteResponse_t,lastTrade_c,lastTrade_i,lastTrade_p,lastTrade_s,lastTrade_t,lastTrade_x,lastTrade_ds,min_o,min_h,min_l,min_c,min_v,min_vw,min_av,min_t,min_n,min_dv,min_dav,prevDay_o,prevDay_h,prevDay_l,prevDay_c,prevDay_v,prevDay_vw\n14.33,15.09,14.2,14.2284,133963,14.5311,\"133963.0\",14.44,11,14.2,25,1605195929997325568,\"[63]\",79372124707124,14.2284,536,1605195848258266112,4,\"536.0\",14.28,14.325,14.2,14.2284,6108,14.2426,133963,1684428600000,5,\"6108.0\",\"133963.0\",0.75,0.799,0.73,0.73,1568097,0.7721\n","schema":{"type":"string"}}},"description":"Get the current tickers of the day"},"default":{"description":"Unexpected error"}},"summary":"Gainers/Losers","tags":["stocks:snapshot"],"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v2/ticks/stocks/nbbo/{ticker}/{date}":{"get":{"description":"Get NBBO quotes for a given ticker symbol on a specified date.\n","operationId":"DeprecatedGetHistoricStocksQuotes","parameters":[{"description":"The ticker symbol we want quotes for.","example":"AAPL","in":"path","name":"ticker","required":true,"schema":{"type":"string"}},{"description":"The date/day of the quotes to retrieve in the format YYYY-MM-DD.","example":"2020-10-14","in":"path","name":"date","required":true,"schema":{"format":"date","type":"string"}},{"description":"The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results.\n","in":"query","name":"timestamp","schema":{"type":"integer"}},{"description":"The maximum timestamp allowed in the results.\n","in":"query","name":"timestampLimit","schema":{"type":"integer"}},{"description":"Reverse the order of the results.\n","example":true,"in":"query","name":"reverse","schema":{"type":"boolean"}},{"description":"Limit the size of the response, max 50000 and default 5000.","example":10,"in":"query","name":"limit","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"db_latency":43,"map":{"P":{"name":"ask_price","type":"float64"},"S":{"name":"ask_size","type":"int"},"X":{"name":"ask_exchange","type":"int"},"c":{"name":"conditions","type":"int"},"f":{"name":"trf_timestamp","type":"int64"},"i":{"name":"indicators","type":"int"},"p":{"name":"bid_price","type":"float64"},"q":{"name":"sequence_number","type":"int"},"s":{"name":"bid_size","type":"int"},"t":{"name":"sip_timestamp","type":"int64"},"x":{"name":"bid_exchange","type":"int"},"y":{"name":"participant_timestamp","type":"int64"},"z":{"name":"tape","type":"int"}},"results":[{"P":0,"S":0,"X":0,"c":[1],"p":102.7,"q":2060,"s":60,"t":1517562000065700400,"x":11,"y":1517562000065321200,"z":3},{"P":0,"S":0,"X":0,"c":[1],"p":170,"q":2061,"s":2,"t":1517562000065791500,"x":11,"y":1517562000065408300,"z":3}],"results_count":2,"success":true,"ticker":"AAPL"},"schema":{"allOf":[{"properties":{"db_latency":{"description":"Latency in milliseconds for the query results from the database.","type":"integer"},"results_count":{"description":"The total number of results for this request.","type":"integer"},"success":{"description":"Whether or not this query was executed successfully.","type":"boolean"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"type":"object"},{"properties":{"results":{"items":{"allOf":[{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"f":{"description":"The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.","type":"integer"},"q":{"description":"The sequence number represents the sequence in which message events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).\n","format":"int64","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"y":{"description":"The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.","type":"integer"}},"required":["T","t","y","f","q"],"type":"object"},{"properties":{"P":{"description":"The ask price.","format":"double","type":"number"},"S":{"description":"The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.","type":"integer"},"X":{"description":"The ask exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"c":{"description":"A list of condition codes.\n","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.\n","type":"integer"},"type":"array"},"i":{"description":"The indicators. For more information, see our glossary of [Conditions and\nIndicators](https://massive.com/glossary/conditions-indicators).\n","items":{"description":"The indicator code.\n","type":"integer"},"type":"array"},"p":{"description":"The bid price.","format":"double","type":"number"},"s":{"description":"The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price.","type":"integer"},"x":{"description":"The bid exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"z":{"description":"There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C.\n* Tape A is NYSE listed securities\n* Tape B is NYSE ARCA / NYSE American\n* Tape C is NASDAQ\n","type":"integer"}},"required":["c","i","p","s","x","P","S","X","z"],"type":"object"}]},"type":"array"}},"type":"object"}]}}},"description":"A list of quotes."},"default":{"description":"Unexpected error"}},"summary":"Quotes (NBBO)","tags":["stocks:quotes"],"x-polygon-deprecation":{"date":1654056060000,"replaces":{"name":"Quotes (NBBO) v3","path":"get_v3_quotes__stockticker"}},"x-polygon-entitlement-data-type":{"description":"NBBO data","name":"nbbo"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v2/ticks/stocks/trades/{ticker}/{date}":{"get":{"description":"Get trades for a given ticker symbol on a specified date.\n","operationId":"DeprecatedGetHistoricStocksTrades","parameters":[{"description":"The ticker symbol we want trades for.","example":"AAPL","in":"path","name":"ticker","required":true,"schema":{"type":"string"}},{"description":"The date/day of the trades to retrieve in the format YYYY-MM-DD.","example":"2020-10-14","in":"path","name":"date","required":true,"schema":{"format":"date","type":"string"}},{"description":"The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results.\n","in":"query","name":"timestamp","schema":{"type":"integer"}},{"description":"The maximum timestamp allowed in the results.\n","in":"query","name":"timestampLimit","schema":{"type":"integer"}},{"description":"Reverse the order of the results.\n","example":true,"in":"query","name":"reverse","schema":{"type":"boolean"}},{"description":"Limit the size of the response, max 50000 and default 5000.","example":10,"in":"query","name":"limit","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"db_latency":11,"map":{"I":{"name":"orig_id","type":"string"},"c":{"name":"conditions","type":"int"},"e":{"name":"correction","type":"int"},"f":{"name":"trf_timestamp","type":"int64"},"i":{"name":"id","type":"string"},"p":{"name":"price","type":"float64"},"q":{"name":"sequence_number","type":"int64"},"r":{"name":"trf_id","type":"int"},"s":{"name":"size","type":"int"},"t":{"name":"sip_timestamp","type":"int64"},"x":{"name":"exchange","type":"int"},"y":{"name":"participant_timestamp","type":"int64"},"z":{"name":"tape","type":"int"}},"results":[{"c":[12,41],"i":"1","p":171.55,"q":1063,"s":100,"t":1517562000016036600,"x":11,"y":1517562000015577000,"z":3},{"c":[12,41],"i":"2","p":171.55,"q":1064,"s":100,"t":1517562000016038100,"x":11,"y":1517562000015577600,"z":3}],"results_count":2,"success":true,"ticker":"AAPL"},"schema":{"allOf":[{"properties":{"db_latency":{"description":"Latency in milliseconds for the query results from the database.","type":"integer"},"results_count":{"description":"The total number of results for this request.","type":"integer"},"success":{"description":"Whether or not this query was executed successfully.","type":"boolean"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"}},"type":"object"},{"properties":{"results":{"items":{"allOf":[{"properties":{"T":{"description":"The exchange symbol that this item is traded under.","type":"string"},"f":{"description":"The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.","type":"integer"},"q":{"description":"The sequence number represents the sequence in which message events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).\n","format":"int64","type":"integer"},"t":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.","type":"integer"},"y":{"description":"The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.","type":"integer"}},"required":["T","t","y","f","q"],"type":"object"},{"properties":{"c":{"description":"A list of condition codes.\n","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.\n","type":"integer"},"type":"array"},"e":{"description":"The trade correction indicator.\n","type":"integer"},"i":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n","type":"string"},"p":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n","format":"double","type":"number"},"r":{"description":"The ID for the Trade Reporting Facility where the trade took place.\n","type":"integer"},"s":{"description":"The size of a trade (also known as volume).\n","format":"double","type":"number"},"x":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"z":{"description":"There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C.\n* Tape A is NYSE listed securities\n* Tape B is NYSE ARCA / NYSE American\n* Tape C is NASDAQ\n","type":"integer"}},"required":["c","i","p","s","e","x","r","z"],"type":"object"}]},"type":"array"}},"type":"object"}]}}},"description":"A list of trades."},"default":{"description":"Unexpected error"}},"summary":"Trades","tags":["stocks:trades"],"x-polygon-deprecation":{"date":1654056060000,"replaces":{"name":"Trades v3","path":"get_v3_trades__stockticker"}},"x-polygon-entitlement-data-type":{"description":"Trade data","name":"trades"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"}}},"/v3/quotes/{fxTicker}":{"get":{"description":"Get BBO quotes for a ticker symbol in a given time range.","operationId":"QuotesFx","parameters":[{"description":"The ticker symbol to get quotes for.","example":"C:EUR-USD","in":"path","name":"fxTicker","required":true,"schema":{"type":"string"}},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 1000 and max is 50000.","in":"query","name":"limit","schema":{"default":1000,"example":10,"maximum":50000,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"timestamp","enum":["timestamp"],"example":"timestamp","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v3/quotes/C:EUR-USD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":[{"ask_exchange":48,"ask_price":1.18565,"bid_exchange":48,"bid_price":1.18558,"participant_timestamp":1625097600000000000},{"ask_exchange":48,"ask_price":1.18565,"bid_exchange":48,"bid_price":1.18559,"participant_timestamp":1625097600000000000}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"properties":{"ask_exchange":{"description":"The ask exchange ID","type":"integer"},"ask_price":{"description":"The ask price.","format":"double","type":"number"},"bid_exchange":{"description":"The bid exchange ID","type":"integer"},"bid_price":{"description":"The bid price.","format":"double","type":"number"},"participant_timestamp":{"description":"The nanosecond Exchange Unix Timestamp. This is the timestamp of when the quote was generated at the exchange.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}}},"required":["participant_timestamp"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"}},"text/csv":{"example":"ask_exchange,ask_price,bid_exchange,bid_price,participant_timestamp\n48,,1.18565,,48,,1.18558,,1625097600000000000\n48,,1.18565,,48,,1.18559,,1625097600000000000\n","schema":{"type":"string"}}},"description":"A list of quotes."}},"summary":"Quotes (BBO)","tags":["fx:quotes"],"x-polygon-entitlement-data-type":{"description":"NBBO data","name":"nbbo"},"x-polygon-entitlement-market-type":{"description":"Forex data","name":"fx"},"x-polygon-paginate":{"limit":{"default":1000,"example":10,"max":50000},"order":{"default":"desc"},"sort":{"default":"timestamp","enum":["timestamp"]}},"x-polygon-replaces":{"date":1654056060000,"replaces":{"name":"Historic Forex Ticks","path":"get_v1_historic_forex__from___to___date"}}},"x-polygon-ignore":true},"/v3/quotes/{optionsTicker}":{"get":{"description":"Get quotes for an options ticker symbol in a given time range.","operationId":"QuotesOptions","parameters":[{"description":"The ticker symbol to get quotes for.","example":"O:SPY241220P00720000","in":"path","name":"optionsTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 1000 and max is 50000.","in":"query","name":"limit","schema":{"default":1000,"example":10,"maximum":50000,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"timestamp","enum":["timestamp"],"example":"timestamp","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v3/quotes/O:SPY241220P00720000?cursor=YXA9NzY5Nzg0NzAxJmFzPSZsaW1pdD0xMCZvcmRlcj1kZXNjJnNvcnQ9dGltZXN0YW1wJnRpbWVzdGFtcC5sdGU9MjAyMi0wMi0xN1QxNyUzQTI1JTNBMTMuMDA5MzU2MDMyWg","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":[{"ask_exchange":323,"ask_price":282,"ask_size":10,"bid_exchange":316,"bid_price":277.5,"bid_size":1,"sequence_number":789539218,"sip_timestamp":1645119125346243600},{"ask_exchange":301,"ask_price":282,"ask_size":1,"bid_exchange":323,"bid_price":277.5,"bid_size":10,"sequence_number":788994206,"sip_timestamp":1645119118474271000}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"properties":{"ask_exchange":{"description":"The ask exchange ID","type":"integer"},"ask_price":{"description":"The ask price.","format":"double","type":"number"},"ask_size":{"description":"The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.","format":"double","type":"number"},"bid_exchange":{"description":"The bid exchange ID","type":"integer"},"bid_price":{"description":"The bid price.","format":"double","type":"number"},"bid_size":{"description":"The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price.","format":"double","type":"number"},"sequence_number":{"description":"The sequence number represents the sequence in which quote events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).","format":"int64","type":"integer"},"sip_timestamp":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}}},"required":["sip_timestamp","sequence_number"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"}},"text/csv":{"example":"ask_exchange,ask_price,ask_size,bid_exchange,bid_price,bid_size,sequence_number,sip_timestamp\n323,282,10,316,277.5,1,789539218,1645119125346243600\n301,282,1,323,277.5,10,788994206,1645119118474271000\n","schema":{"type":"string"}}},"description":"A list of quotes."}},"summary":"Quotes","tags":["options:quotes"],"x-polygon-entitlement-data-type":{"description":"NBBO data","name":"nbbo"},"x-polygon-entitlement-market-type":{"description":"Options data","name":"options"},"x-polygon-paginate":{"limit":{"default":1000,"example":10,"max":50000},"order":{"default":"desc"},"sort":{"default":"timestamp","enum":["timestamp"]}}},"x-polygon-ignore":true},"/v3/quotes/{stockTicker}":{"get":{"description":"Get NBBO quotes for a ticker symbol in a given time range.","operationId":"Quotes","parameters":[{"description":"Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.","example":"AAPL","in":"path","name":"stockTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 1000 and max is 50000.","in":"query","name":"limit","schema":{"default":1000,"example":10,"maximum":50000,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"timestamp","enum":["timestamp"],"example":"timestamp","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v3/quotes/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":[{"ask_exchange":0,"ask_price":0,"ask_size":0,"bid_exchange":11,"bid_price":102.7,"bid_size":60,"conditions":[1],"participant_timestamp":1517562000065321200,"sequence_number":2060,"sip_timestamp":1517562000065700400,"tape":3},{"ask_exchange":0,"ask_price":0,"ask_size":0,"bid_exchange":11,"bid_price":170,"bid_size":2,"conditions":[1],"participant_timestamp":1517562000065408300,"sequence_number":2061,"sip_timestamp":1517562000065791500,"tape":3}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"properties":{"ask_exchange":{"description":"The ask exchange ID","type":"integer"},"ask_price":{"description":"The ask price.","format":"double","type":"number"},"ask_size":{"description":"The total number of shares available for sale at the current ask price.","format":"double","type":"number"},"bid_exchange":{"description":"The bid exchange ID","type":"integer"},"bid_price":{"description":"The bid price.","format":"double","type":"number"},"bid_size":{"description":"The total number of shares that buyers want to purchase at the current bid price.","format":"double","type":"number"},"conditions":{"description":"A list of condition codes.","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.","format":"int32","type":"integer"},"type":"array","x-polygon-go-type":{"name":"Int32Array"}},"indicators":{"description":"A list of indicator codes.","items":{"description":"The indicator codes. For more information, see our glossary of [Conditions and\nIndicators](https://massive.com/glossary/conditions-indicators).","format":"int32","type":"integer"},"type":"array","x-polygon-go-type":{"name":"Int32Array"}},"participant_timestamp":{"description":"The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"sequence_number":{"description":"The sequence number represents the sequence in which quote events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11). Values reset after each trading session/day.","format":"int64","type":"integer"},"sip_timestamp":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"tape":{"description":"There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C.\n* Tape A is NYSE listed securities\n* Tape B is NYSE ARCA / NYSE American\n* Tape C is NASDAQ","format":"int32","type":"integer"},"trf_timestamp":{"description":"The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}}},"required":["participant_timestamp","sequence_number","sip_timestamp"],"type":"object","x-polygon-go-type":{"name":"CommonQuote"}},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"}},"text/csv":{"example":"ask_exchange,ask_price,ask_size,bid_exchange,bid_price,bid_size,conditions,participant_timestamp,sequence_number,sip_timestamp,tape\n0,0,0,11,102.7,60,1,1517562000065321216,2060,1517562000065700260,3\n0,0,0,11,170,2,1,1517562000065408256,2061,1517562000065791515,3\n","schema":{"type":"string"}}},"description":"A list of quotes."}},"summary":"Quotes (NBBO)","tags":["stocks:quotes"],"x-polygon-entitlement-data-type":{"description":"NBBO data","name":"nbbo"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"},"x-polygon-paginate":{"limit":{"default":1000,"example":10,"max":50000},"order":{"default":"desc"},"sort":{"default":"timestamp","enum":["timestamp"]}},"x-polygon-replaces":{"date":1654056060000,"replaces":{"name":"Quotes (NBBO)","path":"get_v2_ticks_stocks_nbbo__ticker___date"}}}},"/v3/reference/conditions":{"get":{"description":"List all conditions that Massive uses.","operationId":"ListConditions","parameters":[{"description":"Filter for conditions within a given asset class.","in":"query","name":"asset_class","schema":{"description":"An identifier for a group of similar financial instruments.","enum":["stocks","options","crypto","fx"],"example":"stocks","type":"string"}},{"description":"Filter by data type.","in":"query","name":"data_type","schema":{"description":"The type of financial data represented by a data model.","enum":["trade","bbo","nbbo"],"type":"string"}},{"description":"Filter for conditions with a given ID.","in":"query","name":"id","schema":{"description":"An identifier used by Massive for this condition. Unique per data type.","type":"integer"}},{"description":"Filter by SIP. If the condition contains a mapping for that SIP, the condition will be returned.","in":"query","name":"sip","schema":{"description":"One of the SIPs.","enum":["CTA","UTP","OPRA"],"type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 1000.","in":"query","name":"limit","schema":{"default":10,"example":10,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"asset_class","enum":["asset_class","id","type","name","data_types","legacy"],"example":"asset_class","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"count":1,"request_id":"31d59dda-80e5-4721-8496-d0d32a654afe","results":[{"asset_class":"stocks","data_types":["trade"],"id":2,"name":"Average Price Trade","sip_mapping":{"CTA":"B","UTP":"W"},"type":"condition","update_rules":{"consolidated":{"updates_high_low":false,"updates_open_close":false,"updates_volume":true},"market_center":{"updates_high_low":false,"updates_open_close":false,"updates_volume":true}}}],"status":"OK"},"properties":{"count":{"description":"The total number of results for this request.","example":1,"type":"integer"},"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request ID assigned by the server.","example":"31d59dda-80e5-4721-8496-d0d32a654afe","type":"string"},"results":{"description":"An array of conditions that match your query.","items":{"description":"A condition generally refers to any extra information passed in a trade or a quote. These conditions\nmay or may not affect the behavior of aggregates.","properties":{"abbreviation":{"description":"A commonly-used abbreviation for this condition.","type":"string"},"asset_class":{"description":"An identifier for a group of similar financial instruments.","enum":["stocks","options","crypto","fx"],"example":"stocks","type":"string"},"data_types":{"description":"Data types that this condition applies to.","items":{"description":"The type of financial data represented by a data model.","enum":["trade","bbo","nbbo"],"type":"string"},"type":"array"},"description":{"description":"A short description of the semantics of this condition.","type":"string"},"exchange":{"description":"If present, mapping this condition from a Massive code to a SIP symbol depends on this attribute.\nIn other words, data with this condition attached comes exclusively from the given exchange.","type":"integer"},"id":{"description":"An identifier used by Massive for this condition. Unique per data type.","type":"integer"},"legacy":{"description":"If true, this condition is from an old version of the SIPs' specs and no longer is used.\nOther conditions may or may not reuse the same symbol as this one.","type":"boolean"},"name":{"description":"The name of this condition.","example":"Acquisition","type":"string"},"sip_mapping":{"description":"A comprehensive mapping that translates condition codes from individual SIPs (CTA, OPRA, UTP) to a unified code used by Massive. This facilitates consistent interpretation and application of market data conditions across different data streams, ensuring that users can accurately apply these conditions to their data analysis and reporting.","properties":{"CTA":{"description":"Condition code from the Consolidated Tape Association (CTA).","type":"string"},"OPRA":{"description":"Condition code from the Options Price Reporting Authority (OPRA).","type":"string"},"UTP":{"description":"Condition code from UTP Plan (UTP).","type":"string"}},"type":"object"},"type":{"description":"An identifier for a collection of related conditions.","enum":["sale_condition","quote_condition","sip_generated_flag","financial_status_indicator","short_sale_restriction_indicator","settlement_condition","market_condition","trade_thru_exempt"],"type":"string"},"update_rules":{"description":"A list of aggregation rules.","properties":{"consolidated":{"description":"Describes aggregation rules on a consolidated (all exchanges) basis.","properties":{"updates_high_low":{"description":"Whether or not trades with this condition update the high/low.","type":"boolean"},"updates_open_close":{"description":"Whether or not trades with this condition update the open/close.","type":"boolean"},"updates_volume":{"description":"Whether or not trades with this condition update the volume.","type":"boolean"}},"required":["updates_high_low","updates_open_close","updates_volume"],"type":"object"},"market_center":{"description":"Describes aggregation rules on a per-market-center basis.","properties":{"updates_high_low":{"description":"Whether or not trades with this condition update the high/low.","type":"boolean"},"updates_open_close":{"description":"Whether or not trades with this condition update the open/close.","type":"boolean"},"updates_volume":{"description":"Whether or not trades with this condition update the volume.","type":"boolean"}},"required":["updates_high_low","updates_open_close","updates_volume"],"type":"object"}},"required":["consolidated","market_center"],"type":"object"}},"required":["id","type","name","asset_class","sip_mapping","data_types"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","example":"OK","type":"string"}},"required":["status","request_id","count","results"],"type":"object"}},"text/csv":{"example":"id,type,abbreviation,name,description,asset_class,sip_mapping,exchange,consolidated_updates_high_low,consolidated_updates_open_close,consolidated_updates_volume,market_center_updates_high_low,market_center_updates_open_close,market_center_updates_volume,data_types,legacy\n0,regular,,Regular Trade,,crypto,null,0,,,,,,,trade,false\n1,buy_or_sell_side,,Sell Side,The asset was sold at the prevailing best bid price on an exchange.,crypto,null,0,,,,,,,trade,false\n2,buy_or_sell_side,,Buy Side,The asset was bought at the prevailing best ask price on an exchange.,crypto,null,0,,,,,,,trade,false\n","schema":{"type":"string"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of results for this request.","example":1,"type":"integer"},"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request ID assigned by the server.","example":"31d59dda-80e5-4721-8496-d0d32a654afe","type":"string"},"results":{"description":"An array of conditions that match your query.","items":{"description":"A condition generally refers to any extra information passed in a trade or a quote. These conditions\nmay or may not affect the behavior of aggregates.","properties":{"abbreviation":{"description":"A commonly-used abbreviation for this condition.","type":"string"},"asset_class":{"description":"An identifier for a group of similar financial instruments.","enum":["stocks","options","crypto","fx"],"example":"stocks","type":"string"},"data_types":{"description":"Data types that this condition applies to.","items":{"description":"The type of financial data represented by a data model.","enum":["trade","bbo","nbbo"],"type":"string"},"type":"array"},"description":{"description":"A short description of the semantics of this condition.","type":"string"},"exchange":{"description":"If present, mapping this condition from a Massive code to a SIP symbol depends on this attribute.\nIn other words, data with this condition attached comes exclusively from the given exchange.","type":"integer"},"id":{"description":"An identifier used by Massive for this condition. Unique per data type.","type":"integer"},"legacy":{"description":"If true, this condition is from an old version of the SIPs' specs and no longer is used.\nOther conditions may or may not reuse the same symbol as this one.","type":"boolean"},"name":{"description":"The name of this condition.","example":"Acquisition","type":"string"},"sip_mapping":{"description":"A comprehensive mapping that translates condition codes from individual SIPs (CTA, OPRA, UTP) to a unified code used by Massive. This facilitates consistent interpretation and application of market data conditions across different data streams, ensuring that users can accurately apply these conditions to their data analysis and reporting.","properties":{"CTA":{"description":"Condition code from the Consolidated Tape Association (CTA).","type":"string"},"OPRA":{"description":"Condition code from the Options Price Reporting Authority (OPRA).","type":"string"},"UTP":{"description":"Condition code from UTP Plan (UTP).","type":"string"}},"type":"object"},"type":{"description":"An identifier for a collection of related conditions.","enum":["sale_condition","quote_condition","sip_generated_flag","financial_status_indicator","short_sale_restriction_indicator","settlement_condition","market_condition","trade_thru_exempt"],"type":"string"},"update_rules":{"description":"A list of aggregation rules.","properties":{"consolidated":{"description":"Describes aggregation rules on a consolidated (all exchanges) basis.","properties":{"updates_high_low":{"description":"Whether or not trades with this condition update the high/low.","type":"boolean"},"updates_open_close":{"description":"Whether or not trades with this condition update the open/close.","type":"boolean"},"updates_volume":{"description":"Whether or not trades with this condition update the volume.","type":"boolean"}},"required":["updates_high_low","updates_open_close","updates_volume"],"type":"object"},"market_center":{"description":"Describes aggregation rules on a per-market-center basis.","properties":{"updates_high_low":{"description":"Whether or not trades with this condition update the high/low.","type":"boolean"},"updates_open_close":{"description":"Whether or not trades with this condition update the open/close.","type":"boolean"},"updates_volume":{"description":"Whether or not trades with this condition update the volume.","type":"boolean"}},"required":["updates_high_low","updates_open_close","updates_volume"],"type":"object"}},"required":["consolidated","market_center"],"type":"object"}},"required":["id","type","name","asset_class","sip_mapping","data_types"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","example":"OK","type":"string"}},"required":["status","request_id","count","results"],"type":"object"}}},"description":"a query parameter was malformed"},"default":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of results for this request.","example":1,"type":"integer"},"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request ID assigned by the server.","example":"31d59dda-80e5-4721-8496-d0d32a654afe","type":"string"},"results":{"description":"An array of conditions that match your query.","items":{"description":"A condition generally refers to any extra information passed in a trade or a quote. These conditions\nmay or may not affect the behavior of aggregates.","properties":{"abbreviation":{"description":"A commonly-used abbreviation for this condition.","type":"string"},"asset_class":{"description":"An identifier for a group of similar financial instruments.","enum":["stocks","options","crypto","fx"],"example":"stocks","type":"string"},"data_types":{"description":"Data types that this condition applies to.","items":{"description":"The type of financial data represented by a data model.","enum":["trade","bbo","nbbo"],"type":"string"},"type":"array"},"description":{"description":"A short description of the semantics of this condition.","type":"string"},"exchange":{"description":"If present, mapping this condition from a Massive code to a SIP symbol depends on this attribute.\nIn other words, data with this condition attached comes exclusively from the given exchange.","type":"integer"},"id":{"description":"An identifier used by Massive for this condition. Unique per data type.","type":"integer"},"legacy":{"description":"If true, this condition is from an old version of the SIPs' specs and no longer is used.\nOther conditions may or may not reuse the same symbol as this one.","type":"boolean"},"name":{"description":"The name of this condition.","example":"Acquisition","type":"string"},"sip_mapping":{"description":"A comprehensive mapping that translates condition codes from individual SIPs (CTA, OPRA, UTP) to a unified code used by Massive. This facilitates consistent interpretation and application of market data conditions across different data streams, ensuring that users can accurately apply these conditions to their data analysis and reporting.","properties":{"CTA":{"description":"Condition code from the Consolidated Tape Association (CTA).","type":"string"},"OPRA":{"description":"Condition code from the Options Price Reporting Authority (OPRA).","type":"string"},"UTP":{"description":"Condition code from UTP Plan (UTP).","type":"string"}},"type":"object"},"type":{"description":"An identifier for a collection of related conditions.","enum":["sale_condition","quote_condition","sip_generated_flag","financial_status_indicator","short_sale_restriction_indicator","settlement_condition","market_condition","trade_thru_exempt"],"type":"string"},"update_rules":{"description":"A list of aggregation rules.","properties":{"consolidated":{"description":"Describes aggregation rules on a consolidated (all exchanges) basis.","properties":{"updates_high_low":{"description":"Whether or not trades with this condition update the high/low.","type":"boolean"},"updates_open_close":{"description":"Whether or not trades with this condition update the open/close.","type":"boolean"},"updates_volume":{"description":"Whether or not trades with this condition update the volume.","type":"boolean"}},"required":["updates_high_low","updates_open_close","updates_volume"],"type":"object"},"market_center":{"description":"Describes aggregation rules on a per-market-center basis.","properties":{"updates_high_low":{"description":"Whether or not trades with this condition update the high/low.","type":"boolean"},"updates_open_close":{"description":"Whether or not trades with this condition update the open/close.","type":"boolean"},"updates_volume":{"description":"Whether or not trades with this condition update the volume.","type":"boolean"}},"required":["updates_high_low","updates_open_close","updates_volume"],"type":"object"}},"required":["consolidated","market_center"],"type":"object"}},"required":["id","type","name","asset_class","sip_mapping","data_types"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","example":"OK","type":"string"}},"required":["status","request_id","count","results"],"type":"object"}}},"description":"an unknown error occurred"}},"summary":"Conditions","tags":["reference:conditions"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"},"x-polygon-paginate":{"limit":{"default":10,"max":1000},"sort":{"default":"asset_class","enum":["asset_class","id","type","name","data_types","legacy"]}}}},"/v3/reference/dividends":{"get":{"description":"Get a list of historical cash dividends, including the ticker symbol,\ndeclaration date, ex-dividend date, record date, pay date, frequency,\nand amount.","operationId":"ListDividends","parameters":[{"description":"Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.","in":"query","name":"ticker","schema":{"type":"string"},"x-polygon-filter-field":{"range":true,"type":"string"}},{"description":"Query by ex-dividend date with the format YYYY-MM-DD.","in":"query","name":"ex_dividend_date","schema":{"format":"date","type":"string"},"x-polygon-filter-field":{"range":true,"type":"string"}},{"description":"Query by record date with the format YYYY-MM-DD.","in":"query","name":"record_date","schema":{"format":"date","type":"string"},"x-polygon-filter-field":{"range":true,"type":"string"}},{"description":"Query by declaration date with the format YYYY-MM-DD.","in":"query","name":"declaration_date","schema":{"format":"date","type":"string"},"x-polygon-filter-field":{"range":true,"type":"string"}},{"description":"Query by pay date with the format YYYY-MM-DD.","in":"query","name":"pay_date","schema":{"format":"date","type":"string"},"x-polygon-filter-field":{"range":true,"type":"string"}},{"description":"Query by the number of times per year the dividend is paid out.  Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), 12 (monthly), 24 (bi-monthly), and 52 (weekly).","in":"query","name":"frequency","schema":{"enum":[0,1,2,4,12,24,52],"type":"integer"}},{"description":"Query by the cash amount of the dividend.","in":"query","name":"cash_amount","schema":{"type":"number"},"x-polygon-filter-field":{"range":true,"type":"number"}},{"description":"Query by the type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD.\nSpecial Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC.","in":"query","name":"dividend_type","schema":{"description":"The type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD.\nSpecial Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC.\nLong-Term and Short-Term capital gain distributions are denoted as LT and ST, respectively.","enum":["CD","SC","LT","ST"],"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Range by ex_dividend_date.","in":"query","name":"ex_dividend_date.gte","schema":{"format":"date","type":"string"}},{"description":"Range by ex_dividend_date.","in":"query","name":"ex_dividend_date.gt","schema":{"format":"date","type":"string"}},{"description":"Range by ex_dividend_date.","in":"query","name":"ex_dividend_date.lte","schema":{"format":"date","type":"string"}},{"description":"Range by ex_dividend_date.","in":"query","name":"ex_dividend_date.lt","schema":{"format":"date","type":"string"}},{"description":"Range by record_date.","in":"query","name":"record_date.gte","schema":{"format":"date","type":"string"}},{"description":"Range by record_date.","in":"query","name":"record_date.gt","schema":{"format":"date","type":"string"}},{"description":"Range by record_date.","in":"query","name":"record_date.lte","schema":{"format":"date","type":"string"}},{"description":"Range by record_date.","in":"query","name":"record_date.lt","schema":{"format":"date","type":"string"}},{"description":"Range by declaration_date.","in":"query","name":"declaration_date.gte","schema":{"format":"date","type":"string"}},{"description":"Range by declaration_date.","in":"query","name":"declaration_date.gt","schema":{"format":"date","type":"string"}},{"description":"Range by declaration_date.","in":"query","name":"declaration_date.lte","schema":{"format":"date","type":"string"}},{"description":"Range by declaration_date.","in":"query","name":"declaration_date.lt","schema":{"format":"date","type":"string"}},{"description":"Range by pay_date.","in":"query","name":"pay_date.gte","schema":{"format":"date","type":"string"}},{"description":"Range by pay_date.","in":"query","name":"pay_date.gt","schema":{"format":"date","type":"string"}},{"description":"Range by pay_date.","in":"query","name":"pay_date.lte","schema":{"format":"date","type":"string"}},{"description":"Range by pay_date.","in":"query","name":"pay_date.lt","schema":{"format":"date","type":"string"}},{"description":"Range by cash_amount.","in":"query","name":"cash_amount.gte","schema":{"type":"number"}},{"description":"Range by cash_amount.","in":"query","name":"cash_amount.gt","schema":{"type":"number"}},{"description":"Range by cash_amount.","in":"query","name":"cash_amount.lte","schema":{"type":"number"}},{"description":"Range by cash_amount.","in":"query","name":"cash_amount.lt","schema":{"type":"number"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 1000.","in":"query","name":"limit","schema":{"default":10,"example":10,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"ex_dividend_date","enum":["ex_dividend_date","pay_date","declaration_date","record_date","cash_amount","ticker"],"example":"ex_dividend_date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"A list of dividends.","example":{"next_url":"https://api.massive.com/v3/reference/dividends/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"6a7e466379af0a71039d60cc78e72282","results":[{"cash_amount":0.22,"declaration_date":"2021-10-28","dividend_type":"CD","ex_dividend_date":"2021-11-05","frequency":4,"id":"E8e3c4f794613e9205e2f178a36c53fcc57cdabb55e1988c87b33f9e52e221444","pay_date":"2021-11-11","record_date":"2021-11-08","ticker":"AAPL"},{"cash_amount":0.22,"declaration_date":"2021-07-27","dividend_type":"CD","ex_dividend_date":"2021-08-06","frequency":4,"id":"E6436c5475706773f03490acf0b63fdb90b2c72bfeed329a6eb4afc080acd80ae","pay_date":"2021-08-12","record_date":"2021-08-09","ticker":"AAPL"}],"status":"OK"},"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"properties":{"cash_amount":{"description":"The cash amount of the dividend per share owned.","type":"number","x-polygon-go-field-tags":{"tags":[{"key":"binding","value":"required"}]}},"currency":{"description":"The currency in which the dividend is paid.","type":"string"},"declaration_date":{"description":"The date that the dividend was announced.","type":"string"},"dividend_type":{"description":"The type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD.\nSpecial Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC.\nLong-Term and Short-Term capital gain distributions are denoted as LT and ST, respectively.","enum":["CD","SC","LT","ST"],"type":"string"},"ex_dividend_date":{"description":"The date that the stock first trades without the dividend, determined by the exchange.","type":"string"},"frequency":{"description":"The number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), 12 (monthly), 24 (bi-monthly), and 52 (weekly).","type":"integer"},"id":{"description":"The unique identifier of the dividend.","type":"string"},"pay_date":{"description":"The date that the dividend is paid out.","type":"string"},"record_date":{"description":"The date that the stock must be held to receive the dividend, set by the company.","type":"string"},"ticker":{"description":"The ticker symbol of the dividend.","type":"string"}},"required":["ticker","ex_dividend_date","frequency","cash_amount","dividend_type","id"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["request_id"],"type":"object"}},"text/csv":{"schema":{"example":"ticker,declaration_date,ex_dividend_date,record_date,pay_date,frequency,cash_amount,dividend_type\nAAPL,2021-10-28,2021-11-05,2021-11-08,2021-11-11,4,0.22,CD\nAAPL,2021-07-27,2021-08-06,2021-08-09,2021-08-12,4,0.22,CD\n","type":"string"}}},"description":"OK"}},"summary":"Dividends v3","tags":["reference:dividends"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"},"x-polygon-paginate":{"limit":{"default":10,"max":1000},"sort":{"default":"ex_dividend_date","enum":["ex_dividend_date","pay_date","declaration_date","record_date","cash_amount","ticker"]}}}},"/v3/reference/exchanges":{"get":{"description":"List all exchanges that Massive knows about.","operationId":"ListExchanges","parameters":[{"description":"Filter by asset class.","in":"query","name":"asset_class","schema":{"description":"An identifier for a group of similar financial instruments.","enum":["stocks","options","crypto","fx","futures"],"example":"stocks","type":"string"}},{"description":"Filter by locale.","in":"query","name":"locale","schema":{"description":"An identifier for a geographical location.","enum":["us","global"],"example":"us","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of results for this request.","example":1,"type":"integer"},"request_id":{"description":"A request ID assigned by the server.","example":"31d59dda-80e5-4721-8496-d0d32a654afe","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"description":"An entity that reports trades.","properties":{"acronym":{"description":"A commonly used abbreviation for this exchange.","example":"AMEX","type":"string"},"asset_class":{"description":"An identifier for a group of similar financial instruments.","enum":["stocks","options","crypto","fx","futures"],"example":"stocks","type":"string"},"id":{"description":"A unique identifier used by Massive for this exchange.","example":1,"type":"integer"},"locale":{"description":"An identifier for a geographical location.","enum":["us","global"],"example":"us","type":"string"},"mic":{"description":"The Market Identifier Code of this exchange (see ISO 10383).","example":"XASE","type":"string"},"name":{"description":"Name of this exchange.","example":"NYSE American, LLC","type":"string"},"operating_mic":{"description":"The MIC of the entity that operates this exchange.","example":"XNYS","type":"string"},"participant_id":{"description":"The ID used by SIP's to represent this exchange.","example":"A","type":"string"},"type":{"description":"Represents the type of exchange.","enum":["exchange","TRF","SIP"],"example":"exchange","type":"string"},"url":{"description":"A link to this exchange's website, if one exists.","example":"https://www.nyse.com/markets/nyse-american","type":"string"}},"required":["id","type","asset_class","locale","name"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","example":"OK","type":"string"}},"required":["status","request_id"],"type":"object"}},"text/csv":{"example":"id,type,asset_class,locale,name,acronym,mic,operating_mic,participant_id,url\n1,exchange,stocks,us,\"NYSE American, LLC\",AMEX,XASE,XNYS,65,https://www.nyse.com/markets/nyse-american\n2,exchange,stocks,us,\"Nasdaq OMX BX, Inc.\",,XBOS,XNAS,66,https://www.nasdaq.com/solutions/nasdaq-bx-stock-market\n3,exchange,stocks,us,\"NYSE National, Inc.\",NSX,XCIS,XNYS,67,https://www.nyse.com/markets/nyse-national\n","schema":{"type":"string"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of results for this request.","example":1,"type":"integer"},"request_id":{"description":"A request ID assigned by the server.","example":"31d59dda-80e5-4721-8496-d0d32a654afe","type":"string"},"status":{"description":"The status of this request's response.","example":"OK","type":"string"}},"required":["status","request_id"],"type":"object"}}},"description":"a query parameter was malformed"},"default":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of results for this request.","example":1,"type":"integer"},"request_id":{"description":"A request ID assigned by the server.","example":"31d59dda-80e5-4721-8496-d0d32a654afe","type":"string"},"status":{"description":"The status of this request's response.","example":"OK","type":"string"}},"required":["status","request_id"],"type":"object"}}},"description":"an unknown error occurred"}},"summary":"Exchanges","tags":["reference:exchanges"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"}}},"/v3/reference/options/contracts":{"get":{"description":"Query for historical options contracts. This provides both active and expired options contracts.","operationId":"ListOptionsContracts","parameters":[{"description":"Query for contracts relating to an underlying stock ticker.","in":"query","name":"underlying_ticker","schema":{"type":"string"},"x-polygon-filter-field":{"range":true,"type":"string"}},{"description":"This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://massive.com/docs/rest/options/contracts/contract-overview).","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Query by the type of contract.","in":"query","name":"contract_type","schema":{"enum":["call","put"],"type":"string"}},{"description":"Query by contract expiration with date format YYYY-MM-DD.","in":"query","name":"expiration_date","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"Specify a point in time for contracts as of this date with format YYYY-MM-DD. Defaults to today's date.","in":"query","name":"as_of","schema":{"type":"string"}},{"description":"Query by strike price of a contract.","in":"query","name":"strike_price","schema":{"type":"number"},"x-polygon-filter-field":{"range":true,"type":"number"}},{"description":"Query for expired contracts. Default is false.","in":"query","name":"expired","schema":{"type":"boolean"}},{"description":"Range by underlying_ticker.","in":"query","name":"underlying_ticker.gte","schema":{"type":"string"}},{"description":"Range by underlying_ticker.","in":"query","name":"underlying_ticker.gt","schema":{"type":"string"}},{"description":"Range by underlying_ticker.","in":"query","name":"underlying_ticker.lte","schema":{"type":"string"}},{"description":"Range by underlying_ticker.","in":"query","name":"underlying_ticker.lt","schema":{"type":"string"}},{"description":"Range by expiration_date.","in":"query","name":"expiration_date.gte","schema":{"type":"string"}},{"description":"Range by expiration_date.","in":"query","name":"expiration_date.gt","schema":{"type":"string"}},{"description":"Range by expiration_date.","in":"query","name":"expiration_date.lte","schema":{"type":"string"}},{"description":"Range by expiration_date.","in":"query","name":"expiration_date.lt","schema":{"type":"string"}},{"description":"Range by strike_price.","in":"query","name":"strike_price.gte","schema":{"type":"number"}},{"description":"Range by strike_price.","in":"query","name":"strike_price.gt","schema":{"type":"number"}},{"description":"Range by strike_price.","in":"query","name":"strike_price.lte","schema":{"type":"number"}},{"description":"Range by strike_price.","in":"query","name":"strike_price.lt","schema":{"type":"number"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 1000.","in":"query","name":"limit","schema":{"default":10,"example":10,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"ticker","enum":["ticker","underlying_ticker","expiration_date","strike_price"],"example":"ticker","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"603902c0-a5a5-406f-bd08-f030f92418fa","results":[{"cfi":"OCASPS","contract_type":"call","exercise_style":"american","expiration_date":"2021-11-19","primary_exchange":"BATO","shares_per_contract":100,"strike_price":85,"ticker":"O:AAPL211119C00085000","underlying_ticker":"AAPL"},{"additional_underlyings":[{"amount":44,"type":"equity","underlying":"VMW"},{"amount":6.53,"type":"currency","underlying":"USD"}],"cfi":"OCASPS","contract_type":"call","exercise_style":"american","expiration_date":"2021-11-19","primary_exchange":"BATO","shares_per_contract":100,"strike_price":90,"ticker":"O:AAPL211119C00090000","underlying_ticker":"AAPL"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"description":"Contains the requested data for the specified options contract.","properties":{"additional_underlyings":{"description":"If an option contract has additional underlyings or deliverables associated with it, they will appear here.\nSee \u003ca rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://www.optionseducation.org/referencelibrary/faq/splits-mergers-spinoffs-bankruptcies\"\u003ehere\u003c/a\u003e for some examples of what might cause a contract to have additional underlyings.","items":{"properties":{"amount":{"description":"The number of shares per contract of the additional underlying, or the cash-in-lieu amount of the currency.","type":"number"},"type":{"description":"The type of the additional underlying asset, either equity or currency.","type":"string"},"underlying":{"description":"The name of the additional underlying asset.","type":"string"}},"type":"object","x-polygon-go-type":{"name":"AdditionalUnderlying"}},"type":"array","x-polygon-go-type":{"name":"AdditionalUnderlyings"}},"cfi":{"description":"The 6 letter CFI code of the contract (defined in \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/ISO_10962\"\u003eISO 10962\u003c/a\u003e)","type":"string"},"contract_type":{"description":"The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\".","type":"string"},"correction":{"description":"The correction number for this option contract.","type":"integer"},"exercise_style":{"description":"The exercise style of this contract. See \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Option_style\"\u003ethis link\u003c/a\u003e for more details on exercise styles.","enum":["american","european","bermudan"],"type":"string"},"expiration_date":{"description":"The contract's expiration date in YYYY-MM-DD format.","type":"string","x-polygon-go-type":{"name":"IDaysPolygonDateString","path":"github.com/polygon-io/ptime"}},"primary_exchange":{"description":"The MIC code of the primary exchange that this contract is listed on.","type":"string"},"shares_per_contract":{"description":"The number of shares per contract for this contract.","type":"number"},"strike_price":{"description":"The strike price of the option contract.","type":"number"},"ticker":{"description":"The ticker for the option contract.","type":"string"},"underlying_ticker":{"description":"The underlying ticker that the option contract relates to.","type":"string"}},"type":"object","x-polygon-go-type":{"name":"OptionsContract"}},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"type":"object"}},"text/csv":{"schema":{"example":"cfi,contract_type,exercise_style,expiration_date,primary_exchange,shares_per_contract,strike_price,ticker,underlying_ticker,additional_underlyings_json\nOCASPS,call,american,2021-11-19,BATO,100,85,O:AAPL211119C00085000,AAPL,\nOCASPS,call,american,2021-11-19,BATO,100,90,O:AAPL211119C00090000,AAPL,\"[{'type': 'equity', 'underlying': 'VMW', 'amount': 44}, {'type': 'currency', 'underlying': 'USD', 'amount': 6.53}]\"\n","type":"string"}}},"description":"A list of options contracts"}},"summary":"Options Contracts","tags":["reference:options:contracts:list"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"},"x-polygon-paginate":{"limit":{"default":10,"max":1000},"sort":{"default":"ticker","enum":["ticker","underlying_ticker","expiration_date","strike_price"]}}}},"/v3/reference/options/contracts/{options_ticker}":{"get":{"description":"Get an options contract","operationId":"GetOptionsContract","parameters":[{"description":"Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://massive.com/blog/how-to-read-a-stock-options-ticker/).","example":"O:SPY251219C00650000","in":"path","name":"options_ticker","required":true,"schema":{"type":"string"}},{"description":"Specify a point in time for the contract as of this date with format YYYY-MM-DD. Defaults to today's date.","in":"query","name":"as_of","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"603902c0-a5a5-406f-bd08-f030f92418fa","results":{"additional_underlyings":[{"amount":44,"type":"equity","underlying":"VMW"},{"amount":6.53,"type":"currency","underlying":"USD"}],"cfi":"OCASPS","contract_type":"call","exercise_style":"american","expiration_date":"2021-11-19","primary_exchange":"BATO","shares_per_contract":100,"strike_price":85,"ticker":"O:AAPL211119C00085000","underlying_ticker":"AAPL"},"status":"OK"},"schema":{"properties":{"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"Contains the requested data for the specified options contract.","properties":{"additional_underlyings":{"description":"If an option contract has additional underlyings or deliverables associated with it, they will appear here.\nSee \u003ca rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://www.optionseducation.org/referencelibrary/faq/splits-mergers-spinoffs-bankruptcies\"\u003ehere\u003c/a\u003e for some examples of what might cause a contract to have additional underlyings.","items":{"properties":{"amount":{"description":"The number of shares per contract of the additional underlying, or the cash-in-lieu amount of the currency.","type":"number"},"type":{"description":"The type of the additional underlying asset, either equity or currency.","type":"string"},"underlying":{"description":"The name of the additional underlying asset.","type":"string"}},"type":"object","x-polygon-go-type":{"name":"AdditionalUnderlying"}},"type":"array","x-polygon-go-type":{"name":"AdditionalUnderlyings"}},"cfi":{"description":"The 6 letter CFI code of the contract (defined in \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/ISO_10962\"\u003eISO 10962\u003c/a\u003e)","type":"string"},"contract_type":{"description":"The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\".","type":"string"},"correction":{"description":"The correction number for this option contract.","type":"integer"},"exercise_style":{"description":"The exercise style of this contract. See \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Option_style\"\u003ethis link\u003c/a\u003e for more details on exercise styles.","enum":["american","european","bermudan"],"type":"string"},"expiration_date":{"description":"The contract's expiration date in YYYY-MM-DD format.","type":"string","x-polygon-go-type":{"name":"IDaysPolygonDateString","path":"github.com/polygon-io/ptime"}},"primary_exchange":{"description":"The MIC code of the primary exchange that this contract is listed on.","type":"string"},"shares_per_contract":{"description":"The number of shares per contract for this contract.","type":"number"},"strike_price":{"description":"The strike price of the option contract.","type":"number"},"ticker":{"description":"The ticker for the option contract.","type":"string"},"underlying_ticker":{"description":"The underlying ticker that the option contract relates to.","type":"string"}},"type":"object","x-polygon-go-type":{"name":"OptionsContract"}},"status":{"description":"The status of this request's response.","type":"string"}},"type":"object"}},"text/csv":{"schema":{"example":"cfi,contract_type,exercise_style,expiration_date,primary_exchange,shares_per_contract,strike_price,ticker,underlying_ticker,additional_underlyings_json\nOCASPS,call,american,2021-11-19,BATO,100,90,O:AAPL211119C00090000,AAPL,\"[{'type': 'equity', 'underlying': 'VMW', 'amount': 44}, {'type': 'currency', 'underlying': 'USD', 'amount': 6.53}]\"\n","type":"string"}}},"description":"A specific options contract"}},"summary":"Options Contract","tags":["reference:options:contract"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"}}},"/v3/reference/splits":{"get":{"description":"Get a list of historical stock splits, including the ticker symbol, the execution date, and the factors of the split ratio.","operationId":"ListStockSplits","parameters":[{"description":"Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.","in":"query","name":"ticker","schema":{"type":"string"},"x-polygon-filter-field":{"range":true,"type":"string"}},{"description":"Query by execution date with the format YYYY-MM-DD.","in":"query","name":"execution_date","schema":{"format":"date","type":"string"},"x-polygon-filter-field":{"range":true,"type":"string"}},{"description":"Query for reverse stock splits. A split ratio where split_from is greater than split_to represents a reverse split. By default this filter is not used.","in":"query","name":"reverse_split","schema":{"nullable":true,"type":"boolean"}},{"description":"Range by ticker.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Range by execution_date.","in":"query","name":"execution_date.gte","schema":{"format":"date","type":"string"}},{"description":"Range by execution_date.","in":"query","name":"execution_date.gt","schema":{"format":"date","type":"string"}},{"description":"Range by execution_date.","in":"query","name":"execution_date.lte","schema":{"format":"date","type":"string"}},{"description":"Range by execution_date.","in":"query","name":"execution_date.lt","schema":{"format":"date","type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 1000.","in":"query","name":"limit","schema":{"default":10,"example":10,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"execution_date","enum":["execution_date","ticker"],"example":"execution_date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v3/splits/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"6a7e466379af0a71039d60cc78e72282","results":[{"execution_date":"2020-08-31","id":"E36416cce743c3964c5da63e1ef1626c0aece30fb47302eea5a49c0055c04e8d0","split_from":1,"split_to":4,"ticker":"AAPL"},{"execution_date":"2005-02-28","id":"E90a77bdf742661741ed7c8fc086415f0457c2816c45899d73aaa88bdc8ff6025","split_from":1,"split_to":2,"ticker":"AAPL"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"properties":{"execution_date":{"description":"The execution date of the stock split. On this date the stock split was applied.","type":"string"},"id":{"description":"The unique identifier for this stock split.","type":"string"},"split_from":{"description":"The second number in the split ratio.\n\nFor example: In a 2-for-1 split, split_from would be 1.","format":"float","type":"number"},"split_to":{"description":"The first number in the split ratio.\n\nFor example: In a 2-for-1 split, split_to would be 2.","format":"float","type":"number"},"ticker":{"description":"The ticker symbol of the stock split.","type":"string"}},"required":["split_from","split_to","id","ticker","execution_date"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"type":"object"}},"text/csv":{"example":"ticker,execution_date,split_from,split_to\nAAPL,2020-08-31,1.0,4.0\nAAPL,2005-02-28,1.0,2.0\n","schema":{"type":"string"}}},"description":"A list of stock splits."}},"summary":"Stock Splits v3","tags":["reference:stocks"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"},"x-polygon-paginate":{"limit":{"default":10,"max":1000},"sort":{"default":"execution_date","enum":["execution_date","ticker"]}}}},"/v3/reference/tickers":{"get":{"description":"Query all ticker symbols which are supported by Massive. This API currently includes Stocks/Equities, Indices, Forex, and Crypto.","operationId":"ListTickers","parameters":[{"description":"Specify a ticker symbol.\nDefaults to empty string which queries all tickers.","in":"query","name":"ticker","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://massive.com/docs/rest/stocks/tickers/ticker-types).\nDefaults to empty string which queries all types.","in":"query","name":"type","schema":{"enum":["CS","ADRC","ADRP","ADRR","UNIT","RIGHT","PFD","FUND","SP","WARRANT","INDEX","ETF","ETN","OS","GDR","OTHER","NYRS","AGEN","EQLK","BOND","ADRW","BASKET","LT"],"type":"string"}},{"description":"Filter by market type. By default all markets are included.","in":"query","name":"market","schema":{"enum":["stocks","crypto","fx","otc","indices"],"type":"string"}},{"description":"Specify the asset's primary exchange Market Identifier Code (MIC) according to [ISO 10383](https://www.iso20022.org/market-identifier-codes).\nDefaults to empty string which queries all exchanges.","in":"query","name":"exchange","schema":{"type":"string"}},{"description":"Specify the CUSIP code of the asset you want to search for. Find more information about CUSIP codes [at their website](https://www.cusip.com/identifiers.html#/CUSIP).\nDefaults to empty string which queries all CUSIPs.\n\nNote: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response.","in":"query","name":"cusip","schema":{"type":"string"}},{"description":"Specify the CIK of the asset you want to search for. Find more information about CIK codes [at their website](https://www.sec.gov/edgar/searchedgar/cik.htm).\nDefaults to empty string which queries all CIKs.","in":"query","name":"cik","schema":{"type":"string"}},{"description":"Specify a point in time to retrieve tickers available on that date.\nDefaults to the most recent available date.","in":"query","name":"date","schema":{"format":"date","type":"string"}},{"description":"Search for terms within the ticker and/or company name.","in":"query","name":"search","schema":{"type":"string"}},{"description":"Specify if the tickers returned should be actively traded on the queried date. Default is true.","example":true,"in":"query","name":"active","schema":{"type":"boolean"}},{"description":"Range by ticker.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 100 and max is 1000.","in":"query","name":"limit","schema":{"default":100,"example":100,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"ticker","enum":["ticker","name","market","locale","primary_exchange","type","currency_symbol","currency_name","base_currency_symbol","base_currency_name","cik","composite_figi","share_class_figi","last_updated_utc","delisted_utc"],"example":"ticker","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"next_url":"https://api.massive.com/v3/reference/tickers?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"e70013d92930de90e089dc8fa098888e","results":[{"active":true,"cik":"0001090872","composite_figi":"BBG000BWQYZ5","currency_name":"usd","last_updated_utc":"2021-04-25T00:00:00Z","locale":"us","market":"stocks","name":"Agilent Technologies Inc.","primary_exchange":"XNYS","share_class_figi":"BBG001SCTQY4","ticker":"A","type":"CS"}],"status":"OK"},"schema":{"properties":{"count":{"description":"The total number of results for this request.","type":"integer"},"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of tickers that match your query.\n\nNote: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response.","items":{"properties":{"active":{"description":"Whether or not the asset is actively traded. False means the asset has been delisted.","type":"boolean"},"base_currency_name":{"description":"The name of the currency that this asset is priced against.","type":"string"},"base_currency_symbol":{"description":"The ISO 4217 code of the currency that this asset is priced against.","type":"string"},"cik":{"description":"The CIK number for this ticker. Find more information [here](https://en.wikipedia.org/wiki/Central_Index_Key).","type":"string"},"composite_figi":{"description":"The composite OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi)","type":"string"},"currency_name":{"description":"The name of the currency that this asset is traded with.","type":"string"},"currency_symbol":{"description":"The ISO 4217 code of the currency that this asset is traded with.","type":"string"},"delisted_utc":{"description":"The last date that the asset was traded.","format":"date-time","type":"string"},"last_updated_utc":{"description":"The information is accurate up to this time.","format":"date-time","type":"string"},"locale":{"description":"The locale of the asset.","enum":["us","global"],"type":"string"},"market":{"description":"The market type of the asset.","enum":["stocks","crypto","fx","otc","indices"],"type":"string"},"name":{"description":"The name of the asset. For stocks/equities this will be the companies registered name. For crypto/fx this will be the name of the currency or coin pair.","type":"string"},"primary_exchange":{"description":"The ISO code of the primary listing exchange for this asset.","type":"string"},"share_class_figi":{"description":"The share Class OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi)","type":"string"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"type":{"description":"The type of the asset. Find the types that we support via our [Ticker Types API](https://massive.com/docs/rest/stocks/tickers/ticker-types).","type":"string"}},"required":["ticker","name","market","locale"],"type":"object","x-polygon-go-type":{"name":"ReferenceTicker","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"type":"object"}},"text/csv":{"example":"ticker,name,market,locale,primary_exchange,type,active,currency_name,cik,composite_figi,share_class_figi,last_updated_utc\nA,Agilent Technologies Inc.,stocks,us,XNYS,CS,true,usd,0001090872,BBG000BWQYZ5,BBG001SCTQY4,2021-04-25T00:00:00Z\n","schema":{"type":"string"}}},"description":"Reference Tickers."},"401":{"description":"Unauthorized - Check our API Key and account status"}},"summary":"Tickers","tags":["reference:tickers:list"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"},"x-polygon-paginate":{"limit":{"default":100,"max":1000},"sort":{"default":"ticker","enum":["ticker","name","market","locale","primary_exchange","type","currency_symbol","currency_name","base_currency_symbol","base_currency_name","cik","composite_figi","share_class_figi","last_updated_utc","delisted_utc"]}}}},"/v3/reference/tickers/types":{"get":{"description":"List all ticker types that Massive has.","operationId":"ListTickerTypes","parameters":[{"description":"Filter by asset class.","in":"query","name":"asset_class","schema":{"description":"An identifier for a group of similar financial instruments.","enum":["stocks","options","crypto","fx","indices"],"example":"stocks","type":"string"}},{"description":"Filter by locale.","in":"query","name":"locale","schema":{"description":"An identifier for a geographical location.","enum":["us","global"],"example":"us","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of results for this request.","example":1,"type":"integer"},"request_id":{"description":"A request ID assigned by the server.","example":"31d59dda-80e5-4721-8496-d0d32a654afe","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"description":"Describes the type of financial instrument represented by a ticker.","properties":{"asset_class":{"description":"An identifier for a group of similar financial instruments.","enum":["stocks","options","crypto","fx","indices"],"example":"stocks","type":"string"},"code":{"description":"A code used by Massive to refer to this ticker type.","example":"CS","type":"string"},"description":{"description":"A short description of this ticker type.","example":"Common Stock","type":"string"},"locale":{"description":"An identifier for a geographical location.","enum":["us","global"],"example":"us","type":"string"}},"required":["code","description","asset_class","locale"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","example":"OK","type":"string"}},"required":["status","request_id"],"type":"object"}},"text/csv":{"example":"code,description,asset_class,locale\nCS,Common Stock,stocks,us\nPFD,Preferred Stock,stocks,us\n","schema":{"type":"string"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of results for this request.","example":1,"type":"integer"},"request_id":{"description":"A request ID assigned by the server.","example":"31d59dda-80e5-4721-8496-d0d32a654afe","type":"string"},"status":{"description":"The status of this request's response.","example":"OK","type":"string"}},"required":["status","request_id"],"type":"object"}}},"description":"a query parameter was malformed"},"default":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of results for this request.","example":1,"type":"integer"},"request_id":{"description":"A request ID assigned by the server.","example":"31d59dda-80e5-4721-8496-d0d32a654afe","type":"string"},"status":{"description":"The status of this request's response.","example":"OK","type":"string"}},"required":["status","request_id"],"type":"object"}}},"description":"an unknown error occurred"}},"summary":"Ticker Types","tags":["reference:tickers:types"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"}}},"/v3/reference/tickers/{ticker}":{"get":{"description":"Get a single ticker supported by Massive. This response will have detailed information about the ticker and the company behind it.","operationId":"GetTicker","parameters":[{"description":"Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.","example":"AAPL","in":"path","name":"ticker","required":true,"schema":{"type":"string"}},{"description":"Specify a point in time to get information about the ticker available on that date.\nWhen retrieving information from SEC filings, we compare this date with the period of report date on the SEC filing.\n\nFor example, consider an SEC filing submitted by AAPL on 2019-07-31, with a period of report date ending on 2019-06-29.\nThat means that the filing was submitted on 2019-07-31, but the filing was created based on information from 2019-06-29.\nIf you were to query for AAPL details on 2019-06-29, the ticker details would include information from the SEC filing.\n\nDefaults to the most recent available date.","in":"query","name":"date","schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"31d59dda-80e5-4721-8496-d0d32a654afe","results":{"active":true,"address":{"address1":"One Apple Park Way","city":"Cupertino","postal_code":"95014","state":"CA"},"branding":{"icon_url":"https://api.massive.com/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-01-10_icon.png","logo_url":"https://api.massive.com/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-01-10_logo.svg"},"cik":"0000320193","composite_figi":"BBG000B9XRY4","currency_name":"usd","description":"Apple designs a wide variety of consumer electronic devices, including smartphones (iPhone), tablets (iPad), PCs (Mac), smartwatches (Apple Watch), AirPods, and TV boxes (Apple TV), among others. The iPhone makes up the majority of Apple's total revenue. In addition, Apple offers its customers a variety of services such as Apple Music, iCloud, Apple Care, Apple TV+, Apple Arcade, Apple Card, and Apple Pay, among others. Apple's products run internally developed software and semiconductors, and the firm is well known for its integration of hardware, software and services. Apple's products are distributed online as well as through company-owned stores and third-party retailers. The company generates roughly 40% of its revenue from the Americas, with the remainder earned internationally.","homepage_url":"https://www.apple.com","list_date":"1980-12-12","locale":"us","market":"stocks","market_cap":2771126040150,"name":"Apple Inc.","phone_number":"(408) 996-1010","primary_exchange":"XNAS","round_lot":100,"share_class_figi":"BBG001S5N8V8","share_class_shares_outstanding":16406400000,"sic_code":"3571","sic_description":"ELECTRONIC COMPUTERS","ticker":"AAPL","ticker_root":"AAPL","total_employees":154000,"type":"CS","weighted_shares_outstanding":16334371000},"status":"OK"},"schema":{"properties":{"count":{"description":"The total number of results for this request.","type":"integer"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"Ticker with details.","properties":{"active":{"description":"Whether or not the asset is actively traded. False means the asset has been delisted.","type":"boolean"},"address":{"description":"Company headquarters address details.","properties":{"address1":{"description":"The first line of the company's headquarters address.","type":"string"},"address2":{"description":"The second line of the company's headquarters address, if applicable.","type":"string"},"city":{"description":"The city of the company's headquarters address.","type":"string"},"postal_code":{"description":"The postal code of the company's headquarters address.","type":"string"},"state":{"description":"The state of the company's headquarters address.","type":"string"}},"type":"object"},"branding":{"description":"Provides URLs aiding in visual identification.","properties":{"icon_url":{"description":"A link to this ticker's company's icon. Icon's are generally smaller, square images that represent the company at a glance.\nNote that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details.","type":"string"},"logo_url":{"description":"A link to this ticker's company's logo.\nNote that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details.","type":"string"}},"type":"object"},"cik":{"description":"The CIK number for this ticker. Find more information [here](https://en.wikipedia.org/wiki/Central_Index_Key).","type":"string"},"composite_figi":{"description":"The composite OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi)","type":"string"},"currency_name":{"description":"The name of the currency that this asset is traded with.","type":"string"},"delisted_utc":{"description":"The last date that the asset was traded.","format":"date-time","type":"string"},"description":{"description":"A description of the company and what they do/offer.","type":"string"},"homepage_url":{"description":"The URL of the company's website homepage.","type":"string"},"list_date":{"description":"The date that the symbol was first publicly listed in the format YYYY-MM-DD.","type":"string"},"locale":{"description":"The locale of the asset.","enum":["us","global"],"type":"string"},"market":{"description":"The market type of the asset.","enum":["stocks","crypto","fx","otc","indices"],"type":"string"},"market_cap":{"description":"The most recent close price of the ticker multiplied by weighted outstanding shares.","format":"double","type":"number"},"name":{"description":"The name of the asset. For stocks/equities this will be the companies registered name. For crypto/fx this will be the name of the currency or coin pair.","type":"string"},"phone_number":{"description":"The phone number for the company behind this ticker.","type":"string"},"primary_exchange":{"description":"The ISO code of the primary listing exchange for this asset.","type":"string"},"round_lot":{"description":"Round lot size of this security.","format":"double","type":"number"},"share_class_figi":{"description":"The share Class OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi)","type":"string"},"share_class_shares_outstanding":{"description":"The recorded number of outstanding shares for this particular share class.","format":"double","type":"number"},"sic_code":{"description":"The standard industrial classification code for this ticker.  For a list of SIC Codes, see the SEC's \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://www.sec.gov/info/edgar/siccodes.htm\"\u003eSIC Code List\u003c/a\u003e.","type":"string"},"sic_description":{"description":"A description of this ticker's SIC code.","type":"string"},"ticker":{"description":"The exchange symbol that this item is traded under.","type":"string"},"ticker_root":{"description":"The root of a specified ticker. For example, the root of BRK.A is BRK.","type":"string"},"ticker_suffix":{"description":"The suffix of a specified ticker. For example, the suffix of BRK.A is A.","type":"string"},"total_employees":{"description":"The approximate number of employees for the company.","type":"number"},"type":{"description":"The type of the asset. Find the types that we support via our [Ticker Types API](https://massive.com/docs/rest/stocks/tickers/ticker-types).","type":"string"},"weighted_shares_outstanding":{"description":"The shares outstanding calculated assuming all shares of other share classes are converted to this share class.","format":"double","type":"number"}},"required":["ticker","name","market","locale","active","currency_name"],"type":"object","x-polygon-go-type":{"name":"ReferenceTicker","path":"github.com/polygon-io/go-lib-models/v2/globals"}},"status":{"description":"The status of this request's response.","type":"string"}},"type":"object"}},"text/csv":{"example":"ticker,name,market,locale,primary_exchange,type,active,currency_name,cik,composite_figi,share_class_figi,share_class_shares_outstanding,weighted_shares_outstanding,round_lot,market_cap,phone_number,address1,address2,city,state,postal_code,sic_code,sic_description,ticker_root,total_employees,list_date,homepage_url,description,branding/logo_url,branding/icon_url\nAAPL,Apple Inc.,stocks,us,XNAS,CS,true,usd,0000320193,BBG000B9XRY4,BBG001S5N8V8,16406400000,16334371000,100,2771126040150,(408) 996-1010,One Apple Park Way,,Cupertino,CA,95014,3571,ELECTRONIC COMPUTERS,AAPL,154000,1980-12-12,https://www.apple.com,\"Apple designs a wide variety of consumer electronic devices, including smartphones (iPhone), tablets (iPad), PCs (Mac), smartwatches (Apple Watch), AirPods, and TV boxes (Apple TV), among others. The iPhone makes up the majority of Apple's total revenue. In addition, Apple offers its customers a variety of services such as Apple Music, iCloud, Apple Care, Apple TV+, Apple Arcade, Apple Card, and Apple Pay, among others. Apple's products run internally developed software and semiconductors, and the firm is well known for its integration of hardware, software and services. Apple's products are distributed online as well as through company-owned stores and third-party retailers. The company generates roughly 40% of its revenue from the Americas, with the remainder earned internationally.\",https://api.massive.com/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-01-10_logo.svg,https://api.massive.com/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-01-10_icon.png\n","schema":{"type":"string"}}},"description":"Reference Tickers."},"401":{"description":"Unauthorized - Check our API Key and account status"}},"summary":"Ticker Details v3","tags":["reference:tickers:get"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"}}},"/v3/snapshot":{"get":{"description":"Get snapshots for assets of all types","operationId":"Snapshots","parameters":[{"description":"Search a range of tickers lexicographically.","in":"query","name":"ticker","schema":{"type":"string"},"x-polygon-filter-field":{"anyOf":{"description":"Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner.\n\nWarning: The maximum number of characters allowed in a URL are subject to your technology stack.\n","enabled":true,"example":"NCLH,O:SPY250321C00380000,C:EURUSD,X:BTCUSD,I:SPX"},"range":true,"type":"string"}},{"description":"Query by the type of asset.","in":"query","name":"type","schema":{"enum":["stocks","options","crypto","fx","indices"],"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner.\n\nWarning: The maximum number of characters allowed in a URL are subject to your technology stack.\n","example":"NCLH,O:SPY250321C00380000,C:EURUSD,X:BTCUSD,I:SPX","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 250.","in":"query","name":"limit","schema":{"default":10,"example":10,"maximum":250,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"ticker","enum":["ticker"],"example":"ticker","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"abc123","results":[{"break_even_price":171.075,"details":{"contract_type":"call","exercise_style":"american","expiration_date":"2022-10-14","shares_per_contract":100,"strike_price":5,"underlying_ticker":"NCLH"},"fmv":0.05,"fmv_last_updated":1636573458757383400,"greeks":{"delta":0.5520187372272933,"gamma":0.00706756515659829,"theta":-0.018532772783847958,"vega":0.7274811132998142},"implied_volatility":0.3048997097864957,"last_quote":{"ask":21.25,"ask_exchange":12,"ask_size":110,"bid":20.9,"bid_exchange":10,"bid_size":172,"last_updated":1636573458756383500,"midpoint":21.075,"timeframe":"REAL-TIME"},"last_trade":{"conditions":[209],"exchange":316,"price":0.05,"sip_timestamp":1675280958783136800,"size":2,"timeframe":"REAL-TIME"},"market_status":"closed","name":"NCLH $5 Call","open_interest":8921,"session":{"change":-0.05,"change_percent":-1.07,"close":6.65,"decimal_volume":"67.0","early_trading_change":-0.01,"early_trading_change_percent":-0.03,"high":7.01,"late_trading_change":-0.4,"late_trading_change_percent":-0.02,"low":5.42,"open":6.7,"previous_close":6.71,"regular_trading_change":-0.6,"regular_trading_change_percent":-0.5,"volume":67},"ticker":"O:NCLH221014C00005000","type":"options","underlying_asset":{"change_to_break_even":23.123999999999995,"last_updated":1636573459862384600,"price":147.951,"ticker":"AAPL","timeframe":"REAL-TIME"}},{"fmv":0.05,"fmv_last_updated":1636573458757383400,"last_minute":{"close":412.05,"decimal_volume":"610.0","high":412.1,"low":412.05,"open":412.1,"transactions":26,"volume":610,"vwap":412.0881},"last_quote":{"ask":21.25,"ask_exchange":300,"ask_size":110,"bid":20.9,"bid_exchange":323,"bid_size":172,"last_updated":1636573458756383500,"timeframe":"REAL-TIME"},"last_trade":{"conditions":[209],"decimal_size":"2.0","exchange":316,"id":"4064","last_updated":1675280958783136800,"price":0.05,"size":2,"timeframe":"REAL-TIME"},"market_status":"closed","name":"Apple Inc.","session":{"change":-1.05,"change_percent":-4.67,"close":21.4,"decimal_volume":"37.0","early_trading_change":-0.39,"early_trading_change_percent":-0.07,"high":22.49,"late_trading_change":1.2,"late_trading_change_percent":3.92,"low":21.35,"open":22.49,"previous_close":22.45,"volume":37},"ticker":"AAPL","type":"stocks"},{"error":"NOT_FOUND","message":"Ticker not found.","ticker":"TSLAAPL"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"properties":{"break_even_price":{"description":"The price of the underlying asset for the contract to break even. For a call, this value is (strike price + premium paid). For a put, this value is (strike price - premium paid).","format":"double","type":"number"},"details":{"description":"The details for this contract.","properties":{"contract_type":{"description":"The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\".","enum":["put","call","other"],"type":"string"},"exercise_style":{"description":"The exercise style of this contract. See \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Option_style\"\u003ethis link\u003c/a\u003e for more details on exercise styles.","enum":["american","european","bermudan"],"type":"string"},"expiration_date":{"description":"The contract's expiration date in YYYY-MM-DD format.","format":"date","type":"string","x-polygon-go-type":{"name":"IDaysPolygonDateString","path":"github.com/polygon-io/ptime"}},"shares_per_contract":{"description":"The number of shares per contract for this contract.","type":"number"},"strike_price":{"description":"The strike price of the option contract.","format":"double","type":"number"}},"required":["contract_type","exercise_style","expiration_date","shares_per_contract","strike_price"],"type":"object"},"error":{"description":"The error while looking for this ticker.","type":"string"},"fmv":{"description":"Fair Market Value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security.\nFor more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","type":"number"},"fmv_last_updated":{"description":"If Fair Market Value (FMV) is available, this field is the nanosecond timestamp of the last FMV calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"greeks":{"description":"The greeks for this contract.\nThere are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money.\nSee this \u003ca href=\"https://massive.com/blog/greeks-and-implied-volatility/#testing\"\nalt=\"link\"\u003earticle\u003c/a\u003e for more information.","properties":{"delta":{"description":"The change in the option's price per $0.01 increment in the price of the underlying asset.","format":"double","type":"number"},"gamma":{"description":"The change in delta per $0.01 change in the price of the underlying asset.","format":"double","type":"number"},"theta":{"description":"The change in the option's price per day.","format":"double","type":"number"},"vega":{"description":"The change in the option's price per 1% increment in volatility.","format":"double","type":"number"}},"required":["delta","gamma","theta","vega"],"type":"object","x-polygon-go-type":{"name":"Greeks"}},"implied_volatility":{"description":"The market's forecast for the volatility of the underlying asset, based on this option's current price.","format":"double","type":"number"},"last_minute":{"description":"The most recent minute aggregate for this stock.","properties":{"close":{"description":"The closing value for the minute aggreate.","format":"double","type":"number"},"decimal_volume":{"description":"The trading volume for the minute aggregate with decimal precision. This field provides support for fractional shares, representing volume as a decimal string where the fractional part is expressed in millionths. This field is only returned for stocks snapshots.","type":"string"},"high":{"description":"The highest value for the minute aggregate.","format":"double","type":"number"},"low":{"description":"The lowest value for the minute aggregate.","format":"double","type":"number"},"open":{"description":"The open value for the minute aggregate.","format":"double","type":"number"},"transactions":{"description":"The number of transactions that took place within the minute aggregate.","format":"int32","type":"integer"},"volume":{"description":"The trading volume for the minute aggregate.","format":"double","type":"number"},"vwap":{"description":"The trading volume weighted average price for the minute aggregate.","format":"double","type":"number","x-polygon-go-id":"VWAP"}},"required":["close","high","low","open","volume","transactions","vwap"],"type":"object","x-polygon-go-type":{"name":"StocksLastMinute"}},"last_quote":{"description":"The most recent quote for this contract. This is only returned if your current plan includes quotes.","properties":{"ask":{"description":"The ask price.","format":"double","type":"number"},"ask_exchange":{"description":"The ask side exchange ID. See \u003ca href=\"https://massive.com/docs/rest/options/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"ask_size":{"description":"The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.","format":"double","type":"number"},"bid":{"description":"The bid price.","format":"double","type":"number"},"bid_exchange":{"description":"The bid side exchange ID. See \u003ca href=\"https://massive.com/docs/rest/options/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"bid_size":{"description":"The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price.","format":"double","type":"number"},"last_updated":{"description":"The nanosecond timestamp of when this information was updated.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"midpoint":{"description":"The average of the bid and ask price.","format":"double","type":"number"},"timeframe":{"description":"The time relevance of the data.","enum":["DELAYED","REAL-TIME"],"type":"string"}},"required":["ask","bid","last_updated","timeframe"],"type":"object","x-polygon-go-type":{"name":"SnapshotLastQuote"}},"last_trade":{"description":"The most recent quote for this contract. This is only returned if your current plan includes trades.","properties":{"conditions":{"description":"A list of condition codes.","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.","format":"int32","type":"integer"},"type":"array"},"decimal_size":{"description":"The size of a trade, including fractional shares, represented as a decimal string where the fractional part is expressed in millionths. This field is only returned for stocks snapshots.","type":"string"},"exchange":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"id":{"description":"The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID.","type":"string"},"last_updated":{"description":"The nanosecond timestamp of when this information was updated.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"participant_timestamp":{"description":"The nanosecond Exchange Unix Timestamp. This is the timestamp of when the trade was generated at the exchange.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"price":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.","format":"double","type":"number"},"sip_timestamp":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it.","format":"int64","type":"integer"},"size":{"description":"The size of a trade (also known as volume).","format":"int32","type":"integer"},"timeframe":{"description":"The time relevance of the data.","enum":["DELAYED","REAL-TIME"],"type":"string"}},"required":["price","size"],"type":"object","x-polygon-go-type":{"name":"SnapshotLastTrade"}},"last_updated":{"description":"The nanosecond timestamp of when this information was updated.","format":"int64","type":"integer"},"market_status":{"description":"The market status for the market that trades this ticker. Possible values for stocks, options, crypto, and forex snapshots are open, closed, early_trading, or late_trading.\nPossible values for indices snapshots are regular_trading, closed, early_trading, and late_trading.","type":"string"},"message":{"description":"The error message while looking for this ticker.","type":"string"},"name":{"description":"The name of this contract.","type":"string"},"open_interest":{"description":"The quantity of this contract held at the end of the last trading day.","format":"double","type":"number"},"session":{"description":"Comprehensive trading session metrics, detailing price changes, trading volume, and key price points (open, close, high, low) for the asset within the current trading day. Includes specific changes during early, regular, and late trading periods to enable detailed performance analysis and trend tracking.","properties":{"change":{"description":"The value of the price change for the asset from the previous trading day.","format":"double","type":"number"},"change_percent":{"description":"The percent of the price change for the asset from the previous trading day.","format":"double","type":"number"},"close":{"description":"The closing price of the asset for the day.","format":"double","type":"number"},"decimal_volume":{"description":"The trading volume for the asset for the day with decimal precision. This field provides support for fractional shares, representing volume as a decimal string. This field is only returned for stocks snapshots.","type":"string"},"early_trading_change":{"description":"Today's early trading change amount, difference between price and previous close if in early trading hours, otherwise difference between last price during early trading and previous close.","format":"double","type":"number"},"early_trading_change_percent":{"description":"Today's early trading change as a percentage.","format":"double","type":"number"},"high":{"description":"The highest price of the asset for the day.","format":"double","type":"number"},"late_trading_change":{"description":"Today's late trading change amount, difference between price and today's close if in late trading hours, otherwise difference between last price during late trading and today's close.","format":"double","type":"number"},"late_trading_change_percent":{"description":"Today's late trading change as a percentage.","format":"double","type":"number"},"low":{"description":"The lowest price of the asset for the day.","format":"double","type":"number"},"open":{"description":"The open price of the asset for the day.","format":"double","type":"number"},"previous_close":{"description":"The closing price of the asset for the previous trading day.","format":"double","type":"number"},"price":{"description":"The price of the most recent trade or bid price for this asset.","format":"double","type":"number"},"regular_trading_change":{"description":"Today's change in regular trading hours, difference between current price and previous trading day's close, otherwise difference between today's close and previous day's close.","format":"double","type":"number"},"regular_trading_change_percent":{"description":"Today's regular trading change as a percentage.","format":"double","type":"number"},"volume":{"description":"The trading volume for the asset for the day.","format":"double","type":"number"}},"required":["change","change_percent","close","high","low","open","previous_close"],"type":"object","x-polygon-go-type":{"name":"Session"}},"ticker":{"description":"The ticker symbol for the asset.","type":"string"},"timeframe":{"description":"The time relevance of the data.","enum":["DELAYED","REAL-TIME"],"type":"string"},"type":{"description":"The asset class for this ticker.","enum":["stocks","options","fx","crypto","indices"],"type":"string"},"underlying_asset":{"description":"Information on the underlying stock for this options contract.  The market data returned depends on your current stocks plan.","properties":{"change_to_break_even":{"description":"The change in price for the contract to break even.","format":"double","type":"number"},"last_updated":{"description":"The nanosecond timestamp of when this information was updated.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"price":{"description":"The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00.","format":"double","type":"number"},"ticker":{"description":"The ticker symbol for the contract's underlying asset.","type":"string"},"timeframe":{"description":"The time relevance of the data.","enum":["DELAYED","REAL-TIME"],"type":"string"},"value":{"description":"The value of the underlying index.","format":"double","type":"number"}},"required":["ticker","change_to_break_even"],"type":"object","x-polygon-go-type":{"name":"UnderlyingAsset"}},"value":{"description":"Value of Index.","type":"number"}},"required":["ticker"],"type":"object","x-polygon-go-type":{"name":"SnapshotResponseModel"}},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","request_id"],"type":"object"}}},"description":"Snapshots for the ticker list"}},"summary":"Universal Snapshot","x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Snapshot data","name":"snapshots"},"x-polygon-entitlement-market-type":{"description":"All asset classes","name":"universal"},"x-polygon-paginate":{"limit":{"default":10,"max":250,"min":1},"sort":{"default":"ticker","enum":["ticker"]}}}},"/v3/snapshot/indices":{"get":{"description":"Get a Snapshot of indices data for said tickers","operationId":"IndicesSnapshot","parameters":[{"description":"Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner.\n\nWarning: The maximum number of characters allowed in a URL are subject to your technology stack.","example":"I:DJI","in":"query","name":"ticker.any_of","schema":{"type":"string"}},{"description":"Search a range of tickers lexicographically.","in":"query","name":"ticker","schema":{"type":"string"},"x-polygon-filter-field":{"range":true,"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.gte","schema":{"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.gt","schema":{"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.lte","schema":{"type":"string"}},{"description":"Range by ticker.","in":"query","name":"ticker.lt","schema":{"type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 250.","in":"query","name":"limit","schema":{"default":10,"example":10,"maximum":250,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"ticker","enum":["ticker"],"example":"ticker","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"6a7e466379af0a71039d60cc78e72282","results":[{"last_updated":1679597116344223500,"market_status":"closed","name":"Dow Jones Industrial Average","session":{"change":-50.01,"change_percent":-1.45,"close":3822.39,"high":3834.41,"low":38217.11,"open":3827.38,"previous_close":3812.19},"ticker":"I:DJI","timeframe":"REAL-TIME","type":"indices","value":3822.39},{"error":"NOT_FOUND","message":"Ticker not found.","ticker":"APx"},{"error":"NOT_ENTITLED","message":"Not entitled to this ticker.","ticker":"APy"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"properties":{"error":{"description":"The error while looking for this ticker.","type":"string"},"last_updated":{"description":"The nanosecond timestamp of when this information was updated.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"market_status":{"description":"The market status for the market that trades this ticker.","type":"string"},"message":{"description":"The error message while looking for this ticker.","type":"string"},"name":{"description":"Name of Index.","type":"string"},"session":{"description":"Trading session metrics, detailing change percentages and key price points (open, close, high, low) for the asset within the current trading day.","properties":{"change":{"description":"The value of the change for the index from the previous trading day.","format":"double","type":"number"},"change_percent":{"description":"The percent of the change for the index from the previous trading day.","format":"double","type":"number"},"close":{"description":"The closing value for the index of the day.","format":"double","type":"number"},"high":{"description":"The highest value for the index of the day.","format":"double","type":"number"},"low":{"description":"The lowest value for the index of the day.","format":"double","type":"number"},"open":{"description":"The open value for the index of the day.","format":"double","type":"number"},"previous_close":{"description":"The closing value for the index of previous trading day.","format":"double","type":"number"}},"type":"object","x-polygon-go-type":{"name":"IndicesSession"}},"ticker":{"description":"Ticker of asset queried.","type":"string"},"timeframe":{"description":"The time relevance of the data.","enum":["DELAYED","REAL-TIME"],"type":"string"},"type":{"description":"The indices market.","enum":["indices"],"type":"string"},"value":{"description":"Value of Index.","type":"number"}},"required":["ticker"],"type":"object","x-polygon-go-type":{"name":"IndicesResult"}},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","request_id"],"type":"object"}}},"description":"Snapshots for indices data of the underlying ticker"}},"summary":"Indices Snapshot","tags":["indices:snapshot"],"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Indices data","name":"indices"},"x-polygon-paginate":{"limit":{"default":10,"max":250},"sort":{"default":"ticker","enum":["ticker"]}}}},"/v3/snapshot/options/{underlyingAsset}":{"get":{"description":"Get the snapshot of all options contracts for an underlying ticker.","operationId":"OptionsChain","parameters":[{"description":"The underlying ticker symbol of the option contract.","example":"EVRI","in":"path","name":"underlyingAsset","required":true,"schema":{"type":"string"}},{"description":"Query by strike price of a contract.","in":"query","name":"strike_price","schema":{"type":"number"},"x-polygon-filter-field":{"range":true,"type":"number"}},{"description":"Query by contract expiration with date format YYYY-MM-DD.","in":"query","name":"expiration_date","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"Query by the type of contract.","in":"query","name":"contract_type","schema":{"enum":["call","put"],"type":"string"}},{"description":"Range by strike_price.","in":"query","name":"strike_price.gte","schema":{"type":"number"}},{"description":"Range by strike_price.","in":"query","name":"strike_price.gt","schema":{"type":"number"}},{"description":"Range by strike_price.","in":"query","name":"strike_price.lte","schema":{"type":"number"}},{"description":"Range by strike_price.","in":"query","name":"strike_price.lt","schema":{"type":"number"}},{"description":"Range by expiration_date.","in":"query","name":"expiration_date.gte","schema":{"type":"string"}},{"description":"Range by expiration_date.","in":"query","name":"expiration_date.gt","schema":{"type":"string"}},{"description":"Range by expiration_date.","in":"query","name":"expiration_date.lte","schema":{"type":"string"}},{"description":"Range by expiration_date.","in":"query","name":"expiration_date.lt","schema":{"type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 250.","in":"query","name":"limit","schema":{"default":10,"example":10,"maximum":250,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"ticker","enum":["ticker","expiration_date","strike_price"],"example":"ticker","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"6a7e466379af0a71039d60cc78e72282","results":[{"break_even_price":151.2,"day":{"change":4.5,"change_percent":6.76,"close":120.73,"high":120.81,"last_updated":1605195918507251700,"low":118.9,"open":119.32,"previous_close":119.12,"volume":868,"vwap":119.31},"details":{"contract_type":"call","exercise_style":"american","expiration_date":"2022-01-21","shares_per_contract":100,"strike_price":150,"ticker":"O:AAPL211022C000150000"},"fmv":0.05,"fmv_last_updated":1605195918508251600,"greeks":{"delta":1,"gamma":0,"theta":0.00229,"vega":0},"implied_volatility":5,"last_quote":{"ask":120.3,"ask_size":4,"bid":120.28,"bid_size":8,"last_updated":1605195918507251700,"midpoint":120.29,"timeframe":"REAL-TIME"},"last_trade":{"conditions":[209],"decimal_size":"2.0","exchange":316,"price":0.05,"sip_timestamp":1675280958783136800,"size":2,"timeframe":"REAL-TIME"},"open_interest":1543,"underlying_asset":{"change_to_break_even":4.2,"last_updated":1605195918507251700,"price":147,"ticker":"AAPL","timeframe":"DELAYED"}}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"description":"Contains the requested snapshot data for the specified contract.","properties":{"break_even_price":{"description":"The price of the underlying asset for the contract to break even. For a call, this value is (strike price + premium paid). For a put, this value is (strike price - premium paid).","format":"double","type":"number"},"day":{"description":"The most recent daily bar for this contract.","properties":{"change":{"description":"The value of the price change for the contract from the previous trading day.","format":"double","type":"number"},"change_percent":{"description":"The percent of the price change for the contract from the previous trading day.","format":"double","type":"number"},"close":{"description":"The closing price for the contract of the day.","format":"double","type":"number"},"high":{"description":"The highest price for the contract of the day.","format":"double","type":"number"},"last_updated":{"description":"The nanosecond timestamp of when this information was updated.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"low":{"description":"The lowest price for the contract of the day.","format":"double","type":"number"},"open":{"description":"The open price for the contract of the day.","format":"double","type":"number"},"previous_close":{"description":"The closing price for the contract of previous trading day.","format":"double","type":"number"},"volume":{"description":"The trading volume for the contract of the day.","format":"double","type":"number"},"vwap":{"description":"The trading volume weighted average price for the contract of the day.","format":"double","type":"number","x-polygon-go-id":"VWAP"}},"required":["open","high","low","close","previous_close","volume","vwap","change_percent","change"],"type":"object","x-polygon-go-type":{"name":"Day"}},"details":{"description":"The details for this contract.","properties":{"contract_type":{"description":"The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\".","enum":["put","call","other"],"type":"string"},"exercise_style":{"description":"The exercise style of this contract. See \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Option_style\"\u003ethis link\u003c/a\u003e for more details on exercise styles.","enum":["american","european","bermudan"],"type":"string"},"expiration_date":{"description":"The contract's expiration date in YYYY-MM-DD format.","format":"date","type":"string","x-polygon-go-type":{"name":"IDaysPolygonDateString","path":"github.com/polygon-io/ptime"}},"shares_per_contract":{"description":"The number of shares per contract for this contract.","type":"number"},"strike_price":{"description":"The strike price of the option contract.","format":"double","type":"number"},"ticker":{"description":"The ticker symbol for the asset.","type":"string"}},"required":["ticker","contract_type","exercise_style","expiration_date","shares_per_contract","strike_price"],"type":"object","x-polygon-go-type":{"name":"Details"}},"fmv":{"description":"Fair Market Value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security.\nFor more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","type":"number"},"fmv_last_updated":{"description":"If Fair Market Value (FMV) is available, this field is the nanosecond timestamp of the last FMV calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"greeks":{"description":"The greeks for this contract.\nThere are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money.\nSee this \u003ca href=\"https://massive.com/blog/greeks-and-implied-volatility/#testing\"\nalt=\"link\"\u003earticle\u003c/a\u003e for more information.","properties":{"delta":{"description":"The change in the option's price per $0.01 increment in the price of the underlying asset.","format":"double","type":"number"},"gamma":{"description":"The change in delta per $0.01 change in the price of the underlying asset.","format":"double","type":"number"},"theta":{"description":"The change in the option's price per day.","format":"double","type":"number"},"vega":{"description":"The change in the option's price per 1% increment in volatility.","format":"double","type":"number"}},"required":["delta","gamma","theta","vega"],"type":"object","x-polygon-go-type":{"name":"Greeks"}},"implied_volatility":{"description":"The market's forecast for the volatility of the underlying asset, based on this option's current price.","format":"double","type":"number"},"last_quote":{"description":"The most recent quote for this contract. This is only returned if your current plan includes quotes.","properties":{"ask":{"description":"The ask price.","format":"double","type":"number"},"ask_exchange":{"description":"The ask side exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","format":"int32","type":"number"},"ask_size":{"description":"The ask size.","format":"double","type":"number"},"bid":{"description":"The bid price.","format":"double","type":"number"},"bid_exchange":{"description":"The bid side exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","format":"int32","type":"number"},"bid_size":{"description":"The bid size.","format":"double","type":"number"},"last_updated":{"description":"The nanosecond timestamp of when this information was updated.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"midpoint":{"description":"The average of the bid and ask price.","format":"double","type":"number"},"timeframe":{"description":"The time relevance of the data.","enum":["DELAYED","REAL-TIME"],"type":"string"}},"required":["ask","ask_size","bid_size","bid","midpoint"],"type":"object","x-polygon-go-type":{"name":"LastQuote"}},"last_trade":{"description":"The most recent trade for this contract. This is only returned if your current plan includes trades.","properties":{"conditions":{"description":"A list of condition codes.","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/options/market-operations/condition-codes)\nfor a mapping to exchange conditions.","format":"int32","type":"integer"},"type":"array"},"exchange":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/options/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"price":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.","format":"double","type":"number"},"sip_timestamp":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it.","format":"int64","type":"integer"},"size":{"description":"The size of a trade (also known as volume).","format":"int32","type":"integer"},"timeframe":{"description":"The time relevance of the data.","enum":["DELAYED","REAL-TIME"],"type":"string"}},"required":["exchange","price","sip_timestamp","size"],"type":"object","x-polygon-go-type":{"name":"OptionsLastTrade"}},"open_interest":{"description":"The quantity of this contract held at the end of the last trading day.","format":"double","type":"number"},"underlying_asset":{"description":"Information on the underlying stock for this options contract.  The market data returned depends on your current stocks plan.","properties":{"change_to_break_even":{"description":"The change in price for the contract to break even.","format":"double","type":"number"},"last_updated":{"description":"The nanosecond timestamp of when this information was updated.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"price":{"description":"The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00.","format":"double","type":"number"},"ticker":{"description":"The ticker symbol for the contract's underlying asset.","type":"string"},"timeframe":{"description":"The time relevance of the data.","enum":["DELAYED","REAL-TIME"],"type":"string"},"value":{"description":"The value of the underlying index.","format":"double","type":"number"}},"required":["ticker","change_to_break_even"],"type":"object","x-polygon-go-type":{"name":"UnderlyingAsset"}}},"required":["day","last_quote","underlying_asset","details","break_even_price","open_interest"],"type":"object","x-polygon-go-type":{"name":"OptionSnapshotResult"}},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","request_id"],"type":"object"}}},"description":"Snapshots for options contracts of the underlying ticker"}},"summary":"Options Chain","tags":["options:snapshot"],"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Options data","name":"options"},"x-polygon-paginate":{"limit":{"default":10,"max":250},"sort":{"default":"ticker","enum":["ticker","expiration_date","strike_price"]}}}},"/v3/snapshot/options/{underlyingAsset}/{optionContract}":{"get":{"description":"Get the snapshot of an option contract for a stock equity.","operationId":"OptionContract","parameters":[{"description":"The underlying ticker symbol of the option contract.","example":"EVRI","in":"path","name":"underlyingAsset","required":true,"schema":{"type":"string"}},{"description":"The option contract identifier.","example":"O:EVRI260116C00015000","in":"path","name":"optionContract","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"d9ff18dac69f55c218f69e4753706acd","results":{"break_even_price":171.075,"day":{"change":-1.05,"change_percent":-4.67,"close":21.4,"high":22.49,"last_updated":1636520400000000000,"low":21.35,"open":22.49,"previous_close":22.45,"volume":37,"vwap":21.6741},"details":{"contract_type":"call","exercise_style":"american","expiration_date":"2023-06-16","shares_per_contract":100,"strike_price":150,"ticker":"O:AAPL230616C00150000"},"fmv":0.05,"fmv_last_updated":1636573458757383400,"greeks":{"delta":0.5520187372272933,"gamma":0.00706756515659829,"theta":-0.018532772783847958,"vega":0.7274811132998142},"implied_volatility":0.3048997097864957,"last_quote":{"ask":21.25,"ask_exchange":301,"ask_size":110,"bid":20.9,"bid_exchange":301,"bid_size":172,"last_updated":1636573458756383500,"midpoint":21.075,"timeframe":"REAL-TIME"},"last_trade":{"conditions":[209],"exchange":316,"price":0.05,"sip_timestamp":1675280958783136800,"size":2,"timeframe":"REAL-TIME"},"open_interest":8921,"underlying_asset":{"change_to_break_even":23.123999999999995,"last_updated":1636573459862384600,"price":147.951,"ticker":"AAPL","timeframe":"REAL-TIME"}},"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"Contains the requested snapshot data for the specified contract.","properties":{"break_even_price":{"description":"The price of the underlying asset for the contract to break even. For a call, this value is (strike price + premium paid). For a put, this value is (strike price - premium paid).","format":"double","type":"number"},"day":{"description":"The most recent daily bar for this contract.","properties":{"change":{"description":"The value of the price change for the contract from the previous trading day.","format":"double","type":"number"},"change_percent":{"description":"The percent of the price change for the contract from the previous trading day.","format":"double","type":"number"},"close":{"description":"The closing price for the contract of the day.","format":"double","type":"number"},"high":{"description":"The highest price for the contract of the day.","format":"double","type":"number"},"last_updated":{"description":"The nanosecond timestamp of when this information was updated.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"low":{"description":"The lowest price for the contract of the day.","format":"double","type":"number"},"open":{"description":"The open price for the contract of the day.","format":"double","type":"number"},"previous_close":{"description":"The closing price for the contract of previous trading day.","format":"double","type":"number"},"volume":{"description":"The trading volume for the contract of the day.","format":"double","type":"number"},"vwap":{"description":"The trading volume weighted average price for the contract of the day.","format":"double","type":"number","x-polygon-go-id":"VWAP"}},"required":["open","high","low","close","previous_close","volume","vwap","change_percent","change"],"type":"object","x-polygon-go-type":{"name":"Day"}},"details":{"description":"The details for this contract.","properties":{"contract_type":{"description":"The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\".","enum":["put","call","other"],"type":"string"},"exercise_style":{"description":"The exercise style of this contract. See \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Option_style\"\u003ethis link\u003c/a\u003e for more details on exercise styles.","enum":["american","european","bermudan"],"type":"string"},"expiration_date":{"description":"The contract's expiration date in YYYY-MM-DD format.","format":"date","type":"string","x-polygon-go-type":{"name":"IDaysPolygonDateString","path":"github.com/polygon-io/ptime"}},"shares_per_contract":{"description":"The number of shares per contract for this contract.","type":"number"},"strike_price":{"description":"The strike price of the option contract.","format":"double","type":"number"},"ticker":{"description":"The ticker symbol for the asset.","type":"string"}},"required":["ticker","contract_type","exercise_style","expiration_date","shares_per_contract","strike_price"],"type":"object","x-polygon-go-type":{"name":"Details"}},"fmv":{"description":"Fair Market Value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security.\nFor more information, \u003ca rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/contact\"\u003econtact us\u003c/a\u003e.","type":"number"},"fmv_last_updated":{"description":"If Fair Market Value (FMV) is available, this field is the nanosecond timestamp of the last FMV calculation.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"greeks":{"description":"The greeks for this contract.\nThere are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money.\nSee this \u003ca href=\"https://massive.com/blog/greeks-and-implied-volatility/#testing\"\nalt=\"link\"\u003earticle\u003c/a\u003e for more information.","properties":{"delta":{"description":"The change in the option's price per $0.01 increment in the price of the underlying asset.","format":"double","type":"number"},"gamma":{"description":"The change in delta per $0.01 change in the price of the underlying asset.","format":"double","type":"number"},"theta":{"description":"The change in the option's price per day.","format":"double","type":"number"},"vega":{"description":"The change in the option's price per 1% increment in volatility.","format":"double","type":"number"}},"required":["delta","gamma","theta","vega"],"type":"object","x-polygon-go-type":{"name":"Greeks"}},"implied_volatility":{"description":"The market's forecast for the volatility of the underlying asset, based on this option's current price.","format":"double","type":"number"},"last_quote":{"description":"The most recent quote for this contract. This is only returned if your current plan includes quotes.","properties":{"ask":{"description":"The ask price.","format":"double","type":"number"},"ask_exchange":{"description":"The ask side exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","format":"int32","type":"number"},"ask_size":{"description":"The ask size.","format":"double","type":"number"},"bid":{"description":"The bid price.","format":"double","type":"number"},"bid_exchange":{"description":"The bid side exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","format":"int32","type":"number"},"bid_size":{"description":"The bid size.","format":"double","type":"number"},"last_updated":{"description":"The nanosecond timestamp of when this information was updated.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"midpoint":{"description":"The average of the bid and ask price.","format":"double","type":"number"},"timeframe":{"description":"The time relevance of the data.","enum":["DELAYED","REAL-TIME"],"type":"string"}},"required":["ask","ask_size","bid_size","bid","midpoint"],"type":"object","x-polygon-go-type":{"name":"LastQuote"}},"last_trade":{"description":"The most recent trade for this contract. This is only returned if your current plan includes trades.","properties":{"conditions":{"description":"A list of condition codes.","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/options/market-operations/condition-codes)\nfor a mapping to exchange conditions.","format":"int32","type":"integer"},"type":"array"},"exchange":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/options/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"price":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.","format":"double","type":"number"},"sip_timestamp":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it.","format":"int64","type":"integer"},"size":{"description":"The size of a trade (also known as volume).","format":"int32","type":"integer"},"timeframe":{"description":"The time relevance of the data.","enum":["DELAYED","REAL-TIME"],"type":"string"}},"required":["exchange","price","sip_timestamp","size"],"type":"object","x-polygon-go-type":{"name":"OptionsLastTrade"}},"open_interest":{"description":"The quantity of this contract held at the end of the last trading day.","format":"double","type":"number"},"underlying_asset":{"description":"Information on the underlying stock for this options contract.  The market data returned depends on your current stocks plan.","properties":{"change_to_break_even":{"description":"The change in price for the contract to break even.","format":"double","type":"number"},"last_updated":{"description":"The nanosecond timestamp of when this information was updated.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"price":{"description":"The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00.","format":"double","type":"number"},"ticker":{"description":"The ticker symbol for the contract's underlying asset.","type":"string"},"timeframe":{"description":"The time relevance of the data.","enum":["DELAYED","REAL-TIME"],"type":"string"},"value":{"description":"The value of the underlying index.","format":"double","type":"number"}},"required":["ticker","change_to_break_even"],"type":"object","x-polygon-go-type":{"name":"UnderlyingAsset"}}},"required":["day","last_quote","underlying_asset","details","break_even_price","open_interest"],"type":"object","x-polygon-go-type":{"name":"OptionSnapshotResult"}},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","request_id"],"type":"object"}},"text/csv":{"schema":{"example":"break_even_price,day_close,day_high,day_last_updated,day_low,day_open,day_previous_close,day_volume,day_vwap,day_change,day_change_percent,details_contract_type,details_exercise_style,details_expiration_date,details_shares_per_contract,details_strike_price,details_ticker,greeks_delta,greeks_gamma,greeks_theta,greeks_vega,implied_volatility,last_quote_ask,last_quote_ask_size,last_quote_bid,last_quote_bid_size,last_quote_last_updated,last_quote_midpoint,last_quote_timeframe,open_interest,underlying_asset_change_to_break_even,underlying_asset_last_updated,underlying_asset_price,underlying_asset_ticker,underlying_asset_timeframe\n0,171.075,21.4,22.49,1636520400000000000,21.35,22.49,22.45,37,21.6741,-1.05,-4.67,call,american,2023-06-16,100,150,O:AAPL230616C00150000,0.5520187372272933,0.00706756515659829,-0.018532772783847958,0.7274811132998142,0.3048997097864957,21.25,110,20.9,172,1636573458756383500,21.075,REAL-TIME,8921,23.123999999999995,1636573459862384600,147.951,AAPL,REAL-TIME\n","type":"string"}}},"description":"Snapshot of the option contract."}},"summary":"Option Contract","tags":["options:snapshot"],"x-polygon-entitlement-allowed-timeframes":[{"description":"Real Time Data","name":"realtime"},{"description":"15 minute delayed data","name":"delayed"}],"x-polygon-entitlement-data-type":{"description":"Aggregate data","name":"aggregates"},"x-polygon-entitlement-market-type":{"description":"Options data","name":"options"}}},"/v3/trades/{cryptoTicker}":{"get":{"description":"Get trades for a crypto ticker symbol in a given time range.","operationId":"TradesCrypto","parameters":[{"description":"The ticker symbol to get trades for.","example":"X:BTC-USD","in":"path","name":"cryptoTicker","required":true,"schema":{"type":"string"}},{"description":"Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 1000 and max is 50000.","in":"query","name":"limit","schema":{"default":1000,"example":10,"maximum":50000,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"timestamp","enum":["timestamp"],"example":"timestamp","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v3/trades/X:BTC-USD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":[{"conditions":[1],"exchange":1,"id":"191450340","participant_timestamp":1625097600103000000,"price":35060,"size":1.0434526},{"conditions":[2],"exchange":1,"id":"191450341","participant_timestamp":1625097600368000000,"price":35059.99,"size":0.0058883}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"properties":{"conditions":{"description":"A list of condition codes.","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.","format":"int32","type":"integer"},"type":"array","x-polygon-go-type":{"name":"Int32Array"}},"exchange":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/crypto/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"id":{"description":"The Trade ID which uniquely identifies a trade on the exchange that the trade happened on.","type":"string"},"participant_timestamp":{"description":"The nanosecond Exchange Unix Timestamp. This is the timestamp of when the trade was generated at the exchange.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"price":{"description":"The price of the trade in the base currency of the crypto pair.","format":"double","type":"number"},"size":{"description":"The size of a trade (also known as volume).","format":"double","type":"number"}},"required":["exchange","price","size"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"}},"text/csv":{"example":"conditions,exchange,id,participant_timestamp,price,size\n1,1,191450340,1625097600103000000,35060,1.0434526\n2,1,191450341,1625097600368000000,35059.99,0.0058883\n","schema":{"type":"string"}}},"description":"A list of trades."}},"summary":"Trades","tags":["crypto:trades"],"x-polygon-entitlement-data-type":{"description":"Trade data","name":"trades"},"x-polygon-entitlement-market-type":{"description":"Crypto data","name":"crypto"},"x-polygon-paginate":{"limit":{"default":1000,"example":10,"max":50000},"order":{"default":"desc"},"sort":{"default":"timestamp","enum":["timestamp"]}},"x-polygon-replaces":{"date":1654056060000,"replaces":{"name":"Historic Crypto Trades","path":"get_v1_historic_crypto__from___to___date"}}},"x-polygon-ignore":true},"/v3/trades/{optionsTicker}":{"get":{"description":"Get trades for an options ticker symbol in a given time range.","operationId":"TradesOptions","parameters":[{"description":"The options ticker symbol to get trades for.","example":"O:TSLA210903C00700000","in":"path","name":"optionsTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 1000 and max is 50000.","in":"query","name":"limit","schema":{"default":1000,"example":10,"maximum":50000,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"timestamp","enum":["timestamp"],"example":"timestamp","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v3/trades/O:AZO140621P00530000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":[{"exchange":46,"participant_timestamp":1401715883806000000,"price":6.91,"sip_timestamp":1401715883806000000,"size":1},{"conditions":[209],"exchange":67,"participant_timestamp":1401716547786000000,"price":7.2,"sip_timestamp":1401716547786000000,"size":1}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"properties":{"conditions":{"description":"A list of condition codes.","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.","format":"int32","type":"integer"},"type":"array","x-polygon-go-type":{"name":"Int32Array"}},"correction":{"description":"The trade correction indicator.","type":"integer"},"exchange":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/options/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"participant_timestamp":{"description":"The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the trade was actually generated at the exchange.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"price":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.","format":"double","type":"number"},"sip_timestamp":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"size":{"description":"The size of a trade (also known as volume).","format":"double","type":"number"}},"required":["exchange","price","sip_timestamp","size"],"type":"object"},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"}},"text/csv":{"example":"conditions,exchange,participant_timestamp,price,sip_timestamp,size\n,46,1401715883806000000,6.91,1401715883806000000,1\n209,67,1401716547786000000,7.2,1401716547786000000,1\n","schema":{"type":"string"}}},"description":"A list of trades."}},"summary":"Trades","tags":["options:trades"],"x-polygon-entitlement-data-type":{"description":"Trade data","name":"trades"},"x-polygon-entitlement-market-type":{"description":"Options data","name":"options"},"x-polygon-paginate":{"limit":{"default":1000,"example":10,"max":50000},"order":{"default":"desc"},"sort":{"default":"timestamp","enum":["timestamp"]}}},"x-polygon-ignore":true},"/v3/trades/{stockTicker}":{"get":{"description":"Get trades for a ticker symbol in a given time range.","operationId":"Trades","parameters":[{"description":"Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.","example":"AAPL","in":"path","name":"stockTicker","required":true,"schema":{"type":"string"},"x-polygon-go-id":"Ticker"},{"description":"Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.","in":"query","name":"timestamp","schema":{"type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.gt","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lte","schema":{"type":"string"}},{"description":"Range by timestamp.","in":"query","name":"timestamp.lt","schema":{"type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 1000 and max is 50000.","in":"query","name":"limit","schema":{"default":1000,"example":10,"maximum":50000,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"timestamp","enum":["timestamp"],"example":"timestamp","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/v3/trades/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"a47d1beb8c11b6ae897ab76cdbbf35a3","results":[{"conditions":[12,41],"decimal_size":"100.0","exchange":11,"id":"1","participant_timestamp":1517562000015577000,"price":171.55,"sequence_number":1063,"sip_timestamp":1517562000016036600,"size":100,"tape":3},{"conditions":[12,41],"decimal_size":"100.0","exchange":11,"id":"2","participant_timestamp":1517562000015577600,"price":171.55,"sequence_number":1064,"sip_timestamp":1517562000016038100,"size":100,"tape":3}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"properties":{"conditions":{"description":"A list of condition codes.","items":{"description":"The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/rest/stocks/market-operations/condition-codes)\nfor a mapping to exchange conditions.","format":"int32","type":"integer"},"type":"array","x-polygon-go-type":{"name":"Int32Array"}},"correction":{"description":"The trade correction indicator.","type":"integer"},"decimal_size":{"description":"The size of the trade including the fractional component. This is represented as a decimal string.","type":"string"},"exchange":{"description":"The exchange ID. See \u003ca href=\"https://massive.com/docs/rest/stocks/market-operations/exchanges\" alt=\"Exchanges\"\u003eExchanges\u003c/a\u003e for Massive's mapping of exchange IDs.","type":"integer"},"id":{"description":"The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.","type":"string"},"participant_timestamp":{"description":"The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the trade was actually generated at the exchange.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"price":{"description":"The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.","format":"double","type":"number"},"sequence_number":{"description":"The sequence number represents the sequence in which trade events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11). Values reset after each trading session/day.","format":"int64","type":"integer"},"sip_timestamp":{"description":"The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}},"size":{"description":"The size of a trade (also known as volume).","format":"double","type":"number"},"tape":{"description":"There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C.\n* Tape A is NYSE listed securities\n* Tape B is NYSE ARCA / NYSE American\n* Tape C is NASDAQ","format":"int32","type":"integer"},"trf_id":{"description":"The ID for the Trade Reporting Facility where the trade took place.","type":"integer"},"trf_timestamp":{"description":"The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this trade.","format":"int64","type":"integer","x-polygon-go-type":{"name":"INanoseconds","path":"github.com/polygon-io/ptime"}}},"required":["exchange","id","price","sequence_number","sip_timestamp","participant_timestamp","size","decimal_size"],"type":"object","x-polygon-go-type":{"name":"CommonTrade"}},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status"],"type":"object"}},"text/csv":{"example":"conditions,exchange,id,participant_timestamp,price,sequence_number,sip_timestamp,size,tape,decimal_size\n\"12,41\",11,1,1517562000015577088,171.55,1063,1517562000016036581,100,3,100.0\n\"12,41\",11,2,1517562000015577600,171.55,1064,1517562000016038175,100,3,100.0\n","schema":{"type":"string"}}},"description":"A list of trades."}},"summary":"Trades","tags":["stocks:trades"],"x-polygon-entitlement-data-type":{"description":"Trade data","name":"trades"},"x-polygon-entitlement-market-type":{"description":"Stocks data","name":"stocks"},"x-polygon-paginate":{"limit":{"default":1000,"example":10,"max":50000},"order":{"default":"desc"},"sort":{"default":"timestamp","enum":["timestamp"]}},"x-polygon-replaces":{"date":1654056060000,"replaces":{"name":"Trades","path":"get_v2_ticks_stocks_trades__ticker___date"}}}},"/vX/reference/financials":{"get":{"description":"Get historical financial data for a stock ticker.\nThe financials data is extracted from XBRL from company SEC filings using the methodology outlined \u003ca rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"http://xbrl.squarespace.com/understanding-sec-xbrl-financi/\"\u003ehere\u003c/a\u003e.","operationId":"ListFinancials","parameters":[{"description":"Query by company ticker.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Query by central index key (\u003ca rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://www.sec.gov/edgar/searchedgar/cik.htm\"\u003eCIK\u003c/a\u003e) Number","in":"query","name":"cik","schema":{"type":"string"}},{"description":"Query by company name.","in":"query","name":"company_name","schema":{"type":"string"},"x-polygon-filter-field":{"search":true}},{"description":"Query by standard industrial classification (\u003ca rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://www.sec.gov/corpfin/division-of-corporation-finance-standard-industrial-classification-sic-code-list\"\u003eSIC\u003c/a\u003e)","in":"query","name":"sic","schema":{"type":"string"}},{"description":"Query by the date when the filing with financials data was filed in YYYY-MM-DD format.\n\nBest used when querying over date ranges to find financials based on filings that happen in a time period.\n\nExamples:\n\nTo get financials based on filings that have happened after January 1, 2009 use the query param filing_date.gte=2009-01-01\n\nTo get financials based on filings that happened in the year 2009 use the query params filing_date.gte=2009-01-01\u0026filing_date.lt=2010-01-01","in":"query","name":"filing_date","schema":{"format":"date","type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"The period of report for the filing with financials data in YYYY-MM-DD format.","in":"query","name":"period_of_report_date","schema":{"format":"date","type":"string"},"x-polygon-filter-field":{"range":true}},{"description":"Query by timeframe. Annual financials originate from 10-K filings, and quarterly financials originate from 10-Q filings. Note: Most companies do not file quarterly reports for Q4 and instead include those financials in their annual report, so some companies my not return quarterly financials for Q4","in":"query","name":"timeframe","schema":{"enum":["annual","quarterly","ttm"],"type":"string"}},{"description":"Whether or not to include the `xpath` and `formula` attributes for each financial data point.\nSee the `xpath` and `formula` response attributes for more info. False by default.","in":"query","name":"include_sources","schema":{"default":false,"type":"boolean"}},{"description":"Search by company_name.","in":"query","name":"company_name.search","schema":{"type":"string"}},{"description":"Search by filing_date.","in":"query","name":"filing_date.gte","schema":{"format":"date","type":"string"}},{"description":"Search by filing_date.","in":"query","name":"filing_date.gt","schema":{"format":"date","type":"string"}},{"description":"Search by filing_date.","in":"query","name":"filing_date.lte","schema":{"format":"date","type":"string"}},{"description":"Search by filing_date.","in":"query","name":"filing_date.lt","schema":{"format":"date","type":"string"}},{"description":"Search by period_of_report_date.","in":"query","name":"period_of_report_date.gte","schema":{"format":"date","type":"string"}},{"description":"Search by period_of_report_date.","in":"query","name":"period_of_report_date.gt","schema":{"format":"date","type":"string"}},{"description":"Search by period_of_report_date.","in":"query","name":"period_of_report_date.lte","schema":{"format":"date","type":"string"}},{"description":"Search by period_of_report_date.","in":"query","name":"period_of_report_date.lt","schema":{"format":"date","type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"enum":["asc","desc"],"example":"asc","type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 100.","in":"query","name":"limit","schema":{"default":10,"example":10,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"period_of_report_date","enum":["filing_date","period_of_report_date"],"example":"filing_date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"next_url":"https://api.massive.com/vX/reference/financials?","request_id":"55eb92ed43b25568ab0cce159830ea34","results":[{"cik":"0001650729","company_name":"SiteOne Landscape Supply, Inc.","end_date":"2022-04-03","filing_date":"2022-05-04","financials":{"balance_sheet":{"assets":{"label":"Assets","order":100,"unit":"USD","value":2407400000},"current_assets":{"label":"Current Assets","order":200,"unit":"USD","value":1385900000},"current_liabilities":{"label":"Current Liabilities","order":700,"unit":"USD","value":597500000},"equity":{"label":"Equity","order":1400,"unit":"USD","value":1099200000},"equity_attributable_to_noncontrolling_interest":{"label":"Equity Attributable To Noncontrolling Interest","order":1500,"unit":"USD","value":0},"equity_attributable_to_parent":{"label":"Equity Attributable To Parent","order":1600,"unit":"USD","value":1099200000},"liabilities":{"label":"Liabilities","order":600,"unit":"USD","value":1308200000},"liabilities_and_equity":{"label":"Liabilities And Equity","order":1900,"unit":"USD","value":2407400000},"noncurrent_assets":{"label":"Noncurrent Assets","order":300,"unit":"USD","value":1021500000},"noncurrent_liabilities":{"label":"Noncurrent Liabilities","order":800,"unit":"USD","value":710700000}},"cash_flow_statement":{"exchange_gains_losses":{"label":"Exchange Gains/Losses","order":1000,"unit":"USD","value":100000},"net_cash_flow":{"label":"Net Cash Flow","order":1100,"unit":"USD","value":-8600000},"net_cash_flow_continuing":{"label":"Net Cash Flow, Continuing","order":1200,"unit":"USD","value":-8700000},"net_cash_flow_from_financing_activities":{"label":"Net Cash Flow From Financing Activities","order":700,"unit":"USD","value":150600000},"net_cash_flow_from_financing_activities_continuing":{"label":"Net Cash Flow From Financing Activities, Continuing","order":800,"unit":"USD","value":150600000},"net_cash_flow_from_investing_activities":{"label":"Net Cash Flow From Investing Activities","order":400,"unit":"USD","value":-41000000},"net_cash_flow_from_investing_activities_continuing":{"label":"Net Cash Flow From Investing Activities, Continuing","order":500,"unit":"USD","value":-41000000},"net_cash_flow_from_operating_activities":{"label":"Net Cash Flow From Operating Activities","order":100,"unit":"USD","value":-118300000},"net_cash_flow_from_operating_activities_continuing":{"label":"Net Cash Flow From Operating Activities, Continuing","order":200,"unit":"USD","value":-118300000}},"comprehensive_income":{"comprehensive_income_loss":{"label":"Comprehensive Income/Loss","order":100,"unit":"USD","value":40500000},"comprehensive_income_loss_attributable_to_noncontrolling_interest":{"label":"Comprehensive Income/Loss Attributable To Noncontrolling Interest","order":200,"unit":"USD","value":0},"comprehensive_income_loss_attributable_to_parent":{"label":"Comprehensive Income/Loss Attributable To Parent","order":300,"unit":"USD","value":40500000},"other_comprehensive_income_loss":{"label":"Other Comprehensive Income/Loss","order":400,"unit":"USD","value":40500000},"other_comprehensive_income_loss_attributable_to_parent":{"label":"Other Comprehensive Income/Loss Attributable To Parent","order":600,"unit":"USD","value":8200000}},"income_statement":{"basic_earnings_per_share":{"label":"Basic Earnings Per Share","order":4200,"unit":"USD / shares","value":0.72},"benefits_costs_expenses":{"label":"Benefits Costs and Expenses","order":200,"unit":"USD","value":768400000},"cost_of_revenue":{"label":"Cost Of Revenue","order":300,"unit":"USD","value":536100000},"costs_and_expenses":{"label":"Costs And Expenses","order":600,"unit":"USD","value":768400000},"diluted_earnings_per_share":{"label":"Diluted Earnings Per Share","order":4300,"unit":"USD / shares","value":0.7},"gross_profit":{"label":"Gross Profit","order":800,"unit":"USD","value":269200000},"income_loss_from_continuing_operations_after_tax":{"label":"Income/Loss From Continuing Operations After Tax","order":1400,"unit":"USD","value":32300000},"income_loss_from_continuing_operations_before_tax":{"label":"Income/Loss From Continuing Operations Before Tax","order":1500,"unit":"USD","value":36900000},"income_tax_expense_benefit":{"label":"Income Tax Expense/Benefit","order":2200,"unit":"USD","value":4600000},"interest_expense_operating":{"label":"Interest Expense, Operating","order":2700,"unit":"USD","value":4300000},"net_income_loss":{"label":"Net Income/Loss","order":3200,"unit":"USD","value":32300000},"net_income_loss_attributable_to_noncontrolling_interest":{"label":"Net Income/Loss Attributable To Noncontrolling Interest","order":3300,"unit":"USD","value":0},"net_income_loss_attributable_to_parent":{"label":"Net Income/Loss Attributable To Parent","order":3500,"unit":"USD","value":32300000},"net_income_loss_available_to_common_stockholders_basic":{"label":"Net Income/Loss Available To Common Stockholders, Basic","order":3700,"unit":"USD","value":32300000},"operating_expenses":{"label":"Operating Expenses","order":1000,"unit":"USD","value":228000000},"operating_income_loss":{"label":"Operating Income/Loss","order":1100,"unit":"USD","value":41200000},"participating_securities_distributed_and_undistributed_earnings_loss_basic":{"label":"Participating Securities, Distributed And Undistributed Earnings/Loss, Basic","order":3800,"unit":"USD","value":0},"preferred_stock_dividends_and_other_adjustments":{"label":"Preferred Stock Dividends And Other Adjustments","order":3900,"unit":"USD","value":0},"revenues":{"label":"Revenues","order":100,"unit":"USD","value":805300000}}},"fiscal_period":"Q1","fiscal_year":"2022","source_filing_file_url":"https://api.massive.com/v1/reference/sec/filings/0001650729-22-000010/files/site-20220403_htm.xml","source_filing_url":"https://api.massive.com/v1/reference/sec/filings/0001650729-22-000010","start_date":"2022-01-03"}],"status":"OK"},"schema":{"properties":{"count":{"description":"The total number of results for this request.","type":"integer"},"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"properties":{"acceptance_datetime":{"description":"The datetime (EST timezone) the filing was accepted by EDGAR in YYYYMMDDHHMMSS format.","type":"string"},"cik":{"description":"The CIK number for the company.","type":"string"},"company_name":{"description":"The company name.","type":"string"},"end_date":{"description":"The end date of the period that these financials cover in YYYYMMDD format.","type":"string"},"filing_date":{"description":"The date that the SEC filing which these financials were derived from was made available. Note that this is not necessarily the date when this information became public, as some companies may publish a press release before filing with the SEC.","type":"string"},"financials":{"description":"Structured financial statements with detailed data points and metadata.","properties":{"balance_sheet":{"description":"Balance sheet.\nThe keys in this object can be any of the fields listed in the Balance Sheet section of the \u003ca target=\"_blank\" href=\"https://massive.com/blog/financials-api-glossary-of-fields\"\u003efinancials API glossary of terms\u003c/a\u003e.","properties":{"*":{"description":"An individual financial data point.","properties":{"derived_from":{"description":"The list of report IDs (or errata) which were used to derive this data point.\nThis value is only returned for data points taken directly from XBRL when the `include_sources` query parameter is `true` and if source is SourceInterReportDerived.","items":{"type":"string"},"type":"array"},"formula":{"description":"The name of the formula used to derive this data point from other financial data points.\nInformation about the formulas can be found \u003ca rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"http://xbrlsite.azurewebsites.net/2020/reporting-scheme/us-gaap/fac/documentation/ImputeRulesList.html\"\u003ehere\u003c/a\u003e.\nThis value is only returned for data points that are not explicitly expressed within the XBRL source file when the `include_sources` query parameter is `true` and if source is SourceIntraReportImpute.","type":"string"},"label":{"description":"A human readable label for the financial data point.","type":"string"},"order":{"description":"An indicator of what order within the statement that you would find this data point.","type":"integer"},"source":{"description":"The source where this data point came from. This will be one of: SourceDirectReport, SourceIntraReportImpute or SourceInterReportDerived.","type":"string"},"unit":{"description":"The unit of the financial data point.","type":"string"},"value":{"description":"The value of the financial data point.","type":"number"},"xpath":{"description":"The \u003ca rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/XPath\"\u003eXPath 1.0\u003c/a\u003e query that identifies the fact from within the XBRL source file.\nThis value is only returned for data points taken directly from XBRL when the `include_sources` query parameter is `true` and if source is SourceDirectReport.","type":"string"}},"required":["label","order","value","unit"],"type":"object"}},"type":"object"},"cash_flow_statement":{"description":"Cash flow statement.\nThe keys in this object can be any of the fields listed in the Cash Flow Statement section of the \u003ca target=\"_blank\" href=\"https://massive.com/blog/financials-api-glossary-of-fields\"\u003efinancials API glossary of terms\u003c/a\u003e.\nSee the attributes of the objects within `balance_sheet` for more details.","type":"object"},"comprehensive_income":{"description":"Comprehensive income.\nThe keys in this object can be any of the fields listed in the Comprehensive Income section of the \u003ca target=\"_blank\" href=\"https://massive.com/blog/financials-api-glossary-of-fields\"\u003efinancials API glossary of terms\u003c/a\u003e.\nSee the attributes of the objects within `balance_sheet` for more details.","type":"object"},"income_statement":{"description":"Income statement.\nThe keys in this object can be any of the fields listed in the Income Statement section of the \u003ca target=\"_blank\" href=\"https://massive.com/blog/financials-api-glossary-of-fields\"\u003efinancials API glossary of terms\u003c/a\u003e.\nSee the attributes of the objects within `balance_sheet` for more details.","type":"object"}},"type":"object"},"fiscal_period":{"description":"Fiscal period of the report according to the company (Q1, Q2, Q3, Q4, or FY).","type":"string"},"fiscal_year":{"description":"Fiscal year of the report according to the company.","type":"string"},"sic":{"description":"The Standard Industrial Classification (SIC) code for the company.","type":"string"},"source_filing_file_url":{"description":"The URL of the specific XBRL instance document within the SEC filing that these financials were derived from.","type":"string"},"source_filing_url":{"description":"The URL of the SEC filing that these financials were derived from.","type":"string"},"start_date":{"description":"The start date of the period that these financials cover in YYYYMMDD format.","type":"string"},"tickers":{"description":"The list of ticker symbols for the company.","items":{"type":"string"},"type":"array"},"timeframe":{"description":"The timeframe of the report (quarterly, annual or ttm).","type":"string"}},"required":["cik","company_name","financials","timeframe","fiscal_period"],"type":"object","x-polygon-go-type":{"name":"FinancialReport"}},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"required":["status","request_id","count","results"],"type":"object"}}},"description":"FIXME"}},"summary":"Stock Financials vX","tags":["reference:stocks"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"},"x-polygon-experimental":{},"x-polygon-paginate":{"limit":{"default":10,"max":100},"sort":{"default":"period_of_report_date","enum":["filing_date","period_of_report_date"]}}}},"/vX/reference/ipos":{"get":{"description":"The IPOs API provides access to detailed information about Initial Public Offerings (IPOs), including both upcoming and historical events. With this API, you can query for a comprehensive list of IPOs, along with key details such as the issuer name, ticker symbol, ISIN, IPO date, number of shares offered, expected price range, and final offering price. You can filter the results by status to focus on new, rumors, pending, historical, and more.","operationId":"ListIPOs","parameters":[{"description":"Specify a case-sensitive ticker symbol. For example, TSLA represents Tesla Inc.","in":"query","name":"ticker","schema":{"type":"string"}},{"description":"Specify a us_code. This is a unique nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.","in":"query","name":"us_code","schema":{"type":"string"}},{"description":"Specify an International Securities Identification Number (ISIN). This is a unique twelve-digit code that is assigned to every security issuance in the world.","in":"query","name":"isin","schema":{"type":"string"}},{"description":"Specify a listing date. This is the first trading date for the newly listed entity.","in":"query","name":"listing_date","schema":{"format":"date","type":"string"},"x-polygon-filter-field":{"range":true,"type":"string"}},{"description":"Specify an IPO status.","in":"query","name":"ipo_status","schema":{"enum":["direct_listing_process","history","new","pending","postponed","rumor","withdrawn"],"type":"string"}},{"description":"Range by listing_date.","in":"query","name":"listing_date.gte","schema":{"format":"date","type":"string"}},{"description":"Range by listing_date.","in":"query","name":"listing_date.gt","schema":{"format":"date","type":"string"}},{"description":"Range by listing_date.","in":"query","name":"listing_date.lte","schema":{"format":"date","type":"string"}},{"description":"Range by listing_date.","in":"query","name":"listing_date.lt","schema":{"format":"date","type":"string"}},{"description":"Order results based on the `sort` field.","in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"example":"desc","type":"string"}},{"description":"Limit the number of results returned, default is 10 and max is 1000.","in":"query","name":"limit","schema":{"default":10,"example":10,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Sort field used for ordering.","in":"query","name":"sort","schema":{"default":"listing_date","enum":["listing_date","ticker","last_updated","security_type","issuer_name","currency_code","isin","us_code","final_issue_price","min_shares_offered","max_shares_offered","lowest_offer_price","highest_offer_price","total_offer_size","shares_outstanding","primary_exchange","lot_size","security_description","ipo_status","announced_date"],"example":"listing_date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"next_url":"https://api.massive.com/vX/reference/ipos?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy","request_id":"6a7e466379af0a71039d60cc78e72282","results":[{"announced_date":"2024-06-01","currency_code":"USD","final_issue_price":17,"highest_offer_price":17,"ipo_status":"history","isin":"US75383L1026","issue_end_date":"2024-06-06","issue_start_date":"2024-06-01","issuer_name":"Rapport Therapeutics Inc.","last_updated":"2024-06-27","listing_date":"2024-06-07","lot_size":100,"lowest_offer_price":17,"max_shares_offered":8000000,"min_shares_offered":1000000,"primary_exchange":"XNAS","security_description":"Ordinary Shares","security_type":"CS","shares_outstanding":35376457,"ticker":"RAPP","total_offer_size":136000000,"us_code":"75383L102"}],"status":"OK"},"schema":{"properties":{"next_url":{"description":"If present, this value can be used to fetch the next page of data.","type":"string"},"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"An array of results containing the requested data.","items":{"properties":{"announced_date":{"description":"The date when the IPO event was announced.","example":"2023-01-01","format":"date","type":"string"},"currency_code":{"description":"Underlying currency of the security.","example":"USD","type":"string"},"final_issue_price":{"description":"The price set by the company and its underwriters before the IPO goes live.","example":14.5,"format":"float","type":"number"},"highest_offer_price":{"description":"The highest price within the IPO price range that the company might use to price the shares.","example":20,"format":"float","type":"number"},"ipo_status":{"description":"The status of the IPO event. IPO events start out as status \"rumor\" or \"pending\". On listing day, the status changes to \"new\". After the listing day, the status changes to \"history\".\n\nThe status \"direct_listing_process\" corresponds to a type of offering where, instead of going through all the IPO processes, the company decides to list its shares directly on an exchange, without using an investment bank or other intermediaries. This is called a direct listing, direct placement, or direct public offering (DPO).","enum":["direct_listing_process","history","new","pending","postponed","rumor","withdrawn"],"example":"history","type":"string"},"isin":{"description":"International Securities Identification Number. This is a unique twelve-digit code that is assigned to every security issuance in the world.","example":"US0378331005","type":"string"},"issuer_name":{"description":"Name of issuer.","example":"Apple Inc.","type":"string"},"last_updated":{"description":"The date when the IPO event was last modified.","example":"2023-01-02","format":"date","type":"string"},"listing_date":{"description":"First trading date for the newly listed entity.","example":"2023-02-01","format":"date","type":"string"},"lot_size":{"description":"The minimum number of shares that can be bought or sold in a single transaction.","example":100,"type":"number"},"lowest_offer_price":{"description":"The lowest price within the IPO price range that the company is willing to offer its shares to investors.","example":10,"format":"float","type":"number"},"max_shares_offered":{"description":"The upper limit of the shares that the company is offering to investors.","example":1000,"type":"number"},"min_shares_offered":{"description":"The lower limit of shares that the company is willing to sell in the IPO.","example":1000,"type":"number"},"primary_exchange":{"description":"Market Identifier Code (MIC) of the primary exchange where the security is listed. The Market Identifier Code (MIC) (ISO 10383) is a unique identification code used to identify securities trading exchanges, regulated and non-regulated trading markets.","example":"XNAS","type":"string"},"security_description":{"description":"Description of the security.","example":"Ordinary Shares - Class A","type":"string"},"security_type":{"description":"The classification of the stock. For example, \"CS\" stands for Common Stock.","example":"CS","type":"string"},"shares_outstanding":{"description":"The total number of shares that the company has issued and are held by investors.","example":1000000,"type":"number"},"ticker":{"description":"The ticker symbol of the IPO event.","example":"TSLA","type":"string"},"total_offer_size":{"description":"The total amount raised by the company for IPO.","example":1000000,"format":"float","type":"number"},"us_code":{"description":"This is a unique nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.","example":37833100,"type":"string"}},"required":["last_updated","issuer_name","security_type","ipo_status","ticker"],"type":"object","x-polygon-go-type":{"name":"IPOsResult"}},"type":"array"},"status":{"description":"The status of this request's response.","type":"string"}},"type":"object"}}},"description":"A list of IPO events."}},"summary":"IPOs","tags":["reference:stocks:ipos"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"},"x-polygon-paginate":{"limit":{"default":10,"max":1000},"order":{"default":"desc","example":"desc"},"sort":{"default":"listing_date","enum":["listing_date","ticker","last_updated","security_type","issuer_name","currency_code","isin","us_code","final_issue_price","min_shares_offered","max_shares_offered","lowest_offer_price","highest_offer_price","total_offer_size","shares_outstanding","primary_exchange","lot_size","security_description","ipo_status","announced_date"]}}}},"/vX/reference/tickers/{id}/events":{"get":{"description":"Get a timeline of events for the entity associated with the given ticker, CUSIP, or Composite FIGI.","operationId":"GetEvents","parameters":[{"description":"Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive \nticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently \nrepresented by that ticker are returned. To find events for entities previously associated with a \nticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://massive.com/docs/rest/stocks/tickers/ticker-overview).","example":"META","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"A comma-separated list of the types of event to include. Currently ticker_change is the only supported event_type.\nLeave blank to return all supported event_types.","in":"query","name":"types","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"31d59dda-80e5-4721-8496-d0d32a654afe","results":{"events":[{"date":"2022-06-09","ticker_change":{"ticker":"META"},"type":"ticker_change"},{"date":"2012-05-18","ticker_change":{"ticker":"FB"},"type":"ticker_change"}],"name":"Meta Platforms, Inc. Class A Common Stock"},"status":"OK"},"schema":{"properties":{"request_id":{"description":"A request id assigned by the server.","type":"string"},"results":{"description":"Contains the requested event data for the specified ticker.","properties":{"events":{"description":"An array of event containing the requested data.","items":{"oneOf":[{"properties":{"date":{"description":"The date the event took place","format":"date","type":"string"},"event_type":{"description":"The type of historical event for the asset","type":"string"},"ticker_change":{"description":"Details about a ticker change","properties":{"ticker":{"description":"A ticker symbol","type":"string"}},"type":"object"}},"required":["event_type","date"],"type":"object"}]},"type":"array"},"name":{"description":"The name of the asset.","type":"string"}},"type":"object","x-polygon-go-type":{"name":"EventsResults"}},"status":{"description":"The status of this request's response.","type":"string"}},"type":"object"}}},"description":"Ticker Events."},"401":{"description":"Unauthorized - Check our API Key and account status"}},"summary":"Ticker Events","tags":["reference:tickers:get"],"x-polygon-entitlement-data-type":{"description":"Reference data","name":"reference"},"x-polygon-experimental":{}}}},"security":[{"apiKey":[]}],"servers":[{"description":"Massive Platform API","url":"https://api.massive.com"},{"description":"Massive Platform API (Staging)","url":"https://api.staging.massive.com"}],"tags":[{"description":"Reference API","name":"reference","x-polygon-sub-tags":["tickers:list","tickers:types","tickers:get","options:contracts:list","news","tickers","stocks","sec:filings","sec:filing","sec:filing:files","sec:filing:file","stocks:market","conditions","stocks:meta:exchanges","crypto","exchanges"]},{"description":"Stocks API","name":"stocks","x-polygon-sub-tags":["trades","quotes","last:trade","last:quote","open-close","aggregates","snapshot"]},{"description":"Options API","name":"options","x-polygon-sub-tags":["trades","quotes","last:trade","last:quote","open-close","aggregates","snapshot"]},{"description":"Forex API","name":"fx","x-polygon-sub-tags":["trades","quotes","conversion","last:trade","last:quote","aggregates","snapshot"]},{"description":"Crypto API","name":"crypto","x-polygon-sub-tags":["trades","last:trade","open-close","aggregates","snapshot"]},{"description":"Indices API","name":"indices","x-polygon-sub-tags":["trades","last:trade","open-close","aggregates","snapshot"]}],"x-polygon-order":{"crypto":{"market":[{"launchpad":"shared","paths":["/v2/aggs/ticker/{cryptoTicker}/range/{multiplier}/{timespan}/{from}/{to}"]},{"launchpad":"exclusive","paths":["/v1/summaries"]},{"paths":["/v2/aggs/grouped/locale/global/market/crypto/{date}"]},{"paths":["/v1/open-close/crypto/{from}/{to}/{date}"]},{"paths":["/v2/aggs/ticker/{cryptoTicker}/prev"]},{"paths":["/v3/trades/{cryptoTicker}"]},{"paths":["/v1/historic/crypto/{from}/{to}/{date}"]},{"paths":["/v1/last/crypto/{from}/{to}"]},{"group":"Snapshots","paths":["/v2/snapshot/locale/global/markets/crypto/tickers","/v2/snapshot/locale/global/markets/crypto/{direction}","/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}","/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}/book","/v3/snapshot"]},{"group":"Technical Indicators","paths":["/v1/indicators/sma/{cryptoTicker}","/v1/indicators/ema/{cryptoTicker}","/v1/indicators/macd/{cryptoTicker}","/v1/indicators/rsi/{cryptoTicker}"]}],"reference":[{"paths":["/v3/reference/tickers"]},{"paths":["/v1/marketstatus/upcoming"]},{"paths":["/v1/marketstatus/now"]},{"paths":["/v3/reference/conditions"]},{"paths":["/v3/reference/exchanges"]}]},"fx":{"market":[{"launchpad":"shared","paths":["/v2/aggs/ticker/{forexTicker}/range/{multiplier}/{timespan}/{from}/{to}"]},{"launchpad":"exclusive","paths":["/v1/summaries"]},{"paths":["/v2/aggs/grouped/locale/global/market/fx/{date}"]},{"paths":["/v2/aggs/ticker/{forexTicker}/prev"]},{"paths":["/v3/quotes/{fxTicker}"]},{"paths":["/v1/historic/forex/{from}/{to}/{date}"]},{"paths":["/v1/last_quote/currencies/{from}/{to}"]},{"paths":["/v1/conversion/{from}/{to}"]},{"group":"Snapshots","paths":["/v2/snapshot/locale/global/markets/forex/tickers","/v2/snapshot/locale/global/markets/forex/{direction}","/v2/snapshot/locale/global/markets/forex/tickers/{ticker}","/v3/snapshot"]},{"group":"Technical Indicators","paths":["/v1/indicators/sma/{fxTicker}","/v1/indicators/ema/{fxTicker}","/v1/indicators/macd/{fxTicker}","/v1/indicators/rsi/{fxTicker}"]}],"reference":[{"paths":["/v3/reference/tickers"]},{"paths":["/v1/marketstatus/upcoming"]},{"paths":["/v1/marketstatus/now"]},{"paths":["/v3/reference/conditions"]},{"paths":["/v3/reference/exchanges"]}]},"indices":{"market":[{"launchpad":"shared","paths":["/v2/aggs/ticker/{indicesTicker}/range/{multiplier}/{timespan}/{from}/{to}"]},{"paths":["/v2/aggs/ticker/{indicesTicker}/prev"]},{"paths":["/v1/open-close/{indicesTicker}/{date}"]},{"group":"Technical Indicators","paths":["/v1/indicators/sma/{indicesTicker}","/v1/indicators/ema/{indicesTicker}","/v1/indicators/macd/{indicesTicker}","/v1/indicators/rsi/{indicesTicker}"]},{"group":"Snapshots","paths":["/v3/snapshot/indices","/v3/snapshot"]}],"reference":[{"paths":["/v3/reference/tickers"]},{"paths":["/v3/reference/tickers/types"]},{"paths":["/v1/marketstatus/upcoming"]},{"paths":["/v1/marketstatus/now"]}]},"options":{"market":[{"launchpad":"shared","paths":["/v2/aggs/ticker/{optionsTicker}/range/{multiplier}/{timespan}/{from}/{to}"]},{"launchpad":"exclusive","paths":["/v1/summaries"]},{"paths":["/v1/open-close/{optionsTicker}/{date}"]},{"paths":["/v2/aggs/ticker/{optionsTicker}/prev"]},{"paths":["/v3/trades/{optionsTicker}"]},{"paths":["/v2/last/trade/{optionsTicker}"]},{"paths":["/v3/quotes/{optionsTicker}"]},{"group":"Snapshots","paths":["/v3/snapshot/options/{underlyingAsset}/{optionContract}","/v3/snapshot/options/{underlyingAsset}","/v3/snapshot"]},{"group":"Technical Indicators","paths":["/v1/indicators/sma/{optionsTicker}","/v1/indicators/ema/{optionsTicker}","/v1/indicators/macd/{optionsTicker}","/v1/indicators/rsi/{optionsTicker}"]}],"reference":[{"paths":["/v3/reference/options/contracts/{options_ticker}"]},{"paths":["/v3/reference/options/contracts"]},{"paths":["/v3/reference/tickers"]},{"paths":["/v1/meta/symbols/{stocksTicker}/company"]},{"paths":["/v3/reference/tickers/{ticker}"]},{"paths":["/v2/reference/news"]},{"paths":["/v3/reference/tickers/types"]},{"paths":["/v1/marketstatus/upcoming"]},{"paths":["/v1/marketstatus/now"]},{"paths":["/v3/reference/conditions"]},{"paths":["/v3/reference/exchanges"]}]},"stocks":{"market":[{"launchpad":"shared","paths":["/v2/aggs/ticker/{stocksTicker}/range/{multiplier}/{timespan}/{from}/{to}"]},{"launchpad":"exclusive","paths":["/v1/summaries"]},{"paths":["/v2/aggs/grouped/locale/us/market/stocks/{date}"]},{"paths":["/v1/open-close/{stocksTicker}/{date}"]},{"paths":["/v2/aggs/ticker/{stocksTicker}/prev"]},{"paths":["/v3/trades/{stockTicker}"]},{"paths":["/v2/ticks/stocks/trades/{ticker}/{date}"]},{"paths":["/v2/last/trade/{stocksTicker}"]},{"paths":["/v3/quotes/{stockTicker}"]},{"paths":["/v2/ticks/stocks/nbbo/{ticker}/{date}"]},{"paths":["/v2/last/nbbo/{stocksTicker}"]},{"group":"Snapshots","paths":["/v2/snapshot/locale/us/markets/stocks/tickers","/v2/snapshot/locale/us/markets/stocks/{direction}","/v2/snapshot/locale/us/markets/stocks/tickers/{stocksTicker}","/v3/snapshot"]},{"group":"Technical Indicators","paths":["/v1/indicators/sma/{stockTicker}","/v1/indicators/ema/{stockTicker}","/v1/indicators/macd/{stockTicker}","/v1/indicators/rsi/{stockTicker}"]},{"paths":["/futures/vX/quotes/{ticker}"]},{"paths":["/futures/vX/trades/{ticker}"]},{"paths":["/futures/vX/snapshot"]}],"reference":[{"paths":["/v3/reference/tickers"]},{"paths":["/v1/meta/symbols/{stocksTicker}/company"]},{"paths":["/v3/reference/tickers/{ticker}"]},{"paths":["/vX/reference/tickers/{id}/events"]},{"paths":["/v2/reference/news"]},{"paths":["/v3/reference/tickers/types"]},{"paths":["/vX/reference/tickers/taxonomies"]},{"paths":["/v1/marketstatus/upcoming"]},{"paths":["/v1/marketstatus/now"]},{"group":"SEC Filings","paths":["/v1/reference/sec/filings","/v1/reference/sec/filings/{filing_id}","/v1/reference/sec/filings/{filing_id}/files","/v1/reference/sec/filings/{filing_id}/files/{file_id}"]},{"paths":["/v3/reference/splits"]},{"paths":["/v3/reference/dividends"]},{"paths":["/vX/reference/financials"]},{"paths":["/v3/reference/conditions"]},{"paths":["/v3/reference/exchanges"]},{"paths":["/v1/related-companies/{ticker}"]},{"paths":["/vX/reference/ipos"]},{"paths":["/vX/reference/short-interest/{identifier_type}/{identifier}"]},{"paths":["/futures/vX/contracts"]},{"paths":["/futures/vX/schedules"]},{"paths":["/futures/vX/products"]},{"paths":["/futures/vX/market-status"]},{"paths":["stocks/vX/listings","stocks/vX/listing/{identifier_type}/{identifier}","stocks/vX/listings/updates"]}]}}}