Finance & Banking

Yahoo Finance Integration

Yahoo Finance API client for retrieving real-time and historical financial market data, stock quotes, company fundamentals, options chains, and market news. Supports equities, ETFs, mutual funds, curr

Yahoo Finance

Category: Finance & Banking
Provider Key: yahooFinance

Configuration

To use Yahoo Finance in your project, add it to your project integrations and provide the following configuration:

Parameter	Type	Required	Description
`rapidApiKey`	`string`	Yes	Your RapidAPI key for Yahoo Finance
`rapidApiHost`	`string`	No	RapidAPI host
`timeout`	`number`	No	Request timeout in milliseconds

Example Configuration

{
  "provider": "yahooFinance",
  "configuration": [
    { "name": "rapidApiKey", "value": "your-rapidApiKey" },
    { "name": "rapidApiHost", "value": "your-rapidApiHost" },
    { "name": "timeout", "value": 0 }
  ]
}

Setup Guide

Yahoo Finance Integration

Retrieve real-time quotes, historical prices, company fundamentals, options, and financial news via Yahoo Finance.

Category: finance

How to Get API Keys

Difficulty: Easy

Yahoo Finance data can be accessed via RapidAPI with a free tier available immediately after sign-up.

Developer Portal: https://rapidapi.com/apidojo/api/yahoo-finance1

Steps:

Go to https://rapidapi.com/signup and create a free RapidAPI account.
Navigate to https://rapidapi.com/apidojo/api/yahoo-finance1 and click "Subscribe to Test".
Choose the free "Basic" plan (500 requests/month) or a paid plan for higher limits.
Once subscribed, copy your X-RapidAPI-Key from the "Header Parameters" section on the API page.
Note the host value: yahoo-finance1.p.rapidapi.com.

Configuration

Field	Type	Required	Description
rapidApiKey	string	Yes	Your RapidAPI key for authenticating requests to Yahoo Finance
rapidApiHost	string	No	RapidAPI host (defaults to yahoo-finance1.p.rapidapi.com)
timeout	number	No	Request timeout in milliseconds (default: 10000)

Config Template

{
  "rapidApiKey": "<YOUR_RAPIDAPI_KEY>",
  "rapidApiHost": "yahoo-finance1.p.rapidapi.com",
  "timeout": 10000
}

Available Methods

Quick reference:

Quotes: getQuotes, searchSymbols
Historical: getHistoricalData
Fundamentals: getCompanySummary, getFinancials, getAnalystRecommendations, getHolders, getInsiderTransactions, getEarnings, getEarningsCalendar, getDividendHistory
Options: getOptionsChain
Market: getMarketSummary, getMarketMovers, getTrendingTickers
News: getNewsForSymbol, getNewsArticle
Recommendations: getSimilarStocks, screenStocks
Funds: getFundProfile

Quotes

`getQuotes`

Get Quotes

Fetches real-time quote data for one or more ticker symbols. Returns price, volume, market cap, and trading statistics.

Parameters:

Parameter	Type	Required	Description
`symbols`	`string`	Yes	Comma-separated list of ticker symbols (e.g., "AAPL,MSFT,GOOGL")
`region`	`string`	No	Market region
`lang`	`string`	No	Response language

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getQuotesAction",
  "provider": "yahooFinance",
  "action": "getQuotes",
  "parameters": [
    { "parameterName": "symbols", "parameterValue": "'your-symbols'" },
    { "parameterName": "region", "parameterValue": "'your-region'" },
    { "parameterName": "lang", "parameterValue": "'your-lang'" }
  ],
  "contextPropertyName": "getQuotesResult"
}

MScript example:

await _yahooFinance.getQuotes({
  symbols: /* string */,
  region: /* string */,
  lang: /* string */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getQuotes({
  symbols: /* string */,
  region: /* string */,
  lang: /* string */,
});

`searchSymbols`

Search Symbols

Returns auto-complete search suggestions for a given query string. Useful for building symbol search boxes in UIs.

Parameters:

Parameter	Type	Required	Description
`query`	`string`	Yes	Search query (company name, ticker, or keyword)
`region`	`string`	No	Market region for results
`lang`	`string`	No	Language for results

Returns: Promise<{ResultSet: {Query: string, Result: Array<{symbol: string, name: string, exch: string, type: string, exchDisp: string, typeDisp: string}>}}>

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "searchSymbolsAction",
  "provider": "yahooFinance",
  "action": "searchSymbols",
  "parameters": [
    { "parameterName": "query", "parameterValue": "'your-query'" },
    { "parameterName": "region", "parameterValue": "'your-region'" },
    { "parameterName": "lang", "parameterValue": "'your-lang'" }
  ],
  "contextPropertyName": "searchSymbolsResult"
}

MScript example:

await _yahooFinance.searchSymbols({
  query: /* string */,
  region: /* string */,
  lang: /* string */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.searchSymbols({
  query: /* string */,
  region: /* string */,
  lang: /* string */,
});

Historical

`getHistoricalData`

Get Historical Prices

Retrieves historical OHLCV (open/high/low/close/volume) price data for a symbol. Supports multiple intervals and date ranges.

Parameters:

Parameter	Type	Required	Description
`symbol`	`string`	Yes	Ticker symbol (e.g., "AAPL")
`interval`	`string`	No	Data interval
`range`	`string`	No	Date range
`region`	`string`	No	Market region
`includePrePost`	`boolean`	No	Include pre/post market data
`useYfid`	`boolean`	No	Use Yahoo Finance ID

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getHistoricalDataAction",
  "provider": "yahooFinance",
  "action": "getHistoricalData",
  "parameters": [
    { "parameterName": "symbol", "parameterValue": "'your-symbol'" },
    { "parameterName": "interval", "parameterValue": "'your-interval'" },
    { "parameterName": "range", "parameterValue": "'your-range'" },
    { "parameterName": "region", "parameterValue": "'your-region'" },
    { "parameterName": "includePrePost", "parameterValue": "true" },
    { "parameterName": "useYfid", "parameterValue": "true" }
  ],
  "contextPropertyName": "getHistoricalDataResult"
}

MScript example:

await _yahooFinance.getHistoricalData({
  symbol: /* string */,
  interval: /* string */,
  range: /* string */,
  region: /* string */,
  includePrePost: /* boolean */,
  useYfid: /* boolean */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getHistoricalData({
  symbol: /* string */,
  interval: /* string */,
  range: /* string */,
  region: /* string */,
  includePrePost: /* boolean */,
  useYfid: /* boolean */,
});

Fundamentals

`getCompanySummary`

Get Company Summary

Fetches detailed company summary including business description, sector, industry, employee count, and key financial ratios.

Parameters:

Parameter	Type	Required	Description
`symbol`	`string`	Yes	Ticker symbol (e.g., "AAPL")
`region`	`string`	No	Market region
`lang`	`string`	No	Language for results

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getCompanySummaryAction",
  "provider": "yahooFinance",
  "action": "getCompanySummary",
  "parameters": [
    { "parameterName": "symbol", "parameterValue": "'your-symbol'" },
    { "parameterName": "region", "parameterValue": "'your-region'" },
    { "parameterName": "lang", "parameterValue": "'your-lang'" }
  ],
  "contextPropertyName": "getCompanySummaryResult"
}

MScript example:

await _yahooFinance.getCompanySummary({
  symbol: /* string */,
  region: /* string */,
  lang: /* string */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getCompanySummary({
  symbol: /* string */,
  region: /* string */,
  lang: /* string */,
});

`getFinancials`

Get Financials

Retrieves income statement, balance sheet, and cash flow data for a company. Available for both annual and quarterly reporting periods.

Parameters:

Parameter	Type	Required	Description
`symbol`	`string`	Yes	Ticker symbol (e.g., "AAPL")
`region`	`string`	No	Market region

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getFinancialsAction",
  "provider": "yahooFinance",
  "action": "getFinancials",
  "parameters": [
    { "parameterName": "symbol", "parameterValue": "'your-symbol'" },
    { "parameterName": "region", "parameterValue": "'your-region'" }
  ],
  "contextPropertyName": "getFinancialsResult"
}

MScript example:

await _yahooFinance.getFinancials({
  symbol: /* string */,
  region: /* string */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getFinancials({
  symbol: /* string */,
  region: /* string */,
});

`getAnalystRecommendations`

Get Analyst Recommendations

Retrieves analyst recommendations, earnings estimates, and revenue forecasts. Includes buy/sell/hold ratings and EPS consensus.

Parameters:

Parameter	Type	Required	Description
`symbol`	`string`	Yes	Ticker symbol (e.g., "AAPL")
`region`	`string`	No	Market region

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getAnalystRecommendationsAction",
  "provider": "yahooFinance",
  "action": "getAnalystRecommendations",
  "parameters": [
    { "parameterName": "symbol", "parameterValue": "'your-symbol'" },
    { "parameterName": "region", "parameterValue": "'your-region'" }
  ],
  "contextPropertyName": "getAnalystRecommendationsResult"
}

MScript example:

await _yahooFinance.getAnalystRecommendations({
  symbol: /* string */,
  region: /* string */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getAnalystRecommendations({
  symbol: /* string */,
  region: /* string */,
});

`getHolders`

Get Holders

Returns a list of institutional and mutual fund holders for a given stock. Includes percentage ownership and share counts.

Parameters:

Parameter	Type	Required	Description
`symbol`	`string`	Yes	Ticker symbol (e.g., "AAPL")
`region`	`string`	No	Market region

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getHoldersAction",
  "provider": "yahooFinance",
  "action": "getHolders",
  "parameters": [
    { "parameterName": "symbol", "parameterValue": "'your-symbol'" },
    { "parameterName": "region", "parameterValue": "'your-region'" }
  ],
  "contextPropertyName": "getHoldersResult"
}

MScript example:

await _yahooFinance.getHolders({
  symbol: /* string */,
  region: /* string */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getHolders({
  symbol: /* string */,
  region: /* string */,
});

`getInsiderTransactions`

Get Insider Transactions

Fetches insider trading activity for a stock including buys, sells, and beneficial ownership filings.

Parameters:

Parameter	Type	Required	Description
`symbol`	`string`	Yes	Ticker symbol (e.g., "AAPL")
`region`	`string`	No	Market region

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getInsiderTransactionsAction",
  "provider": "yahooFinance",
  "action": "getInsiderTransactions",
  "parameters": [
    { "parameterName": "symbol", "parameterValue": "'your-symbol'" },
    { "parameterName": "region", "parameterValue": "'your-region'" }
  ],
  "contextPropertyName": "getInsiderTransactionsResult"
}

MScript example:

await _yahooFinance.getInsiderTransactions({
  symbol: /* string */,
  region: /* string */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getInsiderTransactions({
  symbol: /* string */,
  region: /* string */,
});

`getEarnings`

Get Earnings

Retrieves the earnings history and upcoming earnings calendar for a symbol. Includes EPS actuals vs estimates and surprise percentages.

Parameters:

Parameter	Type	Required	Description
`symbol`	`string`	Yes	Ticker symbol (e.g., "AAPL")
`region`	`string`	No	Market region

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getEarningsAction",
  "provider": "yahooFinance",
  "action": "getEarnings",
  "parameters": [
    { "parameterName": "symbol", "parameterValue": "'your-symbol'" },
    { "parameterName": "region", "parameterValue": "'your-region'" }
  ],
  "contextPropertyName": "getEarningsResult"
}

MScript example:

await _yahooFinance.getEarnings({
  symbol: /* string */,
  region: /* string */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getEarnings({
  symbol: /* string */,
  region: /* string */,
});

`getEarningsCalendar`

Get Earnings Calendar

Returns the earnings calendar showing upcoming earnings announcements for a list of symbols within a date window.

Parameters:

Parameter	Type	Required	Description
`startDate`	`string`	No	ISO date string start of range (e.g., "2024-01-01"); defaults to today
`endDate`	`string`	No	ISO date string end of range (e.g., "2024-01-31"); defaults to 7 days ahead
`region`	`string`	No	Market region
`size`	`number`	No	Number of results to return
`offset`	`number`	No	Pagination offset

Returns: Promise<{finance: {result: {earnings: {rows: Array<{ticker: string, companyshortname: string, startdatetime: string, enddatetime: string, startdatetimetype: string, epsestimate: number, epsactual: number, epssurprisepct: number, timeZoneShortName: string, gmtOffsetMilliSeconds: number}>, count: number}}>}}>

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getEarningsCalendarAction",
  "provider": "yahooFinance",
  "action": "getEarningsCalendar",
  "parameters": [
    { "parameterName": "startDate", "parameterValue": "'your-startDate'" },
    { "parameterName": "endDate", "parameterValue": "'your-endDate'" },
    { "parameterName": "region", "parameterValue": "'your-region'" },
    { "parameterName": "size", "parameterValue": "0" },
    { "parameterName": "offset", "parameterValue": "0" }
  ],
  "contextPropertyName": "getEarningsCalendarResult"
}

MScript example:

await _yahooFinance.getEarningsCalendar({
  startDate: /* string */,
  endDate: /* string */,
  region: /* string */,
  size: /* number */,
  offset: /* number */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getEarningsCalendar({
  startDate: /* string */,
  endDate: /* string */,
  region: /* string */,
  size: /* number */,
  offset: /* number */,
});

`getDividendHistory`

Get Dividend History

Retrieves dividend history for a symbol using the historical data endpoint. Returns date, dividend amount, and split events.

Parameters:

Parameter	Type	Required	Description
`symbol`	`string`	Yes	Ticker symbol (e.g., "AAPL")
`range`	`string`	No	Historical range
`region`	`string`	No	Market region

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getDividendHistoryAction",
  "provider": "yahooFinance",
  "action": "getDividendHistory",
  "parameters": [
    { "parameterName": "symbol", "parameterValue": "'your-symbol'" },
    { "parameterName": "range", "parameterValue": "'your-range'" },
    { "parameterName": "region", "parameterValue": "'your-region'" }
  ],
  "contextPropertyName": "getDividendHistoryResult"
}

MScript example:

await _yahooFinance.getDividendHistory({
  symbol: /* string */,
  range: /* string */,
  region: /* string */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getDividendHistory({
  symbol: /* string */,
  range: /* string */,
  region: /* string */,
});

Options

`getOptionsChain`

Get Options Chain

Fetches the options chain (calls and puts) for a given symbol and expiration date. Returns strike prices, premiums, open interest, and Greeks.

Parameters:

Parameter	Type	Required	Description
`symbol`	`string`	Yes	Ticker symbol (e.g., "AAPL")
`date`	`number`	No	Unix timestamp for expiration date; omit for nearest expiry
`region`	`string`	No	Market region

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getOptionsChainAction",
  "provider": "yahooFinance",
  "action": "getOptionsChain",
  "parameters": [
    { "parameterName": "symbol", "parameterValue": "'your-symbol'" },
    { "parameterName": "date", "parameterValue": "0" },
    { "parameterName": "region", "parameterValue": "'your-region'" }
  ],
  "contextPropertyName": "getOptionsChainResult"
}

MScript example:

await _yahooFinance.getOptionsChain({
  symbol: /* string */,
  date: /* number */,
  region: /* string */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getOptionsChain({
  symbol: /* string */,
  date: /* number */,
  region: /* string */,
});

Market

`getMarketSummary`

Get Market Summary

Returns a market summary with major indices (S&P 500, Nasdaq, Dow Jones, etc.) and their current values, changes, and sparklines.

Parameters:

Parameter	Type	Required	Description
`region`	`string`	No	Market region to summarize
`lang`	`string`	No	Language for results

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getMarketSummaryAction",
  "provider": "yahooFinance",
  "action": "getMarketSummary",
  "parameters": [
    { "parameterName": "region", "parameterValue": "'your-region'" },
    { "parameterName": "lang", "parameterValue": "'your-lang'" }
  ],
  "contextPropertyName": "getMarketSummaryResult"
}

MScript example:

await _yahooFinance.getMarketSummary({
  region: /* string */,
  lang: /* string */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getMarketSummary({
  region: /* string */,
  lang: /* string */,
});

`getMarketMovers`

Get Market Movers

Retrieves top market movers including gainers, losers, and most active stocks for a given market region.

Parameters:

Parameter	Type	Required	Description
`region`	`string`	No	Market region
`lang`	`string`	No	Language for results
`count`	`number`	No	Number of results per category (max 25)
`start`	`number`	No	Offset for pagination

Returns: Promise<{finance: {result: Array<{id: string, title: string, description: string, canonicalName: string, criteriaMeta: Object, rawCriteria: string, start: number, count: number, total: number, quotes: Array<{symbol: string, regularMarketPrice: number, regularMarketChange: number, regularMarketChangePercent: number, regularMarketVolume: number, shortName: string}>}>}}>

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getMarketMoversAction",
  "provider": "yahooFinance",
  "action": "getMarketMovers",
  "parameters": [
    { "parameterName": "region", "parameterValue": "'your-region'" },
    { "parameterName": "lang", "parameterValue": "'your-lang'" },
    { "parameterName": "count", "parameterValue": "0" },
    { "parameterName": "start", "parameterValue": "0" }
  ],
  "contextPropertyName": "getMarketMoversResult"
}

MScript example:

await _yahooFinance.getMarketMovers({
  region: /* string */,
  lang: /* string */,
  count: /* number */,
  start: /* number */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getMarketMovers({
  region: /* string */,
  lang: /* string */,
  count: /* number */,
  start: /* number */,
});

`getTrendingTickers`

Get Trending Tickers

Fetches trending tickers and stocks based on recent search and trading activity.

Parameters:

Parameter	Type	Required	Description
`region`	`string`	No	Market region
`count`	`number`	No	Number of trending tickers to return

Returns: Promise<{finance: {result: Array<{count: number, quotes: Array<{symbol: string, shortName: string, regularMarketPrice: number, regularMarketChange: number, regularMarketChangePercent: number}>, jobTimestamp: number, startInterval: number}>}}>

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getTrendingTickersAction",
  "provider": "yahooFinance",
  "action": "getTrendingTickers",
  "parameters": [
    { "parameterName": "region", "parameterValue": "'your-region'" },
    { "parameterName": "count", "parameterValue": "0" }
  ],
  "contextPropertyName": "getTrendingTickersResult"
}

MScript example:

await _yahooFinance.getTrendingTickers({
  region: /* string */,
  count: /* number */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getTrendingTickers({
  region: /* string */,
  count: /* number */,
});

News

`getNewsForSymbol`

Get News for Symbol

Retrieves the latest financial news headlines for a specific ticker symbol. Includes title, publisher, publish time, and article links.

Parameters:

Parameter	Type	Required	Description
`symbol`	`string`	Yes	Ticker symbol (e.g., "AAPL")
`region`	`string`	No	Market region
`lang`	`string`	No	Language for news articles

Returns: Promise<{items: {title: string, description: string, count: number, stream: Array<{id: string, contentType: string, content: {id: string, contentType: string, title: string, pubDate: string, thumbnail: {resolutions: Array<{url: string, width: number, height: number, tag: string}>}, provider: {displayName: string, url: string}, finance: {stockTickers: Array<{symbol: string}>}, clickThroughUrl: {url: string}}}>}}>

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getNewsForSymbolAction",
  "provider": "yahooFinance",
  "action": "getNewsForSymbol",
  "parameters": [
    { "parameterName": "symbol", "parameterValue": "'your-symbol'" },
    { "parameterName": "region", "parameterValue": "'your-region'" },
    { "parameterName": "lang", "parameterValue": "'your-lang'" }
  ],
  "contextPropertyName": "getNewsForSymbolResult"
}

MScript example:

await _yahooFinance.getNewsForSymbol({
  symbol: /* string */,
  region: /* string */,
  lang: /* string */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getNewsForSymbol({
  symbol: /* string */,
  region: /* string */,
  lang: /* string */,
});

`getNewsArticle`

Get News Article

Retrieves the full detail of a specific news article by its UUID.

Parameters:

Parameter	Type	Required	Description
`uuid`	`string`	Yes	News article UUID obtained from getNewsForSymbol
`region`	`string`	No	Market region

Returns: Promise<{content: {id: string, contentType: string, title: string, pubDate: string, summary: string, author: {name: string}, provider: {displayName: string, url: string}, thumbnail: {resolutions: Array<{url: string, width: number, height: number}>}, finance: {stockTickers: Array<{symbol: string}>}, clickThroughUrl: {url: string}>}}>

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getNewsArticleAction",
  "provider": "yahooFinance",
  "action": "getNewsArticle",
  "parameters": [
    { "parameterName": "uuid", "parameterValue": "'your-uuid'" },
    { "parameterName": "region", "parameterValue": "'your-region'" }
  ],
  "contextPropertyName": "getNewsArticleResult"
}

MScript example:

await _yahooFinance.getNewsArticle({
  uuid: /* string */,
  region: /* string */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getNewsArticle({
  uuid: /* string */,
  region: /* string */,
});

Recommendations

`getSimilarStocks`

Get Similar Stocks

Returns stocks similar to or related to the queried symbol, based on Yahoo Finance's recommendation engine.

Parameters:

Parameter	Type	Required	Description
`symbol`	`string`	Yes	Ticker symbol (e.g., "AAPL")

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getSimilarStocksAction",
  "provider": "yahooFinance",
  "action": "getSimilarStocks",
  "parameters": [
    { "parameterName": "symbol", "parameterValue": "'your-symbol'" }
  ],
  "contextPropertyName": "getSimilarStocksResult"
}

MScript example:

await _yahooFinance.getSimilarStocks({
  symbol: /* string */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getSimilarStocks({
  symbol: /* string */,
});

`screenStocks`

Screen Stocks

Runs a stock screener query to filter equities based on financial criteria. Supports built-in screener IDs like most_actives, day_gainers, day_losers.

Parameters:

Parameter	Type	Required	Description
`screenerType`	`string`	No	Predefined screener type ID
`region`	`string`	No	Market region
`lang`	`string`	No	Language for results
`count`	`number`	No	Number of results to return (max 250)
`offset`	`number`	No	Pagination offset

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "screenStocksAction",
  "provider": "yahooFinance",
  "action": "screenStocks",
  "parameters": [
    { "parameterName": "screenerType", "parameterValue": "'your-screenerType'" },
    { "parameterName": "region", "parameterValue": "'your-region'" },
    { "parameterName": "lang", "parameterValue": "'your-lang'" },
    { "parameterName": "count", "parameterValue": "0" },
    { "parameterName": "offset", "parameterValue": "0" }
  ],
  "contextPropertyName": "screenStocksResult"
}

MScript example:

await _yahooFinance.screenStocks({
  screenerType: /* string */,
  region: /* string */,
  lang: /* string */,
  count: /* number */,
  offset: /* number */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.screenStocks({
  screenerType: /* string */,
  region: /* string */,
  lang: /* string */,
  count: /* number */,
  offset: /* number */,
});

Funds

`getFundProfile`

Get Fund Profile

Retrieves top holdings, sector weights, and asset allocation for an ETF or mutual fund.

Parameters:

Parameter	Type	Required	Description
`symbol`	`string`	Yes	ETF or fund ticker symbol (e.g., "SPY", "QQQ")
`region`	`string`	No	Market region

IntegrationAction example:

{
  "extendClassName": "IntegrationAction",
  "name": "getFundProfileAction",
  "provider": "yahooFinance",
  "action": "getFundProfile",
  "parameters": [
    { "parameterName": "symbol", "parameterValue": "'your-symbol'" },
    { "parameterName": "region", "parameterValue": "'your-region'" }
  ],
  "contextPropertyName": "getFundProfileResult"
}

MScript example:

await _yahooFinance.getFundProfile({
  symbol: /* string */,
  region: /* string */,
})

Service library example:

const { getIntegrationClient } = require("integrations");
const client = await getIntegrationClient("yahooFinance");
const result = await client.getFundProfile({
  symbol: /* string */,
  region: /* string */,
});

Was this page helpful?

Last updated today

Built with Documentation.AI