openapi: 3.0.3
info:
title: 'Mboum - API Documentation'
description: 'Market and crypto API documentation for mboum.com, including endpoints, parameters, and examples.'
version: 1.0.0
servers:
-
url: 'https://api.mboum.com'
paths:
/api/v1/markets/search:
get:
summary: 'GET /v1/search'
operationId: gETv1search
description: "\n\nSearches tickers by symbol or company name. Each match includes the symbol, name, exchange, and asset type, such as equity, ETF, mutual fund, or cryptocurrency. A newer version is available at /v2/search."
parameters:
-
in: query
name: search
description: 'Symbol or company name to look up, up to 255 characters.'
example: AA
required: true
schema:
type: string
description: 'Symbol or company name to look up, up to 255 characters.'
example: AA
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"symbol\": \"mu\",\n \"processedTime\": \"2023-08-11T00:11:21.369821Z\"\n },\n \"body\": [\n {\n \"symbol\": \"MU\",\n \"name\": \"Micron Technology, Inc.\",\n \"exch\": \"NAS\",\n \"type\": \"S\",\n \"exchDisp\": \"NASDAQ\",\n \"typeDisp\": \"Equity\"\n },\n {\n \"symbol\": \"MULN\",\n \"name\": \"Mullen Automotive, Inc.\",\n \"exch\": \"NGM\",\n \"type\": \"S\",\n \"exchDisp\": \"NASDAQ\",\n \"typeDisp\": \"Equity\"\n },\n {...}\n ]\n }"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/movers:
get:
summary: 'GET /v1/movers'
operationId: gETv1movers
description: "\n\nReturns the current session's market movers for one asset class, grouped into tables: most active by share volume, most advanced, most declined, and most active by dollar volume. Each row has the symbol, name, last price, and change."
parameters:
-
in: query
name: type
description: 'Asset class: STOCKS, ETF, MUTUALFUNDS, or FUTURES (case-insensitive).'
example: ETF
required: true
schema:
type: string
description: 'Asset class: STOCKS, ETF, MUTUALFUNDS, or FUTURES (case-insensitive).'
example: ETF
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\"\n },\n \"body\": {\n \"MostActiveByShareVolume\": {\n \"dataAsOf\": \"Data as of Jan 26, 2024 3:38 PM ET\",\n \"lastTradeTimestamp\": \"Jan 26, 2024 3:38 PM ET\",\n \"table\": {\n \"asOf\": null,\n \"headers\": {\n \"symbol\": \"Symbol\",\n \"name\": \"Name\",\n \"lastSalePrice\": \"Last\",\n \"lastSaleChange\": \"Change\",\n \"change\": \"Share Volume\"\n },\n \"rows\": [\n {\n \"symbol\": \"INTC\",\n \"name\": \"Intel Corporation\",\n \"lastSalePrice\": \"$43.60\",\n \"lastSaleChange\": \"-5.94\",\n \"change\": \"102,855,698\",\n \"deltaIndicator\": \"down\"\n },\n {\n \"symbol\": \"AMD\",\n \"name\": \"Advanced Micro Devices, Inc.\",\n \"lastSalePrice\": \"$177.42\",\n \"lastSaleChange\": \"-2.91\",\n \"change\": \"96,179,033\",\n \"deltaIndicator\": \"down\"\n },\n ...\n ]\n }\n },\n \"MostAdvanced\": {\n \"dataAsOf\": \"Data as of Jan 26, 2024 3:38 PM ET\",\n \"lastTradeTimestamp\": \"Jan 26, 2024 3:38 PM ET\",\n \"table\": {\n \"asOf\": null,\n \"headers\": {\n \"symbol\": \"Symbol\",\n \"name\": \"Name\",\n \"lastSalePrice\": \"Last\",\n \"lastSaleChange\": \"Change\",\n \"change\": \"% Change\"\n },\n \"rows\": [\n {\n \"symbol\": \"RTC\",\n \"name\": \"Baijiayun Group Ltd\",\n \"lastSalePrice\": \"$6.25\",\n \"lastSaleChange\": \"+2.03\",\n \"change\": \"+48.1%\",\n \"deltaIndicator\": \"up\"\n },\n {\n \"symbol\": \"APPF\",\n \"name\": \"AppFolio, Inc.\",\n \"lastSalePrice\": \"$224\",\n \"lastSaleChange\": \"+49.62\",\n \"change\": \"+28.46%\",\n \"deltaIndicator\": \"up\"\n },\n ...\n ]\n }\n },\n \"MostDeclined\": {\n \"dataAsOf\": \"Data as of Jan 26, 2024 3:38 PM ET\",\n \"lastTradeTimestamp\": \"Jan 26, 2024 3:38 PM ET\",\n \"table\": {\n \"asOf\": null,\n \"headers\": {\n \"symbol\": \"Symbol\",\n \"name\": \"Name\",\n \"lastSalePrice\": \"Last\",\n \"lastSaleChange\": \"Change\",\n \"change\": \"% Change\"\n },\n \"rows\": [\n {\n \"symbol\": \"LGST\",\n \"name\": \"Semper Paratus Acquisition Corporation\",\n \"lastSalePrice\": \"$7.34\",\n \"lastSaleChange\": \"-3.70\",\n \"change\": \"-33.57%\",\n \"deltaIndicator\": \"down\"\n },\n {\n \"symbol\": \"SGMT\",\n \"name\": \"Sagimet Biosciences Inc.\",\n \"lastSalePrice\": \"$10.43\",\n \"lastSaleChange\": \"-3.59\",\n \"change\": \"-25.61%\",\n \"deltaIndicator\": \"down\"\n },\n ...\n ]\n }\n },\n \"MostActiveByDollarVolume\": {\n \"dataAsOf\": \"Data as of Jan 26, 2024 3:37 PM ET\",\n \"lastTradeTimestamp\": \"Jan 26, 2024 3:37 PM ET\",\n \"table\": {\n \"asOf\": null,\n \"headers\": {\n \"symbol\": \"Symbol\",\n \"name\": \"Name\",\n \"lastSalePrice\": \"Last\",\n \"lastSaleChange\": \"Change\",\n \"change\": \"% Change\"\n },\n \"rows\": [\n {\n \"symbol\": \"NVDA\",\n \"name\": \"NVIDIA Corporation\",\n \"lastSalePrice\": \"$610.44\",\n \"lastSaleChange\": \"-5.72\",\n \"change\": \"-0.93%\",\n \"deltaIndicator\": \"down\"\n },\n {\n \"symbol\": \"TSLA\",\n \"name\": \"Tesla, Inc.\",\n \"lastSalePrice\": \"$183.17\",\n \"lastSaleChange\": \"+0.54\",\n \"change\": \"+0.3%\",\n \"deltaIndicator\": \"up\"\n },\n ...\n ]\n }\n },\n \"Nasdaq100Movers\": {\n \"dataAsOf\": \"Data as of Jan 26, 2024 3:56 PM ET\",\n \"lastTradeTimestamp\": \"Jan 26, 2024 3:56 PM ET\",\n \"table\": {\n \"asOf\": null,\n \"headers\": {\n \"symbol\": \"Symbol\",\n \"name\": \"Name\",\n \"lastSalePrice\": \"Last\",\n \"lastSaleChange\": \"Change\",\n \"change\": \"% Change\"\n },\n \"rows\": [\n {\n \"symbol\": \"ADBE\",\n \"name\": \"Adobe Inc.\",\n \"lastSalePrice\": \"614.1\",\n \"lastSaleChange\": \"-8.48\",\n \"change\": \"-1.36%\",\n \"deltaIndicator\": \"down\"\n },\n {\n \"symbol\": \"AMD\",\n \"name\": \"Advanced Micro Devices, Inc.\",\n \"lastSalePrice\": \"177.435\",\n \"lastSaleChange\": \"-2.895\",\n \"change\": \"-1.61%\",\n \"deltaIndicator\": \"down\"\n },\n ...\n ]\n }\n }\n }\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/screener:
get:
summary: 'GET /v1/screener'
operationId: gETv1screener
description: "\n\nReturns the stocks or ETFs in a predefined screener list, with quote data for each. A newer version is available at /v2/screener."
parameters:
-
in: query
name: list
description: "Name of the predefined list. Accepted values:\n - **trending**: Symbols currently trending in the US market. Returns symbols only and ignores `offset`.\n - **topetfs**: US ETFs ordered by percent change.\n - **undervalued_growth_stocks**: Stocks with earnings growth above 25% and relatively low P/E and PEG ratios.\n - **growth_technology_stocks**: Technology stocks with revenue and earnings growth above 25%.\n - **day_gainers**: Stocks sorted by percent change from the previous close, highest first.\n - **day_losers**: Stocks sorted by percent change from the previous close, lowest first.\n - **most_actives**: Stocks sorted by intraday volume, highest first.\n - **undervalued_large_caps**: Large-cap stocks that are potentially undervalued.\n - **aggressive_small_caps**: Small-cap stocks with earnings growth above 25%.\n - **small_cap_gainers**: Small-cap stocks up 5% or more on the day."
example: day_gainers
required: true
schema:
type: string
description: "Name of the predefined list. Accepted values:\n - **trending**: Symbols currently trending in the US market. Returns symbols only and ignores `offset`.\n - **topetfs**: US ETFs ordered by percent change.\n - **undervalued_growth_stocks**: Stocks with earnings growth above 25% and relatively low P/E and PEG ratios.\n - **growth_technology_stocks**: Technology stocks with revenue and earnings growth above 25%.\n - **day_gainers**: Stocks sorted by percent change from the previous close, highest first.\n - **day_losers**: Stocks sorted by percent change from the previous close, lowest first.\n - **most_actives**: Stocks sorted by intraday volume, highest first.\n - **undervalued_large_caps**: Large-cap stocks that are potentially undervalued.\n - **aggressive_small_caps**: Small-cap stocks with earnings growth above 25%.\n - **small_cap_gainers**: Small-cap stocks up 5% or more on the day."
example: day_gainers
-
in: query
name: offset
description: 'Zero-based position of the first result, used to page through the list. Defaults to 0.'
example: 10
required: true
schema:
type: integer
description: 'Zero-based position of the first result, used to page through the list. Defaults to 0.'
example: 10
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"description\": \"most_actives\",\n \"processedTime\": \"2023-08-10T10:49:27.251123Z\",\n \"offset\": 0,\n \"count\": 25,\n \"total\": 200,\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\"\n },\n \"body\": [\n {\n \"language\": \"en-US\",\n \"region\": \"US\",\n \"quoteType\": \"EQUITY\",\n \"typeDisp\": \"Equity\",\n \"quoteSourceName\": \"Nasdaq Real Time Price\",\n \"triggerable\": false,\n \"customPriceAlertConfidence\": \"LOW\",\n \"lastClosePriceToNNWCPerShare\": 16.553095993152954,\n \"currency\": \"USD\",\n \"regularMarketDayLow\": 15.1,\n \"regularMarketVolume\": 124080792,\n \"regularMarketPreviousClose\": 17.04,\n \"bid\": 0,\n \"ask\": 0,\n \"bidSize\": 418,\n \"askSize\": 14,\n \"market\": \"us_market\",\n \"messageBoardId\": \"finmb_43580005\",\n \"fullExchangeName\": \"NYSE\",\n \"longName\": \"Palantir Technologies Inc.\",\n \"financialCurrency\": \"USD\",\n \"regularMarketOpen\": 16.76,\n \"averageDailyVolume3Month\": 85510943,\n \"averageDailyVolume10Day\": 102521260,\n \"fiftyTwoWeekLowChange\": 9.33,\n \"fiftyTwoWeekLowChangePercent\": 1.5760134,\n \"fiftyTwoWeekRange\": \"5.92 - 20.24\",\n \"fiftyTwoWeekHighChange\": -4.99,\n \"fiftyTwoWeekHighChangePercent\": -0.2465415,\n \"fiftyTwoWeekChangePercent\": 61.889603,\n \"earningsTimestamp\": 1691442000,\n \"earningsTimestampStart\": 1699277400,\n \"earningsTimestampEnd\": 1699623000,\n \"trailingAnnualDividendRate\": 0,\n \"trailingAnnualDividendYield\": 0,\n \"marketState\": \"PRE\",\n \"epsTrailingTwelveMonths\": -0.12,\n \"epsForward\": 0.26,\n \"epsCurrentYear\": 0.22,\n \"priceEpsCurrentYear\": 69.318184,\n \"sharesOutstanding\": 2013760000,\n \"bookValue\": 1.222,\n \"fiftyDayAverage\": 16.1592,\n \"fiftyDayAverageChange\": -0.90920067,\n \"fiftyDayAverageChangePercent\": -0.0562652,\n \"twoHundredDayAverage\": 10.072,\n \"twoHundredDayAverageChange\": 5.1780005,\n \"twoHundredDayAverageChangePercent\": 0.5140986,\n \"marketCap\": 32306208768,\n \"forwardPE\": 58.653847,\n \"priceToBook\": 12.479542,\n \"sourceInterval\": 15,\n \"exchangeDataDelayedBy\": 0,\n \"exchangeTimezoneName\": \"America/New_York\",\n \"exchangeTimezoneShortName\": \"EDT\",\n \"gmtOffSetMilliseconds\": -14400000,\n \"ipoExpectedDate\": \"2020-09-29\",\n \"esgPopulated\": false,\n \"tradeable\": false,\n \"cryptoTradeable\": false,\n \"firstTradeDateMilliseconds\": 1601472600000,\n \"priceHint\": 2,\n \"preMarketChange\": 0.03999996,\n \"preMarketChangePercent\": 0.26229483,\n \"preMarketTime\": 1691664430,\n \"preMarketPrice\": 15.29,\n \"regularMarketChange\": -1.7900009,\n \"regularMarketTime\": 1691611202,\n \"regularMarketPrice\": 15.25,\n \"regularMarketDayHigh\": 16.92,\n \"regularMarketDayRange\": \"15.1 - 16.92\",\n \"averageAnalystRating\": \"3.3 - Hold\",\n \"regularMarketChangePercent\": -10.5047,\n \"exchange\": \"NYQ\",\n \"fiftyTwoWeekLow\": 5.92,\n \"fiftyTwoWeekHigh\": 20.24,\n \"shortName\": \"Palantir Technologies Inc.\",\n \"displayName\": \"Palantir\",\n \"symbol\": \"PLTR\"\n },\n {...}\n ]\n}\n"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/insider-trades:
get:
summary: 'GET /v1/insider-trades hot!'
operationId: gETv1insiderTradessmallStylecolorf8f2f2backgroundfa256fpadding1px4pxborderRadius3pxhotsmall
description: "\n\nReturns insider transactions at US-listed companies from the last three months, newest first, 100 per page. Each row includes the insider's name and title, transaction type, share amount, reported price, dollar value, holdings after the trade, and transaction date. Use `politiciansOnly` to limit results to trades disclosed by US politicians or to exclude them."
parameters:
-
in: query
name: ticker
description: "Limit results to one company's ticker symbol. You can send `symbol` instead."
example: null
required: false
schema:
type: string
description: "Limit results to one company's ticker symbol. You can send `symbol` instead."
example: null
-
in: query
name: type
description: 'Transaction type: Award, Buy, Sell, or Transfer. Defaults to all four.'
example: null
required: false
schema:
type: string
description: 'Transaction type: Award, Buy, Sell, or Transfer. Defaults to all four.'
example: null
-
in: query
name: minValue
description: 'Minimum transaction value in US dollars, as a whole number from 10000 to 1000000. Defaults to 10000.
'
example: '10000'
required: false
schema:
type: string
description: 'Minimum transaction value in US dollars, as a whole number from 10000 to 1000000. Defaults to 10000.
'
example: '10000'
-
in: query
name: politiciansOnly
description: 'Set to true for trades by political figures only, or false to exclude US Congressmen and Senators. Omit it to include everyone.'
example: null
required: false
schema:
type: string
description: 'Set to true for trades by political figures only, or false to exclude US Congressmen and Senators. Omit it to include everyone.'
example: null
-
in: query
name: page
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"count\": 50,\n \"total\": 477,\n \"page\": \"2\"\n },\n \"body\": [\n {\n \"transactionDate\": \"01/24/24\",\n \"firstName\": \"Joshua\",\n \"lastName\": \"Gottheimer\",\n \"shortJobTitle\": \"US Congressman\",\n \"symbol\": \"LAD\",\n \"symbolShortName\": \"Lithia Motors\",\n \"usdValue\": \"8,000\",\n \"transactionType\": \"Sell\",\n \"noteText\": \"Traded $1,001 to $15,000 (we have used the midpoint and the close price on the last day of trade to estimate the amount of shares).\",\n \"symbolCode\": \"STK\",\n \"hasOptions\": \"Yes\",\n \"symbolType\": 1\n },\n {\n \"transactionDate\": \"01/24/24\",\n \"firstName\": \"Joshua\",\n \"lastName\": \"Gottheimer\",\n \"shortJobTitle\": \"US Congressman\",\n \"symbol\": \"CHRD\",\n \"symbolShortName\": \"Chord Energy C\",\n \"usdValue\": \"8,000\",\n \"transactionType\": \"Buy\",\n \"noteText\": \"Traded $1,001 to $15,000 (we have used the midpoint and the close price on the last day of trade to estimate the amount of shares).\",\n \"symbolCode\": \"STK\",\n \"hasOptions\": \"Yes\",\n \"symbolType\": 1\n },\n {...}\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/news:
get:
summary: 'GET /v1/news'
operationId: gETv1news
description: "\n\nReturns recent news headlines for one or more tickers. Without a ticker, it returns up to 20 general stock market headlines. Each item has a title, link, publish date, description, and unique ID."
parameters:
-
in: query
name: ticker
description: 'Ticker symbol, or several separated by commas. You can send `symbol` instead. Omit it for general market news.'
example: 'AAPL,TSLA'
required: false
schema:
type: string
description: 'Ticker symbol, or several separated by commas. You can send `symbol` instead. Omit it for general market news.'
example: 'AAPL,TSLA'
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "[\n {\n \"description\": \"STOCKSTOWATCHTODAY BLOG Apple stock finally ended its post-earnings losing streak on Tuesday only to begin a new one on Wednesday. Donโt be surprised if it keeps falling. Yes, it might be tempting to buy the Apple dip.\",\n \"guid\": \"add44664-1841-3deb-b939-03622143ab97\",\n \"link\": \"https://finance.yahoo.com/m/add44664-1841-3deb-b939-03622143ab97/apple-stock-fell-again.-where.html?.tsrc=rss\",\n \"pubDate\": \"Wed, 09 Aug 2023 21:38:00 +0000\",\n \"title\": \"Apple Stock Fell Again. Where It Might Be Headed Next.\"\n },\n {\n \"description\": \"The Supreme Court dealt a setback to video game publisher Epic in its battle against Apple over how the iPhone giant treats developers that sell programs on the App store.\",\n \"guid\": \"e3329cf7-c056-39f0-acb8-0054a20ff98e\",\n \"link\": \"https://finance.yahoo.com/m/e3329cf7-c056-39f0-acb8-0054a20ff98e/supreme-court-says-apple-can.html?.tsrc=rss\",\n \"pubDate\": \"Wed, 09 Aug 2023 21:33:19 +0000\",\n \"title\": \"Supreme Court Says Apple Can Keep Its Store Payment Rules, For Now\"\n },\n {...}\n ]"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/search:
get:
summary: 'GET /v2/search'
operationId: gETv2search
description: "\n\nSearches U.S.-listed securities, including stocks, ETFs, and mutual funds, by ticker or company name. Returns up to 10 matches with each symbol, name, exchange, and asset class. Use it to look up the exact ticker and asset type before calling the quote and summary endpoints."
parameters:
-
in: query
name: search
description: 'Ticker or company name to search for, up to 255 characters.'
example: AA
required: true
schema:
type: string
description: 'Ticker or company name to search for, up to 255 characters.'
example: AA
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\"\n },\n \"body\": [\n {\n \"symbol\": \"AA\",\n \"name\": \"Alcoa Corporation Common Stock\",\n \"exchange\": \"NYSE\",\n \"subCategory\": \"Common Stock\",\n \"region\": \"North America\",\n \"asset\": \"STOCKS\",\n \"industry\": \"Industrial Products\",\n \"flag\": \"\"\n },\n {\n \"symbol\": \"AAA\",\n \"name\": \"AXS First Priority CLO Bond ETF\",\n \"exchange\": \"PSE\",\n \"subCategory\": \"\",\n \"region\": \"north-america\",\n \"asset\": \"ETF\",\n \"industry\": \"N Products\",\n \"flag\": \"\"\n },\n {\n \"symbol\": \"AAAAX\",\n \"name\": \"DWS RREEF Real Assets Fund - Class A\",\n \"exchange\": \"\",\n \"subCategory\": \"MF\",\n \"region\": \"North America\",\n \"asset\": \"MUTUALFUNDS\",\n \"industry\": \"\",\n \"flag\": \"\"\n },\n {\n \"symbol\": \"AAACX\",\n \"name\": \"Alpha Alternative Assets Fund\",\n \"exchange\": \"\",\n \"subCategory\": \"MF\",\n \"region\": \"North America\",\n \"asset\": \"MUTUALFUNDS\",\n \"industry\": \"\",\n \"flag\": \"\"\n },\n { ... }\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/movers:
get:
summary: 'GET /v2/movers'
operationId: gETv2movers
description: "\n\nReturns the U.S. stocks with the largest gains or losses in the current or most recent session, limited to stocks that have listed options. Each row includes price, change, volume, market cap, and basic fundamentals. Results come 20 per page; `meta` holds `count`, `total`, and `page`."
parameters:
-
in: query
name: change_type
description: 'How to rank movers: PERCENT (percent change), PRICE (dollar change), or GAP (opening price gap). Case-insensitive; defaults to PERCENT if omitted.'
example: PERCENT
required: true
schema:
type: string
description: 'How to rank movers: PERCENT (percent change), PRICE (dollar change), or GAP (opening price gap). Case-insensitive; defaults to PERCENT if omitted.'
example: PERCENT
-
in: query
name: direction
description: 'UP for gainers or DOWN for decliners. Case-insensitive; defaults to UP.'
example: UP
required: false
schema:
type: string
description: 'UP for gainers or DOWN for decliners. Case-insensitive; defaults to UP.'
example: UP
-
in: query
name: price_min
description: 'Whole-number price filter between -5000 and 5000. A positive value keeps stocks priced above it; a negative value keeps stocks priced below its absolute value.'
example: null
required: false
schema:
type: string
description: 'Whole-number price filter between -5000 and 5000. A positive value keeps stocks priced above it; a negative value keeps stocks priced below its absolute value.'
example: null
-
in: query
name: page
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"count\": 20,\n \"total\": 200,\n \"page\": 1\n },\n \"body\": [\n {\n \"symbol\": \"HELE\",\n \"symbolName\": \"Helen of Troy Ltd\",\n \"lastPrice\": \"73.79\",\n \"priceChange\": \"+11.42\",\n \"percentChange\": \"+18.31%\",\n \"volume\": \"2,418,808\",\n \"marketCap\": \"1,422,846\",\n \"enterpriseValue\": \"2,070,016\",\n \"sharesOutstanding\": \"22,813\",\n \"annualSales\": \"2,005,050,000\",\n \"annualNetIncome\": \"168,590,000\",\n \"lastQuarterSales\": \"416,850,000\",\n \"lastQuarterIncome\": \"6,200,000\",\n \"beta\": \"0.86\",\n \"percentInsider\": \"0.39%\",\n \"percentInstitutional\": \"N/A\",\n \"float\": \"22,724\",\n \"floatPercentage\": \"99.61%\",\n \"revenueGrowth5y\": \"28.19%\",\n \"ebit\": \"250,710,000\",\n \"ebitda\": \"303,440,000\",\n \"tradeTime\": \"13:24 ET\",\n \"symbolCode\": \"STK\",\n \"symbolType\": 1,\n \"hasOptions\": \"Yes\"\n },\n { ... }\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/tickers:
get:
summary: 'GET /v2/tickers new!'
operationId: gETv2tickerssmallStylecolor2c1e1ebackground15f07apadding1px4pxborderRadius3pxnewsmall
description: "\n\nLists ticker symbols for one U.S. security type, 25 per page. Use it to build or refresh a symbol list. `meta.totalrecords` gives the total count and `meta.headers` names the columns in each row."
parameters:
-
in: query
name: type
description: 'Security type to list: STOCKS, ETF, MUTUALFUNDS, FUTURES, or INDEX. Case-insensitive.'
example: STOCKS
required: true
schema:
type: string
description: 'Security type to list: STOCKS, ETF, MUTUALFUNDS, FUTURES, or INDEX. Case-insensitive.'
example: STOCKS
-
in: query
name: page
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"totalrecords\": 7249,\n \"headers\": {\n \"symbol\": \"Symbol\",\n \"name\": \"Name\",\n \"lastsale\": \"Last Sale\",\n \"netchange\": \"Net Change\",\n \"pctchange\": \"% Change\",\n \"marketCap\": \"Market Cap\"\n }\n },\n \"body\": [\n {\n \"symbol\": \"AAPL\",\n \"name\": \"Apple Inc. Common Stock\",\n \"lastsale\": \"$185.795\",\n \"netchange\": \"-1.065\",\n \"pctchange\": \"-0.57%\",\n \"marketCap\": \"2,872,742,967,320\"\n },\n {\n \"symbol\": \"AMZN\",\n \"name\": \"Amazon.com, Inc. Common Stock\",\n \"lastsale\": \"$171.97\",\n \"netchange\": \"12.69\",\n \"pctchange\": \"7.967%\",\n \"marketCap\": \"1,777,143,239,874\"\n },\n {\n \"symbol\": \"GOOG\",\n \"name\": \"Alphabet Inc. Class C Capital Stock\",\n \"lastsale\": \"$142.82\",\n \"netchange\": \"0.11\",\n \"pctchange\": \"0.077%\",\n \"marketCap\": \"1,775,681,060,000\"\n },\n {\n \"symbol\": \"GOOGL\",\n \"name\": \"Alphabet Inc. Class A Common Stock\",\n \"lastsale\": \"$141.305\",\n \"netchange\": \"0.145\",\n \"pctchange\": \"0.103%\",\n \"marketCap\": \"1,756,845,065,000\"\n },\n ...\n ]\n }"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/market-info:
get:
summary: 'GET /v2/market-info'
operationId: gETv2marketInfo
description: "\n\nReturns the current U.S. market status: the session indicator (pre-market, open, after hours, or closed), a countdown to the next open or close, pre-market, regular, and after-hours session times in Eastern Time, and the previous and next trading dates. Takes no parameters."
parameters: []
responses:
200:
description: Success
content:
application/json:
schema:
type: object
example:
meta:
version: v1.0
status: 200
copywrite: 'https://steadyapi.com'
body:
country: U.S.
marketIndicator: 'After Hours'
uiMarketIndicator: 'After Hours'
marketCountDown: 'Market Opens in 2D 14H 5M'
preMarketOpeningTime: 'Feb 2, 2024 04:00 AM ET'
preMarketClosingTime: 'Feb 2, 2024 09:30 AM ET'
marketOpeningTime: 'Feb 2, 2024 09:30 AM ET'
marketClosingTime: 'Feb 2, 2024 04:00 PM ET'
afterHoursMarketOpeningTime: 'Feb 2, 2024 04:00 PM ET'
afterHoursMarketClosingTime: 'Feb 2, 2024 08:00 PM ET'
previousTradeDate: 'Feb 1, 2024'
nextTradeDate: 'Feb 5, 2024'
isBusinessDay: true
mrktStatus: After-Hours
mrktCountDown: 'Opens in 2D 14H 5M'
properties:
meta:
type: object
properties:
version:
type: string
example: v1.0
status:
type: integer
example: 200
copywrite:
type: string
example: 'https://steadyapi.com'
body:
type: object
properties:
country:
type: string
example: U.S.
marketIndicator:
type: string
example: 'After Hours'
uiMarketIndicator:
type: string
example: 'After Hours'
marketCountDown:
type: string
example: 'Market Opens in 2D 14H 5M'
preMarketOpeningTime:
type: string
example: 'Feb 2, 2024 04:00 AM ET'
preMarketClosingTime:
type: string
example: 'Feb 2, 2024 09:30 AM ET'
marketOpeningTime:
type: string
example: 'Feb 2, 2024 09:30 AM ET'
marketClosingTime:
type: string
example: 'Feb 2, 2024 04:00 PM ET'
afterHoursMarketOpeningTime:
type: string
example: 'Feb 2, 2024 04:00 PM ET'
afterHoursMarketClosingTime:
type: string
example: 'Feb 2, 2024 08:00 PM ET'
previousTradeDate:
type: string
example: 'Feb 1, 2024'
nextTradeDate:
type: string
example: 'Feb 5, 2024'
isBusinessDay:
type: boolean
example: true
mrktStatus:
type: string
example: After-Hours
mrktCountDown:
type: string
example: 'Opens in 2D 14H 5M'
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/screener:
get:
summary: 'GET /v2/screener new!'
operationId: gETv2screenersmallStylecolor2c1e1ebackground15f07apadding1px4pxborderRadius3pxnewsmall
description: "\n\nRuns a predefined stock screen and returns the matching U.S. stocks, 20 per page. `metricType` picks which set of columns each row includes. `meta.description` explains the selected screen, and `meta.count`, `meta.total`, and `meta.page` support paging."
parameters:
-
in: query
name: metricType
description: "Column set to return for each stock. Case-insensitive; defaults to overview if omitted.\n - **overview**: Name, price, and columns specific to the selected screen\n - **technical**: Analyst opinion, 20-day relative strength, 20-day historic volatility, average volume, and 52-week range\n - **performance**: Weighted alpha and year-to-date, 1-month, 3-month, and 1-year percent change\n - **fundamental**: Market cap, trailing P/E, EPS, net income, beta, dividend rate, and dividend yield\n
"
example: overview
required: true
schema:
type: string
description: "Column set to return for each stock. Case-insensitive; defaults to overview if omitted.\n - **overview**: Name, price, and columns specific to the selected screen\n - **technical**: Analyst opinion, 20-day relative strength, 20-day historic volatility, average volume, and 52-week range\n - **performance**: Weighted alpha and year-to-date, 1-month, 3-month, and 1-year percent change\n - **fundamental**: Market cap, trailing P/E, EPS, net income, beta, dividend rate, and dividend yield\n
"
example: overview
-
in: query
name: filter
description: "Screen to run, in lowercase. Defaults to high_volume if omitted. Accepted values:\n - **high_volume**: Stocks trading above the previous close on higher volume than the prior session, with the 5-day average volume above the 20-day and 100-day averages and a 1-month gain above 5%.\n - **hot_stocks**: Stocks with a buy trend signal, the 20-day moving average above the 50-day and the 50-day above the 100-day, a 1-month gain above 10%, and a market cap of at least $300M.\n - **top_under_10**: Advancing stocks priced under $10, ranked by analyst opinion, with P/E and price-to-sales ratios.\n - **dividend**: Dividend payers with a 5โ60% payout ratio, at least 10% dividend growth over 5 years, a buy opinion signal, and a 1-month high within the last week.\n - **top_fundamentals**: Stocks with quarterly revenue growth and cash flow growth of at least 10%, shareholder equity growth of at least 10% over the last year, and a weighted alpha of at least 15.\n - **top_tech**: Large-cap ($1B+) computer and technology stocks that set a new 6-month high within the last week on rising volume.\n - **j_pattern**: Stocks with a J-hook pattern: an uptrend that dips briefly and then resumes, with a gap up today and a 5-day gain above 5%.\n - **golden_cross**: Stocks whose 50-day moving average has just crossed above the 200-day moving average (a bullish signal).\n - **death_cross**: Stocks whose 50-day moving average has just crossed below the 200-day moving average (a bearish signal).\n - **consolidation**: Stocks in an uptrend trading sideways near recent highs, with volatility and volume contracting.\n - **rsi_overbought**: Actively traded stocks with a 20-day RSI above 70 and a 5-day gain above 5%, a possible overbought condition.\n - **rsi_oversold**: Actively traded stocks with a 20-day RSI below 30 and a 5-day loss greater than 5%, a possible oversold condition.\n - **52wk_toppicks**: Stocks that hit a new 52-week high with a gain above 10% over the past month.\n - **penny_gap**: Stocks priced under $1 that are up more than 20% today and more than 25% over 5 days on rising volume.\n - **defensive_stock**: Low-beta, lower-volatility dividend payers with a market cap of $3B or more, no revenue decline in the last two quarters, at least 10% dividend growth over 5 years, and a P/E under 30.\n - **income_growth**: Stocks priced above $5 with at least 5% earnings growth and 5% dividend growth over 5 years, and no EPS decline over the last year.\n - **buy_longterm**: Stocks with a 100% overall buy signal now and over the past week and month.\n - **sell_longterm**: Stocks with a 100% overall sell signal now and over the past week and month.\n
"
example: high_volume
required: true
schema:
type: string
description: "Screen to run, in lowercase. Defaults to high_volume if omitted. Accepted values:\n - **high_volume**: Stocks trading above the previous close on higher volume than the prior session, with the 5-day average volume above the 20-day and 100-day averages and a 1-month gain above 5%.\n - **hot_stocks**: Stocks with a buy trend signal, the 20-day moving average above the 50-day and the 50-day above the 100-day, a 1-month gain above 10%, and a market cap of at least $300M.\n - **top_under_10**: Advancing stocks priced under $10, ranked by analyst opinion, with P/E and price-to-sales ratios.\n - **dividend**: Dividend payers with a 5โ60% payout ratio, at least 10% dividend growth over 5 years, a buy opinion signal, and a 1-month high within the last week.\n - **top_fundamentals**: Stocks with quarterly revenue growth and cash flow growth of at least 10%, shareholder equity growth of at least 10% over the last year, and a weighted alpha of at least 15.\n - **top_tech**: Large-cap ($1B+) computer and technology stocks that set a new 6-month high within the last week on rising volume.\n - **j_pattern**: Stocks with a J-hook pattern: an uptrend that dips briefly and then resumes, with a gap up today and a 5-day gain above 5%.\n - **golden_cross**: Stocks whose 50-day moving average has just crossed above the 200-day moving average (a bullish signal).\n - **death_cross**: Stocks whose 50-day moving average has just crossed below the 200-day moving average (a bearish signal).\n - **consolidation**: Stocks in an uptrend trading sideways near recent highs, with volatility and volume contracting.\n - **rsi_overbought**: Actively traded stocks with a 20-day RSI above 70 and a 5-day gain above 5%, a possible overbought condition.\n - **rsi_oversold**: Actively traded stocks with a 20-day RSI below 30 and a 5-day loss greater than 5%, a possible oversold condition.\n - **52wk_toppicks**: Stocks that hit a new 52-week high with a gain above 10% over the past month.\n - **penny_gap**: Stocks priced under $1 that are up more than 20% today and more than 25% over 5 days on rising volume.\n - **defensive_stock**: Low-beta, lower-volatility dividend payers with a market cap of $3B or more, no revenue decline in the last two quarters, at least 10% dividend growth over 5 years, and a P/E under 30.\n - **income_growth**: Stocks priced above $5 with at least 5% earnings growth and 5% dividend growth over 5 years, and no EPS decline over the last year.\n - **buy_longterm**: Stocks with a 100% overall buy signal now and over the past week and month.\n - **sell_longterm**: Stocks with a 100% overall sell signal now and over the past week and month.\n
"
example: high_volume
-
in: query
name: page
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"metricType\": \"overview\",\n \"description\": \"Stocks with strong volume gains from the previous session and positive price and volume momentum in the past month.\",\n \"count\": 50,\n \"total\": 220,\n \"page\": \"1\"\n },\n \"body\": [\n {\n \"symbol\": \"A\",\n \"symbolName\": \"Agilent Technologies\",\n \"lastPrice\": \"142.86\",\n \"priceChange\": \"+3.80\",\n \"percentChange\": \"+2.73%\",\n \"highPrice\": \"143.49\",\n \"lowPrice\": \"138.81\",\n \"volume\": \"2,169,200\",\n \"tradeTime\": \"03/04/24\",\n \"symbolCode\": \"STK\",\n \"symbolType\": 1,\n \"hasOptions\": \"Yes\"\n },\n {\n \"symbol\": \"AADI\",\n \"symbolName\": \"Aadi Biosciences Inc\",\n \"lastPrice\": \"2.4300\",\n \"priceChange\": \"+0.5100\",\n \"percentChange\": \"+26.82%\",\n \"highPrice\": \"2.4700\",\n \"lowPrice\": \"1.9200\",\n \"volume\": \"3,894,000\",\n \"tradeTime\": \"03/04/24\",\n \"symbolCode\": \"STK\",\n \"symbolType\": 1,\n \"hasOptions\": \"Yes\"\n },\n {...}\n ]\n }"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/news:
get:
summary: 'GET /v2/news'
operationId: gETv2news
description: "\n\nReturns recent news articles. With `ticker`, it returns news for that company; without it, it returns a general feed chosen by `type`. Video items in a company feed include an embeddable video URL. `meta.total` gives the number of items returned."
parameters:
-
in: query
name: ticker
description: 'Company ticker symbol, such as AAPL. You can send `symbol` instead. When set, `type` is ignored.'
example: AAPL
required: false
schema:
type: string
description: 'Company ticker symbol, such as AAPL. You can send `symbol` instead. When set, `type` is ignored.'
example: AAPL
-
in: query
name: type
description: 'General feed to return when no ticker is given, case-insensitive: ALL (stock news, the default), MARKET (market news), or PRESS-RELEASE (press releases). VIDEO is accepted but currently returns the ALL feed.'
example: ALL
required: false
schema:
type: string
description: 'General feed to return when no ticker is given, case-insensitive: ALL (stock news, the default), MARKET (market news), or PRESS-RELEASE (press releases). VIDEO is accepted but currently returns the ALL feed.'
example: ALL
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"total\": 50\n },\n \"body\": [\n {\n \"url\": \"https://nypost.com/2024/04/12/business/rite-aid-to-close-53-more-stores-amid-bankruptcy-proceedings/\",\n \"img\": \"https://cdn.snapi.dev/images/v1/x/p/wp-content2fuploads2fsites2f22-2368534.jpg\",\n \"title\": \"Rite Aid to close 53 more stores across 9 states amid bankruptcy proceedings\",\n \"text\": \"The company filed for bankruptcy in October in an attempt to address high debt.\",\n \"source\": \"New York Post\",\n \"type\": \"Article\",\n \"tickers\": [\n \"$RADCQ\"\n ],\n \"time\": \"Apr 12, 2024, 12:04 AM EDT\",\n \"ago\": \"22 minutes ago\"\n },\n {\n \"url\": \"https://www.cnbc.com/2024/04/12/jpmorgan-chase-jpm-earnings-q1-2024.html\",\n \"img\": \"https://cdn.snapi.dev/images/v1/p/k/107360168-1708972746073-107360-2368532.jpg\",\n \"title\": \"JPMorgan Chase is set to report first-quarter earnings โ here's what the Street expects\",\n \"text\": \"JPMorgan Chase will be watched closely for clues on how banks fared at the start of the year.\",\n \"source\": \"CNBC\",\n \"type\": \"Article\",\n \"tickers\": [\n \"$JPM\"\n ],\n \"time\": \"Apr 12, 2024, 12:01 AM EDT\",\n \"ago\": \"25 minutes ago\"\n },\n {\n \"url\": \"https://www.reuters.com/business/autos-transportation/uber-lyft-delay-their-plans-leave-minneapolis-2024-04-12/\",\n \"img\": \"https://cdn.snapi.dev/images/v1/i/g/q3hn3kf3ffmpfeu7rblbfifiqa-2368530.jpg\",\n \"title\": \"Uber and Lyft delay their plans to leave Minneapolis\",\n \"text\": \"Ride-hailing companies Lyft and Uber will extend their services in Minneapolis till July 1, they said on Thursday, after city officials voted a day earlier to push back the start of a driver pay raise...\",\n \"source\": \"Reuters\",\n \"type\": \"Article\",\n \"tickers\": [\n \"$LYFT\",\n \"$UBER\"\n ],\n \"time\": \"Apr 11, 2024, 11:34 PM EDT\",\n \"ago\": \"52 minutes ago\"\n },\n { ... }\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/quote:
get:
summary: 'GET /v1/quote (real-time) hot!'
operationId: gETv1quoterealTimesmallStylecolorf8f2f2backgroundfa256fpadding1px4pxborderRadius3pxhotsmall
description: "\n\nReturns the latest quote for one symbol: last sale price, net and percent change, bid and ask, volume, market status, and key price statistics. Use the `type` that matches the symbol's asset class, as returned by the search endpoint."
parameters:
-
in: query
name: ticker
description: 'Ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
required: true
schema:
type: string
description: 'Ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
-
in: query
name: type
description: 'Asset class of the symbol: STOCKS, ETF, MUTUALFUNDS, FUTURES, or INDEX. Case-insensitive.'
example: STOCKS
required: true
schema:
type: string
description: 'Asset class of the symbol: STOCKS, ETF, MUTUALFUNDS, FUTURES, or INDEX. Case-insensitive.'
example: STOCKS
responses:
200:
description: Success
content:
application/json:
schema:
type: object
example:
meta:
version: v1.0
status: 200
copywrite: 'https://steadyapi.com'
processedTime: '2023-12-21T22:13:30.914543Z'
body:
symbol: AAPL
companyName: 'Apple Inc. Common Stock'
stockType: 'Common Stock'
exchange: NASDAQ-GS
primaryData:
lastSalePrice: $194.83
netChange: '+0.15'
percentageChange: +0.08%
deltaIndicator: up
lastTradeTimestamp: 'Dec 21, 2023 5:13 PM ET'
isRealTime: true
bidPrice: $194.82
askPrice: $194.84
bidSize: '112'
askSize: '400'
volume: '45,191,237'
secondaryData:
lastSalePrice: $194.68
netChange: '-0.15'
percentageChange: '-0.08%'
deltaIndicator: down
lastTradeTimestamp: 'Closed at Dec 21, 2023 4:00 PM ET'
isRealTime: false
bidPrice: ''
askPrice: ''
bidSize: ''
askSize: ''
volume: ''
marketStatus: After-Hours
assetClass: STOCKS
keyStats:
fiftyTwoWeekHighLow:
label: '52 Week Range:'
value: '124.17 - 199.62'
dayrange:
label: 'High/Low:'
value: '193.51 - 197.07'
properties:
meta:
type: object
properties:
version:
type: string
example: v1.0
status:
type: integer
example: 200
copywrite:
type: string
example: 'https://steadyapi.com'
processedTime:
type: string
example: '2023-12-21T22:13:30.914543Z'
body:
type: object
properties:
symbol:
type: string
example: AAPL
companyName:
type: string
example: 'Apple Inc. Common Stock'
stockType:
type: string
example: 'Common Stock'
exchange:
type: string
example: NASDAQ-GS
primaryData:
type: object
properties:
lastSalePrice:
type: string
example: $194.83
netChange:
type: string
example: '+0.15'
percentageChange:
type: string
example: +0.08%
deltaIndicator:
type: string
example: up
lastTradeTimestamp:
type: string
example: 'Dec 21, 2023 5:13 PM ET'
isRealTime:
type: boolean
example: true
bidPrice:
type: string
example: $194.82
askPrice:
type: string
example: $194.84
bidSize:
type: string
example: '112'
askSize:
type: string
example: '400'
volume:
type: string
example: '45,191,237'
secondaryData:
type: object
properties:
lastSalePrice:
type: string
example: $194.68
netChange:
type: string
example: '-0.15'
percentageChange:
type: string
example: '-0.08%'
deltaIndicator:
type: string
example: down
lastTradeTimestamp:
type: string
example: 'Closed at Dec 21, 2023 4:00 PM ET'
isRealTime:
type: boolean
example: false
bidPrice:
type: string
example: ''
askPrice:
type: string
example: ''
bidSize:
type: string
example: ''
askSize:
type: string
example: ''
volume:
type: string
example: ''
marketStatus:
type: string
example: After-Hours
assetClass:
type: string
example: STOCKS
keyStats:
type: object
properties:
fiftyTwoWeekHighLow:
type: object
properties:
label:
type: string
example: '52 Week Range:'
value:
type: string
example: '124.17 - 199.62'
dayrange:
type: object
properties:
label:
type: string
example: 'High/Low:'
value:
type: string
example: '193.51 - 197.07'
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/stock/quotes:
get:
summary: 'GET /v1/quotes'
operationId: gETv1quotes
description: "\n\nReturns the latest quote for one or more symbols: price, change, volume, and other quote fields. Pre-market and post-market fields are always present and are null when no extended-hours data exists."
parameters:
-
in: query
name: ticker
description: "One symbol or up to 200 separated by commas. You can send `symbol` instead. Symbol formats by asset type:\n - **Equity**: A,AAPL,GM,MU,TSLA\n - **Futures**: ALI=F,CD=F,QM=F,NQ=F,MNQ=F,H2O=F,BTC=F\n - **Forex**: EURUSD=X,AUDUSD=X,GBPUSD=X\n - **Indices**: ^DJT,^HSI,^VIX,^TNX,^NSEI,^IXIC\n - **Mutual Funds & ETFs**: SPY,AWSHX,VOO,XAIX.BE,CYBR.AS,BLOK\n - **Cryptocurrencies**: BTC-USD,ETH-USD,LTC-USD,ADA-USD\n - **Combination**: AAPL,CD=F,^VIX,CLOA,ADA-USD\n
"
example: 'AAPL,TSLA'
required: true
schema:
type: string
description: "One symbol or up to 200 separated by commas. You can send `symbol` instead. Symbol formats by asset type:\n - **Equity**: A,AAPL,GM,MU,TSLA\n - **Futures**: ALI=F,CD=F,QM=F,NQ=F,MNQ=F,H2O=F,BTC=F\n - **Forex**: EURUSD=X,AUDUSD=X,GBPUSD=X\n - **Indices**: ^DJT,^HSI,^VIX,^TNX,^NSEI,^IXIC\n - **Mutual Funds & ETFs**: SPY,AWSHX,VOO,XAIX.BE,CYBR.AS,BLOK\n - **Cryptocurrencies**: BTC-USD,ETH-USD,LTC-USD,ADA-USD\n - **Combination**: AAPL,CD=F,^VIX,CLOA,ADA-USD\n
"
example: 'AAPL,TSLA'
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"symbol\": \"Quotes Data\",\n \"processedTime\": \"2023-08-11T00:47:22.112881Z\"\n },\n \"body\": [\n {\n \"preMarketChange\": null,\n \"preMarketChangePercent\": null,\n \"preMarketPrice\": null,\n \"preMarketTime\": null,\n \"postMarketChange\": 0.459991,\n \"postMarketChangePercent\": 0.258466,\n \"postMarketPrice\": 178.43,\n \"postMarketTime\": 1691711999,\n \"language\": \"en-US\",\n \"region\": \"US\",\n \"quoteType\": \"EQUITY\",\n \"typeDisp\": \"Equity\",\n \"quoteSourceName\": \"Nasdaq Real Time Price\",\n \"triggerable\": true,\n \"customPriceAlertConfidence\": \"HIGH\",\n \"currency\": \"USD\",\n \"exchange\": \"NMS\",\n \"shortName\": \"Apple Inc.\",\n \"marketState\": \"POSTPOST\",\n \"longName\": \"Apple Inc.\",\n \"messageBoardId\": \"finmb_24937\",\n \"market\": \"us_market\",\n \"regularMarketPrice\": 177.97,\n \"regularMarketChangePercent\": -0.1234644,\n \"gmtOffSetMilliseconds\": -14400000,\n \"exchangeTimezoneName\": \"America/New_York\",\n \"exchangeTimezoneShortName\": \"EDT\",\n \"esgPopulated\": false,\n \"regularMarketDayLow\": 177.601,\n \"regularMarketVolume\": 51330160,\n \"fiftyTwoWeekRange\": \"124.17 - 198.23\",\n \"fiftyTwoWeekHighChange\": -20.259995,\n \"fiftyTwoWeekHighChangePercent\": -0.10220449,\n \"fiftyTwoWeekLow\": 124.17,\n \"fiftyTwoWeekHigh\": 198.23,\n \"fiftyTwoWeekChangePercent\": 5.757022,\n \"dividendDate\": 1692230400,\n \"earningsTimestamp\": 1691096400,\n \"earningsTimestampStart\": 1698231540,\n \"earningsTimestampEnd\": 1698667200,\n \"trailingAnnualDividendRate\": 0.93,\n \"trailingPE\": 30.21562,\n \"dividendRate\": 0.96,\n \"regularMarketPreviousClose\": 178.19,\n \"bid\": 178.37,\n \"ask\": 178.47,\n \"bidSize\": 22,\n \"askSize\": 8,\n \"fullExchangeName\": \"NasdaqGS\",\n \"financialCurrency\": \"USD\",\n \"regularMarketOpen\": 179.48,\n \"averageDailyVolume3Month\": 57113016,\n \"averageDailyVolume10Day\": 62286030,\n \"fiftyTwoWeekLowChange\": 53.800003,\n \"fiftyTwoWeekLowChangePercent\": 0.43327698,\n \"firstTradeDateMilliseconds\": 345479400000,\n \"regularMarketChange\": -0.22000122,\n \"regularMarketTime\": 1691697602,\n \"regularMarketDayHigh\": 180.75,\n \"regularMarketDayRange\": \"177.601 - 180.75\",\n \"trailingAnnualDividendYield\": 0.005219148,\n \"dividendYield\": 0.53,\n \"epsTrailingTwelveMonths\": 5.89,\n \"epsForward\": 6.59,\n \"epsCurrentYear\": 6.07,\n \"priceEpsCurrentYear\": 29.319605,\n \"sharesOutstanding\": 15728700416,\n \"bookValue\": 3.852,\n \"fiftyDayAverage\": 187.4184,\n \"fiftyDayAverageChange\": -9.448395,\n \"fiftyDayAverageChangePercent\": -0.05041338,\n \"twoHundredDayAverage\": 160.5426,\n \"twoHundredDayAverageChange\": 17.427399,\n \"twoHundredDayAverageChangePercent\": 0.10855311,\n \"marketCap\": 2799236808704,\n \"forwardPE\": 27.00607,\n \"priceToBook\": 46.201973,\n \"sourceInterval\": 15,\n \"exchangeDataDelayedBy\": 0,\n \"averageAnalystRating\": \"2.0 - Buy\",\n \"tradeable\": false,\n \"cryptoTradeable\": false,\n \"priceHint\": 2,\n \"displayName\": \"Apple\",\n \"symbol\": \"AAPL\"\n },\n {...}\n ]\n }"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/stock/history:
get:
summary: 'GET /v1/history hot!'
operationId: gETv1historysmallStylecolorf8f2f2backgroundfa256fpadding1px4pxborderRadius3pxhotsmall
description: "\n\nReturns open, high, low, close, and volume candles for one symbol, keyed by Unix timestamp, with the adjusted close when available. Prices are rounded to two decimals. `meta` carries the symbol's trading metadata, such as currency, exchange, and time zone. A newer version is available at /v2/history."
parameters:
-
in: query
name: ticker
description: 'A single symbol, such as AAPL or ES=F; comma-separated lists are rejected. You can send `symbol` instead.'
example: AAPL
required: true
schema:
type: string
description: 'A single symbol, such as AAPL or ES=F; comma-separated lists are rejected. You can send `symbol` instead.'
example: AAPL
-
in: query
name: interval
description: "Candle size. Each interval returns a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
required: true
schema:
type: string
description: "Candle size. Each interval returns a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
-
in: query
name: diffandsplits
description: 'Set to true to add dividend and split events under `body.events`. Accepts true or false; defaults to false.'
example: null
required: false
schema:
type: string
description: 'Set to true to add dividend and split events under `body.events`. Accepts true or false; defaults to false.'
example: null
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"processedTime\": \"2023-08-10T13:08:23.071878Z\",\n \"currency\": \"USD\",\n \"symbol\": \"AAPL\",\n \"exchangeName\": \"NMS\",\n \"instrumentType\": \"EQUITY\",\n \"firstTradeDate\": 345479400,\n \"regularMarketTime\": 1691611201,\n \"gmtoffset\": -14400,\n \"timezone\": \"EDT\",\n \"exchangeTimezoneName\": \"America/New_York\",\n \"regularMarketPrice\": 178.19,\n \"chartPreviousClose\": 178.19,\n \"previousClose\": 179.8,\n \"scale\": 3,\n \"priceHint\": 2,\n \"dataGranularity\": \"1m\",\n \"range\": \"\",\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\"\n },\n \"body\": {\n \"1691593260\": {\n \"date\": \"09-08-2023\",\n \"date_utc\": 1691593260,\n \"open\": 177.85,\n \"high\": 177.89,\n \"low\": 177.82,\n \"close\": 177.89,\n \"volume\": 88211\n },\n \"1691593320\": {\n \"date\": \"09-08-2023\",\n \"date_utc\": 1691593320,\n \"open\": 177.88,\n \"high\": 178.07,\n \"low\": 177.86,\n \"close\": 178.06,\n \"volume\": 147707\n },\n {...}\n }\n }"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/stock/modules:
get:
summary: 'GET /v1/modules updated'
operationId: gETv1modulessmallStylecolorffffffbackground0d9debpadding1px4pxborderRadius3pxupdatedsmall
description: "\n\nReturns one module of company data for a single ticker, such as the profile, financial statements, key statistics, earnings, or analyst recommendations."
parameters:
-
in: query
name: ticker
description: 'A single ticker symbol; comma-separated lists are rejected. You can send `symbol` instead.'
example: AAPL
required: true
schema:
type: string
description: 'A single ticker symbol; comma-separated lists are rejected. You can send `symbol` instead.'
example: AAPL
-
in: query
name: module
description: "The module to return, one per request. Defaults to profile when omitted. Accepted values:\n - **profile**: Company profile: sector, industry, address, business summary, and officers.\n - **income-statement**: Annual and quarterly income statements.\n - **income-statement-v2**: Income statements with line-item definitions, by `timeframe`. New!\n - **balance-sheet**: Annual and quarterly balance sheets.\n - **balance-sheet-v2**: Balance sheets with line-item definitions, by `timeframe`. New!\n - **cashflow-statement**: Annual and quarterly cash flow statements.\n - **cashflow-statement-v2**: Cash flow statements with line-item definitions, by `timeframe`. New!\n - **financial-data**: Current financial data.\n - **statistics**: Key statistics.\n - **ratios**: Valuation and financial ratios with definitions, by `timeframe`. New!\n - **calendar-events**: Upcoming company events such as earnings and dividend dates.\n - **sec-filings**: SEC filings.\n - **recommendation-trend**: Analyst recommendation trend.\n - **upgrade-downgrade-history**: Analyst upgrades and downgrades.\n - **insider-transactions**: Insider transactions.\n - **insider-holders**: Insider holders.\n - **net-share-purchase-activity**: Net insider share purchase activity.\n - **earnings**: Earnings, earnings history, and earnings trend in one response.\n - **index-trend**: Index trend.\n - **industry-trend**: Industry trend.\n - **sector-trend**: Sector trend."
example: profile
required: true
schema:
type: string
description: "The module to return, one per request. Defaults to profile when omitted. Accepted values:\n - **profile**: Company profile: sector, industry, address, business summary, and officers.\n - **income-statement**: Annual and quarterly income statements.\n - **income-statement-v2**: Income statements with line-item definitions, by `timeframe`. New!\n - **balance-sheet**: Annual and quarterly balance sheets.\n - **balance-sheet-v2**: Balance sheets with line-item definitions, by `timeframe`. New!\n - **cashflow-statement**: Annual and quarterly cash flow statements.\n - **cashflow-statement-v2**: Cash flow statements with line-item definitions, by `timeframe`. New!\n - **financial-data**: Current financial data.\n - **statistics**: Key statistics.\n - **ratios**: Valuation and financial ratios with definitions, by `timeframe`. New!\n - **calendar-events**: Upcoming company events such as earnings and dividend dates.\n - **sec-filings**: SEC filings.\n - **recommendation-trend**: Analyst recommendation trend.\n - **upgrade-downgrade-history**: Analyst upgrades and downgrades.\n - **insider-transactions**: Insider transactions.\n - **insider-holders**: Insider holders.\n - **net-share-purchase-activity**: Net insider share purchase activity.\n - **earnings**: Earnings, earnings history, and earnings trend in one response.\n - **index-trend**: Index trend.\n - **industry-trend**: Industry trend.\n - **sector-trend**: Sector trend."
example: profile
-
in: query
name: timeframe
description: 'Reporting period for income-statement-v2, balance-sheet-v2, cashflow-statement-v2, and ratios: annually, quarterly, or trailing. Defaults to annually. Ignored by other modules.'
example: annually
required: false
schema:
type: string
description: 'Reporting period for income-statement-v2, balance-sheet-v2, cashflow-statement-v2, and ratios: annually, quarterly, or trailing. Defaults to annually. Ignored by other modules.'
example: annually
responses:
200:
description: Success
content:
application/json:
schema:
type: object
example:
meta:
version: v1.0
status: 200
copywrite: 'https://steadyapi.com'
symbol: AAPL
processedTime: '2023-08-09T09:10:21.978992Z'
body:
address1: 'One Apple Park Way'
city: Cupertino
state: CA
zip: '95014'
country: 'United States'
phone: '408 996 1010'
website: 'https://www.apple.com'
industry: 'Consumer Electronics'
industryDisp: 'Consumer Electronics'
sector: Technology
sectorDisp: Technology
longBusinessSummary: 'Apple Inc. designs, manufactures, and markets smartphones, personal computers, tablets, wearables, and accessories worldwide. The company offers iPhone, a line of smartphones; Mac, a line of personal computers; iPad, a line of multi-purpose tablets; and wearables, home, and accessories comprising AirPods, Apple TV, Apple Watch, Beats products, and HomePod. It also provides AppleCare support and cloud services; and operates various platforms, including the App Store that allow customers to discover and download applications and digital content, such as books, music, video, games, and podcasts. In addition, the company offers various services, such as Apple Arcade, a game subscription service; Apple Fitness+, a personalized fitness service; Apple Music, which offers users a curated listening experience with on-demand radio stations; Apple News+, a subscription news and magazine service; Apple TV+, which offers exclusive original content; Apple Card, a co-branded credit card; and Apple Pay, a cashless payment service, as well as licenses its intellectual property. The company serves consumers, and small and mid-sized businesses; and the education, enterprise, and government markets. It distributes third-party applications for its products through the App Store. The company also sells its products through its retail and online stores, and direct sales force; and third-party cellular network carriers, wholesalers, retailers, and resellers. Apple Inc. was incorporated in 1977 and is headquartered in Cupertino, California.'
fullTimeEmployees: 164000
companyOfficers:
-
maxAge: 1
name: 'Mr. Timothy D. Cook'
age: 61
title: 'CEO & Director'
yearBorn: 1961
fiscalYear: 2022
totalPay:
raw: 16425933
fmt: 16.43M
longFmt: '16,425,933'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Mr. Luca Maestri'
age: 59
title: 'CFO & Sr. VP'
yearBorn: 1963
fiscalYear: 2022
totalPay:
raw: 5019783
fmt: 5.02M
longFmt: '5,019,783'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Mr. Jeffrey E. Williams'
age: 58
title: 'Chief Operating Officer'
yearBorn: 1964
fiscalYear: 2022
totalPay:
raw: 5018337
fmt: 5.02M
longFmt: '5,018,337'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Ms. Katherine L. Adams'
age: 58
title: 'Sr. VP, Gen. Counsel & Sec.'
yearBorn: 1964
fiscalYear: 2022
totalPay:
raw: 5015208
fmt: 5.02M
longFmt: '5,015,208'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: "Ms. Deirdre O'Brien"
age: 55
title: 'Sr. VP of Retail'
yearBorn: 1967
fiscalYear: 2022
totalPay:
raw: 5019783
fmt: 5.02M
longFmt: '5,019,783'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Mr. Chris Kondo'
title: 'Sr. Director of Corp. Accounting'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Mr. James Wilson'
title: 'Chief Technology Officer'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Ms. Mary Demby'
title: 'Chief Information Officer'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Ms. Nancy Paxton'
title: 'Sr. Director of Investor Relations & Treasury'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Mr. Greg Joswiak'
title: 'Sr. VP of Worldwide Marketing'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
auditRisk: 4
boardRisk: 1
compensationRisk: 5
shareHolderRightsRisk: 1
overallRisk: 1
governanceEpochDate: 1690848000
compensationAsOfEpochDate: 1672444800
maxAge: 86400
properties:
meta:
type: object
properties:
version:
type: string
example: v1.0
status:
type: integer
example: 200
copywrite:
type: string
example: 'https://steadyapi.com'
symbol:
type: string
example: AAPL
processedTime:
type: string
example: '2023-08-09T09:10:21.978992Z'
body:
type: object
properties:
address1:
type: string
example: 'One Apple Park Way'
city:
type: string
example: Cupertino
state:
type: string
example: CA
zip:
type: string
example: '95014'
country:
type: string
example: 'United States'
phone:
type: string
example: '408 996 1010'
website:
type: string
example: 'https://www.apple.com'
industry:
type: string
example: 'Consumer Electronics'
industryDisp:
type: string
example: 'Consumer Electronics'
sector:
type: string
example: Technology
sectorDisp:
type: string
example: Technology
longBusinessSummary:
type: string
example: 'Apple Inc. designs, manufactures, and markets smartphones, personal computers, tablets, wearables, and accessories worldwide. The company offers iPhone, a line of smartphones; Mac, a line of personal computers; iPad, a line of multi-purpose tablets; and wearables, home, and accessories comprising AirPods, Apple TV, Apple Watch, Beats products, and HomePod. It also provides AppleCare support and cloud services; and operates various platforms, including the App Store that allow customers to discover and download applications and digital content, such as books, music, video, games, and podcasts. In addition, the company offers various services, such as Apple Arcade, a game subscription service; Apple Fitness+, a personalized fitness service; Apple Music, which offers users a curated listening experience with on-demand radio stations; Apple News+, a subscription news and magazine service; Apple TV+, which offers exclusive original content; Apple Card, a co-branded credit card; and Apple Pay, a cashless payment service, as well as licenses its intellectual property. The company serves consumers, and small and mid-sized businesses; and the education, enterprise, and government markets. It distributes third-party applications for its products through the App Store. The company also sells its products through its retail and online stores, and direct sales force; and third-party cellular network carriers, wholesalers, retailers, and resellers. Apple Inc. was incorporated in 1977 and is headquartered in Cupertino, California.'
fullTimeEmployees:
type: integer
example: 164000
companyOfficers:
type: array
example:
-
maxAge: 1
name: 'Mr. Timothy D. Cook'
age: 61
title: 'CEO & Director'
yearBorn: 1961
fiscalYear: 2022
totalPay:
raw: 16425933
fmt: 16.43M
longFmt: '16,425,933'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Mr. Luca Maestri'
age: 59
title: 'CFO & Sr. VP'
yearBorn: 1963
fiscalYear: 2022
totalPay:
raw: 5019783
fmt: 5.02M
longFmt: '5,019,783'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Mr. Jeffrey E. Williams'
age: 58
title: 'Chief Operating Officer'
yearBorn: 1964
fiscalYear: 2022
totalPay:
raw: 5018337
fmt: 5.02M
longFmt: '5,018,337'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Ms. Katherine L. Adams'
age: 58
title: 'Sr. VP, Gen. Counsel & Sec.'
yearBorn: 1964
fiscalYear: 2022
totalPay:
raw: 5015208
fmt: 5.02M
longFmt: '5,015,208'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: "Ms. Deirdre O'Brien"
age: 55
title: 'Sr. VP of Retail'
yearBorn: 1967
fiscalYear: 2022
totalPay:
raw: 5019783
fmt: 5.02M
longFmt: '5,019,783'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Mr. Chris Kondo'
title: 'Sr. Director of Corp. Accounting'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Mr. James Wilson'
title: 'Chief Technology Officer'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Ms. Mary Demby'
title: 'Chief Information Officer'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Ms. Nancy Paxton'
title: 'Sr. Director of Investor Relations & Treasury'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
-
maxAge: 1
name: 'Mr. Greg Joswiak'
title: 'Sr. VP of Worldwide Marketing'
exercisedValue:
raw: 0
fmt: null
longFmt: '0'
unexercisedValue:
raw: 0
fmt: null
longFmt: '0'
items:
type: object
properties:
maxAge:
type: integer
example: 1
name:
type: string
example: 'Mr. Timothy D. Cook'
age:
type: integer
example: 61
title:
type: string
example: 'CEO & Director'
yearBorn:
type: integer
example: 1961
fiscalYear:
type: integer
example: 2022
totalPay:
type: object
properties:
raw:
type: integer
example: 16425933
fmt:
type: string
example: 16.43M
longFmt:
type: string
example: '16,425,933'
exercisedValue:
type: object
properties:
raw:
type: integer
example: 0
fmt:
type: string
example: null
longFmt:
type: string
example: '0'
unexercisedValue:
type: object
properties:
raw:
type: integer
example: 0
fmt:
type: string
example: null
longFmt:
type: string
example: '0'
auditRisk:
type: integer
example: 4
boardRisk:
type: integer
example: 1
compensationRisk:
type: integer
example: 5
shareHolderRightsRisk:
type: integer
example: 1
overallRisk:
type: integer
example: 1
governanceEpochDate:
type: integer
example: 1690848000
compensationAsOfEpochDate:
type: integer
example: 1672444800
maxAge:
type: integer
example: 86400
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/stock/analyst-ratings:
get:
summary: 'GET /v1/analyst-ratings'
operationId: gETv1analystRatings
description: "\n\nReturns analyst price targets (mean, high, and low estimates) for up to 10 tickers, along with the current price, daily, weekly, and monthly previous prices and ranges, the 52-week high and low, and weighted alpha."
parameters:
-
in: query
name: ticker
description: 'One ticker symbol or up to 10 separated by commas. You can send `symbol` instead.'
example: 'AAPL,NVDA'
required: true
schema:
type: string
description: 'One ticker symbol or up to 10 separated by commas. You can send `symbol` instead.'
example: 'AAPL,NVDA'
-
in: query
name: page
description: 'Accepted but not used; all requested tickers are returned in one response.'
example: 1
required: false
schema:
type: integer
description: 'Accepted but not used; all requested tickers are returned in one response.'
example: 1
responses:
200:
description: Success
content:
application/json:
schema:
type: object
example:
meta:
version: v1.0
status: 200
copywrite: 'https://steadyapi.com'
count: 3
total: 3
body:
-
symbol: AAPL
exchange: NASDAQ
symbolName: 'Apple Inc'
symbolType: 1
baseCode: A
symbolCode: STK
previousPrice: '181.16'
previousHighPrice: '182.76'
previousLowPrice: '180.65'
weeklyPreviousPrice: '182.52'
weeklyPreviousHighPrice: '185.04'
weeklyPreviousLowPrice: '180.00'
monthlyPreviousPrice: '184.40'
monthlyPreviousHighPrice: '196.38'
monthlyPreviousLowPrice: '180.17'
chartTime: '2024-02-26T07:00:00'
shortSymbol: AAPL
hasBats: 'Yes'
hasJerq: 'Yes'
lastPrice: '182.63'
percentChange: +0.81%
priceChange: '+1.47'
openPrice: '181.10'
lowPrice: '179.56'
highPrice: '183.92'
pointValue: '1.00000'
highPrice1y: '199.62'
lowPrice1y: '143.90'
weightedAlpha: '+14.60'
meanTargetEstimate: '207.56'
highTargetEstimate: '250.00'
lowTargetEstimate: '158.00'
-
symbol: MU
exchange: NASDAQ
symbolName: 'Micron Technology'
symbolType: 1
baseCode: A
symbolCode: STK
previousPrice: '89.46'
previousHighPrice: '92.35'
previousLowPrice: '88.90'
weeklyPreviousPrice: '86.00'
weeklyPreviousHighPrice: '86.82'
weeklyPreviousLowPrice: '79.15'
monthlyPreviousPrice: '85.75'
monthlyPreviousHighPrice: '90.04'
monthlyPreviousLowPrice: '80.58'
chartTime: '2024-02-26T07:00:00'
shortSymbol: MU
hasBats: 'Yes'
hasJerq: 'Yes'
lastPrice: '91.85'
percentChange: +2.67%
priceChange: '+2.39'
openPrice: '91.89'
lowPrice: '90.49'
highPrice: '92.75'
pointValue: '1.00000'
highPrice1y: '92.75'
lowPrice1y: '52.76'
weightedAlpha: '+65.40'
meanTargetEstimate: '97.10'
highTargetEstimate: '140.00'
lowTargetEstimate: '74.75'
-
symbol: NVDA
exchange: NASDAQ
symbolName: 'Nvidia Corp'
symbolType: 1
baseCode: A
symbolCode: STK
previousPrice: '790.92'
previousHighPrice: '806.46'
previousLowPrice: '785.05'
weeklyPreviousPrice: '788.17'
weeklyPreviousHighPrice: '823.94'
weeklyPreviousLowPrice: '662.48'
monthlyPreviousPrice: '615.27'
monthlyPreviousHighPrice: '634.93'
monthlyPreviousLowPrice: '473.20'
chartTime: '2024-02-26T07:00:00'
shortSymbol: NVDA
hasBats: 'Yes'
hasJerq: 'Yes'
lastPrice: '787.01'
percentChange: '-0.49%'
priceChange: '-3.91'
openPrice: '793.81'
lowPrice: '771.62'
highPrice: '794.80'
pointValue: '1.00000'
highPrice1y: '823.94'
lowPrice1y: '222.97'
weightedAlpha: '+228.40'
meanTargetEstimate: '825.38'
highTargetEstimate: '1,200.00'
lowTargetEstimate: '475.00'
properties:
meta:
type: object
properties:
version:
type: string
example: v1.0
status:
type: integer
example: 200
copywrite:
type: string
example: 'https://steadyapi.com'
count:
type: integer
example: 3
total:
type: integer
example: 3
body:
type: array
example:
-
symbol: AAPL
exchange: NASDAQ
symbolName: 'Apple Inc'
symbolType: 1
baseCode: A
symbolCode: STK
previousPrice: '181.16'
previousHighPrice: '182.76'
previousLowPrice: '180.65'
weeklyPreviousPrice: '182.52'
weeklyPreviousHighPrice: '185.04'
weeklyPreviousLowPrice: '180.00'
monthlyPreviousPrice: '184.40'
monthlyPreviousHighPrice: '196.38'
monthlyPreviousLowPrice: '180.17'
chartTime: '2024-02-26T07:00:00'
shortSymbol: AAPL
hasBats: 'Yes'
hasJerq: 'Yes'
lastPrice: '182.63'
percentChange: +0.81%
priceChange: '+1.47'
openPrice: '181.10'
lowPrice: '179.56'
highPrice: '183.92'
pointValue: '1.00000'
highPrice1y: '199.62'
lowPrice1y: '143.90'
weightedAlpha: '+14.60'
meanTargetEstimate: '207.56'
highTargetEstimate: '250.00'
lowTargetEstimate: '158.00'
-
symbol: MU
exchange: NASDAQ
symbolName: 'Micron Technology'
symbolType: 1
baseCode: A
symbolCode: STK
previousPrice: '89.46'
previousHighPrice: '92.35'
previousLowPrice: '88.90'
weeklyPreviousPrice: '86.00'
weeklyPreviousHighPrice: '86.82'
weeklyPreviousLowPrice: '79.15'
monthlyPreviousPrice: '85.75'
monthlyPreviousHighPrice: '90.04'
monthlyPreviousLowPrice: '80.58'
chartTime: '2024-02-26T07:00:00'
shortSymbol: MU
hasBats: 'Yes'
hasJerq: 'Yes'
lastPrice: '91.85'
percentChange: +2.67%
priceChange: '+2.39'
openPrice: '91.89'
lowPrice: '90.49'
highPrice: '92.75'
pointValue: '1.00000'
highPrice1y: '92.75'
lowPrice1y: '52.76'
weightedAlpha: '+65.40'
meanTargetEstimate: '97.10'
highTargetEstimate: '140.00'
lowTargetEstimate: '74.75'
-
symbol: NVDA
exchange: NASDAQ
symbolName: 'Nvidia Corp'
symbolType: 1
baseCode: A
symbolCode: STK
previousPrice: '790.92'
previousHighPrice: '806.46'
previousLowPrice: '785.05'
weeklyPreviousPrice: '788.17'
weeklyPreviousHighPrice: '823.94'
weeklyPreviousLowPrice: '662.48'
monthlyPreviousPrice: '615.27'
monthlyPreviousHighPrice: '634.93'
monthlyPreviousLowPrice: '473.20'
chartTime: '2024-02-26T07:00:00'
shortSymbol: NVDA
hasBats: 'Yes'
hasJerq: 'Yes'
lastPrice: '787.01'
percentChange: '-0.49%'
priceChange: '-3.91'
openPrice: '793.81'
lowPrice: '771.62'
highPrice: '794.80'
pointValue: '1.00000'
highPrice1y: '823.94'
lowPrice1y: '222.97'
weightedAlpha: '+228.40'
meanTargetEstimate: '825.38'
highTargetEstimate: '1,200.00'
lowTargetEstimate: '475.00'
items:
type: object
properties:
symbol:
type: string
example: AAPL
exchange:
type: string
example: NASDAQ
symbolName:
type: string
example: 'Apple Inc'
symbolType:
type: integer
example: 1
baseCode:
type: string
example: A
symbolCode:
type: string
example: STK
previousPrice:
type: string
example: '181.16'
previousHighPrice:
type: string
example: '182.76'
previousLowPrice:
type: string
example: '180.65'
weeklyPreviousPrice:
type: string
example: '182.52'
weeklyPreviousHighPrice:
type: string
example: '185.04'
weeklyPreviousLowPrice:
type: string
example: '180.00'
monthlyPreviousPrice:
type: string
example: '184.40'
monthlyPreviousHighPrice:
type: string
example: '196.38'
monthlyPreviousLowPrice:
type: string
example: '180.17'
chartTime:
type: string
example: '2024-02-26T07:00:00'
shortSymbol:
type: string
example: AAPL
hasBats:
type: string
example: 'Yes'
hasJerq:
type: string
example: 'Yes'
lastPrice:
type: string
example: '182.63'
percentChange:
type: string
example: +0.81%
priceChange:
type: string
example: '+1.47'
openPrice:
type: string
example: '181.10'
lowPrice:
type: string
example: '179.56'
highPrice:
type: string
example: '183.92'
pointValue:
type: string
example: '1.00000'
highPrice1y:
type: string
example: '199.62'
lowPrice1y:
type: string
example: '143.90'
weightedAlpha:
type: string
example: '+14.60'
meanTargetEstimate:
type: string
example: '207.56'
highTargetEstimate:
type: string
example: '250.00'
lowTargetEstimate:
type: string
example: '158.00'
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/stock/history:
get:
summary: 'GET /v2/history new!'
operationId: gETv2historysmallStylecolor2c1e1ebackground15f07apadding1px4pxborderRadius3pxnewsmall
description: "\n\nReturns OHLCV candles for one symbol in oldest-first order. Each candle has a `timestamp` (New York time), `timestamp_unix`, open, high, low, close, and volume. Supports stocks, ETFs, indexes, and futures contracts. Only one symbol per request; a comma-separated list returns an error."
parameters:
-
in: query
name: ticker
description: 'Symbol of the stock, ETF, index, or futures contract. A leading `^` is converted to `$` (^VIX becomes $VIX). You can send `symbol` instead. Example: AAPL or ESM25 or $SPY.'
example: AAPL
required: true
schema:
type: string
description: 'Symbol of the stock, ETF, index, or futures contract. A leading `^` is converted to `$` (^VIX becomes $VIX). You can send `symbol` instead. Example: AAPL or ESM25 or $SPY.'
example: AAPL
-
in: query
name: interval
description: "Candle size. Case-insensitive. Accepted values:\n - **1m**, **2m**, **3m**, **4m**, **5m**, **15m**, **30m**: minute candles.\n - **1h**, **2h**, **4h**: hourly candles.\n - **1d**: daily candles.\n - **1wk**: weekly candles.\n - **1mo**: monthly candles.\n - **1qty**: quarterly candles."
example: 1m
required: true
schema:
type: string
description: "Candle size. Case-insensitive. Accepted values:\n - **1m**, **2m**, **3m**, **4m**, **5m**, **15m**, **30m**: minute candles.\n - **1h**, **2h**, **4h**: hourly candles.\n - **1d**: daily candles.\n - **1wk**: weekly candles.\n - **1mo**: monthly candles.\n - **1qty**: quarterly candles."
example: 1m
-
in: query
name: limit
description: 'Maximum number of candles to return, from 1 to 1000. Defaults to 640.'
example: 640
required: false
schema:
type: integer
description: 'Maximum number of candles to return, from 1 to 1000. Defaults to 640.'
example: 640
-
in: query
name: dividend
description: 'Set to true to include dividends in the series, or false. Defaults to false.'
example: null
required: false
schema:
type: string
description: 'Set to true to include dividends in the series, or false. Defaults to false.'
example: null
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v2.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"ticker\": \"AAPL\",\n \"interval\": \"2m\",\n \"dividend\": \"true\"\n },\n \"body\": [\n {\n \"timestamp\": \"2025-06-04 15:50\",\n \"timestamp_unix\": 1749066600,\n \"open\": 203.09,\n \"high\": 203.09,\n \"low\": 202.79,\n \"close\": 202.84,\n \"volume\": 185027\n },\n {\n \"timestamp\": \"2025-06-04 15:52\",\n \"timestamp_unix\": 1749066720,\n \"open\": 202.84,\n \"high\": 202.99,\n \"low\": 202.8036,\n \"close\": 202.915,\n \"volume\": 156946\n },\n { ... }\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/stock/ticker-summary:
get:
summary: 'GET /v2/ticker-summary'
operationId: gETv2tickerSummary
description: "\n\nReturns a summary of key statistics for one symbol, such as exchange, sector, industry, one-year target, daily and 52-week high/low, volume, market cap, P/E ratio, EPS, and dividend data. Each value comes as a `label`/`value` pair under `summaryData`."
parameters:
-
in: query
name: ticker
description: 'Ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
required: true
schema:
type: string
description: 'Ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
-
in: query
name: type
description: 'Asset class of the symbol: STOCKS, ETF, MUTUALFUNDS, FUTURES, or INDEX. Case-insensitive.'
example: STOCKS
required: true
schema:
type: string
description: 'Asset class of the symbol: STOCKS, ETF, MUTUALFUNDS, FUTURES, or INDEX. Case-insensitive.'
example: STOCKS
responses:
200:
description: Success
content:
application/json:
schema:
type: object
example:
meta:
version: v1.0
status: 200
copywrite: 'https://steadyapi.com'
body:
symbol: AAPL
summaryData:
Exchange:
label: Exchange
value: NASDAQ-GS
Sector:
label: Sector
value: Technology
Industry:
label: Industry
value: 'Computer Manufacturing'
OneYrTarget:
label: '1 Year Target'
value: $205.00
TodayHighLow:
label: "Today's High/Low"
value: $187.33/$179.25
ShareVolume:
label: 'Share Volume'
value: '102,551,680'
AverageVolume:
label: 'Average Volume'
value: '52,248,247'
PreviousClose:
label: 'Previous Close'
value: $186.86
FiftTwoWeekHighLow:
label: '52 Week High/Low'
value: $199.62/$143.9
MarketCap:
label: 'Market Cap'
value: '2,873,593,371,600'
PERatio:
label: 'P/E Ratio'
value: 28.95
ForwardPE1Yr:
label: 'Forward P/E 1 Yr.'
value: '28.40'
EarningsPerShare:
label: 'Earnings Per Share(EPS)'
value: $6.42
AnnualizedDividend:
label: 'Annualized Dividend'
value: $0.96
ExDividendDate:
label: 'Ex Dividend Date'
value: 'Nov 10, 2023'
DividendPaymentDate:
label: 'Dividend Pay Date'
value: 'Nov 16, 2023'
Yield:
label: 'Current Yield'
value: 0.51%
Beta:
label: Beta
value: 0
assetClass: STOCKS
additionalData: null
bidAsk:
'Bid * Size':
label: 'Bid * Size'
value: N/A
'Ask * Size':
label: 'Ask * Size'
value: N/A
properties:
meta:
type: object
properties:
version:
type: string
example: v1.0
status:
type: integer
example: 200
copywrite:
type: string
example: 'https://steadyapi.com'
body:
type: object
properties:
symbol:
type: string
example: AAPL
summaryData:
type: object
properties:
Exchange:
type: object
properties:
label:
type: string
example: Exchange
value:
type: string
example: NASDAQ-GS
Sector:
type: object
properties:
label:
type: string
example: Sector
value:
type: string
example: Technology
Industry:
type: object
properties:
label:
type: string
example: Industry
value:
type: string
example: 'Computer Manufacturing'
OneYrTarget:
type: object
properties:
label:
type: string
example: '1 Year Target'
value:
type: string
example: $205.00
TodayHighLow:
type: object
properties:
label:
type: string
example: "Today's High/Low"
value:
type: string
example: $187.33/$179.25
ShareVolume:
type: object
properties:
label:
type: string
example: 'Share Volume'
value:
type: string
example: '102,551,680'
AverageVolume:
type: object
properties:
label:
type: string
example: 'Average Volume'
value:
type: string
example: '52,248,247'
PreviousClose:
type: object
properties:
label:
type: string
example: 'Previous Close'
value:
type: string
example: $186.86
FiftTwoWeekHighLow:
type: object
properties:
label:
type: string
example: '52 Week High/Low'
value:
type: string
example: $199.62/$143.9
MarketCap:
type: object
properties:
label:
type: string
example: 'Market Cap'
value:
type: string
example: '2,873,593,371,600'
PERatio:
type: object
properties:
label:
type: string
example: 'P/E Ratio'
value:
type: number
example: 28.95
ForwardPE1Yr:
type: object
properties:
label:
type: string
example: 'Forward P/E 1 Yr.'
value:
type: string
example: '28.40'
EarningsPerShare:
type: object
properties:
label:
type: string
example: 'Earnings Per Share(EPS)'
value:
type: string
example: $6.42
AnnualizedDividend:
type: object
properties:
label:
type: string
example: 'Annualized Dividend'
value:
type: string
example: $0.96
ExDividendDate:
type: object
properties:
label:
type: string
example: 'Ex Dividend Date'
value:
type: string
example: 'Nov 10, 2023'
DividendPaymentDate:
type: object
properties:
label:
type: string
example: 'Dividend Pay Date'
value:
type: string
example: 'Nov 16, 2023'
Yield:
type: object
properties:
label:
type: string
example: 'Current Yield'
value:
type: string
example: 0.51%
Beta:
type: object
properties:
label:
type: string
example: Beta
value:
type: integer
example: 0
assetClass:
type: string
example: STOCKS
additionalData:
type: string
example: null
bidAsk:
type: object
properties:
'Bid * Size':
type: object
properties:
label:
type: string
example: 'Bid * Size'
value:
type: string
example: N/A
'Ask * Size':
type: object
properties:
label:
type: string
example: 'Ask * Size'
value:
type: string
example: N/A
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/stock/price-targets:
get:
summary: 'GET /v2/price-targets'
operationId: gETv2priceTargets
description: "\n\nReturns analyst price targets for a company: the low, high, and average target, the current buy/hold/sell rating counts, and a monthly history of the consensus rating alongside the stock price."
parameters:
-
in: query
name: ticker
description: 'Company ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
required: true
schema:
type: string
description: 'Company ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
responses:
200:
description: Success
content:
application/json:
schema:
type: object
example:
meta:
version: v1.0
status: 200
copywrite: 'https://steadyapi.com'
body:
symbol: aapl
consensusOverview:
lowPriceTarget: 158
highPriceTarget: 250
priceTarget: 205.33
buy: 19
sell: 1
hold: 8
historicalConsensus:
-
z:
buy: 25
hold: 5
sell: 0
date: 02/01/2023
consensus: Buy
latest: null
x: 1675209600
'y': 145.43
-
z:
buy: 25
hold: 5
sell: 0
date: 03/01/2023
consensus: Buy
latest: null
x: 1677628800
'y': 145.31
-
z:
buy: 23
hold: 5
sell: 1
date: 04/01/2023
consensus: Buy
latest: null
x: 1680307200
'y': 164.9
-
z:
buy: 25
hold: 4
sell: 1
date: 05/01/2023
consensus: Buy
latest: null
x: 1682899200
'y': 169.59
-
z:
buy: 22
hold: 5
sell: 1
date: 06/01/2023
consensus: Buy
latest: null
x: 1685577600
'y': 180.09
-
z:
buy: 24
hold: 7
sell: 0
date: 07/01/2023
consensus: Buy
latest: null
x: 1688169600
'y': 193.97
-
z:
buy: 23
hold: 8
sell: 0
date: 08/01/2023
consensus: Buy
latest: null
x: 1690848000
'y': 195.605
-
z:
buy: 22
hold: 8
sell: 0
date: 09/01/2023
consensus: Buy
latest: null
x: 1693526400
'y': 189.46
-
z:
buy: 20
hold: 9
sell: 0
date: 10/01/2023
consensus: Buy
latest: null
x: 1696118400
'y': 171.21
-
z:
buy: 21
hold: 9
sell: 0
date: 11/01/2023
consensus: Buy
latest: null
x: 1698796800
'y': 173.97
-
z:
buy: 24
hold: 8
sell: 0
date: 12/01/2023
consensus: Buy
latest: null
x: 1701388800
'y': 191.24
-
z:
buy: 22
hold: 8
sell: 1
date: 01/01/2024
consensus: Buy
latest: null
x: 1704067200
'y': 192.53
-
z:
buy: 20
hold: 9
sell: 1
date: 02/01/2024
consensus: Buy
latest:
high: 186.95
avg: 185.38
low: 183.82
x: 1706745600
'y': 205.33
properties:
meta:
type: object
properties:
version:
type: string
example: v1.0
status:
type: integer
example: 200
copywrite:
type: string
example: 'https://steadyapi.com'
body:
type: object
properties:
symbol:
type: string
example: aapl
consensusOverview:
type: object
properties:
lowPriceTarget:
type: integer
example: 158
highPriceTarget:
type: integer
example: 250
priceTarget:
type: number
example: 205.33
buy:
type: integer
example: 19
sell:
type: integer
example: 1
hold:
type: integer
example: 8
historicalConsensus:
type: array
example:
-
z:
buy: 25
hold: 5
sell: 0
date: 02/01/2023
consensus: Buy
latest: null
x: 1675209600
'y': 145.43
-
z:
buy: 25
hold: 5
sell: 0
date: 03/01/2023
consensus: Buy
latest: null
x: 1677628800
'y': 145.31
-
z:
buy: 23
hold: 5
sell: 1
date: 04/01/2023
consensus: Buy
latest: null
x: 1680307200
'y': 164.9
-
z:
buy: 25
hold: 4
sell: 1
date: 05/01/2023
consensus: Buy
latest: null
x: 1682899200
'y': 169.59
-
z:
buy: 22
hold: 5
sell: 1
date: 06/01/2023
consensus: Buy
latest: null
x: 1685577600
'y': 180.09
-
z:
buy: 24
hold: 7
sell: 0
date: 07/01/2023
consensus: Buy
latest: null
x: 1688169600
'y': 193.97
-
z:
buy: 23
hold: 8
sell: 0
date: 08/01/2023
consensus: Buy
latest: null
x: 1690848000
'y': 195.605
-
z:
buy: 22
hold: 8
sell: 0
date: 09/01/2023
consensus: Buy
latest: null
x: 1693526400
'y': 189.46
-
z:
buy: 20
hold: 9
sell: 0
date: 10/01/2023
consensus: Buy
latest: null
x: 1696118400
'y': 171.21
-
z:
buy: 21
hold: 9
sell: 0
date: 11/01/2023
consensus: Buy
latest: null
x: 1698796800
'y': 173.97
-
z:
buy: 24
hold: 8
sell: 0
date: 12/01/2023
consensus: Buy
latest: null
x: 1701388800
'y': 191.24
-
z:
buy: 22
hold: 8
sell: 1
date: 01/01/2024
consensus: Buy
latest: null
x: 1704067200
'y': 192.53
-
z:
buy: 20
hold: 9
sell: 1
date: 02/01/2024
consensus: Buy
latest:
high: 186.95
avg: 185.38
low: 183.82
x: 1706745600
'y': 205.33
items:
type: object
properties:
z:
type: object
properties:
buy:
type: integer
example: 25
hold:
type: integer
example: 5
sell:
type: integer
example: 0
date:
type: string
example: 02/01/2023
consensus:
type: string
example: Buy
latest:
type: string
example: null
x:
type: integer
example: 1675209600
'y':
type: number
example: 145.43
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/stock/financials:
get:
summary: 'GET /v2/financials'
operationId: gETv2financials
description: "\n\nReturns a company's annual income statement, balance sheet, cash flow statement, and financial ratios as tables of labeled rows. For more fundamentals, see the /v1/modules endpoint."
parameters:
-
in: query
name: ticker
description: 'Company ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
required: true
schema:
type: string
description: 'Company ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
responses:
200:
description: Success
content:
application/json:
schema:
type: object
example:
meta:
version: v1.0
status: 200
copywrite: 'https://steadyapi.com'
symbol: AAPL
body:
incomeStatementTable:
headers:
value1: 'Period Ending:'
value2: 9/30/2023
value3: 9/24/2022
value4: 9/25/2021
value5: 9/26/2020
rows:
-
value1: 'Total Revenue'
value2: '$383,285,000'
value3: '$394,328,000'
value4: '$365,817,000'
value5: '$274,515,000'
-
value1: 'Cost of Revenue'
value2: '$214,137,000'
value3: '$223,546,000'
value4: '$212,981,000'
value5: '$169,559,000'
-
value1: 'Gross Profit'
value2: '$169,148,000'
value3: '$170,782,000'
value4: '$152,836,000'
value5: '$104,956,000'
-
value1: 'Operating Expenses'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Research and Development'
value2: '$29,915,000'
value3: '$26,251,000'
value4: '$21,914,000'
value5: '$18,752,000'
-
value1: 'Sales, General and Admin.'
value2: '$24,932,000'
value3: '$25,094,000'
value4: '$21,973,000'
value5: '$19,916,000'
-
value1: 'Non-Recurring Items'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Other Operating Items'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Operating Income'
value2: '$114,301,000'
value3: '$119,437,000'
value4: '$108,949,000'
value5: '$66,288,000'
-
value1: "Add'l income/expense items"
value2: '-$565,000'
value3: '-$334,000'
value4: '$258,000'
value5: '$803,000'
-
value1: 'Earnings Before Interest and Tax'
value2: '$113,736,000'
value3: '$119,103,000'
value4: '$109,207,000'
value5: '$67,091,000'
-
value1: 'Interest Expense'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Earnings Before Tax'
value2: '$113,736,000'
value3: '$119,103,000'
value4: '$109,207,000'
value5: '$67,091,000'
-
value1: 'Income Tax'
value2: '$16,741,000'
value3: '$19,300,000'
value4: '$14,527,000'
value5: '$9,680,000'
-
value1: 'Minority Interest'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Equity Earnings/Loss Unconsolidated Subsidiary'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Net Income-Cont. Operations'
value2: '$96,995,000'
value3: '$99,803,000'
value4: '$94,680,000'
value5: '$57,411,000'
-
value1: 'Net Income'
value2: '$96,995,000'
value3: '$99,803,000'
value4: '$94,680,000'
value5: '$57,411,000'
-
value1: 'Net Income Applicable to Common Shareholders'
value2: '$96,995,000'
value3: '$99,803,000'
value4: '$94,680,000'
value5: '$57,411,000'
balanceSheetTable:
headers:
value1: 'Period Ending:'
value2: 9/30/2023
value3: 9/24/2022
value4: 9/25/2021
value5: 9/26/2020
rows:
-
value1: 'Current Assets'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Cash and Cash Equivalents'
value2: '$29,965,000'
value3: '$23,646,000'
value4: '$34,940,000'
value5: '$38,016,000'
-
value1: 'Short-Term Investments'
value2: '$31,590,000'
value3: '$24,658,000'
value4: '$27,699,000'
value5: '$52,927,000'
-
value1: 'Net Receivables'
value2: '$60,985,000'
value3: '$60,932,000'
value4: '$51,506,000'
value5: '$37,445,000'
-
value1: Inventory
value2: '$6,331,000'
value3: '$4,946,000'
value4: '$6,580,000'
value5: '$4,061,000'
-
value1: 'Other Current Assets'
value2: '$14,695,000'
value3: '$21,223,000'
value4: '$14,111,000'
value5: '$11,264,000'
-
value1: 'Total Current Assets'
value2: '$143,566,000'
value3: '$135,405,000'
value4: '$134,836,000'
value5: '$143,713,000'
-
value1: 'Long-Term Assets'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Long-Term Investments'
value2: '$100,544,000'
value3: '$120,805,000'
value4: '$127,877,000'
value5: '$100,887,000'
-
value1: 'Fixed Assets'
value2: '$43,715,000'
value3: '$42,117,000'
value4: '$39,440,000'
value5: '$36,766,000'
-
value1: Goodwill
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Intangible Assets'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Other Assets'
value2: '$64,758,000'
value3: '$54,428,000'
value4: '$48,849,000'
value5: '$42,522,000'
-
value1: 'Deferred Asset Charges'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Total Assets'
value2: '$352,583,000'
value3: '$352,755,000'
value4: '$351,002,000'
value5: '$323,888,000'
-
value1: 'Current Liabilities'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Accounts Payable'
value2: '$62,611,000'
value3: '$64,115,000'
value4: '$54,763,000'
value5: '$42,296,000'
-
value1: 'Short-Term Debt / Current Portion of Long-Term Debt'
value2: '$15,807,000'
value3: '$21,110,000'
value4: '$15,613,000'
value5: '$13,769,000'
-
value1: 'Other Current Liabilities'
value2: '$66,890,000'
value3: '$68,757,000'
value4: '$55,105,000'
value5: '$49,327,000'
-
value1: 'Total Current Liabilities'
value2: '$145,308,000'
value3: '$153,982,000'
value4: '$125,481,000'
value5: '$105,392,000'
-
value1: 'Long-Term Debt'
value2: '$95,281,000'
value3: '$98,959,000'
value4: '$109,106,000'
value5: '$98,667,000'
-
value1: 'Other Liabilities'
value2: '$49,848,000'
value3: '$49,142,000'
value4: '$53,325,000'
value5: '$54,490,000'
-
value1: 'Deferred Liability Charges'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Misc. Stocks'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Minority Interest'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Total Liabilities'
value2: '$290,437,000'
value3: '$302,083,000'
value4: '$287,912,000'
value5: '$258,549,000'
-
value1: 'Stock Holders Equity'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Common Stocks'
value2: '$73,812,000'
value3: '$64,849,000'
value4: '$57,365,000'
value5: '$50,779,000'
-
value1: 'Capital Surplus'
value2: '-$214,000'
value3: '-$3,068,000'
value4: '$5,562,000'
value5: '$14,966,000'
-
value1: 'Retained Earnings'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Treasury Stock'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Other Equity'
value2: '-$11,452,000'
value3: '-$11,109,000'
value4: '$163,000'
value5: '-$406,000'
-
value1: 'Total Equity'
value2: '$62,146,000'
value3: '$50,672,000'
value4: '$63,090,000'
value5: '$65,339,000'
-
value1: 'Total Liabilities & Equity'
value2: '$352,583,000'
value3: '$352,755,000'
value4: '$351,002,000'
value5: '$323,888,000'
cashFlowTable:
headers:
value1: 'Period Ending:'
value2: 9/30/2023
value3: 9/24/2022
value4: 9/25/2021
value5: 9/26/2020
rows:
-
value1: 'Net Income'
value2: '$96,995,000'
value3: '$99,803,000'
value4: '$94,680,000'
value5: '$57,411,000'
-
value1: 'Cash Flows-Operating Activities'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: Depreciation
value2: '$11,519,000'
value3: '$11,104,000'
value4: '$11,284,000'
value5: '$11,056,000'
-
value1: 'Net Income Adjustments'
value2: '$8,606,000'
value3: '$10,044,000'
value4: '$2,985,000'
value5: '$6,517,000'
-
value1: 'Changes in Operating Activities'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Accounts Receivable'
value2: '-$417,000'
value3: '-$9,343,000'
value4: '-$14,028,000'
value5: '$8,470,000'
-
value1: 'Changes in Inventories'
value2: '-$1,618,000'
value3: '$1,484,000'
value4: '-$2,642,000'
value5: '-$127,000'
-
value1: 'Other Operating Activities'
value2: '-$5,684,000'
value3: '-$6,499,000'
value4: '-$8,042,000'
value5: '-$9,588,000'
-
value1: Liabilities
value2: '$1,142,000'
value3: '$15,558,000'
value4: '$19,801,000'
value5: '$6,935,000'
-
value1: 'Net Cash Flow-Operating'
value2: '$110,543,000'
value3: '$122,151,000'
value4: '$104,038,000'
value5: '$80,674,000'
-
value1: 'Cash Flows-Investing Activities'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Capital Expenditures'
value2: '-$10,959,000'
value3: '-$10,708,000'
value4: '-$11,085,000'
value5: '-$7,309,000'
-
value1: Investments
value2: '$16,001,000'
value3: '-$9,560,000'
value4: '-$3,075,000'
value5: '$5,453,000'
-
value1: 'Other Investing Activities'
value2: '-$1,337,000'
value3: '-$2,086,000'
value4: '-$385,000'
value5: '-$2,433,000'
-
value1: 'Net Cash Flows-Investing'
value2: '$3,705,000'
value3: '-$22,354,000'
value4: '-$14,545,000'
value5: '-$4,289,000'
-
value1: 'Cash Flows-Financing Activities'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Sale and Purchase of Stock'
value2: '-$77,550,000'
value3: '-$89,402,000'
value4: '-$85,971,000'
value5: '-$72,358,000'
-
value1: 'Net Borrowings'
value2: '-$9,901,000'
value3: '-$123,000'
value4: '$12,665,000'
value5: '$2,499,000'
-
value1: 'Other Financing Activities'
value2: '-$6,012,000'
value3: '-$6,383,000'
value4: '-$5,580,000'
value5: '-$2,880,000'
-
value1: 'Net Cash Flows-Financing'
value2: '-$108,488,000'
value3: '-$110,749,000'
value4: '-$93,353,000'
value5: '-$86,820,000'
-
value1: 'Effect of Exchange Rate'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Net Cash Flow'
value2: '$5,760,000'
value3: '-$10,952,000'
value4: '-$3,860,000'
value5: '-$10,435,000'
financialRatiosTable:
headers:
value1: 'Period Ending:'
value2: 9/30/2023
value3: 9/24/2022
value4: 9/25/2021
value5: 9/26/2020
rows:
-
value1: 'Liquidity Ratios'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Current Ratio'
value2: 98.80117%
value3: 87.9356%
value4: 107.45531%
value5: 136.36044%
-
value1: 'Quick Ratio'
value2: 94.44422%
value3: 84.72354%
value4: 102.21149%
value5: 132.50721%
-
value1: 'Cash Ratio'
value2: 42.36174%
value3: 31.3699%
value4: 49.91911%
value5: 86.29023%
-
value1: 'Profitability Ratios'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Gross Margin'
value2: 44.13113%
value3: 43.30963%
value4: 41.77936%
value5: 38.23325%
-
value1: 'Operating Margin'
value2: 29.82141%
value3: 30.28874%
value4: 29.78238%
value5: 24.14731%
-
value1: 'Pre-Tax Margin'
value2: 29.674%
value3: 30.20404%
value4: 29.8529%
value5: 24.43983%
-
value1: 'Profit Margin'
value2: 25.30623%
value3: 25.30964%
value4: 25.88179%
value5: 20.91361%
-
value1: 'Pre-Tax ROE'
value2: 183.01419%
value3: 235.04697%
value4: 173.09716%
value5: 102.6814%
-
value1: 'After Tax ROE'
value2: 156.07601%
value3: 196.95887%
value4: 150.07133%
value5: 87.86636%
properties:
meta:
type: object
properties:
version:
type: string
example: v1.0
status:
type: integer
example: 200
copywrite:
type: string
example: 'https://steadyapi.com'
symbol:
type: string
example: AAPL
body:
type: object
properties:
incomeStatementTable:
type: object
properties:
headers:
type: object
properties:
value1:
type: string
example: 'Period Ending:'
value2:
type: string
example: 9/30/2023
value3:
type: string
example: 9/24/2022
value4:
type: string
example: 9/25/2021
value5:
type: string
example: 9/26/2020
rows:
type: array
example:
-
value1: 'Total Revenue'
value2: '$383,285,000'
value3: '$394,328,000'
value4: '$365,817,000'
value5: '$274,515,000'
-
value1: 'Cost of Revenue'
value2: '$214,137,000'
value3: '$223,546,000'
value4: '$212,981,000'
value5: '$169,559,000'
-
value1: 'Gross Profit'
value2: '$169,148,000'
value3: '$170,782,000'
value4: '$152,836,000'
value5: '$104,956,000'
-
value1: 'Operating Expenses'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Research and Development'
value2: '$29,915,000'
value3: '$26,251,000'
value4: '$21,914,000'
value5: '$18,752,000'
-
value1: 'Sales, General and Admin.'
value2: '$24,932,000'
value3: '$25,094,000'
value4: '$21,973,000'
value5: '$19,916,000'
-
value1: 'Non-Recurring Items'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Other Operating Items'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Operating Income'
value2: '$114,301,000'
value3: '$119,437,000'
value4: '$108,949,000'
value5: '$66,288,000'
-
value1: "Add'l income/expense items"
value2: '-$565,000'
value3: '-$334,000'
value4: '$258,000'
value5: '$803,000'
-
value1: 'Earnings Before Interest and Tax'
value2: '$113,736,000'
value3: '$119,103,000'
value4: '$109,207,000'
value5: '$67,091,000'
-
value1: 'Interest Expense'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Earnings Before Tax'
value2: '$113,736,000'
value3: '$119,103,000'
value4: '$109,207,000'
value5: '$67,091,000'
-
value1: 'Income Tax'
value2: '$16,741,000'
value3: '$19,300,000'
value4: '$14,527,000'
value5: '$9,680,000'
-
value1: 'Minority Interest'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Equity Earnings/Loss Unconsolidated Subsidiary'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Net Income-Cont. Operations'
value2: '$96,995,000'
value3: '$99,803,000'
value4: '$94,680,000'
value5: '$57,411,000'
-
value1: 'Net Income'
value2: '$96,995,000'
value3: '$99,803,000'
value4: '$94,680,000'
value5: '$57,411,000'
-
value1: 'Net Income Applicable to Common Shareholders'
value2: '$96,995,000'
value3: '$99,803,000'
value4: '$94,680,000'
value5: '$57,411,000'
items:
type: object
properties:
value1:
type: string
example: 'Total Revenue'
value2:
type: string
example: '$383,285,000'
value3:
type: string
example: '$394,328,000'
value4:
type: string
example: '$365,817,000'
value5:
type: string
example: '$274,515,000'
balanceSheetTable:
type: object
properties:
headers:
type: object
properties:
value1:
type: string
example: 'Period Ending:'
value2:
type: string
example: 9/30/2023
value3:
type: string
example: 9/24/2022
value4:
type: string
example: 9/25/2021
value5:
type: string
example: 9/26/2020
rows:
type: array
example:
-
value1: 'Current Assets'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Cash and Cash Equivalents'
value2: '$29,965,000'
value3: '$23,646,000'
value4: '$34,940,000'
value5: '$38,016,000'
-
value1: 'Short-Term Investments'
value2: '$31,590,000'
value3: '$24,658,000'
value4: '$27,699,000'
value5: '$52,927,000'
-
value1: 'Net Receivables'
value2: '$60,985,000'
value3: '$60,932,000'
value4: '$51,506,000'
value5: '$37,445,000'
-
value1: Inventory
value2: '$6,331,000'
value3: '$4,946,000'
value4: '$6,580,000'
value5: '$4,061,000'
-
value1: 'Other Current Assets'
value2: '$14,695,000'
value3: '$21,223,000'
value4: '$14,111,000'
value5: '$11,264,000'
-
value1: 'Total Current Assets'
value2: '$143,566,000'
value3: '$135,405,000'
value4: '$134,836,000'
value5: '$143,713,000'
-
value1: 'Long-Term Assets'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Long-Term Investments'
value2: '$100,544,000'
value3: '$120,805,000'
value4: '$127,877,000'
value5: '$100,887,000'
-
value1: 'Fixed Assets'
value2: '$43,715,000'
value3: '$42,117,000'
value4: '$39,440,000'
value5: '$36,766,000'
-
value1: Goodwill
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Intangible Assets'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Other Assets'
value2: '$64,758,000'
value3: '$54,428,000'
value4: '$48,849,000'
value5: '$42,522,000'
-
value1: 'Deferred Asset Charges'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Total Assets'
value2: '$352,583,000'
value3: '$352,755,000'
value4: '$351,002,000'
value5: '$323,888,000'
-
value1: 'Current Liabilities'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Accounts Payable'
value2: '$62,611,000'
value3: '$64,115,000'
value4: '$54,763,000'
value5: '$42,296,000'
-
value1: 'Short-Term Debt / Current Portion of Long-Term Debt'
value2: '$15,807,000'
value3: '$21,110,000'
value4: '$15,613,000'
value5: '$13,769,000'
-
value1: 'Other Current Liabilities'
value2: '$66,890,000'
value3: '$68,757,000'
value4: '$55,105,000'
value5: '$49,327,000'
-
value1: 'Total Current Liabilities'
value2: '$145,308,000'
value3: '$153,982,000'
value4: '$125,481,000'
value5: '$105,392,000'
-
value1: 'Long-Term Debt'
value2: '$95,281,000'
value3: '$98,959,000'
value4: '$109,106,000'
value5: '$98,667,000'
-
value1: 'Other Liabilities'
value2: '$49,848,000'
value3: '$49,142,000'
value4: '$53,325,000'
value5: '$54,490,000'
-
value1: 'Deferred Liability Charges'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Misc. Stocks'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Minority Interest'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Total Liabilities'
value2: '$290,437,000'
value3: '$302,083,000'
value4: '$287,912,000'
value5: '$258,549,000'
-
value1: 'Stock Holders Equity'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Common Stocks'
value2: '$73,812,000'
value3: '$64,849,000'
value4: '$57,365,000'
value5: '$50,779,000'
-
value1: 'Capital Surplus'
value2: '-$214,000'
value3: '-$3,068,000'
value4: '$5,562,000'
value5: '$14,966,000'
-
value1: 'Retained Earnings'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Treasury Stock'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Other Equity'
value2: '-$11,452,000'
value3: '-$11,109,000'
value4: '$163,000'
value5: '-$406,000'
-
value1: 'Total Equity'
value2: '$62,146,000'
value3: '$50,672,000'
value4: '$63,090,000'
value5: '$65,339,000'
-
value1: 'Total Liabilities & Equity'
value2: '$352,583,000'
value3: '$352,755,000'
value4: '$351,002,000'
value5: '$323,888,000'
items:
type: object
properties:
value1:
type: string
example: 'Current Assets'
value2:
type: string
example: ''
value3:
type: string
example: ''
value4:
type: string
example: ''
value5:
type: string
example: ''
cashFlowTable:
type: object
properties:
headers:
type: object
properties:
value1:
type: string
example: 'Period Ending:'
value2:
type: string
example: 9/30/2023
value3:
type: string
example: 9/24/2022
value4:
type: string
example: 9/25/2021
value5:
type: string
example: 9/26/2020
rows:
type: array
example:
-
value1: 'Net Income'
value2: '$96,995,000'
value3: '$99,803,000'
value4: '$94,680,000'
value5: '$57,411,000'
-
value1: 'Cash Flows-Operating Activities'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: Depreciation
value2: '$11,519,000'
value3: '$11,104,000'
value4: '$11,284,000'
value5: '$11,056,000'
-
value1: 'Net Income Adjustments'
value2: '$8,606,000'
value3: '$10,044,000'
value4: '$2,985,000'
value5: '$6,517,000'
-
value1: 'Changes in Operating Activities'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Accounts Receivable'
value2: '-$417,000'
value3: '-$9,343,000'
value4: '-$14,028,000'
value5: '$8,470,000'
-
value1: 'Changes in Inventories'
value2: '-$1,618,000'
value3: '$1,484,000'
value4: '-$2,642,000'
value5: '-$127,000'
-
value1: 'Other Operating Activities'
value2: '-$5,684,000'
value3: '-$6,499,000'
value4: '-$8,042,000'
value5: '-$9,588,000'
-
value1: Liabilities
value2: '$1,142,000'
value3: '$15,558,000'
value4: '$19,801,000'
value5: '$6,935,000'
-
value1: 'Net Cash Flow-Operating'
value2: '$110,543,000'
value3: '$122,151,000'
value4: '$104,038,000'
value5: '$80,674,000'
-
value1: 'Cash Flows-Investing Activities'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Capital Expenditures'
value2: '-$10,959,000'
value3: '-$10,708,000'
value4: '-$11,085,000'
value5: '-$7,309,000'
-
value1: Investments
value2: '$16,001,000'
value3: '-$9,560,000'
value4: '-$3,075,000'
value5: '$5,453,000'
-
value1: 'Other Investing Activities'
value2: '-$1,337,000'
value3: '-$2,086,000'
value4: '-$385,000'
value5: '-$2,433,000'
-
value1: 'Net Cash Flows-Investing'
value2: '$3,705,000'
value3: '-$22,354,000'
value4: '-$14,545,000'
value5: '-$4,289,000'
-
value1: 'Cash Flows-Financing Activities'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Sale and Purchase of Stock'
value2: '-$77,550,000'
value3: '-$89,402,000'
value4: '-$85,971,000'
value5: '-$72,358,000'
-
value1: 'Net Borrowings'
value2: '-$9,901,000'
value3: '-$123,000'
value4: '$12,665,000'
value5: '$2,499,000'
-
value1: 'Other Financing Activities'
value2: '-$6,012,000'
value3: '-$6,383,000'
value4: '-$5,580,000'
value5: '-$2,880,000'
-
value1: 'Net Cash Flows-Financing'
value2: '-$108,488,000'
value3: '-$110,749,000'
value4: '-$93,353,000'
value5: '-$86,820,000'
-
value1: 'Effect of Exchange Rate'
value2: '--'
value3: '--'
value4: '--'
value5: '--'
-
value1: 'Net Cash Flow'
value2: '$5,760,000'
value3: '-$10,952,000'
value4: '-$3,860,000'
value5: '-$10,435,000'
items:
type: object
properties:
value1:
type: string
example: 'Net Income'
value2:
type: string
example: '$96,995,000'
value3:
type: string
example: '$99,803,000'
value4:
type: string
example: '$94,680,000'
value5:
type: string
example: '$57,411,000'
financialRatiosTable:
type: object
properties:
headers:
type: object
properties:
value1:
type: string
example: 'Period Ending:'
value2:
type: string
example: 9/30/2023
value3:
type: string
example: 9/24/2022
value4:
type: string
example: 9/25/2021
value5:
type: string
example: 9/26/2020
rows:
type: array
example:
-
value1: 'Liquidity Ratios'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Current Ratio'
value2: 98.80117%
value3: 87.9356%
value4: 107.45531%
value5: 136.36044%
-
value1: 'Quick Ratio'
value2: 94.44422%
value3: 84.72354%
value4: 102.21149%
value5: 132.50721%
-
value1: 'Cash Ratio'
value2: 42.36174%
value3: 31.3699%
value4: 49.91911%
value5: 86.29023%
-
value1: 'Profitability Ratios'
value2: ''
value3: ''
value4: ''
value5: ''
-
value1: 'Gross Margin'
value2: 44.13113%
value3: 43.30963%
value4: 41.77936%
value5: 38.23325%
-
value1: 'Operating Margin'
value2: 29.82141%
value3: 30.28874%
value4: 29.78238%
value5: 24.14731%
-
value1: 'Pre-Tax Margin'
value2: 29.674%
value3: 30.20404%
value4: 29.8529%
value5: 24.43983%
-
value1: 'Profit Margin'
value2: 25.30623%
value3: 25.30964%
value4: 25.88179%
value5: 20.91361%
-
value1: 'Pre-Tax ROE'
value2: 183.01419%
value3: 235.04697%
value4: 173.09716%
value5: 102.6814%
-
value1: 'After Tax ROE'
value2: 156.07601%
value3: 196.95887%
value4: 150.07133%
value5: 87.86636%
items:
type: object
properties:
value1:
type: string
example: 'Liquidity Ratios'
value2:
type: string
example: ''
value3:
type: string
example: ''
value4:
type: string
example: ''
value5:
type: string
example: ''
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/stock/revenue:
get:
summary: 'GET /v2/revenue'
operationId: gETv2revenue
description: "\n\nReturns a company's revenue, earnings per share (EPS), and dividends by fiscal quarter, with one column per fiscal year. For more fundamentals, see the /v1/modules endpoint."
parameters:
-
in: query
name: ticker
description: 'Company ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
required: true
schema:
type: string
description: 'Company ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
-
in: query
name: page
description: 'Page of revenue history to return. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'Page of revenue history to return. Defaults to 1.'
example: 1
responses:
200:
description: Success
content:
application/json:
schema:
type: object
example:
meta:
version: v1.0
status: 200
copywrite: 'https://steadyapi.com'
body:
title: 'APPLE INC. REVENUE & EARNINGS PER SHARE (EPS)'
revenueTable:
headers:
value1: 'Fiscal Quarter:'
value2: '2023 (Fiscal Year)'
value3: '2022 (Fiscal Year)'
value4: '2021 (Fiscal Year)'
rows:
-
value1: December
value2: ''
value3: ''
value4: ''
-
value1: Revenue
value2: '$117,154(m)'
value3: '$123,945(m)'
value4: '$111,439(m)'
-
value1: EPS
value2: '$1.88 (12/31/2022)'
value3: '$2.10 (12/25/2021)'
value4: '$1.68 (12/26/2020)'
-
value1: Dividends
value2: $0.23
value3: $0.22
value4: $0.20
-
value1: March
value2: ''
value3: ''
value4: ''
-
value1: Revenue
value2: '$94,836(m)'
value3: '$97,278(m)'
value4: '$89,584(m)'
-
value1: EPS
value2: '$1.53 (04/01/2023)'
value3: '$1.52 (03/26/2022)'
value4: '$1.40 (03/27/2021)'
-
value1: Dividends
value2: $0.24
value3: $0.23
value4: $0.22
-
value1: June
value2: ''
value3: ''
value4: ''
-
value1: Revenue
value2: '$81,797(m)'
value3: '$82,959(m)'
value4: '$81,434(m)'
-
value1: EPS
value2: '$1.26 (07/01/2023)'
value3: '$1.20 (06/25/2022)'
value4: '$1.30 (06/26/2021)'
-
value1: Dividends
value2: $0.24
value3: $0.23
value4: $0.22
-
value1: 'September (FYE)'
value2: ''
value3: ''
value4: ''
-
value1: Revenue
value2: '$89,498(m)'
value3: '$90,146(m)'
value4: '$83,360(m)'
-
value1: EPS
value2: '$1.46 (09/30/2023)'
value3: '$1.29 (09/24/2022)'
value4: '$1.23 (09/25/2021)'
-
value1: Dividends
value2: $0.24
value3: $0.23
value4: $0.22
-
value1: Totals
value2: ''
value3: ''
value4: ''
-
value1: Revenue
value2: '$383,285(m)'
value3: '$394,328(m)'
value4: '$365,817(m)'
-
value1: EPS
value2: $6.13
value3: $6.11
value4: $5.61
-
value1: Dividends
value2: $0.95
value3: $0.91
value4: $0.86
properties:
meta:
type: object
properties:
version:
type: string
example: v1.0
status:
type: integer
example: 200
copywrite:
type: string
example: 'https://steadyapi.com'
body:
type: object
properties:
title:
type: string
example: 'APPLE INC. REVENUE & EARNINGS PER SHARE (EPS)'
revenueTable:
type: object
properties:
headers:
type: object
properties:
value1:
type: string
example: 'Fiscal Quarter:'
value2:
type: string
example: '2023 (Fiscal Year)'
value3:
type: string
example: '2022 (Fiscal Year)'
value4:
type: string
example: '2021 (Fiscal Year)'
rows:
type: array
example:
-
value1: December
value2: ''
value3: ''
value4: ''
-
value1: Revenue
value2: '$117,154(m)'
value3: '$123,945(m)'
value4: '$111,439(m)'
-
value1: EPS
value2: '$1.88 (12/31/2022)'
value3: '$2.10 (12/25/2021)'
value4: '$1.68 (12/26/2020)'
-
value1: Dividends
value2: $0.23
value3: $0.22
value4: $0.20
-
value1: March
value2: ''
value3: ''
value4: ''
-
value1: Revenue
value2: '$94,836(m)'
value3: '$97,278(m)'
value4: '$89,584(m)'
-
value1: EPS
value2: '$1.53 (04/01/2023)'
value3: '$1.52 (03/26/2022)'
value4: '$1.40 (03/27/2021)'
-
value1: Dividends
value2: $0.24
value3: $0.23
value4: $0.22
-
value1: June
value2: ''
value3: ''
value4: ''
-
value1: Revenue
value2: '$81,797(m)'
value3: '$82,959(m)'
value4: '$81,434(m)'
-
value1: EPS
value2: '$1.26 (07/01/2023)'
value3: '$1.20 (06/25/2022)'
value4: '$1.30 (06/26/2021)'
-
value1: Dividends
value2: $0.24
value3: $0.23
value4: $0.22
-
value1: 'September (FYE)'
value2: ''
value3: ''
value4: ''
-
value1: Revenue
value2: '$89,498(m)'
value3: '$90,146(m)'
value4: '$83,360(m)'
-
value1: EPS
value2: '$1.46 (09/30/2023)'
value3: '$1.29 (09/24/2022)'
value4: '$1.23 (09/25/2021)'
-
value1: Dividends
value2: $0.24
value3: $0.23
value4: $0.22
-
value1: Totals
value2: ''
value3: ''
value4: ''
-
value1: Revenue
value2: '$383,285(m)'
value3: '$394,328(m)'
value4: '$365,817(m)'
-
value1: EPS
value2: $6.13
value3: $6.11
value4: $5.61
-
value1: Dividends
value2: $0.95
value3: $0.91
value4: $0.86
items:
type: object
properties:
value1:
type: string
example: December
value2:
type: string
example: ''
value3:
type: string
example: ''
value4:
type: string
example: ''
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/stock/short-interest:
get:
summary: 'GET /v2/short-interest'
operationId: gETv2shortInterest
description: "\n\nReturns short interest history for a symbol. Each row covers one settlement date with the short interest, average daily share volume, and days to cover."
parameters:
-
in: query
name: ticker
description: 'Ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
required: true
schema:
type: string
description: 'Ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
-
in: query
name: type
description: 'Asset class of the symbol: STOCKS, ETF, MUTUALFUNDS, FUTURES, or INDEX. Case-insensitive.'
example: STOCKS
required: true
schema:
type: string
description: 'Asset class of the symbol: STOCKS, ETF, MUTUALFUNDS, FUTURES, or INDEX. Case-insensitive.'
example: STOCKS
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"symbol\": \"aapl\"\n },\n \"body\": [\n {\n \"settlementDate\": \"01/12/2024\",\n \"interest\": \"101,263,039\",\n \"avgDailyShareVolume\": \"56,712,342\",\n \"daysToCover\": 1.785556\n },\n {\n \"settlementDate\": \"12/29/2023\",\n \"interest\": \"108,220,157\",\n \"avgDailyShareVolume\": \"42,416,650\",\n \"daysToCover\": 2.55136\n },\n {\n \"settlementDate\": \"12/15/2023\",\n \"interest\": \"120,233,720\",\n \"avgDailyShareVolume\": \"60,940,693\",\n \"daysToCover\": 1.972963\n },\n ...\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/stock/institutional-holdings:
get:
summary: 'GET /v2/institutional-holdings'
operationId: gETv2institutionalHoldings
description: "\n\nReturns institutional ownership for a company: an ownership summary, counts of increased, decreased, and held positions, and a list of institutional holders sorted by position market value, largest first."
parameters:
-
in: query
name: ticker
description: 'Company ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
required: true
schema:
type: string
description: 'Company ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
-
in: query
name: type
description: 'Which holders to list, in uppercase: TOTAL (all holders), INCREASED, NEW, DECREASED, SOLDOUT (positions closed), or ACTIVITY.'
example: TOTAL
required: true
schema:
type: string
description: 'Which holders to list, in uppercase: TOTAL (all holders), INCREASED, NEW, DECREASED, SOLDOUT (positions closed), or ACTIVITY.'
example: TOTAL
-
in: query
name: limit
description: 'Maximum number of holders to return. Defaults to 15; values above 1000 are capped at 1000.'
example: 15
required: false
schema:
type: integer
description: 'Maximum number of holders to return. Defaults to 15; values above 1000 are capped at 1000.'
example: 15
responses:
200:
description: Success
content:
application/json:
schema:
type: object
example:
meta:
version: v1.0
status: 200
copywrite: 'https://steadyapi.com'
body:
ownershipSummary:
SharesOutstandingPCT:
label: 'Institutional Ownership'
value: 58.67%
ShareoutstandingTotal:
label: 'Total Shares Outstanding (millions)'
value: '15,462'
TotalHoldingsValue:
label: 'Total Value of Holdings (millions)'
value: '$1,685,929'
activePositions:
headers:
positions: 'Active Positions'
holders: Holders
shares: Shares
rows:
-
positions: 'Increased Positions'
holders: '1,938'
shares: '165,067,100'
-
positions: 'Decreased Positions'
holders: '2,507'
shares: '230,155,346'
-
positions: 'Held Positions'
holders: '266'
shares: '8,676,228,894'
-
positions: 'Total Institutional Shares'
holders: '4,711'
shares: '9,071,451,340'
newSoldOutPositions:
headers:
positions: 'Active Positions'
holders: Holders
shares: Shares
rows:
-
positions: 'New Positions'
holders: '189'
shares: '45,522,662'
-
positions: 'Sold Out Positions'
holders: '78'
shares: '6,228,057'
holdingsTransactions:
totalRecords: '78'
institutionalHolders: null
sharesHeld: null
table:
headers:
ownerName: 'Owner Name'
date: Date
sharesHeld: 'Shares Held'
sharesChange: 'Change (Shares)'
sharesChangePCT: 'Change (%)'
marketValue: 'Value (In 1,000s)'
rows:
-
ownerName: 'Acrisure Capital Management, Llc'
date: 3/31/2023
sharesHeld: '0'
sharesChange: '-2,036'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Advisors Capital Management, Llc'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-795,635'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Algert Global Llc'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-48,139'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Alight Capital Management Lp'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-60,000'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Alpine Global Management, Llc'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-120,000'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Andra Ap-Fonden'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-78,700'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Appaloosa Lp'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-480,000'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Appleton Group, Llc'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-2,438'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Arete Wealth Advisors, Llc'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-184,215'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Asset Allocation & Management Company, Llc'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-5,250'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Blueshift Asset Management, Llc'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-5,508'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Briaud Financial Planning, Inc'
date: 12/31/2023
sharesHeld: '0'
sharesChange: '-5,680'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Bridgewater Associates, Lp'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-2,076'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Brookfield Corp /On/'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-31,251'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Brown Shipley& Co Ltd'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-110,243'
sharesChangePCT: 'Sold Out'
marketValue: ''
properties:
meta:
type: object
properties:
version:
type: string
example: v1.0
status:
type: integer
example: 200
copywrite:
type: string
example: 'https://steadyapi.com'
body:
type: object
properties:
ownershipSummary:
type: object
properties:
SharesOutstandingPCT:
type: object
properties:
label:
type: string
example: 'Institutional Ownership'
value:
type: string
example: 58.67%
ShareoutstandingTotal:
type: object
properties:
label:
type: string
example: 'Total Shares Outstanding (millions)'
value:
type: string
example: '15,462'
TotalHoldingsValue:
type: object
properties:
label:
type: string
example: 'Total Value of Holdings (millions)'
value:
type: string
example: '$1,685,929'
activePositions:
type: object
properties:
headers:
type: object
properties:
positions:
type: string
example: 'Active Positions'
holders:
type: string
example: Holders
shares:
type: string
example: Shares
rows:
type: array
example:
-
positions: 'Increased Positions'
holders: '1,938'
shares: '165,067,100'
-
positions: 'Decreased Positions'
holders: '2,507'
shares: '230,155,346'
-
positions: 'Held Positions'
holders: '266'
shares: '8,676,228,894'
-
positions: 'Total Institutional Shares'
holders: '4,711'
shares: '9,071,451,340'
items:
type: object
properties:
positions:
type: string
example: 'Increased Positions'
holders:
type: string
example: '1,938'
shares:
type: string
example: '165,067,100'
newSoldOutPositions:
type: object
properties:
headers:
type: object
properties:
positions:
type: string
example: 'Active Positions'
holders:
type: string
example: Holders
shares:
type: string
example: Shares
rows:
type: array
example:
-
positions: 'New Positions'
holders: '189'
shares: '45,522,662'
-
positions: 'Sold Out Positions'
holders: '78'
shares: '6,228,057'
items:
type: object
properties:
positions:
type: string
example: 'New Positions'
holders:
type: string
example: '189'
shares:
type: string
example: '45,522,662'
holdingsTransactions:
type: object
properties:
totalRecords:
type: string
example: '78'
institutionalHolders:
type: string
example: null
sharesHeld:
type: string
example: null
table:
type: object
properties:
headers:
type: object
properties:
ownerName:
type: string
example: 'Owner Name'
date:
type: string
example: Date
sharesHeld:
type: string
example: 'Shares Held'
sharesChange:
type: string
example: 'Change (Shares)'
sharesChangePCT:
type: string
example: 'Change (%)'
marketValue:
type: string
example: 'Value (In 1,000s)'
rows:
type: array
example:
-
ownerName: 'Acrisure Capital Management, Llc'
date: 3/31/2023
sharesHeld: '0'
sharesChange: '-2,036'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Advisors Capital Management, Llc'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-795,635'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Algert Global Llc'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-48,139'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Alight Capital Management Lp'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-60,000'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Alpine Global Management, Llc'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-120,000'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Andra Ap-Fonden'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-78,700'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Appaloosa Lp'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-480,000'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Appleton Group, Llc'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-2,438'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Arete Wealth Advisors, Llc'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-184,215'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Asset Allocation & Management Company, Llc'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-5,250'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Blueshift Asset Management, Llc'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-5,508'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Briaud Financial Planning, Inc'
date: 12/31/2023
sharesHeld: '0'
sharesChange: '-5,680'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Bridgewater Associates, Lp'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-2,076'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Brookfield Corp /On/'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-31,251'
sharesChangePCT: 'Sold Out'
marketValue: ''
-
ownerName: 'Brown Shipley& Co Ltd'
date: 9/30/2023
sharesHeld: '0'
sharesChange: '-110,243'
sharesChangePCT: 'Sold Out'
marketValue: ''
items:
type: object
properties:
ownerName:
type: string
example: 'Acrisure Capital Management, Llc'
date:
type: string
example: 3/31/2023
sharesHeld:
type: string
example: '0'
sharesChange:
type: string
example: '-2,036'
sharesChangePCT:
type: string
example: 'Sold Out'
marketValue:
type: string
example: ''
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/stock/sec-filings:
get:
summary: 'GET /v2/sec-filings'
operationId: gETv2secFilings
description: "\n\nReturns a company's SEC filings, newest first, such as insider transactions (Form 4), annual and quarterly reports, 8-Ks, proxy statements, and registration statements. The body contains the `latest` filings and the full `rows` list; `meta.totalRecords` gives the total number of filings."
parameters:
-
in: query
name: ticker
description: 'Company ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
required: true
schema:
type: string
description: 'Company ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
-
in: query
name: type
description: 'Filing filter, in uppercase: ALL for every filing type, or FORM-4 for insider transaction filings only.'
example: ALL
required: true
schema:
type: string
description: 'Filing filter, in uppercase: ALL for every filing type, or FORM-4 for insider transaction filings only.'
example: ALL
-
in: query
name: limit
description: 'Maximum number of filings to return. Defaults to 15; values above 1000 are capped at 1000.'
example: 15
required: false
schema:
type: integer
description: 'Maximum number of filings to return. Defaults to 15; values above 1000 are capped at 1000.'
example: 15
responses:
200:
description: Success
content:
application/json:
schema:
type: object
example:
meta:
version: v1.0
status: 200
copywrite: 'https://steadyapi.com'
symbol: AAPL
totalRecords: 14
headers:
companyName: 'Company Name'
formType: 'Form Type'
filed: Filed
period: Period
view: View
body:
latest:
-
label: 10-K
value: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317840268&type=HTML&symbol=AAPL&cdn=438829151a8c993b52ce4aa1a1799f41&companyName=Apple+Inc.&formType=10-K&formDescription=Annual+report+pursuant+to+Section+13+or+15%28d%29&dateFiled=2023-11-03'
-
label: 10-Q
value: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=318027498&type=HTML&symbol=AAPL&cdn=1df15f20ee9331418a331724247bceeb&companyName=Apple+Inc.&formType=10-Q&formDescription=General+form+for+quarterly+reports+under+Section+13+or+15%28d%29&dateFiled=2024-02-02'
rows:
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 12/01/2023
period: 11/29/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317904974&type=HTML&symbol=AAPL&cdn=223480e7e41b2dfefe24d0b584ff09c0&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-12-01'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317904974&type=DOC&symbol=AAPL&cdn=223480e7e41b2dfefe24d0b584ff09c0&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-12-01'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317904974&type=PDF&symbol=AAPL&cdn=223480e7e41b2dfefe24d0b584ff09c0&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-12-01'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317904974&type=XLS&symbol=AAPL&cdn=223480e7e41b2dfefe24d0b584ff09c0&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-12-01'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 11/20/2023
period: 11/16/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317880738&type=HTML&symbol=AAPL&cdn=4fd242b84a9a8919ded44f4497849cbe&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-20'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317880738&type=DOC&symbol=AAPL&cdn=4fd242b84a9a8919ded44f4497849cbe&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-20'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317880738&type=PDF&symbol=AAPL&cdn=4fd242b84a9a8919ded44f4497849cbe&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-20'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317880738&type=XLS&symbol=AAPL&cdn=4fd242b84a9a8919ded44f4497849cbe&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-20'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 11/14/2023
period: 11/10/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317867434&type=HTML&symbol=AAPL&cdn=b8b8223aa4348f02d7bd75bad335e3f8&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-14'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317867434&type=DOC&symbol=AAPL&cdn=b8b8223aa4348f02d7bd75bad335e3f8&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-14'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317867434&type=PDF&symbol=AAPL&cdn=b8b8223aa4348f02d7bd75bad335e3f8&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-14'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317867434&type=XLS&symbol=AAPL&cdn=b8b8223aa4348f02d7bd75bad335e3f8&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-14'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/17/2023
period: 10/15/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317807374&type=HTML&symbol=AAPL&cdn=7119df539b05934fc91fb40e88a48d3d&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-17'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317807374&type=DOC&symbol=AAPL&cdn=7119df539b05934fc91fb40e88a48d3d&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-17'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317807374&type=PDF&symbol=AAPL&cdn=7119df539b05934fc91fb40e88a48d3d&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-17'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317807374&type=XLS&symbol=AAPL&cdn=7119df539b05934fc91fb40e88a48d3d&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-17'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/10/2023
period: 10/06/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797598&type=HTML&symbol=AAPL&cdn=603564ad4bea722dd9f9aa1203ae71a1&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797598&type=DOC&symbol=AAPL&cdn=603564ad4bea722dd9f9aa1203ae71a1&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797598&type=PDF&symbol=AAPL&cdn=603564ad4bea722dd9f9aa1203ae71a1&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797598&type=XLS&symbol=AAPL&cdn=603564ad4bea722dd9f9aa1203ae71a1&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/10/2023
period: 10/06/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797601&type=HTML&symbol=AAPL&cdn=19ec4da2f84b3f2cd887812113217c10&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797601&type=DOC&symbol=AAPL&cdn=19ec4da2f84b3f2cd887812113217c10&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797601&type=PDF&symbol=AAPL&cdn=19ec4da2f84b3f2cd887812113217c10&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797601&type=XLS&symbol=AAPL&cdn=19ec4da2f84b3f2cd887812113217c10&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/03/2023
period: 10/01/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787279&type=HTML&symbol=AAPL&cdn=254341d2f09d0123833fe5199819ddea&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787279&type=DOC&symbol=AAPL&cdn=254341d2f09d0123833fe5199819ddea&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787279&type=PDF&symbol=AAPL&cdn=254341d2f09d0123833fe5199819ddea&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787279&type=XLS&symbol=AAPL&cdn=254341d2f09d0123833fe5199819ddea&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/03/2023
period: 10/01/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787276&type=HTML&symbol=AAPL&cdn=8815c61b91f269d9d5a47816376edc09&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787276&type=DOC&symbol=AAPL&cdn=8815c61b91f269d9d5a47816376edc09&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787276&type=PDF&symbol=AAPL&cdn=8815c61b91f269d9d5a47816376edc09&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787276&type=XLS&symbol=AAPL&cdn=8815c61b91f269d9d5a47816376edc09&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/03/2023
period: 10/01/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787275&type=HTML&symbol=AAPL&cdn=451e2a6ada3b4c63c91f7850b0996a64&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787275&type=DOC&symbol=AAPL&cdn=451e2a6ada3b4c63c91f7850b0996a64&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787275&type=PDF&symbol=AAPL&cdn=451e2a6ada3b4c63c91f7850b0996a64&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787275&type=XLS&symbol=AAPL&cdn=451e2a6ada3b4c63c91f7850b0996a64&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/03/2023
period: 10/01/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787278&type=HTML&symbol=AAPL&cdn=05c2388fbeb3711557b24a57770b9075&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787278&type=DOC&symbol=AAPL&cdn=05c2388fbeb3711557b24a57770b9075&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787278&type=PDF&symbol=AAPL&cdn=05c2388fbeb3711557b24a57770b9075&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787278&type=XLS&symbol=AAPL&cdn=05c2388fbeb3711557b24a57770b9075&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/03/2023
period: 10/01/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787280&type=HTML&symbol=AAPL&cdn=2455af946ea497d2418a499ab5c129f4&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787280&type=DOC&symbol=AAPL&cdn=2455af946ea497d2418a499ab5c129f4&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787280&type=PDF&symbol=AAPL&cdn=2455af946ea497d2418a499ab5c129f4&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787280&type=XLS&symbol=AAPL&cdn=2455af946ea497d2418a499ab5c129f4&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/03/2023
period: 10/01/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787259&type=HTML&symbol=AAPL&cdn=dcd06f6f2fe1f5706c7d139abf7c1d55&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787259&type=DOC&symbol=AAPL&cdn=dcd06f6f2fe1f5706c7d139abf7c1d55&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787259&type=PDF&symbol=AAPL&cdn=dcd06f6f2fe1f5706c7d139abf7c1d55&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787259&type=XLS&symbol=AAPL&cdn=dcd06f6f2fe1f5706c7d139abf7c1d55&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 09/19/2023
period: 08/08/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317757913&type=HTML&symbol=AAPL&cdn=9c916151d6a841e84d373422d808da75&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-09-19'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317757913&type=DOC&symbol=AAPL&cdn=9c916151d6a841e84d373422d808da75&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-09-19'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317757913&type=PDF&symbol=AAPL&cdn=9c916151d6a841e84d373422d808da75&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-09-19'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317757913&type=XLS&symbol=AAPL&cdn=9c916151d6a841e84d373422d808da75&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-09-19'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: "O'BRIEN DEIRDRE"
formType: '4'
filed: 08/08/2023
period: 08/05/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317672169&type=HTML&symbol=AAPL&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-08-08'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317672169&type=DOC&symbol=AAPL&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-08-08'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317672169&type=PDF&symbol=AAPL&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-08-08'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317672169&type=XLS&symbol=AAPL&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-08-08'
xBrlSubDoc: ''
properties:
meta:
type: object
properties:
version:
type: string
example: v1.0
status:
type: integer
example: 200
copywrite:
type: string
example: 'https://steadyapi.com'
symbol:
type: string
example: AAPL
totalRecords:
type: integer
example: 14
headers:
type: object
properties:
companyName:
type: string
example: 'Company Name'
formType:
type: string
example: 'Form Type'
filed:
type: string
example: Filed
period:
type: string
example: Period
view:
type: string
example: View
body:
type: object
properties:
latest:
type: array
example:
-
label: 10-K
value: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317840268&type=HTML&symbol=AAPL&cdn=438829151a8c993b52ce4aa1a1799f41&companyName=Apple+Inc.&formType=10-K&formDescription=Annual+report+pursuant+to+Section+13+or+15%28d%29&dateFiled=2023-11-03'
-
label: 10-Q
value: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=318027498&type=HTML&symbol=AAPL&cdn=1df15f20ee9331418a331724247bceeb&companyName=Apple+Inc.&formType=10-Q&formDescription=General+form+for+quarterly+reports+under+Section+13+or+15%28d%29&dateFiled=2024-02-02'
items:
type: object
properties:
label:
type: string
example: 10-K
value:
type: string
example: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317840268&type=HTML&symbol=AAPL&cdn=438829151a8c993b52ce4aa1a1799f41&companyName=Apple+Inc.&formType=10-K&formDescription=Annual+report+pursuant+to+Section+13+or+15%28d%29&dateFiled=2023-11-03'
rows:
type: array
example:
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 12/01/2023
period: 11/29/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317904974&type=HTML&symbol=AAPL&cdn=223480e7e41b2dfefe24d0b584ff09c0&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-12-01'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317904974&type=DOC&symbol=AAPL&cdn=223480e7e41b2dfefe24d0b584ff09c0&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-12-01'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317904974&type=PDF&symbol=AAPL&cdn=223480e7e41b2dfefe24d0b584ff09c0&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-12-01'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317904974&type=XLS&symbol=AAPL&cdn=223480e7e41b2dfefe24d0b584ff09c0&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-12-01'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 11/20/2023
period: 11/16/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317880738&type=HTML&symbol=AAPL&cdn=4fd242b84a9a8919ded44f4497849cbe&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-20'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317880738&type=DOC&symbol=AAPL&cdn=4fd242b84a9a8919ded44f4497849cbe&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-20'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317880738&type=PDF&symbol=AAPL&cdn=4fd242b84a9a8919ded44f4497849cbe&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-20'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317880738&type=XLS&symbol=AAPL&cdn=4fd242b84a9a8919ded44f4497849cbe&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-20'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 11/14/2023
period: 11/10/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317867434&type=HTML&symbol=AAPL&cdn=b8b8223aa4348f02d7bd75bad335e3f8&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-14'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317867434&type=DOC&symbol=AAPL&cdn=b8b8223aa4348f02d7bd75bad335e3f8&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-14'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317867434&type=PDF&symbol=AAPL&cdn=b8b8223aa4348f02d7bd75bad335e3f8&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-14'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317867434&type=XLS&symbol=AAPL&cdn=b8b8223aa4348f02d7bd75bad335e3f8&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-11-14'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/17/2023
period: 10/15/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317807374&type=HTML&symbol=AAPL&cdn=7119df539b05934fc91fb40e88a48d3d&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-17'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317807374&type=DOC&symbol=AAPL&cdn=7119df539b05934fc91fb40e88a48d3d&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-17'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317807374&type=PDF&symbol=AAPL&cdn=7119df539b05934fc91fb40e88a48d3d&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-17'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317807374&type=XLS&symbol=AAPL&cdn=7119df539b05934fc91fb40e88a48d3d&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-17'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/10/2023
period: 10/06/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797598&type=HTML&symbol=AAPL&cdn=603564ad4bea722dd9f9aa1203ae71a1&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797598&type=DOC&symbol=AAPL&cdn=603564ad4bea722dd9f9aa1203ae71a1&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797598&type=PDF&symbol=AAPL&cdn=603564ad4bea722dd9f9aa1203ae71a1&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797598&type=XLS&symbol=AAPL&cdn=603564ad4bea722dd9f9aa1203ae71a1&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/10/2023
period: 10/06/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797601&type=HTML&symbol=AAPL&cdn=19ec4da2f84b3f2cd887812113217c10&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797601&type=DOC&symbol=AAPL&cdn=19ec4da2f84b3f2cd887812113217c10&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797601&type=PDF&symbol=AAPL&cdn=19ec4da2f84b3f2cd887812113217c10&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317797601&type=XLS&symbol=AAPL&cdn=19ec4da2f84b3f2cd887812113217c10&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-10'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/03/2023
period: 10/01/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787279&type=HTML&symbol=AAPL&cdn=254341d2f09d0123833fe5199819ddea&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787279&type=DOC&symbol=AAPL&cdn=254341d2f09d0123833fe5199819ddea&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787279&type=PDF&symbol=AAPL&cdn=254341d2f09d0123833fe5199819ddea&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787279&type=XLS&symbol=AAPL&cdn=254341d2f09d0123833fe5199819ddea&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/03/2023
period: 10/01/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787276&type=HTML&symbol=AAPL&cdn=8815c61b91f269d9d5a47816376edc09&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787276&type=DOC&symbol=AAPL&cdn=8815c61b91f269d9d5a47816376edc09&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787276&type=PDF&symbol=AAPL&cdn=8815c61b91f269d9d5a47816376edc09&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787276&type=XLS&symbol=AAPL&cdn=8815c61b91f269d9d5a47816376edc09&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/03/2023
period: 10/01/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787275&type=HTML&symbol=AAPL&cdn=451e2a6ada3b4c63c91f7850b0996a64&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787275&type=DOC&symbol=AAPL&cdn=451e2a6ada3b4c63c91f7850b0996a64&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787275&type=PDF&symbol=AAPL&cdn=451e2a6ada3b4c63c91f7850b0996a64&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787275&type=XLS&symbol=AAPL&cdn=451e2a6ada3b4c63c91f7850b0996a64&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/03/2023
period: 10/01/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787278&type=HTML&symbol=AAPL&cdn=05c2388fbeb3711557b24a57770b9075&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787278&type=DOC&symbol=AAPL&cdn=05c2388fbeb3711557b24a57770b9075&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787278&type=PDF&symbol=AAPL&cdn=05c2388fbeb3711557b24a57770b9075&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787278&type=XLS&symbol=AAPL&cdn=05c2388fbeb3711557b24a57770b9075&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/03/2023
period: 10/01/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787280&type=HTML&symbol=AAPL&cdn=2455af946ea497d2418a499ab5c129f4&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787280&type=DOC&symbol=AAPL&cdn=2455af946ea497d2418a499ab5c129f4&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787280&type=PDF&symbol=AAPL&cdn=2455af946ea497d2418a499ab5c129f4&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787280&type=XLS&symbol=AAPL&cdn=2455af946ea497d2418a499ab5c129f4&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 10/03/2023
period: 10/01/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787259&type=HTML&symbol=AAPL&cdn=dcd06f6f2fe1f5706c7d139abf7c1d55&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787259&type=DOC&symbol=AAPL&cdn=dcd06f6f2fe1f5706c7d139abf7c1d55&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787259&type=PDF&symbol=AAPL&cdn=dcd06f6f2fe1f5706c7d139abf7c1d55&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317787259&type=XLS&symbol=AAPL&cdn=dcd06f6f2fe1f5706c7d139abf7c1d55&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-10-03'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: ''
formType: '4'
filed: 09/19/2023
period: 08/08/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317757913&type=HTML&symbol=AAPL&cdn=9c916151d6a841e84d373422d808da75&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-09-19'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317757913&type=DOC&symbol=AAPL&cdn=9c916151d6a841e84d373422d808da75&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-09-19'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317757913&type=PDF&symbol=AAPL&cdn=9c916151d6a841e84d373422d808da75&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-09-19'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317757913&type=XLS&symbol=AAPL&cdn=9c916151d6a841e84d373422d808da75&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-09-19'
xBrlSubDoc: ''
-
companyName: 'Apple Inc.'
reportingOwner: "O'BRIEN DEIRDRE"
formType: '4'
filed: 08/08/2023
period: 08/05/2023
view:
htmlLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317672169&type=HTML&symbol=AAPL&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-08-08'
docLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317672169&type=DOC&symbol=AAPL&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-08-08'
pdfLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317672169&type=PDF&symbol=AAPL&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-08-08'
xbrLink: ''
ixbrlContent: ''
xlsLink: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317672169&type=XLS&symbol=AAPL&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-08-08'
xBrlSubDoc: ''
items:
type: object
properties:
companyName:
type: string
example: 'Apple Inc.'
reportingOwner:
type: string
example: ''
formType:
type: string
example: '4'
filed:
type: string
example: 12/01/2023
period:
type: string
example: 11/29/2023
view:
type: object
properties:
htmlLink:
type: string
example: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317904974&type=HTML&symbol=AAPL&cdn=223480e7e41b2dfefe24d0b584ff09c0&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-12-01'
docLink:
type: string
example: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317904974&type=DOC&symbol=AAPL&cdn=223480e7e41b2dfefe24d0b584ff09c0&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-12-01'
pdfLink:
type: string
example: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317904974&type=PDF&symbol=AAPL&cdn=223480e7e41b2dfefe24d0b584ff09c0&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-12-01'
xbrLink:
type: string
example: ''
ixbrlContent:
type: string
example: ''
xlsLink:
type: string
example: 'https://app.quotemedia.com/data/downloadFiling?webmasterId=90423&ref=317904974&type=XLS&symbol=AAPL&cdn=223480e7e41b2dfefe24d0b584ff09c0&companyName=Apple+Inc.&formType=4&formDescription=Statement+of+changes+in+beneficial+ownership+of+securities&dateFiled=2023-12-01'
xBrlSubDoc:
type: string
example: ''
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/stock/historical:
get:
summary: 'GET /v2/historical'
operationId: gETv2historical
description: "\n\nReturns daily price history for a symbol between two dates: date, open, high, low, close, and volume for each trading day. Without dates, it returns the last 30 days."
parameters:
-
in: query
name: ticker
description: 'Ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
required: true
schema:
type: string
description: 'Ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
-
in: query
name: type
description: 'Asset class of the symbol: STOCKS, ETF, MUTUALFUNDS, FUTURES, or INDEX. Case-insensitive.'
example: STOCKS
required: true
schema:
type: string
description: 'Asset class of the symbol: STOCKS, ETF, MUTUALFUNDS, FUTURES, or INDEX. Case-insensitive.'
example: STOCKS
-
in: query
name: from_date
description: 'Start date in YYYY-MM-DD format. Defaults to 30 days ago.'
example: null
required: false
schema:
type: string
description: 'Start date in YYYY-MM-DD format. Defaults to 30 days ago.'
example: null
-
in: query
name: to_date
description: 'End date in YYYY-MM-DD format; must be after `from_date`. Defaults to today.'
example: null
required: false
schema:
type: string
description: 'End date in YYYY-MM-DD format; must be after `from_date`. Defaults to today.'
example: null
-
in: query
name: limit
description: 'Maximum number of rows to return. Defaults to 100; values above 1000 are capped at 1000.'
example: 50
required: false
schema:
type: integer
description: 'Maximum number of rows to return. Defaults to 100; values above 1000 are capped at 1000.'
example: 50
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"symbol\": \"SPY\",\n \"totalrecords\": 21,\n \"headers\": {\n \"date\": \"Date\",\n \"close\": \"Close/Last\",\n \"volume\": \"Volume\",\n \"open\": \"Open\",\n \"high\": \"High\",\n \"low\": \"Low\"\n }\n },\n \"body\": [\n {\n \"date\": \"02/02/2024\",\n \"close\": \"494.35\",\n \"volume\": \"99,228,190\",\n \"open\": \"489.65\",\n \"high\": \"496.05\",\n \"low\": \"489.30\"\n },\n {\n \"date\": \"02/01/2024\",\n \"close\": \"489.20\",\n \"volume\": \"91,891,640\",\n \"open\": \"484.63\",\n \"high\": \"489.23\",\n \"low\": \"483.80\"\n },\n {\n \"date\": \"01/31/2024\",\n \"close\": \"482.88\",\n \"volume\": \"126,011,100\",\n \"open\": \"488.62\",\n \"high\": \"489.0813\",\n \"low\": \"482.86\"\n },\n ...\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v3/markets/historical:
get:
summary: 'GET /v3/historical new!'
operationId: gETv3historicalsmallStylecolor2c1e1ebackground15f07apadding1px4pxborderRadius3pxnewsmall
description: "\n\nReturns OHLCV price bars for one symbol at intraday (1 to 240 minutes) or end-of-day (daily, weekly, monthly, quarterly) intervals, with an optional date range. Intraday rows carry a `datetime`; end-of-day rows carry `symbol` and `date`. `meta` echoes the request settings. An invalid date format returns 400, and an empty result returns 404."
parameters:
-
in: query
name: ticker
description: 'Symbol of the stock, ETF, index, or futures contract, up to 10 characters. A leading `^` (as in ^VIX) is accepted. Only `ticker` is read; `symbol` is not supported here.'
example: AAPL
required: true
schema:
type: string
description: 'Symbol of the stock, ETF, index, or futures contract, up to 10 characters. A leading `^` (as in ^VIX) is accepted. Only `ticker` is read; `symbol` is not supported here.'
example: AAPL
-
in: query
name: interval
description: "Bar size. Accepted values:\n - **1min**: 1-minute intervals\n - **5min**: 5-minute intervals\n - **10min**: 10-minute intervals\n - **15min**: 15-minute intervals\n - **30min**: 30-minute intervals\n - **60min**: 60-minute (1 hour) intervals\n - **120min**: 2-hour intervals\n - **240min**: 4-hour intervals\n - **daily**: Daily data\n - **weekly**: Weekly data\n - **monthly**: Monthly data\n - **quarterly**: Quarterly data\n
"
example: 1min
required: true
schema:
type: string
description: "Bar size. Accepted values:\n - **1min**: 1-minute intervals\n - **5min**: 5-minute intervals\n - **10min**: 10-minute intervals\n - **15min**: 15-minute intervals\n - **30min**: 30-minute intervals\n - **60min**: 60-minute (1 hour) intervals\n - **120min**: 2-hour intervals\n - **240min**: 4-hour intervals\n - **daily**: Daily data\n - **weekly**: Weekly data\n - **monthly**: Monthly data\n - **quarterly**: Quarterly data\n
"
example: 1min
-
in: query
name: limit
description: 'optional Maximum number of bars to return, from 1 to 4000. Default: 640.'
example: 100
required: false
schema:
type: integer
description: 'optional Maximum number of bars to return, from 1 to 4000. Default: 640.'
example: 100
-
in: query
name: startDate
description: "optional Start of the date range. The format depends on the interval:\n - End-of-day intervals (daily, weekly, monthly, quarterly): YYYYMMDD. Example: 20260202\n - Intraday intervals (1min to 240min): YYYYMMDDHHMMSS."
example: '20260101000000'
required: false
schema:
type: string
description: "optional Start of the date range. The format depends on the interval:\n - End-of-day intervals (daily, weekly, monthly, quarterly): YYYYMMDD. Example: 20260202\n - Intraday intervals (1min to 240min): YYYYMMDDHHMMSS."
example: '20260101000000'
-
in: query
name: endDate
description: 'optional End of the date range, in the same format as `startDate`.'
example: '20260320000000'
required: false
schema:
type: string
description: 'optional End of the date range, in the same format as `startDate`.'
example: '20260320000000'
-
in: query
name: dividends
description: 'optional Include dividends in the series. Send 1 or 0; the default is 0 (false).'
example: null
required: false
schema:
type: boolean
description: 'optional Include dividends in the series. Send 1 or 0; the default is 0 (false).'
example: null
-
in: query
name: splits
description: 'optional Adjust prices for stock splits. Send 1 or 0; the default is 1 (true).'
example: null
required: false
schema:
type: boolean
description: 'optional Adjust prices for stock splits. Send 1 or 0; the default is 1 (true).'
example: null
-
in: query
name: order
description: 'optional Sort order by time: asc (oldest first) or desc (newest first). Default: asc.'
example: null
required: false
schema:
type: string
description: 'optional Sort order by time: asc (oldest first) or desc (newest first). Default: asc.'
example: null
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"ticker\": \"AAPL\",\n \"interval\": \"5min\",\n \"startDate\": \"20250404000000\",\n \"endDate\": \"20250604000000\",\n \"limit\": 640,\n \"order\": \"asc\",\n \"dividends\": false,\n \"splits\": true\n },\n \"body\": [\n {\n \"datetime\": \"2025-05-21 14:40\",\n \"open\": 201.9818,\n \"high\": 202.3598,\n \"low\": 201.9463,\n \"close\": 202.18,\n \"volume\": 282557\n },\n {\n \"datetime\": \"2025-05-21 14:45\",\n \"open\": 202.1702,\n \"high\": 202.22,\n \"low\": 201.58,\n \"close\": 201.64,\n \"volume\": 344149\n },\n {\n \"datetime\": \"2025-05-21 14:50\",\n \"open\": 201.64,\n \"high\": 201.775,\n \"low\": 201.26,\n \"close\": 201.26,\n \"volume\": 421618\n },\n { ... }\n ]\n}"
400:
description: 'Invalid Parameters'
content:
application/json:
schema:
type: object
example:
message: 'Invalid startDate format for intraday interval. Must be YYYYMMDDHHMMSS format (e.g., 20260101000000)'
properties:
message:
type: string
example: 'Invalid startDate format for intraday interval. Must be YYYYMMDDHHMMSS format (e.g., 20260101000000)'
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
message: 'No historical data found for the specified criteria'
properties:
message:
type: string
example: 'No historical data found for the specified criteria'
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/options:
get:
summary: 'GET /v1/options'
operationId: gETv1options
description: "\n\nReturns the options chain for one ticker and one expiration: calls and puts with strike, last price, bid, ask, volume, open interest, and implied volatility, plus the underlying quote and the full lists of available expiration dates and strikes."
parameters:
-
in: query
name: ticker
description: 'A single ticker symbol; comma-separated lists are rejected. You can send `symbol` instead.'
example: AAPL
required: true
schema:
type: string
description: 'A single ticker symbol; comma-separated lists are rejected. You can send `symbol` instead.'
example: AAPL
-
in: query
name: expiration
description: 'Expiration date as a Unix timestamp in seconds, taken from the `expirationDates` list in a previous response. Omit it to get the default expiration.'
example: null
required: false
schema:
type: integer
description: 'Expiration date as a Unix timestamp in seconds, taken from the `expirationDates` list in a previous response. Omit it to get the default expiration.'
example: null
-
in: query
name: display
description: 'Chain layout: list (calls and puts in separate arrays) or straddle (calls and puts grouped by strike). Defaults to list.'
example: straddle
required: false
schema:
type: string
description: 'Chain layout: list (calls and puts in separate arrays) or straddle (calls and puts grouped by strike). Defaults to list.'
example: straddle
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"symbol\": \"AAPL\",\n \"expiration\": null,\n \"processedTime\": \"2023-08-09T22:12:09.199084Z\",\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\"\n },\n \"body\": [\n {\n \"underlyingSymbol\": \"AAPL\",\n \"expirationDates\": [\n 1691712000, 1692316800, 1692921600, 1693526400, 1694131200,\n 1694736000, 1695340800, 1697760000, 1700179200, 1702598400,\n 1705622400, 1710460800, 1718928000, 1726790400, 1734652800,\n 1737072000, 1750377600, 1766102400\n ],\n \"strikes\": [\n 50, 70, 80, 85, 95, 100, 105, 110, 115, 120, 125, 130, 135, 140,\n 145, 150, 155, 160, 162.5, 165, 167.5, 170, 172.5, 175, 177.5,\n 180, 182.5, 185, 187.5, 190, 192.5, 195, 197.5, 200, 202.5, 205,\n 207.5, 210, 212.5, 215, 217.5, 220, 222.5, 225, 230, 235, 240,\n 245, 250, 255, 260, 265\n ],\n \"hasMiniOptions\": false,\n \"quote\": {\n \"language\": \"en-US\",\n \"region\": \"US\",\n \"quoteType\": \"EQUITY\",\n \"typeDisp\": \"Equity\",\n \"quoteSourceName\": \"Nasdaq Real Time Price\",\n \"triggerable\": true,\n \"customPriceAlertConfidence\": \"HIGH\",\n \"currency\": \"USD\",\n \"marketState\": \"POST\",\n \"regularMarketChangePercent\": -0.89543974,\n \"regularMarketPrice\": 178.19,\n \"exchange\": \"NMS\",\n \"shortName\": \"Apple Inc.\",\n \"longName\": \"Apple Inc.\",\n \"messageBoardId\": \"finmb_24937\",\n \"exchangeTimezoneName\": \"America/New_York\",\n \"exchangeTimezoneShortName\": \"EDT\",\n \"gmtOffSetMilliseconds\": -14400000,\n \"market\": \"us_market\",\n \"esgPopulated\": false,\n \"firstTradeDateMilliseconds\": 345479400000,\n \"sharesOutstanding\": 15728700416,\n \"bookValue\": 3.852,\n \"fiftyDayAverage\": 187.3632,\n \"fiftyDayAverageChange\": -9.1732025,\n \"fiftyDayAverageChangePercent\": -0.048959468,\n \"twoHundredDayAverage\": 160.3686,\n \"twoHundredDayAverageChange\": 17.821396,\n \"marketCap\": 2802697109504,\n \"forwardPE\": 29.797659,\n \"priceToBook\": 46.259087,\n \"sourceInterval\": 15,\n \"exchangeDataDelayedBy\": 0,\n \"averageAnalystRating\": \"2.0 - Buy\",\n \"tradeable\": false,\n \"cryptoTradeable\": false,\n \"priceHint\": 2,\n \"postMarketChangePercent\": 0.089793846,\n \"postMarketTime\": 1691619122,\n \"postMarketPrice\": 178.35,\n \"postMarketChange\": 0.16000366,\n \"regularMarketChange\": -1.6100006,\n \"regularMarketTime\": 1691611201,\n \"regularMarketDayHigh\": 180.93,\n \"regularMarketDayRange\": \"177.01 - 180.93\",\n \"regularMarketDayLow\": 177.01,\n \"regularMarketVolume\": 56570198,\n \"regularMarketPreviousClose\": 179.8,\n \"bid\": 178.26,\n \"ask\": 178.25,\n \"bidSize\": 8,\n \"askSize\": 10,\n \"fullExchangeName\": \"NasdaqGS\",\n \"financialCurrency\": \"USD\",\n \"regularMarketOpen\": 180.87,\n \"averageDailyVolume3Month\": 57005840,\n \"averageDailyVolume10Day\": 60996280,\n \"fiftyTwoWeekLowChange\": 54.020004,\n \"fiftyTwoWeekLowChangePercent\": 0.43504876,\n \"fiftyTwoWeekRange\": \"124.17 - 198.23\",\n \"fiftyTwoWeekHighChange\": -20.039993,\n \"fiftyTwoWeekHighChangePercent\": -0.101094656,\n \"fiftyTwoWeekLow\": 124.17,\n \"fiftyTwoWeekHigh\": 198.23,\n \"fiftyTwoWeekChangePercent\": 6.2396646,\n \"dividendDate\": 1692230400,\n \"earningsTimestamp\": 1691096400,\n \"earningsTimestampStart\": 1698231540,\n \"earningsTimestampEnd\": 1698667200,\n \"trailingAnnualDividendRate\": 0.93,\n \"trailingPE\": 30.252972,\n \"dividendRate\": 0.96,\n \"trailingAnnualDividendYield\": 0.005172414,\n \"dividendYield\": 0.53,\n \"epsTrailingTwelveMonths\": 5.89,\n \"epsForward\": 5.98,\n \"epsCurrentYear\": 5.49,\n \"priceEpsCurrentYear\": 32.457195,\n \"twoHundredDayAverageChangePercent\": 0.11112771,\n \"displayName\": \"Apple\",\n \"symbol\": \"AAPL\"\n },\n \"options\": [\n {\n \"expirationDate\": 1691712000,\n \"hasMiniOptions\": false,\n \"calls\": [\n {\n \"contractSymbol\": \"AAPL230811C00050000\",\n \"strike\": 50,\n \"currency\": \"USD\",\n \"lastPrice\": 129.3,\n \"change\": 0,\n \"percentChange\": 0,\n \"volume\": 2,\n \"openInterest\": 4,\n \"bid\": 127.5,\n \"ask\": 128.8,\n \"contractSize\": \"REGULAR\",\n \"expiration\": 1691712000,\n \"lastTradeDate\": 1691518707,\n \"impliedVolatility\": 7.26562591796875,\n \"inTheMoney\": true\n },\n { ... }\n ],\n \"puts\": [\n {\n \"contractSymbol\": \"AAPL230811P00070000\",\n \"strike\": 70,\n \"currency\": \"USD\",\n \"lastPrice\": 0.01,\n \"change\": 0,\n \"percentChange\": 0,\n \"volume\": 1,\n \"openInterest\": 2,\n \"bid\": 0,\n \"ask\": 0.01,\n \"contractSize\": \"REGULAR\",\n \"expiration\": 1691712000,\n \"lastTradeDate\": 1691435803,\n \"impliedVolatility\": 3.1250021875,\n \"inTheMoney\": false\n },\n {...}\n ]\n }\n ]\n }\n ]\n}\n"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/options/unusual-options-activity:
get:
summary: 'GET /v1/unusual-options-activity'
operationId: gETv1unusualOptionsActivity
description: "\n\nReturns option contracts trading at unusually high volume relative to their open interest, sorted by volume/open-interest ratio, 20 per page. Results cover weekly and monthly calls and puts expiring within 30 days. Without `date`, contracts must also have a volume/open-interest ratio of at least 1.24, volume of at least 500, open interest of at least 100, and a last price of at least $0.10."
parameters:
-
in: query
name: type
description: 'Underlying asset class: STOCKS, ETFS, or INDICES, in uppercase. Lowercase values pass validation but are treated as STOCKS. Defaults to STOCKS.'
example: STOCKS
required: true
schema:
type: string
description: 'Underlying asset class: STOCKS, ETFS, or INDICES, in uppercase. Lowercase values pass validation but are treated as STOCKS. Defaults to STOCKS.'
example: STOCKS
-
in: query
name: ticker
description: 'Limit results to one underlying symbol. You can send `symbol` instead.'
example: null
required: false
schema:
type: string
description: 'Limit results to one underlying symbol. You can send `symbol` instead.'
example: null
-
in: query
name: date
description: 'Return the unusual activity list recorded on a past date, in YYYY-MM-DD format.'
example: null
required: false
schema:
type: string
description: 'Return the unusual activity list recorded on a past date, in YYYY-MM-DD format.'
example: null
-
in: query
name: price_min
description: 'Underlying price filter, as a whole number from -5000 to 5000. A positive value keeps underlyings priced above it; a negative value keeps underlyings priced below its absolute value.'
example: null
required: false
schema:
type: string
description: 'Underlying price filter, as a whole number from -5000 to 5000. A positive value keeps underlyings priced above it; a negative value keeps underlyings priced below its absolute value.'
example: null
-
in: query
name: page
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"count\": 20,\n \"total\": 1736,\n \"page\": \"3\"\n },\n \"body\": [\n {\n \"symbol\": \"PANW|20240223|310.00C\",\n \"baseSymbol\": \"PANW\",\n \"baseLastPrice\": \"261.97\",\n \"baseSymbolType\": \"1\",\n \"symbolType\": \"Call\",\n \"strikePrice\": \"310.00\",\n \"expirationDate\": \"02/23/24\",\n \"daysToExpiration\": \"1\",\n \"bidPrice\": \"0.12\",\n \"midpoint\": \"0.13\",\n \"askPrice\": \"0.14\",\n \"lastPrice\": \"0.14\",\n \"volume\": \"2,445\",\n \"openInterest\": \"119\",\n \"volumeOpenInterestRatio\": \"20.55\",\n \"volatility\": \"151.81%\",\n \"delta\": \"0.01892\",\n \"tradeTime\": \"02/21/24\",\n \"symbolCode\": \"N/A\"\n },\n {\n \"symbol\": \"PANW|20240223|235.00P\",\n \"baseSymbol\": \"PANW\",\n \"baseLastPrice\": \"261.97\",\n \"baseSymbolType\": \"1\",\n \"symbolType\": \"Put\",\n \"strikePrice\": \"235.00\",\n \"expirationDate\": \"02/23/24\",\n \"daysToExpiration\": \"1\",\n \"bidPrice\": \"0.28\",\n \"midpoint\": \"0.29\",\n \"askPrice\": \"0.30\",\n \"lastPrice\": \"0.30\",\n \"volume\": \"3,754\",\n \"openInterest\": \"184\",\n \"volumeOpenInterestRatio\": \"20.40\",\n \"volatility\": \"123.03%\",\n \"delta\": \"-0.04259\",\n \"tradeTime\": \"02/21/24\",\n \"symbolCode\": \"N/A\"\n },\n {...}\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/options/iv-rank-percentile:
get:
summary: 'GET /v1/iv-rank-percentile'
operationId: gETv1ivRankPercentile
description: "\n\nReturns symbols from the day's most-active options list for the chosen asset class (last price at least $0.10), 20 per page. Each row includes last price and change, total options volume, weighted implied volatility, one-year IV rank and IV percentile, one-year IV high, and IV change, plus market cap, enterprise value, shares outstanding, annual and last-quarter sales and net income, beta, insider and institutional ownership, float, five-year revenue growth, EBIT, and EBITDA. Fundamentals are N/A for indices."
parameters:
-
in: query
name: type
description: 'Asset class: STOCKS, ETFS, or INDICES. Defaults to STOCKS.'
example: STOCKS
required: true
schema:
type: string
description: 'Asset class: STOCKS, ETFS, or INDICES. Defaults to STOCKS.'
example: STOCKS
-
in: query
name: price_min
description: 'Last price filter, as a whole number from -5000 to 5000. A positive value keeps symbols priced above it; a negative value keeps symbols priced below its absolute value.'
example: null
required: false
schema:
type: string
description: 'Last price filter, as a whole number from -5000 to 5000. A positive value keeps symbols priced above it; a negative value keeps symbols priced below its absolute value.'
example: null
-
in: query
name: page
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"count\": 20,\n \"total\": 500,\n \"page\": 1\n },\n \"body\": [\n {\n \"symbol\": \"NVDA\",\n \"symbolName\": \"Nvidia Corp\",\n \"lastPrice\": \"204.64\",\n \"priceChange\": \"-9.02\",\n \"percentChange\": \"-4.22%\",\n \"marketCap\": \"4,931,824,000\",\n \"enterpriseValue\": \"4,900,464,000\",\n \"sharesOutstanding\": \"24,100,000\",\n \"annualSales\": \"215,938,000,000\",\n \"annualNetIncome\": \"120,067,000,000\",\n \"lastQuarterSales\": \"96,221,000,000\",\n \"lastQuarterIncome\": \"59,688,000,000\",\n \"beta\": \"2.22\",\n \"percentInsider\": \"3.94%\",\n \"percentInstitutional\": \"65.27%\",\n \"float\": \"23,150,460\",\n \"floatPercentage\": \"96.06%\",\n \"revenueGrowth5y\": \"1,194.98%\",\n \"ebit\": \"197,579,000,000\",\n \"ebitda\": \"200,422,000,000\",\n \"optionsTotalVolume\": \"4,355,592\",\n \"optionsWeightedImpliedVolatility\": \"45.67%\",\n \"optionsImpliedVolatilityRank1y\": \"61.38%\",\n \"optionsImpliedVolatilityPercentile1y\": \"84%\",\n \"optionsWeightedImpliedVolatilityHigh1y\": \"54.93%\",\n \"optionsWeightedImpliedVolatilityChange\": \"+4.35%\",\n \"tradeTime\": \"10/30/26\",\n \"symbolCode\": \"STK\",\n \"symbolType\": 1,\n \"hasOptions\": \"Yes\"\n },\n {\n \"symbol\": \"INTC\",\n \"symbolName\": \"Intel Corp\",\n \"lastPrice\": \"65.76\",\n \"priceChange\": \"-26.31\",\n \"percentChange\": \"-28.58%\",\n \"marketCap\": \"331,693,472\",\n \"enterpriseValue\": \"364,013,472\",\n \"sharesOutstanding\": \"5,044,000\",\n \"annualSales\": \"52,853,000,000\",\n \"annualNetIncome\": \"-267,000,000\",\n \"lastQuarterSales\": \"16,128,000,000\",\n \"lastQuarterIncome\": \"-11,033,000,000\",\n \"beta\": \"2.22\",\n \"percentInsider\": \"0.05%\",\n \"percentInstitutional\": \"64.53%\",\n \"float\": \"5,041,478\",\n \"floatPercentage\": \"99.95%\",\n \"revenueGrowth5y\": \"-32.12%\",\n \"ebit\": \"-77,000,000\",\n \"ebitda\": \"11,629,000,000\",\n \"optionsTotalVolume\": \"3,449,047\",\n \"optionsWeightedImpliedVolatility\": \"61.20%\",\n \"optionsImpliedVolatilityRank1y\": \"26.56%\",\n \"optionsImpliedVolatilityPercentile1y\": \"32%\",\n \"optionsWeightedImpliedVolatilityHigh1y\": \"104.35%\",\n \"optionsWeightedImpliedVolatilityChange\": \"-1.58%\",\n \"tradeTime\": \"10/30/26\",\n \"symbolCode\": \"STK\",\n \"symbolType\": 1,\n \"hasOptions\": \"Yes\"\n },\n {...}\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/options/iv-change:
get:
summary: 'GET /v1/iv-change'
operationId: gETv1ivChange
description: "\n\nReturns stock option contracts with the largest percent change in implied volatility, 20 per page. Contracts traded in the last two days, expire in 15 or more days, and have a last price of at least $0.10, volume of at least 500, and open interest of at least 100. Exchanges are limited to AMEX, NYSE, NASDAQ, and CBOE indices."
parameters:
-
in: query
name: type
description: 'Asset class: STOCKS, ETFS, or INDICES. Validated but not applied; results always cover stock options.'
example: STOCKS
required: true
schema:
type: string
description: 'Asset class: STOCKS, ETFS, or INDICES. Validated but not applied; results always cover stock options.'
example: STOCKS
-
in: query
name: direction
description: 'UP returns contracts whose IV rose more than 10%, largest first. DOWN returns contracts with an IV change below 10%, smallest first. Defaults to UP.'
example: UP
required: false
schema:
type: string
description: 'UP returns contracts whose IV rose more than 10%, largest first. DOWN returns contracts with an IV change below 10%, smallest first. Defaults to UP.'
example: UP
-
in: query
name: price_min
description: 'Underlying price filter, as a whole number from -5000 to 5000. A positive value keeps underlyings priced above it; a negative value keeps underlyings priced below its absolute value.'
example: null
required: false
schema:
type: string
description: 'Underlying price filter, as a whole number from -5000 to 5000. A positive value keeps underlyings priced above it; a negative value keeps underlyings priced below its absolute value.'
example: null
-
in: query
name: page
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"count\": 20,\n \"total\": 273,\n \"page\": \"1\"\n },\n \"body\": [\n {\n \"symbol\": \"IONQ|20241018|8.00C\",\n \"baseSymbol\": \"IONQ\",\n \"baseLastPrice\": \"9.71\",\n \"baseSymbolType\": 1,\n \"symbolType\": \"Call\",\n \"strikePrice\": \"8.00\",\n \"expirationDate\": \"10/18/24\",\n \"daysToExpiration\": \"20\",\n \"bidPrice\": \"1.23\",\n \"askPrice\": \"2.12\",\n \"lastPrice\": \"1.72\",\n \"volume\": \"779\",\n \"openInterest\": \"302\",\n \"delta\": \"0.79229\",\n \"volatilityPercentChange\": \"+94.44%\",\n \"volatility\": \"125.74%\",\n \"tradeTime\": \"09/27/24\"\n },\n {\n \"symbol\": \"BTI|20241220|33.00C\",\n \"baseSymbol\": \"BTI\",\n \"baseLastPrice\": \"36.84\",\n \"baseSymbolType\": 1,\n \"symbolType\": \"Call\",\n \"strikePrice\": \"33.00\",\n \"expirationDate\": \"12/20/24\",\n \"daysToExpiration\": \"83\",\n \"bidPrice\": \"2.50\",\n \"askPrice\": \"6.20\",\n \"lastPrice\": \"4.65\",\n \"volume\": \"570\",\n \"openInterest\": \"3,387\",\n \"delta\": \"0.75360\",\n \"volatilityPercentChange\": \"+79.42%\",\n \"volatility\": \"36.71%\",\n \"tradeTime\": \"09/27/24\"\n },\n { ... }\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/options/most-active:
get:
summary: 'GET /v1/most-active hot!'
operationId: gETv1mostActivesmallStylecolorf8f2f2backgroundfa256fpadding1px4pxborderRadius3pxhotsmall
description: "\n\nReturns the stocks, ETFs, or indices with the highest total options volume on the day, 20 per page. Each row includes last price, price change, 1-year IV rank, total options volume, put and call volume percentages, and the put/call volume ratio."
parameters:
-
in: query
name: type
description: 'Asset class: STOCKS, ETFS, or INDICES (uppercase). Defaults to STOCKS.'
example: STOCKS
required: true
schema:
type: string
description: 'Asset class: STOCKS, ETFS, or INDICES (uppercase). Defaults to STOCKS.'
example: STOCKS
-
in: query
name: page
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"count\": 20,\n \"total\": 500,\n \"page\": \"1\"\n },\n \"body\": [\n {\n \"symbol\": \"NVDA\",\n \"symbolType\": 1,\n \"symbolName\": \"Nvidia Corp\",\n \"hasOptions\": \"Yes\",\n \"lastPrice\": \"785.38\",\n \"priceChange\": \"+110.66\",\n \"percentChange\": \"+16.40%\",\n \"optionsImpliedVolatilityRank1y\": \"38.66%\",\n \"optionsTotalVolume\": \"2,493,798\",\n \"optionsPutVolumePercent\": \"38.9%\",\n \"optionsCallVolumePercent\": \"61.1%\",\n \"optionsPutCallVolumeRatio\": \"0.64\",\n \"tradeTime\": \"02/22/24\",\n \"symbolCode\": \"STK\"\n },\n {\n \"symbol\": \"TSLA\",\n \"symbolType\": 1,\n \"symbolName\": \"Tesla Inc\",\n \"hasOptions\": \"Yes\",\n \"lastPrice\": \"197.41\",\n \"priceChange\": \"+2.64\",\n \"percentChange\": \"+1.36%\",\n \"optionsImpliedVolatilityRank1y\": \"29.04%\",\n \"optionsTotalVolume\": \"1,960,746\",\n \"optionsPutVolumePercent\": \"36.3%\",\n \"optionsCallVolumePercent\": \"63.7%\",\n \"optionsPutCallVolumeRatio\": \"0.57\",\n \"tradeTime\": \"02/22/24\",\n \"symbolCode\": \"STK\"\n },\n {...}\n ]\n }"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/options/highest-iv:
get:
summary: 'GET /v1/highest-iv'
operationId: gETv1highestIv
description: "\n\nReturns the 20 stock option contracts with the highest implied volatility, useful for finding covered call, cash-secured put, or spread candidates with elevated premiums. Contracts have IV of at least 60%, 15 or more days to expiration, a last price of at least $0.10, volume of at least 500, and open interest of at least 100."
parameters:
-
in: query
name: sort
description: 'HIGHEST or LOWEST. Validated but not applied; results are always sorted highest IV first.'
example: HIGHEST
required: true
schema:
type: string
description: 'HIGHEST or LOWEST. Validated but not applied; results are always sorted highest IV first.'
example: HIGHEST
-
in: query
name: page
description: 'Page number. Validated and echoed in `meta`, but the response always contains the first 20 results.'
example: 1
required: false
schema:
type: integer
description: 'Page number. Validated and echoed in `meta`, but the response always contains the first 20 results.'
example: 1
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"count\": 20,\n \"total\": 1018,\n \"page\": \"1\"\n },\n \"body\": [\n {\n \"symbol\": \"WULF|20250117|1.50C\",\n \"baseSymbol\": \"WULF\",\n \"baseLastPrice\": \"2.14\",\n \"baseSymbolType\": 1,\n \"symbolType\": \"Call\",\n \"strikePrice\": \"1.50\",\n \"expirationDate\": \"01/17/25\",\n \"daysToExpiration\": \"329\",\n \"bidPrice\": \"1.35\",\n \"askPrice\": \"2.05\",\n \"lastPrice\": \"1.50\",\n \"volume\": \"772\",\n \"openInterest\": \"2,594\",\n \"volumeOpenInterestRatio\": \"0.30\",\n \"delta\": \"0.77343\",\n \"volatility\": \"420.81%\",\n \"tradeTime\": \"02/22/24\"\n },\n {\n \"symbol\": \"IOVA|20240315|5.00C\",\n \"baseSymbol\": \"IOVA\",\n \"baseLastPrice\": \"15.94\",\n \"baseSymbolType\": 1,\n \"symbolType\": \"Call\",\n \"strikePrice\": \"5.00\",\n \"expirationDate\": \"03/15/24\",\n \"daysToExpiration\": \"21\",\n \"bidPrice\": \"10.70\",\n \"askPrice\": \"11.20\",\n \"lastPrice\": \"10.94\",\n \"volume\": \"588\",\n \"openInterest\": \"7,372\",\n \"volumeOpenInterestRatio\": \"0.08\",\n \"delta\": \"0.96607\",\n \"volatility\": \"342.47%\",\n \"tradeTime\": \"02/22/24\"\n },\n {...}\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/options/options-flow:
get:
summary: 'GET /v1/options-flow hot!'
operationId: gETv1optionsFlowsmallStylecolorf8f2f2backgroundfa256fpadding1px4pxborderRadius3pxhotsmall
description: "\n\nReturns large individual option trades (more than 100 contracts) on weekly and monthly calls and puts, sorted by premium, 20 per page. Each trade includes price, size, side, premium, volume, open interest, implied volatility, delta, trade condition, and trade time, which helps gauge directional sentiment from large orders."
parameters:
-
in: query
name: type
description: 'Underlying asset class: STOCKS, ETFS, or INDICES (uppercase). Defaults to STOCKS.'
example: STOCKS
required: true
schema:
type: string
description: 'Underlying asset class: STOCKS, ETFS, or INDICES (uppercase). Defaults to STOCKS.'
example: STOCKS
-
in: query
name: page
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"count\": 20,\n \"total\": 11984,\n \"page\": \"1\"\n },\n \"body\": [\n {\n \"symbol\": \"AMD|20240621|150.00C\",\n \"baseSymbol\": \"AMD\",\n \"lastPrice\": \"183.22\",\n \"symbolType\": \"Call\",\n \"strikePrice\": \"150.00\",\n \"expiration\": \"06/21/24\",\n \"dte\": \"120\",\n \"bidXSize\": \"41.25 x 237\",\n \"askXSize\": \"41.50 x 143\",\n \"tradePrice\": \"41.50\",\n \"tradeSize\": \"10,000\",\n \"side\": \"ask\",\n \"premium\": \"$41,500,000\",\n \"volume\": \"10,048\",\n \"openInterest\": \"9,011\",\n \"volatility\": \"48.50%\",\n \"delta\": \"0.82194\",\n \"tradeCondition\": \"SLCN\",\n \"label\": \"BuyToOpen\",\n \"tradeTime\": \"02/22/24 12:23:58\",\n \"expirationType\": \"M\",\n \"askPrice\": \"41.50\",\n \"bidPrice\": \"41.25\",\n \"baseSymbolType\": 1\n },\n {\n \"symbol\": \"PANW|20240223|335.00P\",\n \"baseSymbol\": \"PANW\",\n \"lastPrice\": \"269.24\",\n \"symbolType\": \"Put\",\n \"strikePrice\": \"335.00\",\n \"expiration\": \"02/23/24\",\n \"dte\": \"1\",\n \"bidXSize\": \"63.95 x 47\",\n \"askXSize\": \"66.80 x 31\",\n \"tradePrice\": \"65.50\",\n \"tradeSize\": \"3,010\",\n \"side\": \"mid\",\n \"premium\": \"$19,715,500\",\n \"volume\": \"4,233\",\n \"openInterest\": \"756\",\n \"volatility\": \"253.36%\",\n \"delta\": \"-0.94328\",\n \"tradeCondition\": \"SLFT\",\n \"label\": \"ToOpen\",\n \"tradeTime\": \"02/22/24 14:51:42\",\n \"expirationType\": \"W\",\n \"askPrice\": \"66.80\",\n \"bidPrice\": \"63.95\",\n \"baseSymbolType\": 1\n },\n {...}\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/options:
get:
summary: 'GET /v2/options'
operationId: gETv2options
description: "\n\nReturns option chain rows for a symbol with calls and puts side by side, covering contracts that expire between two dates. Each row lists the strike with the last price, change, bid, ask, volume, and open interest for both the call and the put. `meta` includes the total record count, last trade, and column headers."
parameters:
-
in: query
name: ticker
description: 'Underlying ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
required: true
schema:
type: string
description: 'Underlying ticker symbol, such as AAPL. You can send `symbol` instead; if both are present, `ticker` wins.'
example: AAPL
-
in: query
name: type
description: 'Asset class of the underlying: STOCKS, ETF, MUTUALFUNDS, FUTURES, or INDEX. Case-insensitive.'
example: STOCKS
required: true
schema:
type: string
description: 'Asset class of the underlying: STOCKS, ETF, MUTUALFUNDS, FUTURES, or INDEX. Case-insensitive.'
example: STOCKS
-
in: query
name: from_date
description: 'Earliest expiration date in YYYY-MM-DD format. Defaults to the first day of the current month.'
example: null
required: false
schema:
type: string
description: 'Earliest expiration date in YYYY-MM-DD format. Defaults to the first day of the current month.'
example: null
-
in: query
name: to_date
description: 'Latest expiration date in YYYY-MM-DD format; must be after `from_date`. Defaults to 30 days after the first day of the current month.'
example: null
required: false
schema:
type: string
description: 'Latest expiration date in YYYY-MM-DD format; must be after `from_date`. Defaults to 30 days after the first day of the current month.'
example: null
-
in: query
name: limit
description: 'Maximum number of rows to return. Defaults to 20; values above 1000 are capped at 1000.'
example: 50
required: false
schema:
type: integer
description: 'Maximum number of rows to return. Defaults to 20; values above 1000 are capped at 1000.'
example: 50
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"totalrecords\": 48,\n \"lastTrade\": \"LAST TRADE: $185.85 (AS OF FEB 2, 2024)\",\n \"headers\": {\n \"expiryDate\": \"Exp. Date\",\n \"c_Last\": \"Last\",\n \"c_Change\": \"Change\",\n \"c_Bid\": \"Bid\",\n \"c_Ask\": \"Ask\",\n \"c_Volume\": \"Volume\",\n \"c_Openinterest\": \"Open Int.\",\n \"strike\": \"Strike\",\n \"p_Last\": \"Last\",\n \"p_Change\": \"Change\",\n \"p_Bid\": \"Bid\",\n \"p_Ask\": \"Ask\",\n \"p_Volume\": \"Volume\",\n \"p_Openinterest\": \"Open Int.\"\n },\n \"from_date\": [\n {\n \"label\": \"February 2024\",\n \"value\": \"2024-02-09|2024-02-23\"\n },\n {\n \"label\": \"March 2024\",\n \"value\": \"2024-03-01|2024-03-22\"\n },\n {\n \"label\": \"April 2024\",\n \"value\": \"2024-04-19|2024-04-19\"\n },\n {\n \"label\": \"May 2024\",\n \"value\": \"2024-05-17|2024-05-17\"\n },\n {\n \"label\": \"June 2024\",\n \"value\": \"2024-06-21|2024-06-21\"\n },\n {\n \"label\": \"July 2024\",\n \"value\": \"2024-07-19|2024-07-19\"\n },\n {\n \"label\": \"August 2024\",\n \"value\": \"2024-08-16|2024-08-16\"\n },\n {\n \"label\": \"September 2024\",\n \"value\": \"2024-09-20|2024-09-20\"\n },\n {\n \"label\": \"December 2024\",\n \"value\": \"2024-12-20|2024-12-20\"\n },\n {\n \"label\": \"January 2025\",\n \"value\": \"2025-01-17|2025-01-17\"\n },\n {\n \"label\": \"March 2025\",\n \"value\": \"2025-03-21|2025-03-21\"\n },\n {\n \"label\": \"June 2025\",\n \"value\": \"2025-06-20|2025-06-20\"\n },\n {\n \"label\": \"September 2025\",\n \"value\": \"2025-09-19|2025-09-19\"\n },\n {\n \"label\": \"December 2025\",\n \"value\": \"2025-12-19|2025-12-19\"\n },\n {\n \"label\": \"January 2026\",\n \"value\": \"2026-01-16|2026-01-16\"\n },\n {\n \"label\": \"June 2026\",\n \"value\": \"2026-06-18|2026-06-18\"\n },\n {\n \"label\": \"All\",\n \"value\": \"all\"\n }\n ]\n },\n \"body\": [\n {\n \"expirygroup\": \"February 9, 2024\",\n \"expiryDate\": null,\n \"c_Last\": null,\n \"c_Change\": null,\n \"c_Bid\": null,\n \"c_Ask\": null,\n \"c_Volume\": null,\n \"c_Openinterest\": null,\n \"c_colour\": false,\n \"strike\": null,\n \"p_Last\": null,\n \"p_Change\": null,\n \"p_Bid\": null,\n \"p_Ask\": null,\n \"p_Volume\": null,\n \"p_Openinterest\": null,\n \"p_colour\": false\n },\n {\n \"expirygroup\": \"\",\n \"expiryDate\": \"Feb 9\",\n \"c_Last\": \"18.80\",\n \"c_Change\": \"-0.40\",\n \"c_Bid\": \"18.20\",\n \"c_Ask\": \"18.95\",\n \"c_Volume\": \"5\",\n \"c_Openinterest\": \"25\",\n \"c_colour\": true,\n \"strike\": \"167.50\",\n \"p_Last\": \"0.05\",\n \"p_Change\": \"-0.20\",\n \"p_Bid\": \"0.04\",\n \"p_Ask\": \"0.06\",\n \"p_Volume\": \"10870\",\n \"p_Openinterest\": \"11770\",\n \"p_colour\": false\n },\n {\n \"expirygroup\": \"\",\n \"expiryDate\": \"Feb 9\",\n \"c_Last\": \"16.30\",\n \"c_Change\": \"-2.55\",\n \"c_Bid\": \"15.65\",\n \"c_Ask\": \"16.40\",\n \"c_Volume\": \"600\",\n \"c_Openinterest\": \"315\",\n \"c_colour\": true,\n \"strike\": \"170.00\",\n \"p_Last\": \"0.05\",\n \"p_Change\": \"-0.28\",\n \"p_Bid\": \"0.05\",\n \"p_Ask\": \"0.07\",\n \"p_Volume\": \"9310\",\n \"p_Openinterest\": \"10219\",\n \"p_colour\": false\n },\n ...\n ]\n }"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v3/markets/options:
get:
summary: 'GET /v3/options new!'
operationId: gETv3optionssmallStylecolor2c1e1ebackground15f07apadding1px4pxborderRadius3pxnewsmall
description: "\n\nReturns the option chain for one expiration date, grouped into `Call` and `Put` lists sorted by strike. Each contract includes bid, ask, midpoint, last price, volume, open interest, implied volatility, the Greeks (delta, theta, vega, rho), moneyness, and days to expiration. `meta.expirations` lists the available expiration dates, and `meta.field` describes each column."
parameters:
-
in: query
name: ticker
description: 'Underlying symbol: a stock, ETF, or index. Prefix indexes with `$` or `^`. You can send `symbol` instead; if both are present, `ticker` wins. Example: AAPL, SPY, or $SPX or IWM.'
example: AAPL
required: true
schema:
type: string
description: 'Underlying symbol: a stock, ETF, or index. Prefix indexes with `$` or `^`. You can send `symbol` instead; if both are present, `ticker` wins. Example: AAPL, SPY, or $SPX or IWM.'
example: AAPL
-
in: query
name: expiration
description: "Expiration date in YYYY-MM-DD format. Defaults to this week's Friday, or next Friday once this week's has passed. If no chain exists for that default date, the nearest listed expiration is used."
example: null
required: false
schema:
type: string
description: "Expiration date in YYYY-MM-DD format. Defaults to this week's Friday, or next Friday once this week's has passed. If no chain exists for that default date, the nearest listed expiration is used."
example: null
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v3.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"expirations\": {\n \"weekly\": [\n \"2025-05-27\",\n \"2025-05-28\",\n ...\n ],\n \"monthly\": [\n \"2025-06-20\",\n \"2025-07-18\",\n ...\n ]\n },\n \"field\": {\n \"symbol\": \"\",\n \"baseSymbol\": \"The underlying equity.\",\n \"strikePrice\": \"The price at which the holder of an option can buy (in the case of a call option) or sell (in the case of a put option) the underlying security when the option is exercised.\",\n \"expirationDate\": \"The option expiration date.\",\n \"moneyness\": \"Relative position of the underlying price to the strike price. (Underlying Price) - (Strike Price of Option)\",\n \"bidPrice\": \"The bid price.\",\n \"midpoint\": \"The midpoint between the bid and ask price for the options contract.\",\n \"askPrice\": \"The ask price.\",\n \"lastPrice\": \"The last trade price.\",\n \"priceChange\": \"The difference between the current price and the previous day's settlement price.\",\n \"percentChange\": \"The difference between the current price and the previous day's settlement price expressed as a percentage.\",\n \"volume\": \"The total number of shares or contracts traded for the day.\",\n \"openInterest\": \"The total number of open contracts for the previous day that have been traded but not yet liquidated via offsetting trades.\",\n \"openInterestChange\": \"The change in the number of option contracts traded but not yet liquidated.\",\n \"volatility\": \"Implied Volatility is the estimated volatility of the option strike over the period of the option.\",\n \"delta\": \"Measures the sensitivity of an option's theoretical value to a change in the price of the underlying asset. \",\n \"vega\": \"Measures the sensitivity of the price of an option to changes in volatility.\",\n \"theta\": \"A measure of the time decay of an option, the dollar amount that an option will lose each day due to the passage of time. \",\n \"optionType\": \"Put or Call. A Call option gives you the right to buy a stock and a Put option gives you the right to sell a stock.\",\n \"daysToExpiration\": \"The number of days until the option expires.\",\n \"tradeTime\": \"The trade time.\",\n \"averageVolatility\": \"The average implied volatility of the calls and puts immediately above and below the underlying price.\",\n \"historicVolatility30d\": \"30-Day Historical Volatility: The average deviation from the average price over the last 30 days.\",\n \"baseNextEarningsDate\": \"The next reported earnings date for the underlying asset, or the latest earnings date as reported by the company (if no future date has been released).\",\n \"dividendExDate\": \"The next ex-dividend date, or the latest ex-dividend date if no future date has been released.\",\n \"baseTimeCode\": \"The date on which the earnings report for the underlying asset is released.\",\n \"expirationType\": \"The type of option expiration: monthly or weekly.\",\n \"impliedVolatilityRank1y\": \"The ATM average implied volatility relative to the highest and lowest values over the past 1-year. If IV Rank is 100% this means the IV is at its highest level over the past 1-year.\",\n \"symbolCode\": \"\",\n \"symbolType\": \"A Call option gives you the right to buy a stock and a Put option gives you the right to sell a stock.\"\n }\n },\n \"body\": {\n \"Call\": [\n {\n \"symbol\": \"SPY|20250530|590.00C\",\n \"baseSymbol\": \"SPY\",\n \"strikePrice\": \"590.00\",\n \"expirationDate\": \"05/30/25\",\n \"moneyness\": \"+0.19%\",\n \"bidPrice\": \"4.96\",\n \"midpoint\": \"4.97\",\n \"askPrice\": \"4.98\",\n \"lastPrice\": \"5.00\",\n \"priceChange\": \"+3.40\",\n \"percentChange\": \"+212.50%\",\n \"volume\": \"39,945\",\n \"openInterest\": \"30,435\",\n \"openInterestChange\": \"+2,108\",\n \"volatility\": \"20.08%\",\n \"delta\": \"0.5518\",\n \"vega\": \"0.2120\",\n \"theta\": \"-0.7369\",\n \"optionType\": \"Call\",\n \"daysToExpiration\": \"3\",\n \"tradeTime\": \"05/27/25\",\n \"averageVolatility\": \"18.63%\",\n \"historicVolatility30d\": \"19.69%\",\n \"baseNextEarningsDate\": \"N/A\",\n \"dividendExDate\": \"N/A\",\n \"baseTimeCode\": \"--\",\n \"expirationType\": \"weekly\",\n \"impliedVolatilityRank1y\": \"17.80%\",\n \"symbolType\": \"Call\"\n },\n { ... }\n ],\n \"Put\": [\n {\n \"symbol\": \"SPY|20250530|590.00P\",\n \"baseSymbol\": \"SPY\",\n \"strikePrice\": \"590.00\",\n \"expirationDate\": \"05/30/25\",\n \"moneyness\": \"-0.19%\",\n \"bidPrice\": \"3.21\",\n \"midpoint\": \"3.22\",\n \"askPrice\": \"3.23\",\n \"lastPrice\": \"3.21\",\n \"priceChange\": \"-9.44\",\n \"percentChange\": \"-74.62%\",\n \"volume\": \"23,676\",\n \"openInterest\": \"7,496\",\n \"openInterestChange\": \"-281\",\n \"volatility\": \"17.88%\",\n \"delta\": \"-0.4438\",\n \"vega\": \"0.2116\",\n \"theta\": \"-0.6105\",\n \"optionType\": \"Put\",\n \"daysToExpiration\": \"3\",\n \"tradeTime\": \"05/27/25\",\n \"averageVolatility\": \"18.63%\",\n \"historicVolatility30d\": \"19.69%\",\n \"baseNextEarningsDate\": \"N/A\",\n \"dividendExDate\": \"N/A\",\n \"baseTimeCode\": \"--\",\n \"expirationType\": \"weekly\",\n \"impliedVolatilityRank1y\": \"17.80%\",\n \"symbolType\": \"Put\"\n },\n { ... }\n ]\n }\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/calendar/earnings:
get:
summary: 'GET /v1/earnings'
operationId: gETv1earnings
description: "\n\nReturns the earnings calendar for one date: companies reporting that day with EPS estimates, number of estimates, and last year's report date and EPS. With `ticker`, it instead returns that company's earnings surprise history and its quarterly and yearly EPS forecasts. A newer version is available at /v2/earnings."
parameters:
-
in: query
name: ticker
description: 'Ticker symbol. When set, the response contains the earnings surprise table and forecasts for that company, and `date` is ignored. You can send `symbol` instead.'
example: null
required: false
schema:
type: string
description: 'Ticker symbol. When set, the response contains the earnings surprise table and forecasts for that company, and `date` is ignored. You can send `symbol` instead.'
example: null
-
in: query
name: date
description: 'Calendar date in YYYY-MM-DD format. Defaults to the next trading day.'
example: '2023-11-30'
required: false
schema:
type: string
description: 'Calendar date in YYYY-MM-DD format. Defaults to the next trading day.'
example: '2023-11-30'
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"ticker\": \"AAPL\",\n \"processedTime\": \"2025-05-10T20:23:39.352396Z\"\n },\n \"body\": {\n \"earningsSurpriseTable\": {\n \"headers\": {\n \"fiscalQtrEnd\": \"Fiscal Quarter End\",\n \"dateReported\": \"Date Reported\",\n \"eps\": \"Earnings Per Share*\",\n \"consensusForecast\": \"Consensus EPS* Forecast\",\n \"percentageSurprise\": \"% Surprise\"\n },\n \"rows\": [\n {\n \"fiscalQtrEnd\": \"Mar 2025\",\n \"dateReported\": \"5/1/2025\",\n \"eps\": 1.65,\n \"consensusForecast\": \"1.61\",\n \"percentageSurprise\": \"2.48\"\n },\n { ... }\n ]\n },\n \"quarterlyForecast\": {\n \"asOf\": null,\n \"headers\": {\n \"fiscalEnd\": \"Fiscal Quarter End\",\n \"consensusEPSForecast\": \"Consensus EPS* Forecast\",\n \"highEPSForecast\": \"High EPS* Forecast\",\n \"lowEPSForecast\": \"Low EPS* Forecast\",\n \"noOfEstimates\": \"Number of Estimates\",\n \"up\": \"Over the Last 4 Weeks Number of Revisions - Up\",\n \"down\": \"Over the Last 4 Weeks Number of Revisions - Down\"\n },\n \"rows\": [\n {\n \"fiscalEnd\": \"Jun 2025\",\n \"consensusEPSForecast\": 1.42,\n \"highEPSForecast\": 1.47,\n \"lowEPSForecast\": 1.34,\n \"noOfEstimates\": 10,\n \"up\": 1,\n \"down\": 5\n },\n { ... }\n ]\n },\n \"yearlyForecast\": {\n \"asOf\": null,\n \"headers\": {\n \"fiscalEnd\": \"Fiscal Year End\",\n \"consensusEPSForecast\": \"Consensus EPS* Forecast\",\n \"highEPSForecast\": \"High EPS* Forecast\",\n \"lowEPSForecast\": \"Low EPS* Forecast\",\n \"noOfEstimates\": \"Number of Estimates\",\n \"up\": \"Over the Last 4 Weeks Number of Revisions - Up\",\n \"down\": \"Over the Last 4 Weeks Number of Revisions - Down\"\n },\n \"rows\": [\n {\n \"fiscalEnd\": \"Sep 2025\",\n \"consensusEPSForecast\": 7.12,\n \"highEPSForecast\": 7.25,\n \"lowEPSForecast\": 6.9,\n \"noOfEstimates\": 12,\n \"up\": 3,\n \"down\": 8\n },\n { ... }\n ]\n }\n }\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/calendar/dividends:
get:
summary: 'GET /v1/dividends'
operationId: gETv1dividends
description: "\n\nReturns the dividend calendar for one date: each company's ex-dividend, record, payment, and announcement dates, dividend rate, and indicated annual dividend. With `ticker`, it instead returns that company's dividend history, with the summary fields that accompany it merged into `meta`. A newer version is available at /v2/dividends."
parameters:
-
in: query
name: ticker
description: "Ticker symbol. When set, the response contains that company's dividend history and `date` is ignored. You can send `symbol` instead."
example: AAPL
required: false
schema:
type: string
description: "Ticker symbol. When set, the response contains that company's dividend history and `date` is ignored. You can send `symbol` instead."
example: AAPL
-
in: query
name: date
description: 'Calendar date in YYYY-MM-DD format. Defaults to the next trading day.'
example: null
required: false
schema:
type: string
description: 'Calendar date in YYYY-MM-DD format. Defaults to the next trading day.'
example: null
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"date\": \"2023-11-30\",\n \"processedTime\": \"2023-12-01T00:53:49.609846Z\"\n },\n \"body\": [\n {\n \"companyName\": \"ACNB Corporation Common Stock\",\n \"symbol\": \"ACNB\",\n \"dividend_Ex_Date\": \"11/30/2023\",\n \"payment_Date\": \"12/15/2023\",\n \"record_Date\": \"12/01/2023\",\n \"dividend_Rate\": 0.3,\n \"indicated_Annual_Dividend\": 1.12,\n \"announcement_Date\": \"10/17/2023\"\n },\n { ... }\n ]\n }"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/calendar/economic_events:
get:
summary: 'GET /v1/economic_events'
operationId: gETv1economicEvents
description: "\n\nReturns economic events scheduled for one date across several countries. Each event includes the GMT time, country, event name, actual, consensus, and previous values, and a description of the indicator."
parameters:
-
in: query
name: date
description: 'Calendar date in YYYY-MM-DD format. Defaults to the next trading day.'
example: null
required: false
schema:
type: string
description: 'Calendar date in YYYY-MM-DD format. Defaults to the next trading day.'
example: null
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"date\": \"2023-11-30\",\n \"processedTime\": \"2023-12-01T01:03:25.016842Z\"\n },\n \"body\": [\n {\n \"gmt\": \"24H\",\n \"country\": \"Japan\",\n \"eventName\": \"Construction Orders\",\n \"actual\": \"4.2%\",\n \"consensus\": \"-\",\n \"previous\": \"-3.0%\",\n \"description\": \"Construction Orders number checks with 50 representative construction companies in Japan as subjects, the survey uses mail questionnaires to collect the information. The survey data are used to tabulate: amount of orders received (separately for investors and construction type); completed work amount in a month; amount of unfinished construction at the end of the month; and remaining orders received in terms of the number of months. A higher than expected number should be taken as positive to the JPY, while a lower than expected number as negative.\"\n },\n {\n \"gmt\": \"24H\",\n \"country\": \"Japan\",\n \"eventName\": \"Household Confidence\",\n \"actual\": \"36.1\",\n \"consensus\": \"35.6\",\n \"previous\": \"35.7\",\n \"description\": \"The Japanese Household Confidence indicator is a measure of the mood of consumers. <br/>The index is based on data collected from a survey of around 5000 households.<br/>\\r\\nThe consumer confidence indicator is closely linked to consumer spending and correlated with personal income, purchasing power, employment and business conditions.<BR/><BR/>A higher than expected reading should be taken as positive/bullish for the JPY, while a lower than expected reading should be taken as negative/bearish for the JPY.\"\n },\n {\n \"gmt\": \"24H\",\n \"country\": \"Japan\",\n \"eventName\": \"Housing Starts\",\n \"actual\": \"-6.3%\",\n \"consensus\": \"-6.8%\",\n \"previous\": \"-6.8%\",\n \"description\": \"Housing starts measures the change in the annualized number of new residential buildings that began construction during the reported month. It is a leading indicator of strength in the housing sector.\\r\\n<BR/><BR/>A higher than expected reading should be taken as positive/bullish for the JPY, while a lower than expected reading should be taken as negative/bearish for the JPY.\"\n },\n { ... }\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/calendar/ipo:
get:
summary: 'GET /v1/ipo'
operationId: gETv1ipo
description: "\n\nReturns initial public offerings for one month, split into `priced` and `upcoming` deals. Each deal includes the proposed ticker, company name, exchange, share price, shares offered, dollar value, and deal status."
parameters:
-
in: query
name: date
description: 'Month in YYYY-MM format. Defaults to the current month.'
example: null
required: false
schema:
type: string
description: 'Month in YYYY-MM format. Defaults to the current month.'
example: null
responses:
200:
description: Success
content:
application/json:
schema:
type: object
example:
meta:
version: v1.0
status: 200
copywrite: 'https://steadyapi.com'
date: 2026-10
processedTime: '2026-11-01T15:36:29.998197Z'
body:
priced:
-
dealID: 1404187-119517
proposedTickerSymbol: BHAIU
companyName: 'BHAV Acquisition Corp II'
proposedExchange: 'NASDAQ Global'
proposedSharePrice: '10.00'
sharesOffered: '10,000,000'
pricedDate: 10/29/2026
dollarValueOfSharesOffered: '$100,000,000'
dealStatus: Priced
-
dealID: 165535-119563
proposedTickerSymbol: GBC
companyName: 'GEORGIA BANKING CO INC'
proposedExchange: 'NASDAQ Capital'
proposedSharePrice: null
sharesOffered: '7,074,016'
pricedDate: 10/29/2026
dollarValueOfSharesOffered: ''
dealStatus: Priced
upcoming:
-
dealID: 1405668-119603
proposedTickerSymbol: OPAY
companyName: 'OPAY Ltd'
proposedExchange: NYSE
proposedSharePrice: 19.00-21.00
sharesOffered: '16,000,000'
expectedPriceDate: 10/30/2026
dollarValueOfSharesOffered: '$386,400,000'
properties:
meta:
type: object
properties:
version:
type: string
example: v1.0
status:
type: integer
example: 200
copywrite:
type: string
example: 'https://steadyapi.com'
date:
type: string
example: 2026-10
processedTime:
type: string
example: '2026-11-01T15:36:29.998197Z'
body:
type: object
properties:
priced:
type: array
example:
-
dealID: 1404187-119517
proposedTickerSymbol: BHAIU
companyName: 'BHAV Acquisition Corp II'
proposedExchange: 'NASDAQ Global'
proposedSharePrice: '10.00'
sharesOffered: '10,000,000'
pricedDate: 10/29/2026
dollarValueOfSharesOffered: '$100,000,000'
dealStatus: Priced
-
dealID: 165535-119563
proposedTickerSymbol: GBC
companyName: 'GEORGIA BANKING CO INC'
proposedExchange: 'NASDAQ Capital'
proposedSharePrice: null
sharesOffered: '7,074,016'
pricedDate: 10/29/2026
dollarValueOfSharesOffered: ''
dealStatus: Priced
items:
type: object
properties:
dealID:
type: string
example: 1404187-119517
proposedTickerSymbol:
type: string
example: BHAIU
companyName:
type: string
example: 'BHAV Acquisition Corp II'
proposedExchange:
type: string
example: 'NASDAQ Global'
proposedSharePrice:
type: string
example: '10.00'
sharesOffered:
type: string
example: '10,000,000'
pricedDate:
type: string
example: 10/29/2026
dollarValueOfSharesOffered:
type: string
example: '$100,000,000'
dealStatus:
type: string
example: Priced
upcoming:
type: array
example:
-
dealID: 1405668-119603
proposedTickerSymbol: OPAY
companyName: 'OPAY Ltd'
proposedExchange: NYSE
proposedSharePrice: 19.00-21.00
sharesOffered: '16,000,000'
expectedPriceDate: 10/30/2026
dollarValueOfSharesOffered: '$386,400,000'
items:
type: object
properties:
dealID:
type: string
example: 1405668-119603
proposedTickerSymbol:
type: string
example: OPAY
companyName:
type: string
example: 'OPAY Ltd'
proposedExchange:
type: string
example: NYSE
proposedSharePrice:
type: string
example: 19.00-21.00
sharesOffered:
type: string
example: '16,000,000'
expectedPriceDate:
type: string
example: 10/30/2026
dollarValueOfSharesOffered:
type: string
example: '$386,400,000'
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/calendar/public_offerings:
get:
summary: 'GET /v1/public_offerings'
operationId: gETv1publicOfferings
description: "\n\nReturns secondary public offerings (SPOs) for one month, split into `priced`, `upcoming`, `filed`, and `withdrawn` lists."
parameters:
-
in: query
name: date
description: 'Month in YYYY-MM format. Defaults to the current month.'
example: 2023-11
required: false
schema:
type: string
description: 'Month in YYYY-MM format. Defaults to the current month.'
example: 2023-11
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"date\": \"2023-11\",\n \"processedTime\": \"2023-12-01T01:28:23.124844Z\"\n },\n \"body\": {\n \"priced\": [\n {\n \"dealID\": \"1003944-107155\",\n \"proposedTickerSymbol\": \"SNES\",\n \"companyName\": \"SenesTech, Inc.\",\n \"proposedExchange\": \"NASDAQ Capital\",\n \"proposedSharePrice\": \"1.30\",\n \"sharesOffered\": \"450,306\",\n \"pricedDate\": \"11/29/2023\",\n \"dollarValueOfSharesOffered\": \"$585,398\",\n \"dealStatus\": \"Priced\"\n },\n {\n \"dealID\": \"1178963-108161\",\n \"proposedTickerSymbol\": \"THAR\",\n \"companyName\": \"Tharimmune, Inc.\",\n \"proposedExchange\": \"NASDAQ Capital\",\n \"proposedSharePrice\": \"1.00\",\n \"sharesOffered\": \"1,825,000\",\n \"pricedDate\": \"11/29/2023\",\n \"dollarValueOfSharesOffered\": \"$1,825,000\",\n \"dealStatus\": \"Priced\"\n },\n { ... },\n ],\n \"upcoming\": [],\n \"filed\": [\n {\n \"dealID\": \"1153880-108422\",\n \"proposedTickerSymbol\": \"BWMN\",\n \"companyName\": \"Bowman Consulting Group Ltd.\",\n \"filedDate\": \"11/29/2023\",\n \"dollarValueOfSharesOffered\": \"$100,000,000\"\n },\n {\n \"dealID\": \"935042-108420\",\n \"proposedTickerSymbol\": \"ISTR\",\n \"companyName\": \"Investar Holding Corp\",\n \"filedDate\": \"11/29/2023\",\n \"dollarValueOfSharesOffered\": \"$150,000,000\"\n },\n { ... },\n ],\n \"withdrawn\": [\n {\n \"dealID\": \"1242194-107928\",\n \"proposedTickerSymbol\": \"SGD\",\n \"companyName\": \"Safe & Green Development Corp\",\n \"proposedExchange\": null,\n \"sharesOffered\": \"6,299,212\",\n \"filedDate\": \"10/12/2023\",\n \"dollarValueOfSharesOffered\": \"$8,000,000\",\n \"withdrawDate\": \"11/16/2023\"\n },\n { ... }\n ]\n }\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/calendar/stock-splits:
get:
summary: 'GET /v1/stock-splits'
operationId: gETv1stockSplits
description: "\n\nReturns stock splits from the previous trading day up to an end date, newest first, 100 per page. Each split includes the ticker, company name, split date, whether the stock is optionable, and the split ratio as `old_share_worth` to `share_worth`. `meta.total` holds the total number of splits in the range."
parameters:
-
in: query
name: date
description: 'End of the date range (exclusive) in YYYY-MM-DD format. The range always starts on the previous trading day. Defaults to the next trading day.'
example: null
required: false
schema:
type: string
description: 'End of the date range (exclusive) in YYYY-MM-DD format. The range always starts on the previous trading day. Defaults to the next trading day.'
example: null
-
in: query
name: page
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"date\": \"2025-05-12\",\n \"total\": 65,\n \"page\": \"1\",\n \"processedTime\": \"2025-05-11T17:15:13.751423Z\"\n },\n \"body\": [\n {\n \"ticker\": \"0QRA.IL\",\n \"companyshortname\": \"Bufab AB\",\n \"startdatetime\": \"2025-05-09T04:00:00.000Z\",\n \"optionable\": false,\n \"old_share_worth\": 1,\n \"share_worth\": 5\n },\n {\n \"ticker\": \"1ZY0.BE\",\n \"companyshortname\": \"Medaro Mining Corp\",\n \"startdatetime\": \"2025-05-09T04:00:00.000Z\",\n \"optionable\": false,\n \"old_share_worth\": 5,\n \"share_worth\": 1\n },\n { ... }\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/calendar/earnings:
get:
summary: 'GET /v2/earnings hot!'
operationId: gETv2earningssmallStylecolorf8f2f2backgroundfa256fpadding1px4pxborderRadius3pxhotsmall
description: "\n\nReturns U.S. companies scheduled to report earnings, with the next earnings date, report timing, estimated EPS, last reported EPS, last earnings surprise, and current price data. Choose one mode: upcoming reports within the next `days`, reports between `start_date` and `end_date`, or the next report for a single `ticker`. Results come 50 per page; `meta` holds `count`, `total`, and `page`."
parameters:
-
in: query
name: ticker
description: "Company ticker symbol. Returns that company's next earnings record and ignores the other filters. You can send `symbol` instead; index symbols with a `^` prefix are accepted."
example: null
required: false
schema:
type: string
description: "Company ticker symbol. Returns that company's next earnings record and ignores the other filters. You can send `symbol` instead; index symbols with a `^` prefix are accepted."
example: null
-
in: query
name: days
description: 'Number of days ahead to include, from 1 to 30. Defaults to 30. Ignored when both `start_date` and `end_date` are set.'
example: 7
required: false
schema:
type: integer
description: 'Number of days ahead to include, from 1 to 30. Defaults to 30. Ignored when both `start_date` and `end_date` are set.'
example: 7
-
in: query
name: start_date
description: 'First report date of the range, in YYYY-MM-DD format. Used only together with `end_date`.'
example: null
required: false
schema:
type: string
description: 'First report date of the range, in YYYY-MM-DD format. Used only together with `end_date`.'
example: null
-
in: query
name: end_date
description: 'Last report date of the range, in YYYY-MM-DD format. Used only together with `start_date`.'
example: null
required: false
schema:
type: string
description: 'Last report date of the range, in YYYY-MM-DD format. Used only together with `start_date`.'
example: null
-
in: query
name: price_min
description: 'Whole-number price filter between -5000 and 5000. A positive value keeps stocks priced above it; a negative value keeps stocks priced below its absolute value.'
example: null
required: false
schema:
type: string
description: 'Whole-number price filter between -5000 and 5000. A positive value keeps stocks priced above it; a negative value keeps stocks priced below its absolute value.'
example: null
-
in: query
name: optionable
description: 'true (default) returns only stocks with listed options; false returns stocks without listed options.'
example: null
required: false
schema:
type: string
description: 'true (default) returns only stocks with listed options; false returns stocks without listed options.'
example: null
-
in: query
name: page
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"count\": 8,\n \"total\": 8,\n \"page\": \"1\"\n },\n \"body\": [\n {\n \"symbol\": \"AZO\",\n \"symbolName\": \"Autozone\",\n \"nextEarningsDate\": \"09/24/24\",\n \"lastPrice\": \"3,042.74\",\n \"priceChange\": \"+22.08\",\n \"percentChange\": \"+0.73%\",\n \"highPrice\": \"3,046.28\",\n \"lowPrice\": \"3,013.05\",\n \"volume\": \"100,430\",\n \"tradeTime\": \"15:43 ET\",\n \"timeCode\": \"Before Open\",\n \"estimatedEarnings\": \"$53.59\",\n \"lastReportedEarnings\": \"N/A\",\n \"lastEarningsSurpriseAmount\": \"N/A\",\n \"lastEarningsSurprisePercent\": \"N/A\",\n \"symbolCode\": \"STK\",\n \"symbolType\": 1,\n \"hasOptions\": \"Yes\"\n },\n {\n \"symbol\": \"THO\",\n \"symbolName\": \"Thor Industries\",\n \"nextEarningsDate\": \"09/24/24\",\n \"lastPrice\": \"103.19\",\n \"priceChange\": \"-0.32\",\n \"percentChange\": \"-0.31%\",\n \"highPrice\": \"104.85\",\n \"lowPrice\": \"102.05\",\n \"volume\": \"459,102\",\n \"tradeTime\": \"15:42 ET\",\n \"timeCode\": \"Before Open\",\n \"estimatedEarnings\": \"$1.35\",\n \"lastReportedEarnings\": \"N/A\",\n \"lastEarningsSurpriseAmount\": \"N/A\",\n \"lastEarningsSurprisePercent\": \"N/A\",\n \"symbolCode\": \"STK\",\n \"symbolType\": 1,\n \"hasOptions\": \"Yes\"\n },\n { ... }\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v2/markets/calendar/dividends:
get:
summary: 'GET /v2/dividends new!'
operationId: gETv2dividendssmallStylecolor2c1e1ebackground15f07apadding1px4pxborderRadius3pxnewsmall
description: "\n\nReturns U.S. stocks with listed options that have a dividend event on a given date, with the dividend amount, yield, ex-dividend date, payable date, and latest price. Results come 20 per page; `meta` holds `count`, `total`, and `page`."
parameters:
-
in: query
name: date
description: 'Calendar date in YYYY-MM-DD format. Defaults to the next trading day.'
example: null
required: false
schema:
type: string
description: 'Calendar date in YYYY-MM-DD format. Defaults to the next trading day.'
example: null
-
in: query
name: page
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
required: false
schema:
type: integer
description: 'Page number, starting at 1. Defaults to 1.'
example: 1
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"count\": 56,\n \"total\": 56,\n \"page\": \"1\"\n },\n \"body\": [\n {\n \"symbol\": \"ALCO\",\n \"symbolName\": \"Alico Inc\",\n \"lastPrice\": \"27.99\",\n \"priceChange\": \"-0.01\",\n \"amount\": \"$0.050\",\n \"yield\": \"0.78%\",\n \"exDivDate\": \"09/27/24\",\n \"payableDate\": \"10/11/24\",\n \"symbolType\": 1\n },\n {\n \"symbol\": \"CIB\",\n \"symbolName\": \"Bancolombia S.A. ADR\",\n \"lastPrice\": \"31.97\",\n \"priceChange\": \"-1.05\",\n \"amount\": \"$0.846\",\n \"yield\": \"9.90%\",\n \"exDivDate\": \"09/27/24\",\n \"payableDate\": \"10/11/24\",\n \"symbolType\": 1\n },\n { ... }\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/indicators/sma:
get:
summary: 'GET /v1/indicators/sma'
operationId: gETv1indicatorssma
description: "Returns the simple moving average (SMA) of the chosen price series, calculated from the ticker's price history at the requested interval. Each value is paired with its Unix timestamp, and the response holds the latest 50 values.\n\n"
parameters:
-
in: query
name: ticker
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: TSLA\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
required: true
schema:
type: string
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: TSLA\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
-
in: query
name: interval
description: "Candle size. Each interval uses a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
required: true
schema:
type: string
description: "Candle size. Each interval uses a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
-
in: query
name: series_type
description: "Price used in the calculation:\n - **open**: candle open\n - **close**: candle close\n - **high**: candle high\n - **low**: candle low"
example: close
required: true
schema:
type: string
description: "Price used in the calculation:\n - **open**: candle open\n - **close**: candle close\n - **high**: candle high\n - **low**: candle low"
example: close
-
in: query
name: time_period
description: 'Number of candles in each average, from 1 to 500. Defaults to 10 when omitted.'
example: '50'
required: true
schema:
type: string
description: 'Number of candles in each average, from 1 to 500. Defaults to 10 when omitted.'
example: '50'
-
in: query
name: limit
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
required: false
schema:
type: string
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: ''
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/indicators/rsi:
get:
summary: 'GET /v1/indicators/rsi hot!'
operationId: gETv1indicatorsrsismallStylecolorf8f2f2backgroundfa256fpadding1px4pxborderRadius3pxhotsmall
description: "\n\nReturns the relative strength index (RSI), a 0โ100 momentum oscillator, for the chosen price series. Each value is paired with its Unix timestamp, and the response holds the latest 50 values."
parameters:
-
in: query
name: ticker
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
required: true
schema:
type: string
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
-
in: query
name: interval
description: "Candle size. Each interval uses a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
required: true
schema:
type: string
description: "Candle size. Each interval uses a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
-
in: query
name: series_type
description: "Price used in the calculation:\n - **open**: candle open\n - **close**: candle close\n - **high**: candle high\n - **low**: candle low"
example: close
required: true
schema:
type: string
description: "Price used in the calculation:\n - **open**: candle open\n - **close**: candle close\n - **high**: candle high\n - **low**: candle low"
example: close
-
in: query
name: time_period
description: 'Number of candles in the RSI lookback, from 1 to 500. Defaults to 14 when omitted.'
example: '50'
required: true
schema:
type: string
description: 'Number of candles in the RSI lookback, from 1 to 500. Defaults to 14 when omitted.'
example: '50'
-
in: query
name: limit
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
required: false
schema:
type: string
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: ''
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/indicators/macd:
get:
summary: 'GET /v1/indicators/macd'
operationId: gETv1indicatorsmacd
description: "\n\nReturns the moving average convergence/divergence (MACD) for the chosen price series. Each point includes the MACD line, the signal line, and the histogram with its Unix timestamp, and the response holds the latest 50 points."
parameters:
-
in: query
name: ticker
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
required: true
schema:
type: string
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
-
in: query
name: interval
description: "Candle size. Each interval uses a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
required: true
schema:
type: string
description: "Candle size. Each interval uses a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
-
in: query
name: series_type
description: "Price used in the calculation:\n - **open**: candle open\n - **close**: candle close\n - **high**: candle high\n - **low**: candle low"
example: close
required: true
schema:
type: string
description: "Price used in the calculation:\n - **open**: candle open\n - **close**: candle close\n - **high**: candle high\n - **low**: candle low"
example: close
-
in: query
name: fast_period
description: 'Fast EMA period, from 1 to 200. Default: 12'
example: '12'
required: false
schema:
type: string
description: 'Fast EMA period, from 1 to 200. Default: 12'
example: '12'
-
in: query
name: slow_period
description: 'Slow EMA period, from 1 to 200. Default: 26'
example: '26'
required: false
schema:
type: string
description: 'Slow EMA period, from 1 to 200. Default: 26'
example: '26'
-
in: query
name: signal_period
description: 'Signal line EMA period, from 1 to 200. Default: 9'
example: '9'
required: false
schema:
type: string
description: 'Signal line EMA period, from 1 to 200. Default: 9'
example: '9'
-
in: query
name: limit
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
required: false
schema:
type: string
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: ''
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/indicators/cci:
get:
summary: 'GET /v1/indicators/cci'
operationId: gETv1indicatorscci
description: "\n\nReturns the commodity channel index (CCI), calculated from each candle's high, low, and close. The latest 50 CCI values are returned, each with its Unix timestamp."
parameters:
-
in: query
name: ticker
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
required: true
schema:
type: string
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
-
in: query
name: interval
description: "Candle size. Each interval uses a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
required: true
schema:
type: string
description: "Candle size. Each interval uses a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
-
in: query
name: series_type
description: "Must be sent and must be one of the values below, but it does not change the result, because CCI always uses high, low, and close:\n - **open**: candle open\n - **close**: candle close\n - **high**: candle high\n - **low**: candle low"
example: close
required: true
schema:
type: string
description: "Must be sent and must be one of the values below, but it does not change the result, because CCI always uses high, low, and close:\n - **open**: candle open\n - **close**: candle close\n - **high**: candle high\n - **low**: candle low"
example: close
-
in: query
name: time_period
description: 'Number of candles in the CCI lookback, from 1 to 500. Defaults to 10.'
example: '50'
required: false
schema:
type: string
description: 'Number of candles in the CCI lookback, from 1 to 500. Defaults to 10.'
example: '50'
-
in: query
name: limit
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
required: false
schema:
type: string
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: ''
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/indicators/adx:
get:
summary: 'GET /v1/indicators/adx'
operationId: gETv1indicatorsadx
description: "\n\nReturns the average directional movement index (ADX), which measures trend strength from each candle's high, low, and close. You get the latest 50 ADX values with their Unix timestamps."
parameters:
-
in: query
name: ticker
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
required: true
schema:
type: string
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
-
in: query
name: interval
description: "Candle size. Each interval uses a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
required: true
schema:
type: string
description: "Candle size. Each interval uses a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
-
in: query
name: series_type
description: "Not used by ADX, which always uses high, low, and close. If sent, it must be one of:\n - **open**: candle open\n - **close**: candle close\n - **high**: candle high\n - **low**: candle low"
example: close
required: true
schema:
type: string
description: "Not used by ADX, which always uses high, low, and close. If sent, it must be one of:\n - **open**: candle open\n - **close**: candle close\n - **high**: candle high\n - **low**: candle low"
example: close
-
in: query
name: time_period
description: 'Number of candles in the ADX lookback, from 1 to 500. Defaults to 14 when omitted.'
example: '50'
required: true
schema:
type: string
description: 'Number of candles in the ADX lookback, from 1 to 500. Defaults to 14 when omitted.'
example: '50'
-
in: query
name: limit
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
required: false
schema:
type: string
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: ''
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/indicators/ema:
get:
summary: 'GET /v1/indicators/ema'
operationId: gETv1indicatorsema
description: "\n\nReturns the exponential moving average (EMA) of the chosen price series. Recent candles carry more weight than in an SMA. The response contains the latest 50 EMA values, each with its Unix timestamp."
parameters:
-
in: query
name: ticker
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
required: true
schema:
type: string
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
-
in: query
name: interval
description: "Candle size. Each interval uses a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
required: true
schema:
type: string
description: "Candle size. Each interval uses a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
-
in: query
name: series_type
description: "Price used in the calculation:\n - **open**: candle open\n - **close**: candle close\n - **high**: candle high\n - **low**: candle low"
example: close
required: true
schema:
type: string
description: "Price used in the calculation:\n - **open**: candle open\n - **close**: candle close\n - **high**: candle high\n - **low**: candle low"
example: close
-
in: query
name: time_period
description: 'Number of candles in each average, from 1 to 500. Defaults to 30 when omitted.'
example: '50'
required: true
schema:
type: string
description: 'Number of candles in each average, from 1 to 500. Defaults to 30 when omitted.'
example: '50'
-
in: query
name: limit
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
required: false
schema:
type: string
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: ''
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/indicators/stoch:
get:
summary: 'GET /v1/indicators/stoch'
operationId: gETv1indicatorsstoch
description: "\n\nReturns the stochastic oscillator (STOCH), calculated from each candle's high, low, and close. Each point has SlowK and SlowD values with a Unix timestamp; the latest 50 points are returned."
parameters:
-
in: query
name: ticker
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
required: true
schema:
type: string
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
-
in: query
name: interval
description: 'Candle size: 1m, 5m, 15m, 30m, 1h, 1d, 1wk, 1mo, or 3mo. The lookback is 1 day for 1m, 1 month for 5m to 1h, 5 years for 1d and 1wk, and 10 years for 1mo and 3mo.'
example: 5m
required: true
schema:
type: string
description: 'Candle size: 1m, 5m, 15m, 30m, 1h, 1d, 1wk, 1mo, or 3mo. The lookback is 1 day for 1m, 1 month for 5m to 1h, 5 years for 1d and 1wk, and 10 years for 1mo and 3mo.'
example: 5m
-
in: query
name: fastK_Period
description: 'Number of candles for the fast %K line, from 1 to 50. Default: 5'
example: '5'
required: false
schema:
type: string
description: 'Number of candles for the fast %K line, from 1 to 50. Default: 5'
example: '5'
-
in: query
name: slowK_Period
description: 'Smoothing period for the slow %K line, from 1 to 50. Default: 3'
example: '3'
required: false
schema:
type: string
description: 'Smoothing period for the slow %K line, from 1 to 50. Default: 3'
example: '3'
-
in: query
name: slowD_Period
description: 'Smoothing period for the slow %D line, from 1 to 50. Default: 3'
example: '3'
required: false
schema:
type: string
description: 'Smoothing period for the slow %D line, from 1 to 50. Default: 3'
example: '3'
-
in: query
name: slowK_MAType
description: "Moving average type used to smooth slow %K. Default: 0 Available options:\n - **0**: Simple Moving Average (SMA)\n - **1**: Exponential Moving Average (EMA)\n - **2**: Weighted Moving Average (WMA)\n - **3**: Double Exponential Moving Average (DEMA)\n - **4**: Triple Exponential Moving Average (TEMA)\n - **5**: Triangular Moving Average (TRIMA)\n - **6**: T3 Moving Average\n - **7**: Kaufman Adaptive Moving Average (KAMA)\n - **8**: MESA Adaptive Moving Average (MAMA)"
example: '0'
required: false
schema:
type: string
description: "Moving average type used to smooth slow %K. Default: 0 Available options:\n - **0**: Simple Moving Average (SMA)\n - **1**: Exponential Moving Average (EMA)\n - **2**: Weighted Moving Average (WMA)\n - **3**: Double Exponential Moving Average (DEMA)\n - **4**: Triple Exponential Moving Average (TEMA)\n - **5**: Triangular Moving Average (TRIMA)\n - **6**: T3 Moving Average\n - **7**: Kaufman Adaptive Moving Average (KAMA)\n - **8**: MESA Adaptive Moving Average (MAMA)"
example: '0'
-
in: query
name: slowD_MAType
description: "Moving average type used to smooth slow %D. Default: 0 Available options:\n - **0**: Simple Moving Average (SMA)\n - **1**: Exponential Moving Average (EMA)\n - **2**: Weighted Moving Average (WMA)\n - **3**: Double Exponential Moving Average (DEMA)\n - **4**: Triple Exponential Moving Average (TEMA)\n - **5**: Triangular Moving Average (TRIMA)\n - **6**: T3 Moving Average\n - **7**: Kaufman Adaptive Moving Average (KAMA)\n - **8**: MESA Adaptive Moving Average (MAMA)"
example: '0'
required: false
schema:
type: string
description: "Moving average type used to smooth slow %D. Default: 0 Available options:\n - **0**: Simple Moving Average (SMA)\n - **1**: Exponential Moving Average (EMA)\n - **2**: Weighted Moving Average (WMA)\n - **3**: Double Exponential Moving Average (DEMA)\n - **4**: Triple Exponential Moving Average (TEMA)\n - **5**: Triangular Moving Average (TRIMA)\n - **6**: T3 Moving Average\n - **7**: Kaufman Adaptive Moving Average (KAMA)\n - **8**: MESA Adaptive Moving Average (MAMA)"
example: '0'
-
in: query
name: limit
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
required: false
schema:
type: string
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: ''
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/indicators/adosc:
get:
summary: 'GET /v1/indicators/adosc'
operationId: gETv1indicatorsadosc
description: "\n\nReturns the Chaikin A/D Oscillator (ADOSC): the difference between a fast and a slow EMA of the accumulation/distribution line, calculated from high, low, close, and volume. The latest 50 values are returned with their Unix timestamps."
parameters:
-
in: query
name: ticker
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
required: true
schema:
type: string
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
-
in: query
name: interval
description: "Candle size. Each interval uses a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
required: true
schema:
type: string
description: "Candle size. Each interval uses a fixed lookback window ending now:\n - **1m**: 1-minute candles, last 1 day\n - **5m**: 5-minute candles, last 1 month\n - **15m**: 15-minute candles, last 1 month\n - **30m**: 30-minute candles, last 1 month\n - **1h**: 1-hour candles, last 1 month\n - **1d**: daily candles, last 5 years\n - **1wk**: weekly candles, last 5 years\n - **1mo**: monthly candles, last 10 years\n - **3mo**: quarterly candles, last 10 years"
example: 5m
-
in: query
name: series_type
description: "Not used by ADOSC, which always uses high, low, close, and volume. If sent, it must be one of:\n - **open**: candle open\n - **close**: candle close\n - **high**: candle high\n - **low**: candle low"
example: close
required: true
schema:
type: string
description: "Not used by ADOSC, which always uses high, low, close, and volume. If sent, it must be one of:\n - **open**: candle open\n - **close**: candle close\n - **high**: candle high\n - **low**: candle low"
example: close
-
in: query
name: fast_period
description: 'Fast EMA period, from 1 to 200. Default: 3'
example: '3'
required: false
schema:
type: string
description: 'Fast EMA period, from 1 to 200. Default: 3'
example: '3'
-
in: query
name: slow_period
description: 'Slow EMA period, from 1 to 200. Default: 10'
example: '3'
required: false
schema:
type: string
description: 'Slow EMA period, from 1 to 200. Default: 10'
example: '3'
-
in: query
name: limit
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
required: false
schema:
type: string
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: ''
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/markets/indicators/ad:
get:
summary: 'GET /v1/indicators/ad'
operationId: gETv1indicatorsad
description: "\n\nReturns the Chaikin A/D Line (AD), a cumulative accumulation/distribution measure calculated from high, low, close, and volume. It takes no period settings. The latest 50 values come back with their Unix timestamps."
parameters:
-
in: query
name: ticker
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
required: true
schema:
type: string
description: "A single symbol; comma-separated lists are rejected. You can send `symbol` instead. Example: AAPL\n - **Equity**: AAPL\n - **Cryptocurrencies**: BTC-USD or ETH-USD\n
"
example: AAPL
-
in: query
name: interval
description: 'Candle size: 1m, 5m, 15m, 30m, 1h, 1d, 1wk, 1mo, or 3mo. The lookback is 1 day for 1m, 1 month for 5m to 1h, 5 years for 1d and 1wk, and 10 years for 1mo and 3mo.'
example: 5m
required: true
schema:
type: string
description: 'Candle size: 1m, 5m, 15m, 30m, 1h, 1d, 1wk, 1mo, or 3mo. The lookback is 1 day for 1m, 1 month for 5m to 1h, 5 years for 1d and 1wk, and 10 years for 1mo and 3mo.'
example: 5m
-
in: query
name: limit
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
required: false
schema:
type: string
description: 'Accepts 1 to 1000, but the response currently always contains the latest 50 values.'
example: '50'
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: ''
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- '๐ Stocks & Options hot!'
/api/v1/crypto/profile:
get:
summary: 'GET /v1/crypto/profile'
operationId: gETv1cryptoprofile
description: "\n\nReturns the profile of one cryptocurrency: slug, name, symbol, category, description, date added, status, and project links such as website, explorers, source code, and social accounts."
parameters:
-
in: query
name: key
description: "Coin slug, a lowercase, hyphenated form of the coin's name, such as bitcoin or ethereum."
example: bitcoin
required: true
schema:
type: string
description: "Coin slug, a lowercase, hyphenated form of the coin's name, such as bitcoin or ethereum."
example: bitcoin
responses:
200:
description: Success
content:
application/json:
schema:
type: object
example:
meta:
version: v1.0
status: 200
copywrite: 'https://steadyapi.com'
key: Bitcoin
body:
key: bitcoin
name: Bitcoin
symbol: BTC
category: coin
description: "## What Is Bitcoin (BTC)?\n\nBitcoin is a decentralized cryptocurrency originally described in a 2008 whitepaper by a person, or group of people, using the alias Satoshi Nakamoto. It was launched soon after, in January 2009.\n\nBitcoin is a peer-to-peer online currency, meaning that all transactions happen directly between equal, independent network participants, without the need for any intermediary to permit or facilitate them. Bitcoin was created, according to Nakamotoโs own words, to allow โonline payments to be sent directly from one party to another without going through a financial institution..."
dateAdded: '2010-07-13T00:00:00.000Z'
status: active
urls:
website:
- 'https://bitcoin.org/'
technical_doc:
- 'https://bitcoin.org/bitcoin.pdf'
explorer:
- 'https://blockchain.info/'
- 'https://live.blockcypher.com/btc/'
- 'https://blockchair.com/bitcoin'
- 'https://explorer.viabtc.com/btc'
- 'https://www.oklink.com/btc'
source_code:
- 'https://github.com/bitcoin/bitcoin'
message_board:
- 'https://bitcointalk.org'
chat: []
announcement: []
reddit:
- 'https://reddit.com/r/bitcoin'
facebook: []
twitter: []
properties:
meta:
type: object
properties:
version:
type: string
example: v1.0
status:
type: integer
example: 200
copywrite:
type: string
example: 'https://steadyapi.com'
key:
type: string
example: Bitcoin
body:
type: object
properties:
key:
type: string
example: bitcoin
name:
type: string
example: Bitcoin
symbol:
type: string
example: BTC
category:
type: string
example: coin
description:
type: string
example: "## What Is Bitcoin (BTC)?\n\nBitcoin is a decentralized cryptocurrency originally described in a 2008 whitepaper by a person, or group of people, using the alias Satoshi Nakamoto. It was launched soon after, in January 2009.\n\nBitcoin is a peer-to-peer online currency, meaning that all transactions happen directly between equal, independent network participants, without the need for any intermediary to permit or facilitate them. Bitcoin was created, according to Nakamotoโs own words, to allow โonline payments to be sent directly from one party to another without going through a financial institution..."
dateAdded:
type: string
example: '2010-07-13T00:00:00.000Z'
status:
type: string
example: active
urls:
type: object
properties:
website:
type: array
example:
- 'https://bitcoin.org/'
items:
type: string
technical_doc:
type: array
example:
- 'https://bitcoin.org/bitcoin.pdf'
items:
type: string
explorer:
type: array
example:
- 'https://blockchain.info/'
- 'https://live.blockcypher.com/btc/'
- 'https://blockchair.com/bitcoin'
- 'https://explorer.viabtc.com/btc'
- 'https://www.oklink.com/btc'
items:
type: string
source_code:
type: array
example:
- 'https://github.com/bitcoin/bitcoin'
items:
type: string
message_board:
type: array
example:
- 'https://bitcointalk.org'
items:
type: string
chat:
type: array
example: []
announcement:
type: array
example: []
reddit:
type: array
example:
- 'https://reddit.com/r/bitcoin'
items:
type: string
facebook:
type: array
example: []
twitter:
type: array
example: []
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- 'โฟ Crypto'
/api/v1/crypto/holders:
get:
summary: 'GET /v1/crypto/holders'
operationId: gETv1cryptoholders
description: "\n\nReturns holder data for one cryptocurrency. `meta` holds the total holder count and daily active addresses; `data` lists the top holder addresses with each balance and its percentage share of supply."
parameters:
-
in: query
name: key
description: "Coin slug, a lowercase, hyphenated form of the coin's name, such as bitcoin or ethereum."
example: bitcoin
required: true
schema:
type: string
description: "Coin slug, a lowercase, hyphenated form of the coin's name, such as bitcoin or ethereum."
example: bitcoin
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"key\": \"Bitcoin\",\n \"holderCount\": 48834937,\n \"dailyActive\": 963625,\n \"total\": 100\n },\n \"data\": [\n {\n \"address\": \"34xp4vRoCGJym3xR7yCVPFHoCNxv4Twseo\",\n \"balance\": 248597.3905837,\n \"share\": 1.18\n },\n { ... }\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- 'โฟ Crypto'
/api/v1/crypto/quotes:
get:
summary: 'GET /v1/crypto/quotes hot!'
operationId: gETv1cryptoquotessmallStylecolorf8f2f2backgroundfa256fpadding1px4pxborderRadius3pxhotsmall
description: "\n\nReturns market statistics for one cryptocurrency: price, percent change from 1 hour to all time, market cap and fully diluted market cap, circulating, total, and max supply, market dominance, rank, and high/low prices from 24 hours to all time. Also includes 24-hour volume and its percent change."
parameters:
-
in: query
name: key
description: "Coin slug, a lowercase, hyphenated form of the coin's name, such as bitcoin or ethereum."
example: bitcoin
required: true
schema:
type: string
description: "Coin slug, a lowercase, hyphenated form of the coin's name, such as bitcoin or ethereum."
example: bitcoin
responses:
200:
description: Success
content:
application/json:
schema:
type: object
example:
meta:
version: v1.0
status: 200
copywrite: 'https://steadyapi.com'
key: Bitcoin
total: 48
data:
price: 27777.482861316
priceChangePercentage1h: -2.15185151
priceChangePercentage24h: -4.02576734
priceChangePercentage7d: -5.49823801
priceChangePercentage30d: -7.16085892
priceChangePercentage60d: 4.37805208
priceChangePercentage90d: 3.1949905
priceChangePercentageAll: 449231.62562378
marketCap: 540557260846.61
marketCapChangePercentage24h: -4.0204
fullyDilutedMarketCap: 583327140087.63
fullyDilutedMarketCapChangePercentage24h: -4.03
circulatingSupply: 19460268
totalSupply: 19460268
maxSupply: 21000000
marketCapDominance: 48.8796
rank: 1
roi: 44923077.092789
low24h: 27718.146260229
high24h: 29192.260813212
low7d: 27718.146260229
high7d: 29660.254339272
low30d: 27718.146260229
high30d: 30330.640392011
low90d: 24797.167848615
high90d: 31814.514812068
low52w: 15599.047175383
high52w: 31814.514812068
lowAllTime: 0.04864654
highAllTime: 68789.625938922
lowAllTimeChangePercentage: 57100534.21
highAllTimeChangePercentage: -59.62
lowAllTimeTimestamp: '2010-07-14T19:24:00.000Z'
highAllTimeTimestamp: '2021-11-10T14:17:02.000Z'
lowYesterday: 28701.779524531
highYesterday: 29221.975742975
openYesterday: 29169.074019916
closeYesterday: 28701.779524531
priceChangePercentageYesterday: -1.6
volumeYesterday: 14949271904.13
turnover: 0.03826141
ytdPriceChangePercentage: 67.0818
volumeRank: 2
volumeMcRank: 2235
mcTotalNum: 9598
volumeTotalNum: 9598
volumeMcTotalNum: 9598
status: ''
volume: 20682484655.138
volumeChangePercentage24h: 48.7042
properties:
meta:
type: object
properties:
version:
type: string
example: v1.0
status:
type: integer
example: 200
copywrite:
type: string
example: 'https://steadyapi.com'
key:
type: string
example: Bitcoin
total:
type: integer
example: 48
data:
type: object
properties:
price:
type: number
example: 27777.482861316
priceChangePercentage1h:
type: number
example: -2.15185151
priceChangePercentage24h:
type: number
example: -4.02576734
priceChangePercentage7d:
type: number
example: -5.49823801
priceChangePercentage30d:
type: number
example: -7.16085892
priceChangePercentage60d:
type: number
example: 4.37805208
priceChangePercentage90d:
type: number
example: 3.1949905
priceChangePercentageAll:
type: number
example: 449231.62562378
marketCap:
type: number
example: 540557260846.61
marketCapChangePercentage24h:
type: number
example: -4.0204
fullyDilutedMarketCap:
type: number
example: 583327140087.63
fullyDilutedMarketCapChangePercentage24h:
type: number
example: -4.03
circulatingSupply:
type: integer
example: 19460268
totalSupply:
type: integer
example: 19460268
maxSupply:
type: integer
example: 21000000
marketCapDominance:
type: number
example: 48.8796
rank:
type: integer
example: 1
roi:
type: number
example: 44923077.092789
low24h:
type: number
example: 27718.146260229
high24h:
type: number
example: 29192.260813212
low7d:
type: number
example: 27718.146260229
high7d:
type: number
example: 29660.254339272
low30d:
type: number
example: 27718.146260229
high30d:
type: number
example: 30330.640392011
low90d:
type: number
example: 24797.167848615
high90d:
type: number
example: 31814.514812068
low52w:
type: number
example: 15599.047175383
high52w:
type: number
example: 31814.514812068
lowAllTime:
type: number
example: 0.04864654
highAllTime:
type: number
example: 68789.625938922
lowAllTimeChangePercentage:
type: number
example: 57100534.21
highAllTimeChangePercentage:
type: number
example: -59.62
lowAllTimeTimestamp:
type: string
example: '2010-07-14T19:24:00.000Z'
highAllTimeTimestamp:
type: string
example: '2021-11-10T14:17:02.000Z'
lowYesterday:
type: number
example: 28701.779524531
highYesterday:
type: number
example: 29221.975742975
openYesterday:
type: number
example: 29169.074019916
closeYesterday:
type: number
example: 28701.779524531
priceChangePercentageYesterday:
type: number
example: -1.6
volumeYesterday:
type: number
example: 14949271904.13
turnover:
type: number
example: 0.03826141
ytdPriceChangePercentage:
type: number
example: 67.0818
volumeRank:
type: integer
example: 2
volumeMcRank:
type: integer
example: 2235
mcTotalNum:
type: integer
example: 9598
volumeTotalNum:
type: integer
example: 9598
volumeMcTotalNum:
type: integer
example: 9598
status:
type: string
example: ''
volume:
type: number
example: 20682484655.138
volumeChangePercentage24h:
type: number
example: 48.7042
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- 'โฟ Crypto'
/api/v1/crypto/coins:
get:
summary: 'GET /v1/crypto/coins'
operationId: gETv1cryptocoins
description: "\n\nReturns one page of the cryptocurrency listing, ordered by market cap rank, with each coin's name, symbol, slug, supply, and price data. `meta.total` gives the number of coins in the full listing."
parameters:
-
in: query
name: page
description: 'Page number of the listing, from 1 to 100. Defaults to 1 if omitted.'
example: '1'
required: true
schema:
type: string
description: 'Page number of the listing, from 1 to 100. Defaults to 1 if omitted.'
example: '1'
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"page\": \"1\",\n \"total\": \"10458\"\n },\n \"body\": [\n {\n \"id\": 1,\n \"name\": \"Bitcoin\",\n \"symbol\": \"BTC\",\n \"slug\": \"bitcoin\",\n \"cmcRank\": 1,\n \"marketPairCount\": 12000,\n \"circulatingSupply\": 19842075,\n \"selfReportedCirculatingSupply\": 0,\n \"totalSupply\": 19842075,\n \"maxSupply\": 21000000,\n \"ath\": 109114.884834088,\n \"atl\": 0.04864654,\n \"high24h\": 88542.3946728374,\n \"low24h\": 86359.4926625361,\n \"isActive\": 1,\n \"lastUpdated\": \"2025-03-26T04:40:00.000Z\",\n \"dateAdded\": \"2010-07-13T00:00:00.000Z\",\n \"quotes\": [\n {\n \"name\": \"BTC\",\n \"price\": 1,\n \"volume24h\": 331733.807450252,\n \"volume7d\": 2522819.47458302,\n \"volume30d\": 10317236.9067138,\n \"marketCap\": 19842075,\n \"selfReportedMarketCap\": 0,\n \"percentChange1h\": 0,\n \"percentChange24h\": 0,\n \"percentChange7d\": 0,\n \"lastUpdated\": \"2025-03-26T04:40:00.000Z\",\n \"percentChange30d\": 0,\n \"percentChange60d\": 0,\n \"percentChange90d\": 0,\n \"fullyDilluttedMarketCap\": 1835504320348.81,\n \"marketCapByTotalSupply\": 19842075,\n \"dominance\": 60.6059,\n \"turnover\": 0.01671871,\n \"ytdPriceChangePercentage\": -7.4294,\n \"percentChange1y\": 23.80301685\n },\n {\n \"name\": \"ETH\",\n \"price\": 42.498197559466,\n \"volume24h\": 14098088.8861746,\n \"volume7d\": 107215280.437697,\n \"volume30d\": 438463972.329336,\n \"marketCap\": 843252423.339741,\n \"selfReportedMarketCap\": 0,\n \"percentChange1h\": -0.147407,\n \"percentChange24h\": 0.497907,\n \"percentChange7d\": -0.994794,\n \"lastUpdated\": \"2025-03-26T04:40:00.000Z\",\n \"percentChange30d\": 20.575073,\n \"percentChange60d\": 34.083485,\n \"percentChange90d\": 48.530835,\n \"fullyDilluttedMarketCap\": 1835504320348.81,\n \"marketCapByTotalSupply\": 843252423.339741,\n \"dominance\": 60.6059,\n \"turnover\": 0.01671871,\n \"ytdPriceChangePercentage\": -7.4294,\n \"percentChange1y\": 23.80301685\n },\n {\n \"name\": \"USD\",\n \"price\": 87404.9676356577,\n \"volume24h\": 28995182703.8427,\n \"volume7d\": 220506954526.536,\n \"volume30d\": 901777757920.731,\n \"marketCap\": 1734295923199.29,\n \"selfReportedMarketCap\": 0,\n \"percentChange1h\": 0.30272694,\n \"percentChange24h\": 1.03877854,\n \"percentChange7d\": 5.36278451,\n \"lastUpdated\": \"2025-03-26T04:40:00.000Z\",\n \"percentChange30d\": -8.15481455,\n \"percentChange60d\": -16.57444939,\n \"percentChange90d\": -11.19494517,\n \"fullyDilluttedMarketCap\": 1835504320348.81,\n \"marketCapByTotalSupply\": 1734295923199.29,\n \"dominance\": 60.6059,\n \"turnover\": 0.01671871,\n \"ytdPriceChangePercentage\": -7.4294,\n \"percentChange1y\": 23.80301685\n }\n ],\n \"isAudited\": false,\n \"auditInfoList\": [],\n \"badges\": [1]\n },\n { ... }\n ]\n }"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- 'โฟ Crypto'
/api/v1/crypto/modules:
get:
summary: 'GET /v1/crypto/modules'
operationId: gETv1cryptomodules
description: "\n\nReturns one market-wide crypto data set selected by `module`: global market metrics, trending coins, most-visited coins, newly added coins, or the top gainers or losers. `meta.module` names the data set returned."
parameters:
-
in: query
name: module
description: "Data set to return. Defaults to global_matric if omitted; any other value returns an error.\n - **global_matric**: Global crypto market metrics.\n - **trending**: Trending cryptocurrencies.\n - **most_visited**: Most-visited cryptocurrencies.\n - **new_coins**: Recently added cryptocurrencies.\n - **gainer**: Top cryptocurrency gainers.\n - **loser**: Top cryptocurrency losers."
example: trending
required: true
schema:
type: string
description: "Data set to return. Defaults to global_matric if omitted; any other value returns an error.\n - **global_matric**: Global crypto market metrics.\n - **trending**: Trending cryptocurrencies.\n - **most_visited**: Most-visited cryptocurrencies.\n - **new_coins**: Recently added cryptocurrencies.\n - **gainer**: Top cryptocurrency gainers.\n - **loser**: Top cryptocurrency losers."
example: trending
responses:
200:
description: Success
content:
text/plain:
schema:
type: string
example: "{\n \"meta\": {\n \"version\": \"v1.0\",\n \"status\": 200,\n \"copywrite\": \"https://steadyapi.com\",\n \"total\": 10,\n \"module\": \"trendingList\"\n },\n \"body\": [\n {\n \"id\": 24781,\n \"dataType\": 2,\n \"name\": \"CyberConnect\",\n \"symbol\": \"CYBER\",\n \"rank\": 378,\n \"status\": \"active\",\n \"marketCap\": 43825691.01,\n \"selfReportedMarketCap\": 0,\n \"priceChange\": {\n \"price\": 3.9704376710966343,\n \"priceChange24h\": -5.25190314,\n \"priceChange7d\": 120.13555185,\n \"priceChange30d\": 120.13555185,\n \"volume24h\": 39253295.67980275,\n \"lastUpdate\": \"2023-08-17T17:31:00.000Z\"\n }\n },\n { ... }\n ]\n}"
401:
description: Unauthenticated
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
403:
description: Unauthorized
content:
application/json:
schema:
type: object
example:
message: 'This action is unauthorized.'
properties:
message:
type: string
example: 'This action is unauthorized.'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
success: false
message: 'Resource Not Found'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Resource Not Found'
422:
description: 'Error Validations'
content:
application/json:
schema:
type: object
example:
message: 'The ticker field is required.'
errors:
ticker:
- 'The ticker field is required.'
properties:
message:
type: string
example: 'The ticker field is required.'
errors:
type: object
properties:
ticker:
type: array
example:
- 'The ticker field is required.'
items:
type: string
tags:
- 'โฟ Crypto'
tags:
-
name: '๐ Stocks & Options hot!'
description: "\nStock and options market data: quotes, company fundamentals, options chains and screens, market calendars, and technical indicators.\n\n- Ticker search, market news, screeners, market movers, and insider trades\n- Stock quotes, price history, analyst price targets, financial statements, and institutional holdings\n- Options chains, unusual options activity, implied volatility screens, most-active options, and options flow\n- Earnings, dividends, economic events, IPOs, secondary offerings, and stock splits\n- Technical indicators: SMA, EMA, RSI, MACD, CCI, ADX, STOCH, ADOSC, and AD"
-
name: 'โฟ Crypto'
description: "\n**Crypto API** for cryptocurrency listings, profiles, market statistics, and holder data.\n\n- Paginated coin listings ranked by market cap\n- Coin profiles with description, category, and project links\n- Price, market cap, supply, and price-range statistics for one coin\n- Global market metrics, trending coins, new listings, and top gainers and losers\n- Holder counts and top holder addresses\n\nCoins are identified by their slug, a lowercase, hyphenated form of the coin's name, such as `bitcoin` or `ethereum`."
components:
securitySchemes:
default:
type: http
scheme: bearer
description: "To generate a token, visit your dashboard, go to your account in the upper-right corner and click on the Personal Access Tokens in the dropdown menu. There you will have access to generate and delete Personal Access Tokens\n\n# Rate Limiting\n\nOur API implements rate limiting to ensure fair usage and maintain optimal performance for all users. The current limit is set to 10 requests per second.\n\nIf you exceed this rate, you may receive a 429 Too Many Requests response. We recommend implementing a retry mechanism in your application to handle rate-limited responses gracefully."
security:
-
default: []