API - Corsair

Every alphavantage.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Commodities

all

commodities.all Get the global commodities price index Risk: read

await corsair.alphavantage.api.commodities.all({});

Input

Name	Type	Required	Description
`interval`	`monthly \| quarterly \| annual`	No	Sampling interval. Defaults to monthly.

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

aluminum

commodities.aluminum Get global aluminum prices Risk: read

await corsair.alphavantage.api.commodities.aluminum({});

Input

Name	Type	Required	Description
`interval`	`monthly \| quarterly \| annual`	No	Sampling interval. Defaults to monthly.

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

brent

commodities.brent Get Brent crude oil prices Risk: read

await corsair.alphavantage.api.commodities.brent({});

Input

Name	Type	Required	Description
`interval`	`daily \| weekly \| monthly`	No	Sampling interval. Defaults to monthly.

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

coffee

commodities.coffee Get global coffee prices Risk: read

await corsair.alphavantage.api.commodities.coffee({});

Input

Name	Type	Required	Description
`interval`	`monthly \| quarterly \| annual`	No	Sampling interval. Defaults to monthly.

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

copper

commodities.copper Get global copper prices Risk: read

await corsair.alphavantage.api.commodities.copper({});

Input

Name	Type	Required	Description
`interval`	`monthly \| quarterly \| annual`	No	Sampling interval. Defaults to monthly.

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

corn

commodities.corn Get global corn prices Risk: read

await corsair.alphavantage.api.commodities.corn({});

Input

Name	Type	Required	Description
`interval`	`monthly \| quarterly \| annual`	No	Sampling interval. Defaults to monthly.

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

cotton

commodities.cotton Get global cotton prices Risk: read

await corsair.alphavantage.api.commodities.cotton({});

Input

Name	Type	Required	Description
`interval`	`monthly \| quarterly \| annual`	No	Sampling interval. Defaults to monthly.

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

sugar

commodities.sugar Get global sugar prices Risk: read

await corsair.alphavantage.api.commodities.sugar({});

Input

Name	Type	Required	Description
`interval`	`monthly \| quarterly \| annual`	No	Sampling interval. Defaults to monthly.

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

wheat

commodities.wheat Get global wheat prices Risk: read

await corsair.alphavantage.api.commodities.wheat({});

Input

Name	Type	Required	Description
`interval`	`monthly \| quarterly \| annual`	No	Sampling interval. Defaults to monthly.

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

Crypto

daily

crypto.daily Get daily bars for a digital currency Risk: read

await corsair.alphavantage.api.crypto.daily({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`market`	`string`	Yes	—

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

intraday

crypto.intraday Get intraday bars for a digital currency [PREMIUM PLAN] Risk: read

await corsair.alphavantage.api.crypto.intraday({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	Crypto ticker, e.g. BTC.
`market`	`string`	Yes	Quote currency, e.g. USD.
`interval`	`1min \| 5min \| 15min \| 30min \| 60min`	Yes	—
`outputsize`	`compact \| full`	No	compact returns the latest 100 points, full the full history.

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

monthly

crypto.monthly Get monthly bars for a digital currency Risk: read

await corsair.alphavantage.api.crypto.monthly({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`market`	`string`	Yes	—

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

weekly

crypto.weekly Get weekly bars for a digital currency Risk: read

await corsair.alphavantage.api.crypto.weekly({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`market`	`string`	Yes	—

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

Economic

cpi

economic.cpi Get the US consumer price index Risk: read

await corsair.alphavantage.api.economic.cpi({});

Input

Name	Type	Required	Description
`interval`	`monthly \| semiannual`	No	Sampling interval. Defaults to monthly.

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

durables

economic.durables Get US durable goods orders Risk: read

await corsair.alphavantage.api.economic.durables({});

Input: empty object Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

federalFundsRate

economic.federalFundsRate Get the US federal funds rate Risk: read

await corsair.alphavantage.api.economic.federalFundsRate({});

Input

Name	Type	Required	Description
`interval`	`daily \| weekly \| monthly`	No	Sampling interval. Defaults to monthly.

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

inflation

economic.inflation Get annual US inflation Risk: read

await corsair.alphavantage.api.economic.inflation({});

Input: empty object Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

nonfarmPayroll

economic.nonfarmPayroll Get US nonfarm payroll totals Risk: read

await corsair.alphavantage.api.economic.nonfarmPayroll({});

Input: empty object Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

realGdp

economic.realGdp Get US real gross domestic product Risk: read

await corsair.alphavantage.api.economic.realGdp({});

Input

Name	Type	Required	Description
`interval`	`quarterly \| annual`	No	Sampling interval. Defaults to annual.

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

realGdpPerCapita

economic.realGdpPerCapita Get US real GDP per capita Risk: read

await corsair.alphavantage.api.economic.realGdpPerCapita({});

Input: empty object Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

retailSales

economic.retailSales Get US advance retail sales Risk: read

await corsair.alphavantage.api.economic.retailSales({});

Input: empty object Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

treasuryYield

economic.treasuryYield Get US treasury yield for a constant maturity Risk: read

await corsair.alphavantage.api.economic.treasuryYield({});

Input

Name	Type	Required	Description
`interval`	`daily \| weekly \| monthly`	No	—
`maturity`	`3month \| 2year \| 5year \| 7year \| 10year \| 30year`	No	—

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

unemployment

economic.unemployment Get the US unemployment rate Risk: read

await corsair.alphavantage.api.economic.unemployment({});

Input: empty object Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`interval`	`string`	Yes	—
`unit`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  date: string,
  value: string
}[]

Forex

daily

forex.daily Get daily bars for a currency pair Risk: read

await corsair.alphavantage.api.forex.daily({});

Input

Name	Type	Required	Description
`from_symbol`	`string`	Yes	—
`to_symbol`	`string`	Yes	—
`outputsize`	`compact \| full`	No	compact returns the latest 100 points, full the full history.

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

exchangeRate

forex.exchangeRate Get the current rate for a currency pair Risk: read

await corsair.alphavantage.api.forex.exchangeRate({});

Input

Name	Type	Required	Description
`from_currency`	`string`	Yes	—
`to_currency`	`string`	Yes	—

Output

Name	Type	Required	Description
`Realtime Currency Exchange Rate`	`object`	Yes	—

Realtime Currency Exchange Rate full type

{
From_Currency Code: string,
From_Currency Name: string,
To_Currency Code: string,
To_Currency Name: string,
Exchange Rate: string,
Last Refreshed: string,
Time Zone: string,
Bid Price?: string,
Ask Price?: string
}

intraday

forex.intraday Get intraday bars for a currency pair [PREMIUM PLAN] Risk: read

await corsair.alphavantage.api.forex.intraday({});

Input

Name	Type	Required	Description
`from_symbol`	`string`	Yes	—
`to_symbol`	`string`	Yes	—
`interval`	`1min \| 5min \| 15min \| 30min \| 60min`	Yes	—
`outputsize`	`compact \| full`	No	compact returns the latest 100 points, full the full history.

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

monthly

forex.monthly Get monthly bars for a currency pair Risk: read

await corsair.alphavantage.api.forex.monthly({});

Input

Name	Type	Required	Description
`from_symbol`	`string`	Yes	—
`to_symbol`	`string`	Yes	—

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

weekly

forex.weekly Get weekly bars for a currency pair Risk: read

await corsair.alphavantage.api.forex.weekly({});

Input

Name	Type	Required	Description
`from_symbol`	`string`	Yes	—
`to_symbol`	`string`	Yes	—

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

Fundamentals

balanceSheet

fundamentals.balanceSheet Get annual and quarterly balance sheets Risk: read

await corsair.alphavantage.api.fundamentals.balanceSheet({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—

Output

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`annualReports`	`object[]`	Yes	—
`quarterlyReports`	`object[]`	Yes	—

annualReports full type

{
  fiscalDateEnding: string,
  reportedCurrency: string
}[]

quarterlyReports full type

{
  fiscalDateEnding: string,
  reportedCurrency: string
}[]

cashFlow

fundamentals.cashFlow Get annual and quarterly cash flow statements Risk: read

await corsair.alphavantage.api.fundamentals.cashFlow({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—

Output

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`annualReports`	`object[]`	Yes	—
`quarterlyReports`	`object[]`	Yes	—

annualReports full type

{
  fiscalDateEnding: string,
  reportedCurrency: string
}[]

quarterlyReports full type

{
  fiscalDateEnding: string,
  reportedCurrency: string
}[]

companyOverview

fundamentals.companyOverview Get a company profile with sector and valuation figures Risk: read

await corsair.alphavantage.api.fundamentals.companyOverview({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—

Output

Name	Type	Required	Description
`Symbol`	`string`	Yes	—
`AssetType`	`string`	No	—
`Name`	`string`	No	—
`Description`	`string`	No	—
`CIK`	`string`	No	—
`Exchange`	`string`	No	—
`Currency`	`string`	No	—
`Country`	`string`	No	—
`Sector`	`string`	No	—
`Industry`	`string`	No	—
`Address`	`string`	No	—
`OfficialSite`	`string`	No	—
`FiscalYearEnd`	`string`	No	—
`LatestQuarter`	`string`	No	—
`MarketCapitalization`	`string`	No	—
`EBITDA`	`string`	No	—
`PERatio`	`string`	No	—
`PEGRatio`	`string`	No	—
`BookValue`	`string`	No	—
`DividendPerShare`	`string`	No	—
`DividendYield`	`string`	No	—
`EPS`	`string`	No	—
`RevenuePerShareTTM`	`string`	No	—
`ProfitMargin`	`string`	No	—
`OperatingMarginTTM`	`string`	No	—
`ReturnOnAssetsTTM`	`string`	No	—
`ReturnOnEquityTTM`	`string`	No	—
`RevenueTTM`	`string`	No	—
`GrossProfitTTM`	`string`	No	—
`DilutedEPSTTM`	`string`	No	—
`QuarterlyEarningsGrowthYOY`	`string`	No	—
`QuarterlyRevenueGrowthYOY`	`string`	No	—
`AnalystTargetPrice`	`string`	No	—
`AnalystRatingStrongBuy`	`string`	No	—
`AnalystRatingBuy`	`string`	No	—
`AnalystRatingHold`	`string`	No	—
`AnalystRatingSell`	`string`	No	—
`AnalystRatingStrongSell`	`string`	No	—
`TrailingPE`	`string`	No	—
`ForwardPE`	`string`	No	—
`PriceToSalesRatioTTM`	`string`	No	—
`PriceToBookRatio`	`string`	No	—
`EVToRevenue`	`string`	No	—
`EVToEBITDA`	`string`	No	—
`Beta`	`string`	No	—
`52WeekHigh`	`string`	No	—
`52WeekLow`	`string`	No	—
`50DayMovingAverage`	`string`	No	—
`200DayMovingAverage`	`string`	No	—
`SharesOutstanding`	`string`	No	—
`SharesFloat`	`string`	No	—
`PercentInsiders`	`string`	No	—
`PercentInstitutions`	`string`	No	—
`DividendDate`	`string`	No	—
`ExDividendDate`	`string`	No	—

dividends

fundamentals.dividends Get historical and declared dividends Risk: read

await corsair.alphavantage.api.fundamentals.dividends({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—

Output

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  ex_dividend_date: string,
  declaration_date?: string,
  record_date?: string,
  payment_date?: string,
  amount: string
}[]

earnings

fundamentals.earnings Get reported and estimated earnings per share Risk: read

await corsair.alphavantage.api.fundamentals.earnings({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—

Output

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`annualEarnings`	`object[]`	Yes	—
`quarterlyEarnings`	`object[]`	Yes	—

annualEarnings full type

{
  fiscalDateEnding: string,
  reportedEPS: string
}[]

quarterlyEarnings full type

{
  fiscalDateEnding: string,
  reportedDate: string,
  reportedEPS: string
}[]

earningsCalendar

fundamentals.earningsCalendar List upcoming earnings dates (CSV upstream) Risk: read

await corsair.alphavantage.api.fundamentals.earningsCalendar({});

Input

Name	Type	Required	Description
`symbol`	`string`	No	—
`horizon`	`3month \| 6month \| 12month`	No	—

Output: object[]

Output full type

{
}[]

earningsCallTranscript

fundamentals.earningsCallTranscript Get an earnings call transcript with per-speaker sentiment Risk: read

await corsair.alphavantage.api.fundamentals.earningsCallTranscript({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`quarter`	`string`	Yes	—

Output

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`quarter`	`string`	Yes	—
`transcript`	`object[]`	Yes	—

transcript full type

{
  speaker: string,
  title?: string,
  content: string,
  sentiment?: string
}[]

incomeStatement

fundamentals.incomeStatement Get annual and quarterly income statements Risk: read

await corsair.alphavantage.api.fundamentals.incomeStatement({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—

Output

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`annualReports`	`object[]`	Yes	—
`quarterlyReports`	`object[]`	Yes	—

annualReports full type

{
  fiscalDateEnding: string,
  reportedCurrency: string
}[]

quarterlyReports full type

{
  fiscalDateEnding: string,
  reportedCurrency: string
}[]

ipoCalendar

fundamentals.ipoCalendar List IPOs expected in the next three months (CSV upstream) Risk: read

await corsair.alphavantage.api.fundamentals.ipoCalendar({});

Input: empty object Output: object[]

Output full type

{
}[]

splits

fundamentals.splits Get historical stock splits Risk: read

await corsair.alphavantage.api.fundamentals.splits({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—

Output

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  effective_date: string,
  split_factor: string
}[]

Intelligence

historicalOptions

intelligence.historicalOptions Get a full options chain for one date [PREMIUM PLAN] Risk: read

await corsair.alphavantage.api.intelligence.historicalOptions({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`date`	`string`	No	—

Output

Name	Type	Required	Description
`endpoint`	`string`	No	—
`message`	`string`	No	—
`data`	`object[]`	No	—

data full type

{
  contractID: string,
  symbol: string,
  expiration: string,
  strike: string,
  type: string
}[]

newsSentiment

intelligence.newsSentiment Get market news with article and ticker sentiment scores Risk: read

await corsair.alphavantage.api.intelligence.newsSentiment({});

Input

Name	Type	Required	Description
`tickers`	`string[]`	No	—
`topics`	`string[]`	No	—
`time_from`	`string`	No	—
`time_to`	`string`	No	—
`sort`	`LATEST \| EARLIEST \| RELEVANCE`	No	—
`limit`	`number`	No	—

Output

Name	Type	Required	Description
`items`	`string`	Yes	—
`sentiment_score_definition`	`string`	Yes	—
`relevance_score_definition`	`string`	Yes	—
`feed`	`object[]`	Yes	—

feed full type

{
  title: string,
  url: string,
  time_published: string,
  summary: string,
  source: string,
  overall_sentiment_score: number,
  overall_sentiment_label: string,
  ticker_sentiment?: {
    ticker: string,
    relevance_score: string,
    ticker_sentiment_score: string,
    ticker_sentiment_label: string
  }[]
}[]

slidingWindowAnalytics

intelligence.slidingWindowAnalytics Get rolling-window statistics across a set of tickers Risk: read

await corsair.alphavantage.api.intelligence.slidingWindowAnalytics({});

Input

Name	Type	Required	Description
`symbols`	`string[]`	Yes	—
`range`	`string`	Yes	Lookback window, e.g. 2month, 6month, full.
`interval`	`DAILY \| WEEKLY \| MONTHLY`	Yes	—
`window_size`	`number`	Yes	—
`calculations`	`string[]`	Yes	e.g. MEAN, STDDEV, CORRELATION.
`ohlc`	`open \| high \| low \| close`	No	—

Output

Name	Type	Required	Description
`meta_data`	`object`	Yes	—
`payload`	`object`	Yes	—

meta_data full type

{
  symbols: string,
  window_size: number,
  min_dt: string,
  max_dt: string,
  ohlc: string,
  interval: string
}

payload full type

{
}

Market

listingStatus

market.listingStatus List every covered security, active or delisted (CSV upstream) Risk: read

await corsair.alphavantage.api.market.listingStatus({});

Input

Name	Type	Required	Description
`date`	`string`	No	—
`state`	`active \| delisted`	No	—

Output: object[]

Output full type

{
}[]

sector

market.sector Get sector performance [DEPRECATED UPSTREAM: returns an empty body] Risk: read

await corsair.alphavantage.api.market.sector({});

Input: empty object Output: object

Output full type

{
}

status

market.status Get the open or closed state of global exchanges Risk: read

await corsair.alphavantage.api.market.status({});

Input: empty object Output

Name	Type	Required	Description
`endpoint`	`string`	Yes	—
`markets`	`object[]`	Yes	—

markets full type

{
  market_type: string,
  region: string,
  primary_exchanges: string,
  local_open: string,
  local_close: string,
  current_status: string,
  notes?: string
}[]

symbolSearch

market.symbolSearch Search securities by name or ticker fragment Risk: read

await corsair.alphavantage.api.market.symbolSearch({});

Input

Name	Type	Required	Description
`keywords`	`string`	Yes	—

Output

Name	Type	Required	Description
`bestMatches`	`object[]`	Yes	—

bestMatches full type

{
symbol: string,
name: string,
type: string,
region: string,
marketOpen: string,
marketClose: string,
timezone: string,
currency: string,
matchScore: string
}[]

topGainersLosers

market.topGainersLosers Get the top gainers, losers and most actively traded US tickers Risk: read

await corsair.alphavantage.api.market.topGainersLosers({});

Input: empty object Output

Name	Type	Required	Description
`metadata`	`string`	Yes	—
`last_updated`	`string`	Yes	—
`top_gainers`	`object[]`	Yes	—
`top_losers`	`object[]`	Yes	—
`most_actively_traded`	`object[]`	Yes	—

top_gainers full type

{
  ticker: string,
  price: string,
  change_amount: string,
  change_percentage: string,
  volume: string
}[]

top_losers full type

{
  ticker: string,
  price: string,
  change_amount: string,
  change_percentage: string,
  volume: string
}[]

most_actively_traded full type

{
  ticker: string,
  price: string,
  change_amount: string,
  change_percentage: string,
  volume: string
}[]

Technical

indicator

technical.indicator Calculate any technical indicator (SMA, EMA, RSI, MACD, …) Risk: read

await corsair.alphavantage.api.technical.indicator({});

Input

Name	Type	Required	Description
`indicator`	`string`	Yes	—
`symbol`	`string`	Yes	—
`interval`	`1min \| 5min \| 15min \| 30min \| 60min \| daily \| weekly \| monthly`	Yes	—
`time_period`	`number`	No	—
`series_type`	`close \| open \| high \| low`	No	—
`month`	`string`	No	—
`extra_params`	`object`	No	—

extra_params full type

{
}

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

Time Series

daily

timeSeries.daily Get daily OHLCV bars Risk: read

await corsair.alphavantage.api.timeSeries.daily({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`outputsize`	`compact \| full`	No	compact returns the latest 100 points, full the full history.

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

globalQuote

timeSeries.globalQuote Get the latest price and volume for one ticker Risk: read

await corsair.alphavantage.api.timeSeries.globalQuote({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—

Output

Name	Type	Required	Description
`Global Quote`	`object`	Yes	—

Global Quote full type

{
symbol: string,
open: string,
high: string,
low: string,
price: string,
volume: string,
latest trading day: string,
previous close: string,
change: string,
change percent: string
} | {
}

intraday

timeSeries.intraday Get intraday OHLCV bars at 1-60 minute resolution [PREMIUM PLAN] Risk: read

await corsair.alphavantage.api.timeSeries.intraday({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`interval`	`1min \| 5min \| 15min \| 30min \| 60min`	Yes	—
`adjusted`	`boolean`	No	—
`extended_hours`	`boolean`	No	—
`month`	`string`	No	—
`outputsize`	`compact \| full`	No	compact returns the latest 100 points, full the full history.

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

intradayExtended

timeSeries.intradayExtended Get historical intraday bars beyond the default window [PREMIUM PLAN] Risk: read

await corsair.alphavantage.api.timeSeries.intradayExtended({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—
`interval`	`1min \| 5min \| 15min \| 30min \| 60min`	Yes	—
`slice`	`string`	No	—
`month`	`string`	No	—
`adjusted`	`boolean`	No	—

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

monthly

timeSeries.monthly Get monthly OHLCV bars Risk: read

await corsair.alphavantage.api.timeSeries.monthly({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

monthlyAdjusted

timeSeries.monthlyAdjusted Get monthly bars adjusted for splits and dividends Risk: read

await corsair.alphavantage.api.timeSeries.monthlyAdjusted({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

realtimeBulkQuotes

timeSeries.realtimeBulkQuotes Get quotes for up to 100 tickers at once [PREMIUM PLAN] Risk: read

await corsair.alphavantage.api.timeSeries.realtimeBulkQuotes({});

Input

Name	Type	Required	Description
`symbols`	`string[]`	Yes	Up to 100 tickers, sent to the API as a comma-separated list.

Output

Name	Type	Required	Description
`endpoint`	`string`	No	—
`message`	`string`	No	—
`data`	`object[]`	No	—

data full type

{
  symbol: string
}[]

weekly

timeSeries.weekly Get weekly OHLCV bars Risk: read

await corsair.alphavantage.api.timeSeries.weekly({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

weeklyAdjusted

timeSeries.weeklyAdjusted Get weekly bars adjusted for splits and dividends Risk: read

await corsair.alphavantage.api.timeSeries.weeklyAdjusted({});

Input

Name	Type	Required	Description
`symbol`	`string`	Yes	—

Output

Name	Type	Required	Description
`Meta Data`	`object`	No	—

Meta Data full type

{
}

​Commodities

​all

​aluminum

​brent

​coffee

​copper

​corn

​cotton

​sugar

​wheat

​Crypto

​daily

​intraday

​monthly

​weekly

​Economic

​cpi

​durables

​federalFundsRate

​inflation

​nonfarmPayroll

​realGdp

​realGdpPerCapita

​retailSales

​treasuryYield

​unemployment

​Forex

​daily

​exchangeRate

​intraday

​monthly

​weekly

​Fundamentals

​balanceSheet

​cashFlow

​companyOverview

​dividends

​earnings

​earningsCalendar

​earningsCallTranscript

​incomeStatement

​ipoCalendar

​splits

​Intelligence

​historicalOptions

​newsSentiment

​slidingWindowAnalytics

​Market

​listingStatus

​sector

​status

​symbolSearch

​topGainersLosers

​Technical

​indicator

​Time Series

​daily

​globalQuote

​intraday

​intradayExtended

​monthly

​monthlyAdjusted

​realtimeBulkQuotes

​weekly

​weeklyAdjusted

Commodities

all

aluminum

brent

coffee

copper

corn

cotton

sugar

wheat

Crypto

daily

intraday

monthly

weekly

Economic

cpi

durables

federalFundsRate

inflation

nonfarmPayroll

realGdp

realGdpPerCapita

retailSales

treasuryYield

unemployment

Forex

daily

exchangeRate

intraday

monthly

weekly

Fundamentals

balanceSheet

cashFlow

companyOverview

dividends

earnings

earningsCalendar

earningsCallTranscript

incomeStatement

ipoCalendar

splits

Intelligence

historicalOptions

newsSentiment

slidingWindowAnalytics

Market

listingStatus

sector

status

symbolSearch

topGainersLosers

Technical

indicator

Time Series

daily

globalQuote

intraday

intradayExtended

monthly

monthlyAdjusted

realtimeBulkQuotes

weekly

weeklyAdjusted