Fortune Finance
Fortune Finance · Acciones GPT
Fortune Finance
A comprehensive financial data tool offering extensive market insights and streamlined organizational features. It utilizes real-time market data to provide users with information about various assets (stocks, crypto, commodities & forex), while facilitating the management of user-saved portfolios without personalized advice. This tool encompasses a wide array of financial analysis tools, including performance tracking, market news, social sentiment analysis, and detailed financial statements.
POST /savePortfoliosavePortfolioSave a portfolio of user-provided assets along with their respective quantities. Return the saved data in a visual table to the user.
POST /readPortfolio/{portfolio_name}readPortfolioRetrieve the user's previously saved portfolios based on the portfolio name. If unsure about the portfolio name, use the getPortfolioNames endpoint.
POST /getPortfolioNamesgetPortfolioNamesGet the names of all saved portfolios for the user.
POST /performancePortfolio/{portfolio_name}performancePortfolioCalculate the performance of the user's selected portfolio based on historical data. Return the data to the user using a markdown table.
POST /deletePortfolio/{portfolio_name}deletePortfolioRemove a user's saved portfolio based on the provided portfolio name. If unsure about the portfolio name, use the getPortfolioNames endpoint.
POST /updatePortfolioupdatePortfolioUpdate an existing portfolio by adding an additional asset and its quantity, as provided by the user.
POST /removeAssetPortfolioremoveAssetPortfolioRemove a specific asset from the user-provided portfolio.
POST /socialSentimentsocialSentimentGet the social sentiment for a specific stock/crypto/forex based on real-time news data.
POST /news/{asset_type}newsGet the latest news on stock/crypto/forex/commodities.
POST /newsIndividualnewsIndividualGet the latest news about a specific crypto/stock/forex pair/commodity provided by the user.
POST /historicalPricehistoricalPriceGet the historical price for any company or cryptocurrency or forex pair or commodity. Return the data to the user using a markdown table.
POST /historicalPriceCharthistoricalPriceChartReturns a link of the historical price for any company or cryptocurrency or forex pair or commodity. This should not be used for your own computations but only as visual aid for the user.
GET /assetInformation/{asset_ticker}assetInformationGet real-time data about a specific asset (stock, crypto, commodity and forex) provided by the user. Return the data to the user using a markdown table.
POST /stockFilterstockFilterFilter stocks based on user-provided criteria, such as sector, market cap, or other factors. Return the filtered list of stocks in a markdown table without providing any specific recommendations.
POST /getGainersOrLosersOrActives/{stock_type}getGainersOrLosersOrActivesGet stock data for today's gainers, losers, or most active stocks. Return the data to the user using a markdown table.
POST /getESGRatinggetESGRatingGet ESG company rating for a stock ticker and filter based on the number of years. Return the data to the user using a markdown table.
POST /incomeStatementincomeStatementGet the income statement(s) for a specific company for any year and filter based on the period(ANNUAL/QUARTER). Return the data to the user using a markdown table.
POST /balanceSheetbalanceSheetGet the balance sheets(s) for a specific company for any year and filter based on the period(ANNUAL/QUARTER). Return the data to the user using a markdown table.
POST /cashFlowcashFlowGet the cash flow(s) for a specific company for any year and filter based on the period(ANNUAL/QUARTER). Return the data to the user using a markdown table.
POST /sectorPerformancesectorPerformanceGet daily performance of all sectors for the past 10 trading days. Return the data to the user using a markdown table.
POST /economicIndicatorseconomicIndicatorsGet economic indicator data based on a list of indicator names. Return the data to the user using a markdown table.
POST /quantitativeFundamentalAnalysis/{stock_ticker}quantitativeFundamentalAnalysisGet financial data for a quantitative fundamental analysis on any stock.
POST /getCompetitors/{stock_ticker}getCompetitorsGet the competitors of any stock.
POST /getForexPairsgetForexPairsGet all forex pair symbols available. Use this if you are not sure about the exact symbol.
POST /getCommoditiesgetCommoditiesGet all commodity symbols available. Use this if you are not sure about the exact symbol.
POST /optionsChainoptionsChainGet the options chain for a specific stock ticker symbol.
Esquema original API
{
"openapi": "3.1.0",
"info": {
"title": "Fortune Finance",
"description": "A comprehensive financial data tool offering extensive market insights and streamlined organizational features. It utilizes real-time market data to provide users with information about various assets (stocks, crypto, commodities & forex), while facilitating the management of user-saved portfolios without personalized advice. This tool encompasses a wide array of financial analysis tools, including performance tracking, market news, social sentiment analysis, and detailed financial statements.",
"version": "v1"
},
"servers": [
{
"url": "https://fortune-finance-api.plugin-port-api.com"
}
],
"paths": {
"/savePortfolio": {
"post": {
"operationId": "savePortfolio",
"description": "Save a portfolio of user-provided assets along with their respective quantities. Return the saved data in a visual table to the user.",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/savePortfolioRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/savePortfolioResponse"
}
}
}
}
}
}
},
"/readPortfolio/{portfolio_name}": {
"post": {
"operationId": "readPortfolio",
"description": "Retrieve the user's previously saved portfolios based on the portfolio name. If unsure about the portfolio name, use the getPortfolioNames endpoint.",
"x-openai-isConsequential": false,
"parameters": [
{
"in": "path",
"name": "portfolio_name",
"schema": {
"type": "string"
},
"required": true,
"description": "The name of the portfolio."
}
],
"responses": {
"200": {
"description": "The saved portfolio data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/readPortfolioResponse"
}
}
}
}
}
}
},
"/getPortfolioNames": {
"post": {
"operationId": "getPortfolioNames",
"description": "Get the names of all saved portfolios for the user.",
"x-openai-isConsequential": false,
"responses": {
"200": {
"description": "The list of portfolio names.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getPortfolioNamesResponse"
}
}
}
}
}
}
},
"/performancePortfolio/{portfolio_name}": {
"post": {
"operationId": "performancePortfolio",
"description": "Calculate the performance of the user's selected portfolio based on historical data. Return the data to the user using a markdown table.",
"x-openai-isConsequential": false,
"parameters": [
{
"in": "path",
"name": "portfolio_name",
"schema": {
"type": "string"
},
"required": true,
"description": "The name of the portfolio"
}
],
"responses": {
"200": {
"description": "The performance of the portfolio.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/performancePortfolioResponse"
}
}
}
}
}
}
},
"/deletePortfolio/{portfolio_name}": {
"post": {
"operationId": "deletePortfolio",
"description": "Remove a user's saved portfolio based on the provided portfolio name. If unsure about the portfolio name, use the getPortfolioNames endpoint.",
"x-openai-isConsequential": false,
"parameters": [
{
"in": "path",
"name": "portfolio_name",
"schema": {
"type": "string"
},
"required": true,
"description": "The name of the portfolio"
}
],
"responses": {
"200": {
"description": "The status of the deletion operation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/deletePortfolioResponse"
}
}
}
}
}
}
},
"/updatePortfolio": {
"post": {
"operationId": "updatePortfolio",
"description": "Update an existing portfolio by adding an additional asset and its quantity, as provided by the user.",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/updatePortfolioRequest"
}
}
}
},
"responses": {
"200": {
"description": "Status of the update operation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/updatePortfolioResponse"
}
}
}
}
}
}
},
"/removeAssetPortfolio": {
"post": {
"operationId": "removeAssetPortfolio",
"description": "Remove a specific asset from the user-provided portfolio.",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/removeAssetPortfolioRequest"
}
}
}
},
"responses": {
"200": {
"description": "Status of the asset removal operation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/removeAssetPortfolioResponse"
}
}
}
}
}
}
},
"/socialSentiment": {
"post": {
"operationId": "socialSentiment",
"description": "Get the social sentiment for a specific stock/crypto/forex based on real-time news data.",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/socialSentimentRequest"
}
}
}
},
"responses": {
"200": {
"description": "The social sentiment and a list of the most recent news articles.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/socialSentimentResponse"
}
}
}
}
}
}
}
},
"/news/{asset_type}": {
"post": {
"operationId": "news",
"description": "Get the latest news on stock/crypto/forex/commodities.",
"x-openai-isConsequential": false,
"parameters": [
{
"in": "path",
"name": "asset_type",
"schema": {
"type": "string",
"enum": [
"stock_news",
"crypto_news",
"forex_news"
]
},
"required": true,
"description": "the asset type"
}
],
"responses": {
"200": {
"description": "The latest news on stock/crypto/forex/commodities.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/newsResponse"
}
}
}
}
}
}
},
"/newsIndividual": {
"post": {
"operationId": "newsIndividual",
"description": "Get the latest news about a specific crypto/stock/forex pair/commodity provided by the user.",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/socialSentimentRequest"
}
}
}
},
"responses": {
"200": {
"description": "The latest news about a specific crypto/stock/commodity/forex pair provided by the user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/newsIndividualResponse"
}
}
}
}
}
}
},
"/historicalPrice": {
"post": {
"operationId": "historicalPrice",
"description": "Get the historical price for any company or cryptocurrency or forex pair or commodity. Return the data to the user using a markdown table.",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/historicalStockPriceRequest"
}
}
}
},
"responses": {
"200": {
"description": "The historical price for an asset.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/historicalPriceResponse"
}
}
}
}
}
}
},
"/historicalPriceChart": {
"post": {
"operationId": "historicalPriceChart",
"description": "Returns a link of the historical price for any company or cryptocurrency or forex pair or commodity. This should not be used for your own computations but only as visual aid for the user.",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/historicalStockPriceRequest"
}
}
}
},
"responses": {
"200": {
"description": "The historical price chart for an asset.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/historicalPriceChartResponse"
}
}
}
}
}
}
},
"/assetInformation/{asset_ticker}": {
"get": {
"operationId": "assetInformation",
"description": "Get real-time data about a specific asset (stock, crypto, commodity and forex) provided by the user. Return the data to the user using a markdown table.",
"x-openai-isConsequential": false,
"parameters": [
{
"in": "path",
"name": "asset_ticker",
"schema": {
"type": "string"
},
"required": true,
"description": "The asset ticker symbol."
}
],
"responses": {
"200": {
"description": "The real-time data about a specific asset.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/assetInformationResponse"
}
}
}
}
}
}
},
"/stockFilter": {
"post": {
"operationId": "stockFilter",
"description": "Filter stocks based on user-provided criteria, such as sector, market cap, or other factors. Return the filtered list of stocks in a markdown table without providing any specific recommendations.",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/stockFilterRequest"
}
}
}
},
"responses": {
"200": {
"description": "The filtered list of stocks.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/stockFilterResponse"
}
}
}
}
}
}
},
"/getGainersOrLosersOrActives/{stock_type}": {
"post": {
"operationId": "getGainersOrLosersOrActives",
"description": "Get stock data for today's gainers, losers, or most active stocks. Return the data to the user using a markdown table.",
"x-openai-isConsequential": false,
"parameters": [
{
"name": "stock_type",
"in": "path",
"description": "Type of stock data to fetch (gainers, losers, or actives)",
"required": true,
"schema": {
"type": "string",
"enum": [
"gainers",
"losers",
"actives"
]
}
}
],
"responses": {
"200": {
"description": "The stock data for today's gainers, losers, or most active stocks.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getGainersOrLosersOrActivesResponse"
}
}
}
}
}
}
},
"/getESGRating": {
"post": {
"operationId": "getESGRating",
"description": "Get ESG company rating for a stock ticker and filter based on the number of years. Return the data to the user using a markdown table.",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ESGRatingRequest"
}
}
}
},
"responses": {
"200": {
"description": "The ESG company rating for a stock ticker.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getESGRatingResponse"
}
}
}
}
}
}
},
"/incomeStatement": {
"post": {
"operationId": "incomeStatement",
"description": "Get the income statement(s) for a specific company for any year and filter based on the period(ANNUAL/QUARTER). Return the data to the user using a markdown table.",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/incomeStatementRequest"
}
}
}
},
"responses": {
"200": {
"description": "The income statement(s) for a specific company.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/incomeStatementResponse"
}
}
}
}
}
}
},
"/balanceSheet": {
"post": {
"operationId": "balanceSheet",
"description": "Get the balance sheets(s) for a specific company for any year and filter based on the period(ANNUAL/QUARTER). Return the data to the user using a markdown table.",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/balanceSheetRequest"
}
}
}
},
"responses": {
"200": {
"description": "The balance sheet(s) for a specific company.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/balanceSheetResponse"
}
}
}
}
}
}
},
"/cashFlow": {
"post": {
"operationId": "cashFlow",
"description": "Get the cash flow(s) for a specific company for any year and filter based on the period(ANNUAL/QUARTER). Return the data to the user using a markdown table.",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cashFlowRequest"
}
}
}
},
"responses": {
"200": {
"description": "The cash flow(s) for a specific company.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cashFlowResponse"
}
}
}
}
}
}
},
"/sectorPerformance": {
"post": {
"operationId": "sectorPerformance",
"description": "Get daily performance of all sectors for the past 10 trading days. Return the data to the user using a markdown table.",
"x-openai-isConsequential": false,
"responses": {
"200": {
"description": "The daily performance of all sectors for the past 10 trading days.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/sectorPerformanceResponse"
}
}
}
}
}
}
},
"/economicIndicators": {
"post": {
"operationId": "economicIndicators",
"description": "Get economic indicator data based on a list of indicator names. Return the data to the user using a markdown table.",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/economicIndicatorsRequest"
}
}
}
},
"responses": {
"200": {
"description": "The economic indicator data based on a list of indicator names.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/economicIndicatorsResponse"
}
}
}
}
}
}
},
"/quantitativeFundamentalAnalysis/{stock_ticker}": {
"post": {
"operationId": "quantitativeFundamentalAnalysis",
"description": "Get financial data for a quantitative fundamental analysis on any stock.",
"x-openai-isConsequential": false,
"parameters": [
{
"in": "path",
"name": "stock_ticker",
"schema": {
"type": "string"
},
"required": true,
"description": "the stock ticker symbol"
}
],
"responses": {
"200": {
"description": "The financial data for a quantitative fundamental analysis on any stock.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/quantitativeFundamentalAnalysisResponse"
}
}
}
}
}
}
},
"/getCompetitors/{stock_ticker}": {
"post": {
"operationId": "getCompetitors",
"description": "Get the competitors of any stock.",
"x-openai-isConsequential": false,
"parameters": [
{
"in": "path",
"name": "stock_ticker",
"schema": {
"type": "string"
},
"required": true,
"description": "the stock ticker symbol"
}
],
"responses": {
"200": {
"description": "The competitors of any stock.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getCompetitorsResponse"
}
}
}
}
}
}
},
"/getForexPairs": {
"post": {
"operationId": "getForexPairs",
"description": "Get all forex pair symbols available. Use this if you are not sure about the exact symbol.",
"x-openai-isConsequential": false,
"responses": {
"200": {
"description": "The list of forex pair symbols available.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getForexPairsResponse"
}
}
}
}
}
}
},
"/getCommodities": {
"post": {
"operationId": "getCommodities",
"description": "Get all commodity symbols available. Use this if you are not sure about the exact symbol.",
"x-openai-isConsequential": false,
"responses": {
"200": {
"description": "The list of commodity symbols available.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getCommoditiesResponse"
}
}
}
}
}
}
},
"/optionsChain": {
"post": {
"operationId": "optionsChain",
"description": "Get the options chain for a specific stock ticker symbol.",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/optionsChainRequest"
}
}
}
}
}
}
},
"components": {
"schemas": {
"savePortfolioRequest": {
"type": "object",
"required": [
"name",
"budget",
"portfolio_description",
"stocks"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the portfolio"
},
"budget": {
"type": "number",
"description": "The budget restriction for the entire portfolio"
},
"portfolio_description": {
"type": "string",
"description": "A short description about the portfolio."
},
"stocks": {
"type": "array",
"items": {
"type": "object",
"required": [
"ticker",
"price",
"shares",
"allocation",
"position",
"investment_type"
],
"properties": {
"ticker": {
"type": "string",
"description": "The stock/crypto/forex pair/commodity/gold symbol"
},
"price": {
"type": "number",
"description": "The stock/crypto/forex pair/commodity/gold price for the company"
},
"shares": {
"type": "number",
"description": "The number of shares for the stock/crypto/forex pair/commodity/gold",
"minimum": 0.01
},
"position": {
"type": "string",
"enum": [
"short",
"long"
],
"description": "The position on the stock/crypto/forex pair/commodity/gold (short or long)"
},
"investment_type": {
"type": "string",
"enum": [
"stock",
"crypto",
"forex",
"commodity",
"gold",
"call",
"put"
],
"description": "The type the asset is (stock or crypto or forex or commodity or gold or call or put)"
}
}
},
"description": "The list of stocks in the portfolio."
}
}
},
"stockFilterRequest": {
"type": "object",
"properties": {
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"filter_name": {
"type": "string",
"enum": [
"marketCapMoreThan",
"marketCapLowerThan",
"priceMoreThan",
"priceLowerThan",
"betaMoreThan",
"betaLowerThan",
"volumeMoreThan",
"volumeLowerThan",
"dividendMoreThan",
"dividendLowerThan"
]
},
"filter_value": {
"type": "number"
}
}
}
},
"sector": {
"type": "string",
"description": "Only use the sectors provided.",
"enum": [
"Consumer Cyclical",
"Energy",
"Technology",
"Industrials",
"Financial Services",
"Basic Materials",
"Communication Services",
"Consumer Defensive",
"Healthcare",
"Real Estate",
"Utilities",
"Industrial Goods",
"Financial",
"Services",
"Conglomerates"
]
},
"industry": {
"type": "string",
"enum": [
"Autos",
"Banks",
"Banks Diversified",
"Software",
"Banks Regional",
"Beverages Alcoholic",
"Beverages Brewers",
"Beverages Non-Alcoholic"
]
},
"country": {
"type": "string",
"description": "The 2 letter country code"
},
"exchange": {
"type": "string",
"enum": [
"nyse",
"nasdaq",
"amex",
"euronext",
"tsx",
"etf",
"mutual_fund"
]
}
}
},
"updatePortfolioRequest": {
"type": "object",
"required": [
"name",
"new_asset_data"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the portfolio"
},
"new_asset_data": {
"type": "object",
"required": [
"ticker",
"price",
"shares",
"allocation",
"position",
"investment_type"
],
"properties": {
"ticker": {
"type": "string",
"description": "The stock/crypto/forex pair/commodity/gold symbol"
},
"price": {
"type": "number",
"description": "The stock/crypto/forex pair/commodity/gold price for the company"
},
"shares": {
"type": "number",
"description": "The number of shares for the stock/crypto/forex pair/commodity/gold",
"minimum": 0.01
},
"position": {
"type": "string",
"enum": [
"short",
"long"
],
"description": "The position on the stock/crypto/forex pair/commodity/gold (short or long)"
},
"investment_type": {
"type": "string",
"enum": [
"stock",
"crypto",
"forex",
"commodity",
"gold",
"call",
"put"
],
"description": "The type the asset is (stock or crypto or forex or commodity or gold or call or put)"
}
}
}
}
},
"removeAssetPortfolioRequest": {
"type": "object",
"required": [
"name",
"asset_name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the portfolio"
},
"asset_name": {
"type": "string",
"description": "The asset name to remove"
}
}
},
"socialSentimentRequest": {
"type": "object",
"required": [
"symbol",
"asset_type"
],
"properties": {
"symbol": {
"type": "string",
"description": "Company or cryptocurrency symbol or forex pair such as AAPL or BTCUSD or JPYUSD"
},
"asset_type": {
"type": "string",
"description": "the asset type",
"enum": [
"stock_news",
"crypto_news",
"forex_news"
]
}
}
},
"ESGRatingRequest": {
"type": "object",
"required": [
"stock_ticker",
"years"
],
"properties": {
"years": {
"type": "number",
"minimum": 1,
"description": "Number of years to filter data"
},
"stock_ticker": {
"type": "string",
"description": "Stock ticker symbol"
}
}
},
"balanceSheetRequest": {
"type": "object",
"required": [
"stock_ticker",
"period",
"limit"
],
"properties": {
"period": {
"type": "string",
"description": "ANNUAL or QUARTER data"
},
"stock_ticker": {
"type": "string",
"description": "Stock ticker symbol"
},
"limit": {
"type": "number",
"description": "The number of Balance Sheet statements returned"
}
}
},
"incomeStatementRequest": {
"type": "object",
"required": [
"stock_ticker",
"period",
"limit"
],
"properties": {
"period": {
"type": "string",
"description": "ANNUAL or QUARTER data"
},
"stock_ticker": {
"type": "string",
"description": "Stock ticker symbol"
},
"limit": {
"type": "number",
"description": "The number of income statements returned"
}
}
},
"cashFlowRequest": {
"type": "object",
"required": [
"stock_ticker",
"period",
"limit"
],
"properties": {
"period": {
"type": "string",
"description": "ANNUAL or QUARTER data"
},
"stock_ticker": {
"type": "string",
"description": "Stock ticker symbol"
},
"limit": {
"type": "number",
"description": "The number of cash flow statements returned"
}
}
},
"historicalStockPriceRequest": {
"type": "object",
"required": [
"stock_ticker",
"period"
],
"properties": {
"stock_ticker": {
"type": "string",
"description": "Company or cryptocurrency symbol or forex pair or commodity such as AAPL or BTCUSD or JPYUSD or XAUUSD"
},
"period": {
"type": "string",
"enum": [
"1min",
"5min",
"15min",
"30min",
"1hour",
"4hour",
"daily"
],
"description": "The time interval between each data point"
}
}
},
"economicIndicatorsRequest": {
"type": "object",
"properties": {
"indicators": {
"type": "array",
"minItems": 1,
"maxItems": 7,
"items": {
"type": "string",
"enum": [
"GDP",
"realGDP",
"nominalPotentialGDP",
"realGDPPerCapita",
"federalFunds",
"CPI",
"inflationRate",
"inflation",
"retailSales",
"consumerSentiment",
"durableGoods",
"unemploymentRate",
"totalNonfarmPayroll",
"initialClaims",
"industrialProductionTotalIndex",
"newPrivatelyOwnedHousingUnitsStartedTotalUnits",
"totalVehicleSales",
"retailMoneyFunds",
"smoothedUSRecessionProbabilities",
"3MonthOr90DayRatesAndYieldsCertificatesOfDeposit",
"commercialBankInterestRateOnCreditCardPlansAllAccounts",
"30YearFixedRateMortgageAverage",
"15YearFixedRateMortgageAverage"
]
}
}
},
"required": [
"indicators"
]
},
"optionsChainRequest": {
"type": "object",
"required": [
"stock_ticker",
"option_type"
],
"properties": {
"stock_ticker": {
"type": "string",
"description": "Stock ticker symbol."
},
"option_type": {
"type": "string",
"enum": [
"call",
"put",
"both"
],
"description": "The type of option (call, put or both)"
},
"strike_price": {
"type": "number",
"description": "The strike price of the option."
},
"period": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"range",
"exact"
],
"description": "The type of period to search for. Either \"range\" or \"exact\". Only fill data for either \"range\" or \"exact\"."
},
"range": {
"type": "string",
"enum": [
"1d",
"1w",
"1m",
"3m",
"6m",
"1y",
"2y",
"5y"
],
"description": "The range of time to search for."
},
"exact": {
"type": "string",
"description": "The exact date to search for in the format \"YYYY-MM-DD\"."
}
}
}
}
},
"savePortfolioResponse": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the request."
}
}
},
"readPortfolioResponse": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the request."
},
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the portfolio."
},
"date_created": {
"type": "string",
"description": "The date the portfolio was created."
},
"portfolio_description": {
"type": "string",
"description": "A short description about the portfolio."
},
"budget": {
"type": "number",
"description": "The budget restriction for the entire portfolio."
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"allocation": {
"type": "number",
"description": "The allocation of the asset in the portfolio."
},
"value": {
"type": "number",
"description": "The value of the asset in the portfolio."
},
"price": {
"type": "number",
"description": "The purchase price of the asset."
},
"investment_type": {
"type": "string",
"description": "The type the asset is (stock or crypto or forex or commodity)."
},
"position": {
"type": "string",
"description": "The position on the asset (short or long)."
},
"shares": {
"type": "number",
"description": "The number of shares for the asset."
},
"ticker": {
"type": "string",
"description": "The asset symbol."
},
"cash": {
"type": "number",
"description": "The cash available in the portfolio (if applicable)."
}
}
}
}
}
}
}
},
"getPortfolioNamesResponse": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the request."
},
"portfolios": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the portfolio."
},
"portfolio_description": {
"type": "string",
"description": "A short description about the portfolio."
},
"date_created": {
"type": "string",
"description": "The date the portfolio was created."
}
}
}
}
}
},
"performancePortfolioResponse": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the request."
},
"portfolio_details": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the portfolio."
},
"date_created": {
"type": "string",
"description": "The date the portfolio was created."
},
"portfolio_description": {
"type": "string",
"description": "A short description about the portfolio."
},
"budget": {
"type": "number",
"description": "The budget restriction for the entire portfolio."
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"allocation": {
"type": "number",
"description": "The allocation of the asset in the portfolio."
},
"value": {
"type": "number",
"description": "The current value of the asset in the portfolio."
},
"price": {
"type": "number",
"description": "The purchase price of the asset."
},
"new_price": {
"type": "number",
"description": "The current price of the asset."
},
"value_change": {
"type": "number",
"description": "The change in value of the asset since purchase."
},
"percentage_change": {
"type": "number",
"description": "The percentage change in value of the asset since purchase."
},
"portfolio_value_change": {
"type": "number",
"description": "The change in the portfolio's value."
},
"investment_type": {
"type": "string",
"description": "The type of the asset (stock, crypto, forex, commodity)."
},
"position": {
"type": "string",
"description": "The position on the asset (short or long)."
},
"shares": {
"type": "number",
"description": "The number of shares for the asset."
},
"ticker": {
"type": "string",
"description": "The asset symbol."
},
"cash": {
"type": "number",
"description": "The cash available in the portfolio (if applicable)."
}
}
}
},
"portfolio_net_change": {
"type": "number",
"description": "The net change in the portfolio's value."
}
}
}
}
},
"deletePortfolioResponse": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the request, indicating success or failure of the delete operation."
},
"message": {
"type": "string",
"description": "A message providing additional information about the result of the delete operation."
}
}
},
"updatePortfolioResponse": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the request, indicating success or failure of the update operation."
}
}
},
"removeAssetPortfolioResponse": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the request, indicating success or failure of the asset removal operation."
}
}
},
"socialSentimentResponse": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"headline": {
"type": "string",
"description": "The headline of the news article."
},
"text": {
"type": "string",
"description": "The text of the news article."
},
"url": {
"type": "string",
"description": "The url of the news article."
},
"publishedDate": {
"type": "string",
"description": "The published date of the news article."
},
"sentiment": {
"type": "string",
"description": "The sentiment of the news article."
}
}
},
"recommendation": {
"type": "string",
"description": "the recommendation based on the social sentiment of all the news."
}
}
},
"newsResponse": {
"type": "array",
"items": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The asset ticker symbol the news is related to."
},
"publishedDate": {
"type": "string",
"description": "The date and time when the news article was published."
},
"title": {
"type": "string",
"description": "The title of the news article."
},
"text": {
"type": "string",
"description": "A brief text snippet or summary of the news article."
},
"url": {
"type": "string",
"description": "The URL link to the full news article."
}
}
}
},
"newsIndividualResponse": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the news article."
},
"text": {
"type": "string",
"description": "A brief text snippet or summary of the news article."
},
"url": {
"type": "string",
"description": "The URL link to the full news article."
},
"publishedDate": {
"type": "string",
"description": "The date and time when the news article was published."
}
}
}
},
"historicalPriceResponse": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date and time of the price data point."
},
"open": {
"type": "number",
"description": "The opening price of the asset at the beginning of the time interval."
},
"high": {
"type": "number",
"description": "The highest price of the asset during the time interval."
},
"low": {
"type": "number",
"description": "The lowest price of the asset during the time interval."
},
"close": {
"type": "number",
"description": "The closing price of the asset at the end of the time interval."
},
"volume": {
"type": "number",
"description": "The volume of the asset traded during the time interval."
}
}
}
},
"historicalPriceChartResponse": {
"type": "object",
"properties": {
"website_url": {
"type": "string",
"description": "The URL link to the interactive chart displaying historical price data for the specified stock ticker and time interval."
}
}
},
"assetInformationResponse": {
"type": "array",
"items": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The asset ticker symbol."
},
"name": {
"type": "string",
"description": "The full name of the asset."
},
"price": {
"type": "number",
"description": "The current trading price of the asset."
},
"changesPercentage": {
"type": "number",
"format": "float",
"description": "The percentage change in the asset price."
},
"change": {
"type": "number",
"description": "The absolute change in the asset price."
},
"dayLow": {
"type": "number",
"description": "The lowest trading price of the asset for the current day."
},
"dayHigh": {
"type": "number",
"description": "The highest trading price of the asset for the current day."
},
"yearHigh": {
"type": "number",
"description": "The highest trading price of the asset for the last 52 weeks."
},
"yearLow": {
"type": "number",
"description": "The lowest trading price of the asset for the last 52 weeks."
},
"marketCap": {
"type": "number",
"description": "The market capitalization of the asset."
},
"priceAvg50": {
"type": "number",
"description": "The 50-day average trading price of the asset."
},
"priceAvg200": {
"type": "number",
"description": "The 200-day average trading price of the asset."
},
"exchange": {
"type": "string",
"description": "The asset exchange where the asset is listed."
},
"volume": {
"type": "number",
"description": "The trading volume of the asset for the current day."
},
"avgVolume": {
"type": "number",
"description": "The average trading volume of the asset."
},
"open": {
"type": "number",
"description": "The opening price of the asset for the current trading day."
},
"previousClose": {
"type": "number",
"description": "The closing price of the asset from the previous trading day."
},
"eps": {
"type": "number",
"description": "The earnings per share of the asset."
},
"pe": {
"type": "number",
"description": "The price-to-earnings ratio of the asset."
},
"earningsAnnouncement": {
"type": "string",
"description": "The date and time of the asset's last earnings announcement."
},
"sharesOutstanding": {
"type": "number",
"description": "The total number of outstanding shares of the asset."
},
"timestamp": {
"type": "number",
"description": "The timestamp of when the data was last updated."
}
}
}
},
"stockFilterResponse": {
"type": "array",
"items": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The stock ticker symbol."
},
"companyName": {
"type": "string",
"description": "The full name of the company."
},
"marketCap": {
"type": "number",
"description": "The market capitalization of the company."
},
"sector": {
"type": "string",
"description": "The sector in which the company operates."
},
"industry": {
"type": "string",
"description": "The industry in which the company operates."
},
"beta": {
"type": "number",
"description": "The beta value of the stock."
},
"price": {
"type": "number",
"description": "The current trading price of the stock."
},
"lastAnnualDividend": {
"type": "number",
"description": "The last annual dividend paid by the company."
},
"volume": {
"type": "number",
"description": "The trading volume of the stock for the current day."
},
"exchange": {
"type": "string",
"description": "The stock exchange where the company is listed."
},
"exchangeShortName": {
"type": "string",
"description": "The short name of the exchange where the company is listed."
},
"country": {
"type": "string",
"description": "The country in which the company is located."
},
"isEtf": {
"type": "boolean",
"description": "Indicates whether the stock is an ETF."
},
"isActivelyTrading": {
"type": "boolean",
"description": "Indicates whether the stock is actively trading."
}
}
}
},
"getGainersOrLosersOrActivesResponse": {
"type": "array",
"items": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The stock ticker symbol."
},
"name": {
"type": "string",
"description": "The full name of the company."
},
"change": {
"type": "number",
"description": "The absolute change in the stock price."
},
"price": {
"type": "number",
"description": "The current trading price of the stock."
},
"changesPercentage": {
"type": "number",
"format": "float",
"description": "The percentage change in the stock price."
}
}
}
},
"getESGRatingResponse": {
"type": "array",
"items": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The stock ticker symbol of the company."
},
"cik": {
"type": "string",
"description": "The Central Index Key (CIK) number assigned by the SEC to the company."
},
"companyName": {
"type": "string",
"description": "The full name of the company."
},
"industry": {
"type": "string",
"description": "The industry in which the company operates."
},
"year": {
"type": "integer",
"description": "The year for which the ESG risk rating is applicable."
},
"ESGRiskRating": {
"type": "string",
"description": "The ESG risk rating assigned to the company."
},
"industryRank": {
"type": "string",
"description": "The rank of the company within its industry based on ESG risk rating."
}
}
}
},
"incomeStatementResponse": {
"type": "object",
"properties": {
"currentDate": {
"type": "string",
"description": "The current date when the request was made."
},
"incomeStatements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date of the income statement."
},
"symbol": {
"type": "string",
"description": "The stock ticker symbol of the company."
},
"reportedCurrency": {
"type": "string",
"description": "The currency in which the financials are reported."
},
"cik": {
"type": "string",
"description": "The Central Index Key (CIK) number assigned by the SEC to the company."
},
"fillingDate": {
"type": "string",
"description": "The date the financial statement was filed."
},
"acceptedDate": {
"type": "string",
"description": "The date and time the financial statement was accepted."
},
"calendarYear": {
"type": "string",
"description": "The calendar year of the financial statement."
},
"period": {
"type": "string",
"description": "The period of the financial statement (e.g., FY for fiscal year)."
},
"revenue": {
"type": "number",
"description": "The total revenue of the company."
},
"costOfRevenue": {
"type": "number",
"description": "The cost of revenue or cost of goods sold."
},
"grossProfit": {
"type": "number",
"description": "The gross profit of the company."
},
"grossProfitRatio": {
"type": "number",
"format": "float",
"description": "The gross profit ratio."
},
"researchAndDevelopmentExpenses": {
"type": "number",
"description": "The expenses on research and development."
},
"generalAndAdministrativeExpenses": {
"type": "number",
"description": "The general and administrative expenses."
},
"sellingAndMarketingExpenses": {
"type": "number",
"description": "The selling and marketing expenses."
},
"sellingGeneralAndAdministrativeExpenses": {
"type": "number",
"description": "The combined selling, general, and administrative expenses."
},
"otherExpenses": {
"type": "number",
"description": "Other expenses incurred by the company."
},
"operatingExpenses": {
"type": "number",
"description": "The total operating expenses."
},
"costAndExpenses": {
"type": "number",
"description": "The total cost and expenses."
},
"interestIncome": {
"type": "number",
"description": "The income from interest."
},
"interestExpense": {
"type": "number",
"description": "The expenses on interest."
},
"depreciationAndAmortization": {
"type": "number",
"description": "The depreciation and amortization expenses."
},
"ebitda": {
"type": "number",
"description": "Earnings before interest, taxes, depreciation, and amortization."
},
"ebitdaratio": {
"type": "number",
"format": "float",
"description": "The EBITDA ratio."
},
"operatingIncome": {
"type": "number",
"description": "The operating income."
},
"operatingIncomeRatio": {
"type": "number",
"format": "float",
"description": "The operating income ratio."
},
"totalOtherIncomeExpensesNet": {
"type": "number",
"description": "The net total of other incomes and expenses."
},
"incomeBeforeTax": {
"type": "number",
"description": "The income before tax."
},
"incomeBeforeTaxRatio": {
"type": "number",
"format": "float",
"description": "The income before tax ratio."
},
"incomeTaxExpense": {
"type": "number",
"description": "The income tax expense."
},
"netIncome": {
"type": "number",
"description": "The net income."
},
"netIncomeRatio": {
"type": "number",
"format": "float",
"description": "The net income ratio."
},
"eps": {
"type": "number",
"description": "Earnings per share."
},
"epsdiluted": {
"type": "number",
"description": "Diluted earnings per share."
},
"weightedAverageShsOut": {
"type": "number",
"description": "The weighted average number of shares outstanding."
},
"weightedAverageShsOutDil": {
"type": "number",
"description": "The weighted average number of diluted shares outstanding."
},
"link": {
"type": "string",
"description": "The link to the SEC filing."
},
"finalLink": {
"type": "string",
"description": "The direct link to the final SEC filing document."
}
}
}
}
}
},
"balanceSheetResponse": {
"type": "object",
"properties": {
"currentDate": {
"type": "string",
"description": "The current date when the request was made."
},
"balanceSheets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date of the balance sheet."
},
"symbol": {
"type": "string",
"description": "The stock ticker symbol of the company."
},
"reportedCurrency": {
"type": "string",
"description": "The currency in which the financials are reported."
},
"cik": {
"type": "string",
"description": "The Central Index Key (CIK) number assigned by the SEC to the company."
},
"fillingDate": {
"type": "string",
"description": "The date the financial statement was filed."
},
"acceptedDate": {
"type": "string",
"description": "The date and time the financial statement was accepted."
},
"calendarYear": {
"type": "string",
"description": "The calendar year of the financial statement."
},
"period": {
"type": "string",
"description": "The period of the financial statement (e.g., FY for fiscal year)."
},
"cashAndCashEquivalents": {
"type": "number",
"description": "The amount of cash and cash equivalents held by the company."
},
"shortTermInvestments": {
"type": "number",
"description": "The amount of short-term investments."
},
"cashAndShortTermInvestments": {
"type": "number",
"description": "The total amount of cash and short-term investments."
},
"netReceivables": {
"type": "number",
"description": "The total net receivables."
},
"inventory": {
"type": "number",
"description": "The value of the company's inventory."
},
"otherCurrentAssets": {
"type": "number",
"description": "The value of other current assets."
},
"totalCurrentAssets": {
"type": "number",
"description": "The total current assets."
},
"propertyPlantEquipmentNet": {
"type": "number",
"description": "The net value of property, plant, and equipment."
},
"goodwill": {
"type": "number",
"description": "The value of goodwill."
},
"intangibleAssets": {
"type": "number",
"description": "The value of intangible assets."
},
"goodwillAndIntangibleAssets": {
"type": "number",
"description": "The total value of goodwill and intangible assets."
},
"longTermInvestments": {
"type": "number",
"description": "The total long-term investments."
},
"taxAssets": {
"type": "number",
"description": "The total tax assets."
},
"otherNonCurrentAssets": {
"type": "number",
"description": "The total other non-current assets."
},
"totalNonCurrentAssets": {
"type": "number",
"description": "The total non-current assets."
},
"otherAssets": {
"type": "number",
"description": "The total other assets."
},
"totalAssets": {
"type": "number",
"description": "The total assets of the company."
},
"accountPayables": {
"type": "number",
"description": "The total accounts payable."
},
"shortTermDebt": {
"type": "number",
"description": "The total short-term debt."
},
"taxPayables": {
"type": "number",
"description": "The total tax payables."
},
"deferredRevenue": {
"type": "number",
"description": "The total deferred revenue."
},
"otherCurrentLiabilities": {
"type": "number",
"description": "The total other current liabilities."
},
"totalCurrentLiabilities": {
"type": "number",
"description": "The total current liabilities."
},
"longTermDebt": {
"type": "number",
"description": "The total long-term debt."
},
"deferredRevenueNonCurrent": {
"type": "number",
"description": "The total non-current deferred revenue."
},
"deferredTaxLiabilitiesNonCurrent": {
"type": "number",
"description": "The total non-current deferred tax liabilities."
},
"otherNonCurrentLiabilities": {
"type": "number",
"description": "The total other non-current liabilities."
},
"totalNonCurrentLiabilities": {
"type": "number",
"description": "The total non-current liabilities."
},
"otherLiabilities": {
"type": "number",
"description": "The total other liabilities."
},
"capitalLeaseObligations": {
"type": "number",
"description": "The total capital lease obligations."
},
"totalLiabilities": {
"type": "number",
"description": "The total liabilities."
},
"preferredStock": {
"type": "number",
"description": "The total preferred stock."
},
"commonStock": {
"type": "number",
"description": "The total common stock."
},
"retainedEarnings": {
"type": "number",
"description": "The total retained earnings."
},
"accumulatedOtherComprehensiveIncomeLoss": {
"type": "number",
"description": "The total accumulated other comprehensive income (loss)."
},
"othertotalStockholdersEquity": {
"type": "number",
"description": "The total other stockholders' equity."
},
"totalStockholdersEquity": {
"type": "number",
"description": "The total stockholders' equity."
},
"totalEquity": {
"type": "number",
"description": "The total equity."
},
"totalLiabilitiesAndStockholdersEquity": {
"type": "number",
"description": "The total liabilities and stockholders' equity."
},
"minorityInterest": {
"type": "number",
"description": "The total minority interest."
},
"totalLiabilitiesAndTotalEquity": {
"type": "number",
"description": "The total liabilities and total equity."
},
"totalInvestments": {
"type": "number",
"description": "The total investments."
},
"totalDebt": {
"type": "number",
"description": "The total debt."
},
"netDebt": {
"type": "number",
"description": "The net debt."
},
"link": {
"type": "string",
"description": "The link to the SEC filing."
},
"finalLink": {
"type": "string",
"description": "The direct link to the final SEC filing document."
}
}
}
}
}
},
"cashFlowResponse": {
"type": "object",
"properties": {
"currentDate": {
"type": "string",
"description": "The current date when the request was made."
},
"cashFlows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date of the cash flow statement."
},
"symbol": {
"type": "string",
"description": "The stock ticker symbol of the company."
},
"reportedCurrency": {
"type": "string",
"description": "The currency in which the financials are reported."
},
"cik": {
"type": "string",
"description": "The Central Index Key (CIK) number assigned by the SEC to the company."
},
"fillingDate": {
"type": "string",
"description": "The date the financial statement was filed."
},
"acceptedDate": {
"type": "string",
"description": "The date and time the financial statement was accepted."
},
"calendarYear": {
"type": "string",
"description": "The calendar year of the financial statement."
},
"period": {
"type": "string",
"description": "The period of the financial statement (e.g., FY for fiscal year)."
},
"netIncome": {
"type": "number",
"description": "The net income."
},
"depreciationAndAmortization": {
"type": "number",
"description": "The depreciation and amortization expenses."
},
"deferredIncomeTax": {
"type": "number",
"description": "The deferred income tax."
},
"stockBasedCompensation": {
"type": "number",
"description": "The stock-based compensation expenses."
},
"changeInWorkingCapital": {
"type": "number",
"description": "The change in working capital."
},
"accountsReceivables": {
"type": "number",
"description": "The change in accounts receivables."
},
"inventory": {
"type": "number",
"description": "The change in inventory."
},
"accountsPayables": {
"type": "number",
"description": "The change in accounts payables."
},
"otherWorkingCapital": {
"type": "number",
"description": "The change in other working capital."
},
"otherNonCashItems": {
"type": "number",
"description": "The total other non-cash items."
},
"netCashProvidedByOperatingActivities": {
"type": "number",
"description": "The net cash provided by operating activities."
},
"investmentsInPropertyPlantAndEquipment": {
"type": "number",
"description": "The investments in property, plant, and equipment."
},
"acquisitionsNet": {
"type": "number",
"description": "The net acquisitions."
},
"purchasesOfInvestments": {
"type": "number",
"description": "The purchases of investments."
},
"salesMaturitiesOfInvestments": {
"type": "number",
"description": "The sales and maturities of investments."
},
"otherInvestingActivites": {
"type": "number",
"description": "The total other investing activities."
},
"netCashUsedForInvestingActivites": {
"type": "number",
"description": "The net cash used for investing activities."
},
"debtRepayment": {
"type": "number",
"description": "The total debt repayment."
},
"commonStockIssued": {
"type": "number",
"description": "The total common stock issued."
},
"commonStockRepurchased": {
"type": "number",
"description": "The total common stock repurchased."
},
"dividendsPaid": {
"type": "number",
"description": "The total dividends paid."
},
"otherFinancingActivites": {
"type": "number",
"description": "The total other financing activities."
},
"netCashUsedProvidedByFinancingActivities": {
"type": "number",
"description": "The net cash used/provided by financing activities."
},
"effectOfForexChangesOnCash": {
"type": "number",
"description": "The effect of forex changes on cash."
},
"netChangeInCash": {
"type": "number",
"description": "The net change in cash."
},
"cashAtEndOfPeriod": {
"type": "number",
"description": "The cash at the end of the period."
},
"cashAtBeginningOfPeriod": {
"type": "number",
"description": "The cash at the beginning of the period."
},
"operatingCashFlow": {
"type": "number",
"description": "The operating cash flow."
},
"capitalExpenditure": {
"type": "number",
"description": "The capital expenditure."
},
"freeCashFlow": {
"type": "number",
"description": "The free cash flow."
},
"link": {
"type": "string",
"description": "The link to the SEC filing."
},
"finalLink": {
"type": "string",
"description": "The direct link to the final SEC filing document."
}
}
}
}
}
},
"sectorPerformanceResponse": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date of the sector performance data."
},
"utilitiesChangesPercentage": {
"type": "number",
"description": "The percentage change in the Utilities sector (may be null if no data)."
},
"basicMaterialsChangesPercentage": {
"type": "number",
"description": "The percentage change in the Basic Materials sector (may be null if no data)."
},
"communicationServicesChangesPercentage": {
"type": "number",
"description": "The percentage change in the Communication Services sector (may be null if no data)."
},
"conglomeratesChangesPercentage": {
"type": "number",
"description": "The percentage change in the Conglomerates sector (may be null if no data) (may be null if no data)."
},
"consumerCyclicalChangesPercentage": {
"type": "number",
"description": "The percentage change in the Consumer Cyclical sector (may be null if no data)."
},
"consumerDefensiveChangesPercentage": {
"type": "number",
"description": "The percentage change in the Consumer Defensive sector (may be null if no data)."
},
"energyChangesPercentage": {
"type": "number",
"description": "The percentage change in the Energy sector (may be null if no data)."
},
"financialChangesPercentage": {
"type": "number",
"description": "The percentage change in the Financial sector (may be null if no data)."
},
"financialServicesChangesPercentage": {
"type": "number",
"description": "The percentage change in the Financial Services sector (may be null if no data)."
},
"healthcareChangesPercentage": {
"type": "number",
"description": "The percentage change in the Healthcare sector (may be null if no data)."
},
"industrialsChangesPercentage": {
"type": "number",
"description": "The percentage change in the Industrials sector (may be null if no data)."
},
"realEstateChangesPercentage": {
"type": "number",
"description": "The percentage change in the Real Estate sector (may be null if no data)."
},
"servicesChangesPercentage": {
"type": "number",
"description": "The percentage change in the Services sector (may be null if no data)."
},
"technologyChangesPercentage": {
"type": "number",
"description": "The percentage change in the Technology sector (may be null if no data)."
}
}
}
},
"economicIndicatorsResponse": {
"type": "array",
"items": {
"type": "object",
"properties": {
"indicator": {
"type": "string",
"description": "The name of the economic indicator."
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date for the economic data point."
},
"value": {
"type": "number",
"description": "The value for the economic data point."
}
}
}
}
}
}
},
"quantitativeFundamentalAnalysisResponse": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"stock_data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The stock ticker symbol."
},
"name": {
"type": "string",
"description": "The name of the company."
},
"price": {
"type": "number",
"description": "The current price of the stock."
},
"changesPercentage": {
"type": "number",
"description": "The percentage change in the stock price."
},
"change": {
"type": "number",
"description": "The numerical change in the stock price."
},
"dayLow": {
"type": "number",
"description": "The lowest price of the stock for the day."
},
"dayHigh": {
"type": "number",
"description": "The highest price of the stock for the day."
},
"yearHigh": {
"type": "number",
"description": "The highest price of the stock for the year."
},
"yearLow": {
"type": "number",
"description": "The lowest price of the stock for the year."
},
"marketCap": {
"type": "number",
"description": "The market capitalization of the company."
},
"priceAvg50": {
"type": "number",
"description": "The 50-day average price of the stock."
},
"priceAvg200": {
"type": "number",
"description": "The 200-day average price of the stock."
},
"exchange": {
"type": "string",
"description": "The stock exchange where the company is listed."
},
"volume": {
"type": "number",
"description": "The trading volume for the stock."
},
"avgVolume": {
"type": "number",
"description": "The average trading volume for the stock."
},
"open": {
"type": "number",
"description": "The opening price of the stock for the trading day."
},
"previousClose": {
"type": "number",
"description": "The closing price of the stock from the previous trading day."
},
"eps": {
"type": "number",
"description": "Earnings per share."
},
"pe": {
"type": "number",
"description": "Price-to-earnings ratio."
},
"earningsAnnouncement": {
"type": "string",
"description": "The date and time of the earnings announcement."
},
"sharesOutstanding": {
"type": "number",
"description": "The number of shares that are currently outstanding."
},
"timestamp": {
"type": "number",
"description": "The timestamp of when the data was retrieved."
}
}
}
},
"income_statement_annual": {
"type": "array",
"description": "The annual income statement data for the company.",
"items": {
"$ref": "#/components/schemas/incomeStatementResponse"
}
},
"balance_sheet_annual": {
"type": "array",
"description": "The annual balance sheet data for the company.",
"items": {
"$ref": "#/components/schemas/balanceSheetResponse"
}
},
"cash_flow_annual": {
"type": "array",
"description": "The annual cash flow data for the company.",
"items": {
"$ref": "#/components/schemas/cashFlowResponse"
}
},
"financial_ratios": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dividendYielTTM": {
"type": "number",
"description": "The dividend yield over the trailing twelve months."
},
"dividendYielPercentageTTM": {
"type": "number",
"description": "The dividend yield percentage over the trailing twelve months."
},
"peRatioTTM": {
"type": "number",
"description": "The price to earnings ratio over the trailing twelve months."
},
"pegRatioTTM": {
"type": "number",
"description": "The price/earnings to growth ratio over the trailing twelve months."
},
"payoutRatioTTM": {
"type": "number",
"description": "The payout ratio over the trailing twelve months."
},
"currentRatioTTM": {
"type": "number",
"description": "The current ratio over the trailing twelve months."
},
"quickRatioTTM": {
"type": "number",
"description": "The quick ratio over the trailing twelve months."
},
"cashRatioTTM": {
"type": "number",
"description": "The cash ratio over the trailing twelve months."
},
"daysOfSalesOutstandingTTM": {
"type": "number",
"description": "The days of sales outstanding over the trailing twelve months."
},
"daysOfInventoryOutstandingTTM": {
"type": "number",
"description": "The days of inventory outstanding over the trailing twelve months."
},
"operatingCycleTTM": {
"type": "number",
"description": "The operating cycle over the trailing twelve months."
},
"daysOfPayablesOutstandingTTM": {
"type": "number",
"description": "The days of payables outstanding over the trailing twelve months."
},
"cashConversionCycleTTM": {
"type": "number",
"description": "The cash conversion cycle over the trailing twelve months."
},
"grossProfitMarginTTM": {
"type": "number",
"description": "The gross profit margin over the trailing twelve months."
},
"operatingProfitMarginTTM": {
"type": "number",
"description": "The operating profit margin over the trailing twelve months."
},
"pretaxProfitMarginTTM": {
"type": "number",
"description": "The pretax profit margin over the trailing twelve months."
},
"netProfitMarginTTM": {
"type": "number",
"description": "The net profit margin over the trailing twelve months."
},
"effectiveTaxRateTTM": {
"type": "number",
"description": "The effective tax rate over the trailing twelve months."
},
"returnOnAssetsTTM": {
"type": "number",
"description": "The return on assets over the trailing twelve months."
},
"returnOnEquityTTM": {
"type": "number",
"description": "The return on equity over the trailing twelve months."
},
"returnOnCapitalEmployedTTM": {
"type": "number",
"description": "The return on capital employed over the trailing twelve months."
},
"netIncomePerEBTTTM": {
"type": "number",
"description": "The net income per earnings before taxes over the trailing twelve months."
},
"ebtPerEbitTTM": {
"type": "number",
"description": "The earnings before taxes per earnings before interest and taxes over the trailing twelve months."
},
"ebitPerRevenueTTM": {
"type": "number",
"description": "The earnings before interest and taxes per total revenue over the trailing twelve months."
},
"debtRatioTTM": {
"type": "number",
"description": "The debt ratio over the trailing twelve months."
},
"debtEquityRatioTTM": {
"type": "number",
"description": "The debt to equity ratio over the trailing twelve months."
},
"longTermDebtToCapitalizationTTM": {
"type": "number",
"description": "The long-term debt to capitalization ratio over the trailing twelve months."
},
"totalDebtToCapitalizationTTM": {
"type": "number",
"description": "The total debt to capitalization ratio over the trailing twelve months."
},
"interestCoverageTTM": {
"type": "number",
"description": "The interest coverage ratio over the trailing twelve months."
},
"cashFlowToDebtRatioTTM": {
"type": "number",
"description": "The cash flow to debt ratio over the trailing twelve months."
},
"companyEquityMultiplierTTM": {
"type": "number",
"description": "The company equity multiplier over the trailing twelve months."
},
"receivablesTurnoverTTM": {
"type": "number",
"description": "The receivables turnover ratio over the trailing twelve months."
},
"payablesTurnoverTTM": {
"type": "number",
"description": "The payables turnover ratio over the trailing twelve months."
},
"inventoryTurnoverTTM": {
"type": "number",
"description": "The inventory turnover ratio over the trailing twelve months."
},
"fixedAssetTurnoverTTM": {
"type": "number",
"description": "The fixed asset turnover ratio over the trailing twelve months."
},
"assetTurnoverTTM": {
"type": "number",
"description": "The asset turnover ratio over the trailing twelve months."
},
"operatingCashFlowPerShareTTM": {
"type": "number",
"description": "The operating cash flow per share over the trailing twelve months."
},
"freeCashFlowPerShareTTM": {
"type": "number",
"description": "The free cash flow per share over the trailing twelve months."
},
"cashPerShareTTM": {
"type": "number",
"description": "The cash per share over the trailing twelve months."
},
"operatingCashFlowSalesRatioTTM": {
"type": "number",
"description": "The operating cash flow sales ratio over the trailing twelve months."
},
"freeCashFlowOperatingCashFlowRatioTTM": {
"type": "number",
"description": "The free cash flow to operating cash flow ratio over the trailing twelve months."
},
"cashFlowCoverageRatiosTTM": {
"type": "number",
"description": "The cash flow coverage ratios over the trailing twelve months."
},
"shortTermCoverageRatiosTTM": {
"type": "number",
"description": "The short-term coverage ratios over the trailing twelve months."
},
"capitalExpenditureCoverageRatioTTM": {
"type": "number",
"description": "The capital expenditure coverage ratio over the trailing twelve months."
},
"dividendPaidAndCapexCoverageRatioTTM": {
"type": "number",
"description": "The dividend paid and capital expenditures coverage ratio over the trailing twelve months."
},
"priceBookValueRatioTTM": {
"type": "number",
"description": "The price to book value ratio over the trailing twelve months."
},
"priceToBookRatioTTM": {
"type": "number",
"description": "The price to book ratio over the trailing twelve months."
},
"priceToSalesRatioTTM": {
"type": "number",
"description": "The price to sales ratio over the trailing twelve months."
},
"priceEarningsRatioTTM": {
"type": "number",
"description": "The price earnings ratio over the trailing twelve months."
},
"priceToFreeCashFlowsRatioTTM": {
"type": "number",
"description": "The price to free cash flows ratio over the trailing twelve months."
},
"priceToOperatingCashFlowsRatioTTM": {
"type": "number",
"description": "The price to operating cash flows ratio over the trailing twelve months."
},
"priceCashFlowRatioTTM": {
"type": "number",
"description": "The price cash flow ratio over the trailing twelve months."
},
"priceEarningsToGrowthRatioTTM": {
"type": "number",
"description": "The price earnings to growth ratio over the trailing twelve months."
},
"priceSalesRatioTTM": {
"type": "number",
"description": "The price sales ratio over the trailing twelve months."
},
"enterpriseValueMultipleTTM": {
"type": "number",
"description": "The enterprise value multiple over the trailing twelve months."
},
"priceFairValueTTM": {
"type": "number",
"description": "The price to fair value ratio over the trailing twelve months."
},
"dividendPerShareTTM": {
"type": "number",
"description": "The dividend per share over the trailing twelve months."
}
}
}
}
}
}
}
},
"getCompetitorsResponse": {
"type": "array",
"items": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The stock ticker symbol of the company for which competitors are listed."
},
"peersList": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of stock ticker symbols representing the competitors of the company."
}
}
}
},
"getForexPairsResponse": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"AEDAUD",
"AEDBHD",
"AEDCAD",
"AEDCHF",
"AEDEUR",
"..."
]
},
"getCommoditiesResponse": {
"type": "array",
"items": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The commodity ticker symbol."
},
"name": {
"type": "string",
"description": "The name of the commodity."
}
}
}
}
}
}
}