AlphaVantage (alpha_vantage_client v0.1.0)

Link to this section Summary

Functions

Fetches the Chaikin A/D line values.

Fetches the Chaikin A/D oscillator values.

Fetches the average directional movement index values.

Fetches the average directional movement index rating values.

Fetches the prices for aluminum.

Fetches the absolute price oscillator values.

Fetches the Aroon indicator values.

Fetches the Aroon oscillator values.

Fetches the average true range values.

Fetches the balance sheets for a given symbol.

Fetches the balance of power values.

Fetches the prices for Brent crude oil.

Fetches the cash flow statements for a given symbol.

Fetches the commodity channel index values.

Fetches the Chande momentum oscillator values.

Fetches the prices for coffee

Fetches the prices for commodities index

Fetches the company overview for a given symbol.

Fetches the prices for copper.

Fetches the prices for corn

Fetches the prices for cotton

Fetches the consumer price index of the United States.

Fetches the daily crypto exchange rate for a given currency pair.

Fetches the crypto exchange rate for a given currency pair.

Fetches the intraday crypto exchange rate for a given currency pair.

Fetches the monthly crypto exchange rate for a given currency pair.

Fetches the weekly crypto exchange rate for a given currency pair.

Fetches double exponential moving average values for a given symbol.

Fetches the durable goods orders of the United States.

Fetches the direction movement index values.

Fetches the earnings for a given symbol.

Fetches exponential moving average values for a given symbol.

Fetches the federal funds rate of the United States.

Fetches the daily exchange rate for a given currency pair.

Fetches the current exchange rate for a given currency pair.

Fetches the intraday exchange rate for a given currency pair.

Fetches the monthly exchange rate for a given currency pair.

Fetches the weekly exchange rate for a given currency pair.

Fetches the Hilbert transform, dominant cycle period values.

Fetches the Hilbert transform, dominant cycle phase values.

Fetches the Hilbert transform, phasor components values.

Fetches the Hilbert transform, sine wave values.

Fetches the Hilbert transform, instantaneous trendline values.

Fetches the Hilbert transform, trend vs cycle mode values.

Fetches the income statements for a given symbol.

Fetches the inflation rate of the United States.

Fetches Kaufman adaptive moving average values for a given symbol.

Fetches the moving average convergence / divergence values.

Fetches the moving average convergence / divergence values with controllable moving average type.

Fetches the MESA adaptive moving average values for a given symbol.

Fetches the market status.

Fetches the money flow index values.

Fetches the midpoint price values.

Fetches the minus directional indicator values.

Fetches the minus directional movement values.

Fetches the normalized average true range values.

Fetches the prices for natural gas.

Fetches the news sentiment

Fetches the nonfarm payroll of the United States.

Fetches the on balance volume values.

Fetches the plus directional indicator values.

Fetches the plus directional movement values.

Fetches the percentage price oscillator values.

Fetches the quote for a given symbol.

Fetches the real GDP of the United States.

Fetches the real GDP per capita of the United States.

Fetches the retail sales of the United States.

Fetches the rate of change values.

Fetches the rate of change ratio values.

Fetches the relative strength index values.

Fetches the parabolic sar values.

Fetches the search results for a given keyword.

Fetches simple moving average values for a given symbol.

Callback implementation for Application.start/2.

Fetches the stochastic oscillator values.

Fetches the stochastic oscillator fast values.

Fetches the stochastic relative strength index values.

Fetches the prices for sugar

Fetches the triple exponential moving average values for a given symbol.

Fetches triple exponential moving average values for a given symbol.

Fetches the daily time series for a given symbol.

Fetches the daily adjusted time series for a given symbol.

Fetches the daily time series for a given symbol.

Fetches the monthly time series for a given symbol.

Fetches the monthly adjusted time series for a given symbol.

Fetches the weekly time series for a given symbol.

Fetches the weekly adjusted time series for a given symbol.

Fetches the top gainers, losers, and most actively traded US tickers.

Fetches the true range values.

Fetches the treasury yield of the United States.

Fetches triangular moving average values for a given symbol.

Fetches the 1-day rate of change of a triple smooth exponential moving average values.

Fetches the ultimate oscillator values.

Fetches the unemployment rate of the United States.

Fetches the volume weighted average price.

Fetches the prices for wheat

Fetches the Williams' %R values.

Fetches weighted moving average values for a given symbol.

Fetches the prices for WTI crude oil.

Link to this section Functions

Link to this function

ad(symbol, interval)

Fetches the Chaikin A/D line values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Chaikin A/D Line",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: Chaikin A/D" => %{
    "2023-06-02 14:36" => %{
      "Chaikin A/D" => "3704000.2959"
    },
  }
}
Link to this function

adosc(symbol, interval, opts \\ %{})

Fetches the Chaikin A/D oscillator values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.

optional

Optional

  • fastperiod - The time period of the fast Aroon oscillator.
  • slowperiod - The time period of the slow Aroon oscillator.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Chaikin A/D Oscillator (ADOSC)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5.1: FastK Period" => 3,
    "5.2: SlowK Period" => 10,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: ADOSC" => %{
    "2023-06-02 14:36" => %{
      "ADOSC" => "102618.4584"
    },
  }
}
Link to this function

adx(symbol, interval, time_period)

Fetches the average directional movement index values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each ADX value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Average Directional Movement Index (ADX)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: ADX" => %{
    "2023-06-02 14:36" => %{
      "ADX" => "8.5204"
    },
  }
}
Link to this function

adxr(symbol, interval, time_period)

Fetches the average directional movement index rating values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each ADXR value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Average Directional Movement Index Rating (ADXR)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: ADXR" => %{
    "2023-06-02 14:36" => %{
      "ADXR" => "8.4428"
    },
  }
}
Link to this function

aluminum(interval \\ "monthly")

Fetches the prices for aluminum.

required

Required

  • interval - The interval between two consecutive data points in the time series.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "2274.01260869565"
    },
  ],
  "interval" => "monthly",
  "name" => "Global Price of Aluminum",
  "unit" => "dollar per metric ton"
}
Link to this function

apo(symbol, interval, series_type, opts \\ %{})

Fetches the absolute price oscillator values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • series_type - The desired price type in the time series.

optional

Optional

  • fastperiod - The time period of the fast EMA.
  • slowperiod - The time period of the slow EMA.
  • matype - The type of moving average to be used.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Absolute Price Oscillator (APO)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5.1: Fast Period" => 12,
    "5.2: Slow Period" => 26,
    "5.3: MA Type" => 0,
    "6: Series Type" => "close",
    "7: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: APO" => %{
    "2023-06-02 14:36" => %{
      "APO" => "0.0889"
    },
  }
}
Link to this function

aroon(symbol, interval, time_period)

Fetches the Aroon indicator values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Aroon (AROON)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: AROON" => %{
    "2023-06-02 14:36" => %{
      "Aroon Down" => "53.3333",
      "Aroon Up" => "13.3333"
    },
  }
}
Link to this function

aroonosc(symbol, interval, time_period)

Fetches the Aroon oscillator values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Aroon Oscillator (AROONOSC)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: AROONOSC" => %{
    "2023-06-02 14:36" => %{
      "AROONOSC" => "-40.0000"
    },
  }
}
Link to this function

atr(symbol, interval, time_period)

Fetches the average true range values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Average True Range (ATR)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: ATR" => %{
    "2023-06-02 14:36" => %{
      "ATR" => "0.0948"
    },
  }
}
Link to this function

balance_sheets(symbol)

Fetches the balance sheets for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the balance sheets for.

response

Response

%{
  "annualReports" => [
    %{
      "inventory" => "4946000000",
      "otherCurrentLiabilities" => "60845000000",
      "propertyPlantEquipment" => "42117000000",
      "goodwill" => "None",
      "totalNonCurrentAssets" => "217350000000",
      "totalLiabilities" => "302083000000",
      "longTermDebt" => "110100000000",
      "fiscalDateEnding" => "2022-09-30",
      "currentLongTermDebt" => "11128000000",
      "shortTermDebt" => "9982000000",
      "totalShareholderEquity" => "50672000000",
      "intangibleAssetsExcludingGoodwill" => "None",
      "reportedCurrency" => "USD",
      "totalAssets" => "352755000000",
      "otherCurrentAssets" => "21223000000",
      "otherNonCurrentLiabilities" => "49142000000",
      "totalCurrentLiabilities" => "153982000000",
      "investments" => "292870000000",
      "currentNetReceivables" => "60932000000",
      "capitalLeaseObligations" => "812000000",
      "currentAccountsPayable" => "64115000000",
      "commonStock" => "64849000000",
      "retainedEarnings" => "-3068000000",
      "longTermInvestments" => "120805000000",
      "commonStockSharesOutstanding" => "15943425000",
      "currentDebt" => "21239000000",
      "shortLongTermDebtTotal" => "233256000000",
      "deferredRevenue" => "20312000000",
      "treasuryStock" => "None",
      "intangibleAssets" => "None",
      "longTermDebtNoncurrent" => "98959000000",
      "shortTermInvestments" => "24658000000",
      "accumulatedDepreciationAmortizationPPE" => "72340000000",
      "cashAndCashEquivalentsAtCarryingValue" => "23646000000",
      "cashAndShortTermInvestments" => "48304000000",
      "otherNonCurrentAssets" => "54428000000",
      "totalNonCurrentLiabilities" => "148101000000",
      "totalCurrentAssets" => "135405000000"
    },
  ],
  "symbol" => "AAPL"
}
Link to this function

bbands(symbol, interval, time_period, series_type, opts \\ %{})

Fetches the bollinger bands values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.

optional

Optional

  • ndbevup - The number of standard deviations above the upper band.
  • nbdevdn - The number of standard deviations below the lower band.
  • matype - The type of moving average to use.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Bollinger Bands (BBANDS)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6.1: Deviation multiplier for upper band" => 2,
    "6.2: Deviation multiplier for lower band" => 2,
    "6.3: MA Type" => 0,
    "7: Series Type" => "close",
    "8: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: BBANDS" => %{
    "2023-06-02 14:36" => %{
      "Real Lower Band" => "180.1986",
      "Real Middle Band" => "180.4696",
      "Real Upper Band" => "180.7405"
    },
  }
}
Link to this function

bop(symbol, interval)

Fetches the balance of power values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Balance Of Power (BOP)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: BOP" => %{
    "2023-06-02 14:36" => %{
      "BOP" => "-0.2817"
    },
  }
}
Link to this function

brent(interval \\ "monthly")

Fetches the prices for Brent crude oil.

required

Required

  • interval - The interval between two consecutive data points in the time series.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "75.47"
    },
  ],
  "interval" => "monthly",
  "name" => "Crude Oil Prices Brent",
  "unit" => "dollars per barrel"
}
Link to this function

cash_flow_statements(symbol)

Fetches the cash flow statements for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the cash flow statements for.

response

Response

%{
  "annualReports" => [
    %{
      "capitalExpenditures" => "10708000000",
      "cashflowFromFinancing" => "-110749000000",
      "cashflowFromInvestment" => "-22354000000",
      "changeInCashAndCashEquivalents" => "-10952000000",
      "changeInExchangeRate" => "None",
      "changeInInventory" => "-1484000000",
      "changeInOperatingAssets" => "14358000000",
      "changeInOperatingLiabilities" => "15558000000",
      "changeInReceivables" => "9343000000",
      "depreciationDepletionAndAmortization" => "11104000000",
      "dividendPayout" => "14841000000",
      "dividendPayoutCommonStock" => "14841000000",
      "dividendPayoutPreferredStock" => "None",
      "fiscalDateEnding" => "2022-09-30",
      "netIncome" => "99803000000",
      "operatingCashflow" => "122151000000",
      "paymentsForOperatingActivities" => "4665000000",
      "paymentsForRepurchaseOfCommonStock" => "89402000000",
      "paymentsForRepurchaseOfEquity" => "89402000000",
      "paymentsForRepurchaseOfPreferredStock" => "None",
      "proceedsFromIssuanceOfCommonStock" => "None",
      "proceedsFromIssuanceOfLongTermDebtAndCapitalSecuritiesNet" => "5465000000",
      "proceedsFromIssuanceOfPreferredStock" => "None",
      "proceedsFromOperatingActivities" => "None",
      "proceedsFromRepaymentsOfShortTermDebt" => "7910000000",
      "proceedsFromRepurchaseOfEquity" => "-89402000000",
      "proceedsFromSaleOfTreasuryStock" => "None",
      "profitLoss" => "99803000000",
      "reportedCurrency" => "USD"
    },
  ],
  "symbol" => "AAPL"
}
Link to this function

cci(symbol, interval, time_period)

Fetches the commodity channel index values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Commodity Channel Index (CCI)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: CCI" => %{
    "2023-06-02 14:36" => %{
      "CCI" => "52.8769"
    },
  }
}
Link to this function

cmo(symbol, interval, time_period, series_type)

Fetches the Chande momentum oscillator values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Chande Momentum Oscillator (CMO)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Series Type" => "close",
    "7: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: CMO" => %{
    "2023-06-02 14:36" => %{
      "CMO" => "0.6637"
    },
  }
}
Link to this function

coffee(interval \\ "monthly")

Fetches the prices for coffee

required

Required

  • interval - The interval between two consecutive data points in the time series.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "220.121304347826"
    },
  ],
  "interval" => "monthly",
  "name" => "Global Price of Coffee",
  "unit" => "cents per pound"
}
Link to this function

commodities(interval \\ "monthly")

Fetches the prices for commodities index

required

Required

  • interval - The interval between two consecutive data points in the time series.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "158.293349926295"
    },
  ],
  "interval" => "monthly",
  "name" => "Global Price Index of All Commodities",
  "unit" => "index 2016=100"
}
Link to this function

company_overview(symbol)

Fetches the company overview for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the overview for.

response

Response

%{
  "PriceToBookRatio" => "44.63",
  "EBITDA" => "123788001000",
  "OperatingMarginTTM" => "0.292",
  "Exchange" => "NASDAQ",
  "52WeekLow" => "123.81",
  "200DayMovingAverage" => "154.08",
  "Address" => "ONE INFINITE LOOP, CUPERTINO, CA, US",
  "Symbol" => "AAPL",
  "ReturnOnAssetsTTM" => "0.206",
  "RevenueTTM" => "385095008000",
  "EVToEBITDA" => "17.53",
  "QuarterlyRevenueGrowthYOY" => "-0.025",
  "DividendYield" => "0.0051",
  "PEGRatio" => "2.75",
  "QuarterlyEarningsGrowthYOY" => "0",
  "AssetType" => "Common Stock",
  "52WeekHigh" => "188.39",
  "Sector" => "TECHNOLOGY",
  "Description" => "Apple Inc. is an American multinational technology company",
  "TrailingPE" => "31.87",
  "Currency" => "USD",
  "50DayMovingAverage" => "175.14",
  "FiscalYearEnd" => "September",
  "EVToRevenue" => "5.92",
  "Name" => "Apple Inc",
  "DividendDate" => "2023-05-18",
  "SharesOutstanding" => "15728700000",
  "GrossProfitTTM" => "170782000000",
  "Country" => "USA",
  "ReturnOnEquityTTM" => "1.456",
  "ForwardPE" => "25.4",
  "RevenuePerShareTTM" => "24.12",
  "AnalystTargetPrice" => "187.11",
  "Industry" => "ELECTRONIC COMPUTERS",
  "BookValue" => "3.953",
  "ProfitMargin" => "0.245",
  "EPS" => "5.9",
  "LatestQuarter" => "2023-03-31",
  "DilutedEPSTTM" => "5.9",
  "CIK" => "320193",
  "MarketCapitalization" => "2957939311000",
  "PERatio" => "31.87",
  "DividendPerShare" => "0.92",
  "ExDividendDate" => "2023-05-12",
  "PriceToSalesRatioTTM" => "5.51",
  "Beta" => "1.289"
}
Link to this function

copper(interval \\ "monthly")

Fetches the prices for copper.

required

Required

  • interval - The interval between two consecutive data points in the time series.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "8243.15608695652"
    },
  ],
  "interval" => "monthly",
  "name" => "Global Price of Copper",
  "unit" => "dollar per metric ton"
}
Link to this function

corn(interval \\ "monthly")

Fetches the prices for corn

required

Required

  • interval - The interval between two consecutive data points in the time series.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "268.172526360544"
    },
  ],
  "interval" => "monthly",
  "name" => "Global Price of Corn",
  "unit" => "dollar per metric ton"
}
Link to this function

cotton(interval \\ "monthly")

Fetches the prices for cotton

required

Required

  • interval - The interval between two consecutive data points in the time series.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "93.8847826086957"
    },
  ],
  "interval" => "monthly",
  "name" => "Global Price of Cotton",
  "unit" => "cents per pound"
}
Link to this function

cpi(interval \\ "monthly")

Fetches the consumer price index of the United States.

required

Required

  • interval - The interval between two consecutive data points in the time series.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "304.127"
    },
  ],
  "interval" => "monthly",
  "name" => "Consumer Price Index for all Urban Consumers",
  "unit" => "index 1982-1984=100"
}
Link to this function

crypto_daily(symbol, market, outputsize \\ "compact")

Fetches the daily crypto exchange rate for a given currency pair.

required

Required

  • symbol - The currency to convert from.
  • market - The currency to convert to.
  • outputsize - The size of the time series to return. Either compact or full.

response

Response

%{
  "Meta Data" => %{
    "1. Information" => "Daily Prices and Volumes for Digital Currency",
    "2. Digital Currency Code" => "BTC",
    "3. Digital Currency Name" => "Bitcoin",
    "4. Market Code" => "USD",
    "5. Market Name" => "United States Dollar",
    "6. Last Refreshed" => "2023-06-29 00:00:00",
    "7. Time Zone" => "UTC"
  },
  "Time Series (Digital Currency Daily)" => %{
    "2023-01-21" => %{
      "1a. open (USD)" => "22666.00000000",
      "1b. open (USD)" => "22666.00000000",
      "2a. high (USD)" => "23371.80000000",
      "2b. high (USD)" => "23371.80000000",
      "3a. low (USD)" => "22422.00000000",
      "3b. low (USD)" => "22422.00000000",
      "4a. close (USD)" => "22783.55000000",
      "4b. close (USD)" => "22783.55000000",
      "5. volume" => "346445.48432000",
      "6. market cap (USD)" => "346445.48432000"
    },
  }
}
Link to this function

crypto_exchange_rates(from_symbol, to_symbol)

Fetches the crypto exchange rate for a given currency pair.

required

Required

  • from_symbol - The currency to convert from.
  • to_symbol - The currency to convert to.

response

Response

%{
  "Realtime Currency Exchange Rate" => %{
    "1. From_Currency Code" => "BTC",
    "2. From_Currency Name" => "Bitcoin",
    "3. To_Currency Code" => "USD",
    "4. To_Currency Name" => "United States Dollar",
    "5. Exchange Rate" => "30234.14000000",
    "6. Last Refreshed" => "2023-06-29 06:50:01",
    "7. Time Zone" => "UTC",
    "8. Bid Price" => "30234.13000000",
    "9. Ask Price" => "30234.14000000"
  }
}
Link to this function

crypto_intraday(symbol, market, interval, outputsize \\ "compact")

Fetches the intraday crypto exchange rate for a given currency pair.

required

Required

  • symbol - The currency to convert from.
  • market - The currency to convert to.
  • interval - The interval between two consecutive data points in the time series.
  • outputsize - The size of the time series to return. Either compact or full.

response

Response

%{
  "Meta Data" => %{
    "1. Information" => "Crypto Intraday (5min) Time Series",
    "2. Digital Currency Code" => "ETH",
    "3. Digital Currency Name" => "Ethereum",
    "4. Market Code" => "USD",
    "5. Market Name" => "United States Dollar",
    "6. Last Refreshed" => "2023-06-29 06:55:00",
    "7. Interval" => "5min",
    "8. Output Size" => "Compact",
    "9. Time Zone" => "UTC"
  },
  "Time Series Crypto (5min)": %{
    "2023-06-29 06:55:00" => %{
      "1. open" => "1838.83000",
      "2. high" => "1838.83000",
      "3. low" => "1838.01000",
      "4. close" => "1838.19000",
      "5. volume" => 56
    },
  }
}
Link to this function

crypto_monthly(symbol, market, outputsize \\ "compact")

Fetches the monthly crypto exchange rate for a given currency pair.

required

Required

  • symbol - The currency to convert from.
  • market - The currency to convert to.
  • outputsize - The size of the time series to return. Either compact or full.

response

Response

%{
  "Meta Data" => %{
    "1. Information" => "Monthly Prices and Volumes for Digital Currency",
    "2. Digital Currency Code" => "BTC",
    "3. Digital Currency Name" => "Bitcoin",
    "4. Market Code" => "USD",
    "5. Market Name" => "United States Dollar",
    "6. Last Refreshed" => "2023-06-29 00:00:00",
    "7. Time Zone" => "UTC"
  },
  "Time Series (Digital Currency Monthly)" => %{
    "2020-11-30" => %{
      "1a. open (USD)" => "13791.00000000",
      "1b. open (USD)" => "13791.00000000",
      "2a. high (USD)" => "19863.16000000",
      "2b. high (USD)" => "19863.16000000",
      "3a. low (USD)" => "13195.05000000",
      "3b. low (USD)" => "13195.05000000",
      "4a. close (USD)" => "19695.87000000",
      "4b. close (USD)" => "19695.87000000",
      "5. volume" => "2707064.91116500",
      "6. market cap (USD)" => "2707064.91116500"
    },
  }
}
Link to this function

crypto_weekly(symbol, market, outputsize \\ "compact")

Fetches the weekly crypto exchange rate for a given currency pair.

required

Required

  • symbol - The currency to convert from.
  • market - The currency to convert to.
  • outputsize - The size of the time series to return. Either compact or full.

response

Response

%{
  "Meta Data" => %{
    "1. Information" => "Weekly Prices and Volumes for Digital Currency",
    "2. Digital Currency Code" => "BTC",
    "3. Digital Currency Name" => "Bitcoin",
    "4. Market Code" => "USD",
    "5. Market Name" => "United States Dollar",
    "6. Last Refreshed" => "2023-06-29 00:00:00",
    "7. Time Zone" => "UTC"
  },
  "Time Series (Digital Currency Weekly)" => %{
    "2022-05-01" => %{
      "1a. open (USD)" => "39450.12000000",
      "1b. open (USD)" => "39450.12000000",
      "2a. high (USD)" => "40797.31000000",
      "2b. high (USD)" => "40797.31000000",
      "3a. low (USD)" => "37386.38000000",
      "3b. low (USD)" => "37386.38000000",
      "4a. close (USD)" => "38468.35000000",
      "4b. close (USD)" => "38468.35000000",
      "5. volume" => "368444.26814000",
      "6. market cap (USD)" => "368444.26814000"
    },
  }
}
Link to this function

dema(symbol, interval, time_period, series_type)

Fetches double exponential moving average values for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each moving average value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Double Exponential Moving Average (DEMA)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 20,
    "6: Series Type" => "high",
    "7: Time Zone" => "US/Eastern"
  },
  "Technical Analysis: DEMA" => %{
    "2023-06-02 14:36" => %{
      "DEMA" => "180.5467"
    },
  }
}
Link to this function

durable_goods_orders()

Fetches the durable goods orders of the United States.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "288027"
    },
  ],
  "interval" => "monthly",
  "name" => "Manufacturer New Orders: Durable Goods",
  "unit" => "millions of dollars"
}
Link to this function

dx(symbol, interval, time_period)

Fetches the direction movement index values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Directional Movement Index (DX)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: DX" => %{
    "2023-06-02 14:36" => %{
      "DX" => "2.0516"
    },
  }
}
Link to this function

earnings(symbol)

Fetches the earnings for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the earnings for.

response

Response

%{
  "annualEarnings" => [
    %{
      "fiscalDateEnding" => "2023-03-31",
      "reportedEPS" => "3.4"
    },
  ],
  "quarterlyEarnings" => [
    %{
      "estimatedEPS" => "1.43",
      "fiscalDateEnding" => "2023-03-31",
      "reportedDate" => "2023-05-04",
      "reportedEPS" => "1.52",
      "surprise" => "0.09",
      "surprisePercentage" => "6.2937"
    },
  ],
  "symbol" => "AAPL"
}
Link to this function

ema(symbol, interval, time_period, series_type)

Fetches exponential moving average values for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each moving average value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Exponential Moving Average (EMA)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 20,
    "6: Series Type" => "high",
    "7: Time Zone" => "US/Eastern"
  },
  "Technical Analysis: EMA" => %{
    "2023-06-02 14:36" => %{
      "EMA" => "180.5264"
    },
  }
}
Link to this function

federal_funds_rate(interval \\ "monthly")

Fetches the federal funds rate of the United States.

required

Required

  • interval - The interval between two consecutive data points in the time series.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "5.06"
    },
  ],
  "interval" => "monthly",
  "name" => "Effective Federal Funds Rate",
  "unit" => "percent"
}
Link to this function

fx_daily(from_symbol, to_symbol, outputsize \\ "compact")

Fetches the daily exchange rate for a given currency pair.

required

Required

  • from_symbol - The currency to convert from.
  • to_symbol - The currency to convert to.
  • outputsize - The size of the time series to return. Either compact or full.

response

Response

%{
  "Meta Data" => %{
    "1. Information" => "Forex Daily Prices (open, high, low, close)",
    "2. From Symbol" => "EUR",
    "3. To Symbol" => "USD",
    "4. Output Size" => "Compact",
    "5. Last Refreshed" => "2023-06-29 06:50:00",
    "6. Time Zone" => "UTC"
  },
  "Time Series FX (Daily)" => %{
    "2018-07-02" => %{
      "1. open" => "1.16736",
      "2. high" => "1.16824",
      "3. low" => "1.15900",
      "4. close" => "1.16390"
    },
  }
}
Link to this function

fx_exchange_rates(from_currency, to_currency)

Fetches the current exchange rate for a given currency pair.

required

Required

  • from_currency - The currency to convert from.
  • to_currency - The currency to convert to.

response

Response

%{
  "Realtime Currency Exchange Rate" => %{
    "1. From_Currency Code" => "USD",
    "2. From_Currency Name" => "United States Dollar",
    "3. To_Currency Code" => "EUR",
    "4. To_Currency Name" => "Euro",
    "5. Exchange Rate" => "0.91760000",
    "6. Last Refreshed" => "2023-06-29 06:04:42",
    "7. Time Zone" => "UTC",
    "8. Bid Price" => "0.91757000",
    "9. Ask Price" => "0.91761000"
  }
}
Link to this function

fx_intraday(from_symbol, to_symbol, interval, outputsize \\ "compact")

Fetches the intraday exchange rate for a given currency pair.

required

Required

  • from_symbol - The currency to convert from.
  • to_symbol - The currency to convert to.
  • interval - The interval between two consecutive data points in the time series.
  • outputsize - The size of the time series to return. Either compact or full.

response

Response

%{
  "Meta Data" => %{
    "1. Information" => "FX Intraday (5min) Time Series",
    "2. From Symbol" => "EUR",
    "3. To Symbol" => "USD",
    "4. Last Refreshed" => "2023-06-29 06:40:00",
    "5. Interval" => "5min",
    "6. Output Size" => "Compact",
    "7. Time Zone" => "UTC"
  },
  "Time Series FX (5min)" => %{
    "2023-06-29 06:40:00" => %{
      "1. open" => "1.08923",
      "2. high" => "1.08967",
      "3. low" => "1.08910",
      "4. close" => "1.08962"
    },
  }
}
Link to this function

fx_monthly(from_symbol, to_symbol, outputsize \\ "compact")

Fetches the monthly exchange rate for a given currency pair.

required

Required

  • from_symbol - The currency to convert from.
  • to_symbol - The currency to convert to.
  • outputsize - The size of the time series to return. Either compact or full.

response

Response

%{
  "Meta Data" => %{
    "1. Information" => "Forex Monthly Prices (open, high, low, close)",
    "2. From Symbol" => "EUR",
    "3. To Symbol" => "USD",
    "4. Last Refreshed" => "2023-06-29 06:50:00",
    "5. Time Zone" => "UTC"
  },
  "Time Series FX (Monthly)" => %{
    "2010-07-30" => %{
      "1. open" => "1.22330",
      "2. high" => "1.31070",
      "3. low" => "1.21910",
      "4. close" => "1.30500"
    },
  }
}
Link to this function

fx_weekly(from_symbol, to_symbol, outputsize \\ "compact")

Fetches the weekly exchange rate for a given currency pair.

required

Required

  • from_symbol - The currency to convert from.
  • to_symbol - The currency to convert to.
  • outputsize - The size of the time series to return. Either compact or full.

response

Response

%{
  "Meta Data" => %{
    "1. Information" => "Forex Weekly Prices (open, high, low, close)",
    "2. From Symbol" => "EUR",
    "3. To Symbol" => "USD",
    "4. Last Refreshed" => "2023-06-29 06:50:00",
    "5. Time Zone" => "UTC"
  },
  "Time Series FX (Weekly)" => %{
    "2010-07-30" => %{
      "1. open" => "1.28960",
      "2. high" => "1.31070",
      "3. low" => "1.28740",
      "4. close" => "1.30500"
    },
  }
}
Link to this function

ht_dcperiod(symbol, interval, series_type)

Fetches the Hilbert transform, dominant cycle period values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Hilbert Transform - Dominant Cycle Period (HT_DCPERIOD)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Series Type" => "60",
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: HT_DCPERIOD" => %{
    "2023-06-02 14:36" => %{
      "DCPERIOD" => "15.7589"
    },
  }
}
Link to this function

ht_dcphase(symbol, interval, series_type)

Fetches the Hilbert transform, dominant cycle phase values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Hilbert Transform - Dominant Cycle Phase (HT_DCPHASE)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Series Type" => "60",
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: HT_DCPHASE" => %{
    "2023-06-02 14:36" => %{
      "HT_DCPHASE" => "209.2570"
    },
  }
}
Link to this function

ht_phasor(symbol, interval, series_type)

Fetches the Hilbert transform, phasor components values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Hilbert Transform - Phasor Components (HT_PHASOR)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Series Type" => "60",
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: HT_PHASOR" => %{
    "2023-06-02 14:36" => %{
      "PHASE" => "0.0051",
      "QUADRATURE" => "0.1202"
    },
  }
}
Link to this function

ht_sine(symbol, interval, series_type)

Fetches the Hilbert transform, sine wave values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Hilbert Transform - SineWave (HT_SINE)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Series Type" => "60",
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: HT_SINE" => %{
    "2023-06-02 14:36" => %{
      "LEAD SINE" => "-0.9625",
      "SINE" => "-0.4887"
    },
  }
}
Link to this function

ht_trendline(symbol, interval, series_type)

Fetches the Hilbert transform, instantaneous trendline values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Hilbert Transform - Instantaneous Trendline (HT_TRENDLINE)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Series Type" => "60",
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: HT_TRENDLINE" => %{
    "2023-06-02 14:36" => %{
      "HT_TRENDLINE" => "180.4392"
    },
  }
}
Link to this function

ht_trendmode(symbol, interval, series_type)

Fetches the Hilbert transform, trend vs cycle mode values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Hilbert Transform - Trend vs Cycle Mode (HT_TRENDMODE)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Series Type" => "60",
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: HT_TRENDMODE" => %{
    "2023-06-02 14:36" => %{
      "TRENDMODE" => "1"
    },
  }
}
Link to this function

income_statements(symbol)

Fetches the income statements for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the income statements for.

response

Response

%{
  "annualReports" => [
    %{
      "comprehensiveIncomeNetOfTax" => "88531000000",
      "costOfRevenue" => "248640000000",
      "costofGoodsAndServicesSold" => "223546000000",
      "depreciation" => "8700000000",
      "depreciationAndAmortization" => "11104000000",
      "ebit" => "122034000000",
      "ebitda" => "130541000000",
      "fiscalDateEnding" => "2022-09-30",
      "grossProfit" => "170782000000",
      "incomeBeforeTax" => "119103000000",
      "incomeTaxExpense" => "19300000000",
      "interestAndDebtExpense" => "2931000000",
      "interestExpense" => "2931000000",
      "interestIncome" => "106000000",
      "investmentIncomeNet" => "2825000000",
      "netIncome" => "99803000000",
      "netIncomeFromContinuingOperations" => "99803000000",
      "netInterestIncome" => "-2931000000",
      "nonInterestIncome" => "394328000000",
      "operatingExpenses" => "51345000000",
      "operatingIncome" => "119437000000",
      "otherNonOperatingIncome" => "-228000000",
      "reportedCurrency" => "USD",
      "researchAndDevelopment" => "26251000000",
      "sellingGeneralAndAdministrative" => "25094000000",
      "totalRevenue" => "391397000000"
    },
  ],
  "symbol" => "AAPL"
}

Fetches the inflation rate of the United States.

response

Response

%{
  "data" => [
    %{
      "date" => "2022-01-01",
      "value" => "8.00279982052117"
    },
  ],
  "interval" => "annual",
  "name" => "Inflation - US Consumer Prices",
  "unit" => "percent"
}
Link to this function

kama(symbol, interval, time_period, series_type)

Fetches Kaufman adaptive moving average values for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each moving average value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Kaufman Adaptive Moving Average (KAMA)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 20,
    "6: Series Type" => "high",
    "7: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: KAMA" => %{
    "2023-06-02 14:36" => %{
      "KAMA" => "180.5189"
    },
  }
}
Link to this function

macd(symbol, interval, series_type, opts \\ %{})

Fetches the moving average convergence / divergence values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • series_type - The desired price type in the time series.

optional

Optional

  • fastperiod - The time period of the fast EMA.
  • slowperiod - The time period of the slow EMA.
  • signalperiod - The time period of the signal EMA.

response

Response

%{
  "Meta Data" => %{
      "1: Symbol" => "IBM",
      "2: Indicator" => "Moving Average Convergence/Divergence (MACD)",
      "3: Last Refreshed" => "2023-06-29",
      "4: Interval" => "daily",
      "5.1: Fast Period" => 12,
      "5.2: Slow Period" => 26,
      "5.3: Signal Period" => 9,
      "6: Series Type" => "open",
      "7: Time Zone" => "US/Eastern"
  },
  "Technical Analysis: MACD" => %{
    "2023-06-29" => %{
      "MACD" => "0.8975",
      "MACD_Signal" => "1.6957",
      "MACD_Hist" => "-0.7982"
    },
  }
}
Link to this function

macdext(symbol, interval, series_type, opts \\ %{})

Fetches the moving average convergence / divergence values with controllable moving average type.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • series_type - The desired price type in the time series.

optional

Optional

  • fastperiod - The time period of the fast EMA.
  • slowperiod - The time period of the slow EMA.
  • signalperiod - The time period of the signal EMA.

response

Response

Link to this function

mama(symbol, interval, time_period, series_type)

Fetches the MESA adaptive moving average values for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each moving average value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "MESA Adaptive Moving Average (MAMA)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5.1: Fast Limit" => 0.01,
    "5.2: Slow Limit" => 0.01,
    "6: Series Type" => "high",
    "7: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: MAMA" => %{
    "2023-06-02 14:36" => %{
      "FAMA" => "180.7266",
      "MAMA" => "180.6225"
    },
  }
}
Link to this function

market_status()

Fetches the market status.

response

Response

%{
  "endpoint" => "Global Market Open & Close Status",
  "markets" => [
    %{
      "current_status" => "closed",
      "local_close" => "16:15",
      "local_open" => "09:30",
      "market_type" => "Equity",
      "notes" => "",
      "primary_exchanges" => "NASDAQ, NYSE, AMEX, BATS",
      "region" => "United States"
    },
  ]
}
Link to this function

mfi(symbol, interval, time_period)

Fetches the money flow index values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Money Flow Index (MFI)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: MFI" => %{
    "2023-06-02 14:36" => %{
      "MFI" => "49.2195"
    },
  }
}
Link to this function

midpoint(symbol, interval, time_period, series_type)

Fetches the midpoint

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "MidPoint over period (MIDPOINT)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Series Type" => "close",
    "7: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: MIDPOINT" => %{
    "2023-06-02 14:36" => %{
      "MIDPOINT" => "180.4450"
    },
  }
}
Link to this function

midprice(symbol, interval, time_period)

Fetches the midpoint price values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Midpoint Price over period (MIDPRICE)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: MIDPRICE" => %{
    "2023-06-02 14:36" => %{
      "MIDPRICE" => "180.4150"
    },
  }
}
Link to this function

minus_di(symbol, interval, time_period)

Fetches the minus directional indicator values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Minus Directional Indicator (MINUS_DI)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: MINUS_DI" => %{
    "2023-06-02 14:36" => %{
      "MINUS_DI" => "21.9017"
    },
  }
}
Link to this function

minus_dm(symbol, interval, time_period)

Fetches the minus directional movement values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Minus Directional Movement (MINUS_DM)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: MINUS_DM" => %{
    "2023-06-02 14:36" => %{
      "MINUS_DM" => "1.2460"
    },
  }
}
Link to this function

mom(symbol, interval, time_period, series_type)

Fetches the momentum values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Momentum (MOM)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Series Type" => "close",
    "7: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: MOM" => %{
    "2023-06-02 14:36" => %{
      "MOM" => "0.0350"
    },
  }
}
Link to this function

natr(symbol, interval, time_period)

Fetches the normalized average true range values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Normalized Average True Range (NATR)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: NATR" => %{
    "2023-06-02 14:36" => %{
      "NATR" => "0.0525"
    },
  }
}
Link to this function

natural_gas(interval \\ "monthly")

Fetches the prices for natural gas.

required

Required

  • interval - The interval between two consecutive data points in the time series.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "2.15"
    },
  ],
  "interval" => "monthly",
  "name" => "Henry Hub Natural Gas Spot Price",
  "unit" => "dollars per million BTU"
}
Link to this function

news_sentiment(params \\ %{})

Fetches the news sentiment

optional

Optional

  • tickers - A comma-separated list of stock tickers.
  • topics - A comma-separated list of topics.
  • time_from - A date in the format YYYYMMDDTHHMM.
  • time_to - A date in the format YYYYMMDDTHHMM.
  • sort - The sort order of the results. Possible values are LATEST, EARLIEST, RELEVANCE.
  • limit - The number of results to return. Possible values are 1-1000.

response

Response

%{
  "feed" => [
    %{
      "authors" => [],
      "banner_image" => "https://www.financialexpress.com/wp-content/uploads/2023/06/Satya-Nadella.jpg",
      "category_within_source" => "n/a",
      "overall_sentiment_label" => "Neutral",
      "overall_sentiment_score" => 0.050773,
      "source" => "The Financial Express",
      "source_domain" => "www.financialexpress.com",
      "summary" => "Microsoft CEO Nadella tells a judge his planned Activision takeover is good for gaming The Financial Express ...",
      "ticker_sentiment" => [
        %{
          "relevance_score" => "0.491399",
          "ticker" => "ATVI",
          "ticker_sentiment_label" => "Neutral",
          "ticker_sentiment_score" => "0.035327"
        },
      ],
      "time_published" => "20230629T044402",
      "title" => "Microsoft CEO Nadella tells a judge his planned Activision takeover is good for gaming | The Financial Express",
      "topics" => [
        %{
          "relevance_score" => "0.5",
          "topic" => "Technology"
        },
      ],
      "url" => "https://www.financialexpress.com/tech-trends/microsoft-ceo-nadella-tells-a-judge-his-planned-activision-takeover-is-good-for-gaming/3147293/"
    },
  ],
  "items" => "50",
  "relevance_score_definition" => "0 < x <= 1, with a higher score indicating higher relevance.",
  "sentiment_score_definition" => "x <= -0.35: Bearish;"
}
Link to this function

nonfarm_payroll()

Fetches the nonfarm payroll of the United States.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "156306"
    },
  ],
  "interval" => "monthly",
  "name" => "Total Nonfarm Payroll",
  "unit" => "thousands of persons"
}
Link to this function

obv(symbol, interval)

Fetches the on balance volume values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "On Balance Volume (OBV)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: OBV" => %{
    "2023-06-02 14:36" => %{
      "OBV" => "-5959522.0000"
    },
  }
}
Link to this function

plus_di(symbol, interval, time_period)

Fetches the plus directional indicator values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Plus Directional Indicator (PLUS_DI)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: PLUS_DI" => %{
    "2023-06-02 14:36" => %{
      "PLUS_DI" => "21.0211"
    },
  }
}
Link to this function

plus_dm(symbol, interval, time_period)

Fetches the plus directional movement values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Plus Directional Movement (PLUS_DM)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: PLUS_DM" => %{
    "2023-06-02 14:36" => %{
      "PLUS_DM" => "1.1959"
    },
  }
}
Link to this function

ppo(symbol, interval, series_type, opts \\ %{})

Fetches the percentage price oscillator values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • series_type - The desired price type in the time series.

optional

Optional

  • fastperiod - The time period of the fast EMA.
  • slowperiod - The time period of the slow EMA.
  • matype - The type of moving average to be used.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Percentage Price Oscillator (PPO)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5.1: Fast Period" => 12,
    "5.2: Slow Period" => 26,
    "5.3: MA Type" => 0,
    "6: Series Type" => "close",
    "7: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: PPO" => %{
    "2023-06-02 14:36" => %{
      "PPO" => "0.0493"
    },
  }
}

Fetches the quote for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the quote for.

response

Response

%{
  "Global Quote" => %{
    "01. symbol" => "AAPL",
    "02. open" => "187.9300",
    "03. high" => "189.9000",
    "04. low" => "187.6000",
    "05. price" => "189.2500",
    "06. volume" => "51216801",
    "07. latest trading day" => "2023-06-28",
    "08. previous close" => "188.0600",
    "09. change" => "1.1900",
    "10. change percent" => "0.6328%"
  }
}
Link to this function

real_gdp(interval \\ "annual")

Fetches the real GDP of the United States.

required

Required

  • interval - The interval between two consecutive data points in the time series.

response

Response

%{
  "data" => [
    %{
      "date" => "2022-01-01",
      "value" => "20014.128"
    },
  ],
  "interval" => "annual",
  "name" => "Real Gross Domestic Product",
  "unit" => "billions of dollars"
}
Link to this function

real_gdp_per_capita()

Fetches the real GDP per capita of the United States.

required

Required

  • interval - The interval between two consecutive data points in the time series.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-01-01",
      "value" => "60502.0"
    },
  ],
  "interval" => "quarterly",
  "name" => "Real Gross Domestic Product per Capita",
  "unit" => "chained 2012 dollars"
}

Fetches the retail sales of the United States.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "629656.0"
    },
  ],
  "interval" => "monthly",
  "name" => "Advance Retail Sales: Retail Trade",
  "unit" => "millions of dollars"
}
Link to this function

roc(symbol, interval, time_period, series_type)

Fetches the rate of change values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Rate of change : ((price/prevPrice)-1)*100",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Series Type" => "close",
    "7: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: ROC" => %{
    "2023-06-02 14:36" => %{
      "ROC" => "0.0194"
    },
  }
}
Link to this function

rocr(symbol, interval, time_period, series_type)

Fetches the rate of change ratio values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Rate of change ratio: (price/prevPrice)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Series Type" => "close",
    "7: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: ROCR" => %{
    "2023-06-02 14:36" => %{
      "ROCR" => "1.0002"
    },
  }
}
Link to this function

rsi(symbol, interval, time_period, series_type)

Fetches the relative strength index values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each RSI value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Relative Strength Index (RSI)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Series Type" => "close",
    "7: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: RSI" => %{
    "2023-06-02 14:36" => %{
      "RSI" => "50.3319"
    },
  }
}
Link to this function

sar(symbol, interval, opts \\ %{})

Fetches the parabolic sar values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.

optional

Optional

  • acceleration - The acceleration factor.
  • maximum - The maximum acceleration factor.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Parabolic SAR (SAR)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5.1: Acceleration" => 0.01,
    "5.2: Maximum" => 0.2,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: SAR" => %{
    "2023-06-02 14:36" => %{
      "SAR" => "180.3625"
    },
  }
}
Link to this function

search(keywords)

Fetches the search results for a given keyword.

required

Required

  • keywords - The keywords to search for.

response

Response

%{
  "bestMatches" => [
    %{
      "1. symbol" => "MSF0.FRK",
      "2. name" => "MICROSOFT CORP. CDR",
      "3. type" => "Equity",
      "4. region" => "Frankfurt",
      "5. marketOpen" => "08:00",
      "6. marketClose" => "20:00",
      "7. timezone" => "UTC+02",
      "8. currency" => "EUR",
      "9. matchScore" => "0.6429"
    },
  ]
}
Link to this function

sma(symbol, interval, time_period, series_type)

Fetches simple moving average values for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each moving average value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Simple Moving Average (SMA)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 20,
    "6: Series Type" => "high",
    "7: Time Zone" => "US/Eastern"
  },
  "Technical Analysis: SMA" => %{
    "2023-06-02 14:36" => %{
      "SMA" => "180.5028"
    },
  }
}
Link to this function

start(type, args)

Callback implementation for Application.start/2.

Link to this function

stoch(symbol, interval, opts \\ %{})

Fetches the stochastic oscillator values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.

optional

Optional

  • fastkperiod - The time period of the fastk moving average.
  • slowkperiod - The time period of the slowk moving average.
  • slowdperiod - The time period of the slowd moving average.
  • slowkmatype - The type of moving average for the slowk moving average.
  • slowdmatype - The type of moving average for the slowd moving average.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Stochastic (STOCH)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5.1: FastK Period" => 5,
    "5.2: SlowK Period" => 3,
    "5.3: SlowK MA Type" => 0,
    "5.4: SlowD Period" => 3,
    "5.5: SlowD MA Type" => 0,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: STOCH" => %{
    "2023-06-02 14:36" => %{
      "SlowD" => "66.4452",
      "SlowK" => "54.1389"
    },
  }
}
Link to this function

stochf(symbol, interval, opts \\ %{})

Fetches the stochastic oscillator fast values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.

optional

Optional

  • fastkperiod - The time period of the fastk moving average.
  • fastdperiod - The time period of the fastd moving average.
  • fastdmatype - The type of moving average for the fastd moving average.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Stochastic Fast (STOCHF)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5.1: FastK Period" => 5,
    "5.2: FastD Period" => 3,
    "5.3: FastD MA Type" => 0,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: STOCHF" => %{
    "2023-06-02 14:36" => %{
      "FastD" => "54.1389",
      "FastK" => "43.7500"
    },
  }
}
Link to this function

stochrsi(symbol, interval, time_period, series_type, opts \\ %{})

Fetches the stochastic relative strength index values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each RSI value.
  • series_type - The desired price type in the time series.

optional

Optional

  • fastkperiod - The time period of the fastk moving average.
  • fastdperiod - The time period of the fastd moving average.
  • fastdmatype - The type of moving average for the fastd moving average.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Relative Strength Index (RSI)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Series Type" => "close",
    "7: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: RSI" => %{
    "2023-06-02 14:36" => %{
      "RSI" => "50.3319"
    },
  }
}
Link to this function

sugar(interval \\ "monthly")

Fetches the prices for sugar

required

Required

  • interval - The interval between two consecutive data points in the time series.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "25.7295652173913"
    },
  ],
  "interval" => "monthly",
  "name" => "Global Price of Sugar",
  "unit" => "cents per pound"
}
Link to this function

t3(symbol, interval, time_period, series_type)

Fetches the triple exponential moving average values for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each moving average value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Triple Exponential Moving Average (T3)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 20,
    "6: Volume Factor (vFactor)" => 0.7,
    "7: Series Type" => "high",
    "8: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: T3" => %{
    "2023-06-02 14:36" => %{
      "T3" => "180.4336"
    },
  }
}
Link to this function

tema(symbol, interval, time_period, series_type)

Fetches triple exponential moving average values for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each moving average value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Triple Exponential Moving Average (TEMA)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 20,
    "6: Series Type" => "high",
    "7: Time Zone" => "US/Eastern"
  },
  "Technical Analysis: TEMA" => %{
    "2023-06-02 14:36" => %{
      "TEMA" => "180.6256"
    },
  }
}
Link to this function

time_series_daily(symbol, outputsize \\ "compact")

Fetches the daily time series for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the time series for.
  • outputsize - The size of the time series to return. Either compact or full.

response

Response

%{
  "Meta Data" => %{
    "1. Information" => "Daily Prices (open, high, low, close) and Volumes",
    "2. Symbol" => "IBM",
    "3. Last Refreshed" => "2023-06-28",
    "4. Output Size" => "Compact",
    "5. Time Zone" => "US/Eastern"
  },
  "Time Series (Daily)" => %{
    "2023-06-28" => %{
      "1. open" => "132.0600",
      "2. high" => "132.1700",
      "3. low" => "130.9100",
      "4. close" => "131.7600",
      "5. volume" => "2753779"
    },
  }
}
Link to this function

time_series_daily_adjusted(symbol, outputsize \\ "compact")

Fetches the daily adjusted time series for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the time series for.
  • outputsize - The size of the time series to return. Either compact or full.

response

Response

%{
  "Meta Data" => %{
    "1. Information" => "Daily Time Series with Splits and Dividend Events",
    "2. Symbol" => "AAPL",
    "3. Last Refreshed" => "2023-06-28",
    "4. Output Size" => "Compact",
    "5. Time Zone" => "US/Eastern"
  },
  "Time Series (Daily)" => %{
    "2023-02-10" => %{
      "1. open" => "149.46",
      "2. high" => "151.3401",
      "3. low" => "149.22",
      "4. close" => "151.01",
      "5. adjusted close" => "150.800276025693",
      "6. volume" => "57450708",
      "7. dividend amount" => "0.2300",
      "8. split coefficient" => "1.0"
    },
  }
}
Link to this function

time_series_intraday(symbol, interval, params \\ %{})

Fetches the daily time series for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the time series for.
  • interval - The interval to fetch the time series for.

optional

Optional

  • adjusted - If true, the adjusted time series is returned.
  • extended_hours - If true, the extended hours time series is returned.
  • outputsize - The size of the time series to return. Either compact or full.

response

Response

%{
  "Meta Data" => %{
    "1. Information" => "Intraday (1min) open, high, low, close prices and volume",
    "2. Symbol" => "AAPL",
    "3. Last Refreshed" => "2023-06-28 19:59:00",
    "4. Interval" => "1min",
    "5. Output Size" => "Full size",
    "6. Time Zone" => "US/Eastern"
  },
  "Time Series (1min)" => %{
    "2023-06-28 09:43:00" => %{
      "1. open" => "188.4720",
      "2. high" => "188.6300",
      "3. low" => "188.4400",
      "4. close" => "188.6000",
      "5. volume" => "260376"
    },
  }
}
Link to this function

time_series_monthly(symbol)

Fetches the monthly time series for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the time series for.

response

Response

%{
  "Meta Data" => %{
    "1. Information" => "Monthly Prices (open, high, low, close) and Volumes",
    "2. Symbol" => "AAPL",
    "3. Last Refreshed" => "2023-06-28",
    "4. Time Zone" => "US/Eastern"
  },
  "Monthly Time Series" => %{
    "2010-07-30" => %{
      "1. open" => "254.3000",
      "2. high" => "265.9900",
      "3. low" => "239.6000",
      "4. close" => "257.2500",
      "5. volume" => "559632300"
    },
  }
}
Link to this function

time_series_monthly_adjusted(symbol)

Fetches the monthly adjusted time series for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the time series for.

response

Response

%{
  "Meta Data" => %{
    "1. Information" => "Monthly Adjusted Prices and Volumes",
    "2. Symbol" => "AAPL",
    "3. Last Refreshed" => "2023-06-28",
    "4. Time Zone" => "US/Eastern"
  },
  "Monthly Adjusted Time Series" => %{
    "2010-07-30" => %{
      "1. open" => "254.3000",
      "2. high" => "265.9900",
      "3. low" => "239.6000",
      "4. close" => "257.2500",
      "5. adjusted close" => "7.8079",
      "6. volume" => "559632300",
      "7. dividend amount" => "0.0000"
    },
  }
}
Link to this function

time_series_weekly(symbol)

Fetches the weekly time series for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the time series for.

response

Response

%{
  "Meta Data" => %{
    "1. Information" => "Weekly Prices (open, high, low, close) and Volumes",
    "2. Symbol" => "AAPL",
    "3. Last Refreshed" => "2023-06-28",
    "4. Time Zone" => "US/Eastern"
  },
  "Weekly Time Series" => %{
    "2010-07-30" => %{
      "1. open" => "260.0000",
      "2. high" => "265.9900",
      "3. low" => "254.9000",
      "4. close" => "257.2500",
      "5. volume" => "93475900"
    },
  }
}
Link to this function

time_series_weekly_adjusted(symbol)

Fetches the weekly adjusted time series for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the time series for.

response

Response

%{
  "Meta Data" => %{
    "1. Information" => "Weekly Adjusted Prices and Volumes",
    "2. Symbol" => "AAPL",
    "3. Last Refreshed" => "2023-06-28",
    "4. Time Zone" => "US/Eastern"
  },
  "Weekly Adjusted Time Series" => %{
    "2010-07-30" => %{
      "1. open" => "260.0000",
      "2. high" => "265.9900",
      "3. low" => "254.9000",
      "4. close" => "257.2500",
      "5. adjusted close" => "7.8079",
      "6. volume" => "93475900",
      "7. dividend amount" => "0.0000"
    },
  }
}
Link to this function

top_gainers_losers_and_active()

Fetches the top gainers, losers, and most actively traded US tickers.

response

Response

%{
  "last_updated" => "2023-06-28 16:15:59 US/Eastern",
  "metadata" => "Top gainers, losers, and most actively traded US tickers",
  "most_actively_traded" => [
    %{
      "change_amount" => "-0.0267",
      "change_percentage" => "-19.5175%",
      "price" => "0.1101",
      "ticker" => "MULN",
      "volume" => "396949152"
    },
  ],
  "top_gainers" => [
    %{
      "change_amount" => "0.0526",
      "change_percentage" => "316.8675%",
      "price" => "0.0692",
      "ticker" => "XPDBW",
      "volume" => "77067"
    },
  ],
  "top_losers" => [
    %{
      "change_amount" => "-0.0515",
      "change_percentage" => "-52.0202%",
      "price" => "0.0475",
      "ticker" => "MMVWW",
      "volume" => "3892"
    },
  ]
}
Link to this function

trange(symbol, interval)

Fetches the true range values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "True Range (TRANGE)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: TRANGE" => %{
    "2023-06-02 14:36" => %{
      "TRANGE" => "0.0710"
    },
  }
}
Link to this function

treasury_yield(interval \\ "daily", maturity \\ "10year")

Fetches the treasury yield of the United States.

required

Required

  • interval - The interval between two consecutive data points in the time series.
  • maturity - The maturity of treasury yield.

response

Response

  "data" => [
    %{
      "date" => "2023-06-27",
      "value" => "3.77"
    },
  ],
  "interval" => "daily",
  "name" => "10-Year Treasury Constant Maturity Rate",
  "unit" => "percent"
}
Link to this function

trima(symbol, interval, time_period, series_type)

Fetches triangular moving average values for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each moving average value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Triangular Exponential Moving Average (TRIMA)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 20,
    "6: Series Type" => "high",
    "7: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: TRIMA" => %{
    "2023-06-02 14:36" => %{
      "TRIMA" => "180.5130"
    },
  }
}
Link to this function

trix(symbol, interval, time_period, series_type)

Fetches the 1-day rate of change of a triple smooth exponential moving average values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each momentum value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "1-day Rate-Of-Change (ROC) of a Triple Smooth EMA (TRIX)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Series Type" => "close",
    "7: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: TRIX" => %{
    "2023-06-02 14:36" => %{
      "TRIX" => "-0.0014"
    },
  }
}
Link to this function

ultosc(symbol, interval, opts \\ %{})

Fetches the ultimate oscillator values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.

optional

Optional

  • timeperiod1 - The number of data points used to calculate the first momentum value.
  • timeperiod2 - The number of data points used to calculate the second momentum value.
  • timeperiod3 - The number of data points used to calculate the third momentum value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Ultimate Oscillator (ULTOSC)",
    "3: Last Refreshed" => "2023-06-29 19:59:00",
    "4: Interval" => "1min",
    "5.1: Time Period 1" => 7,
    "5.2: Time Period 2" => 14,
    "5.3: Time Period 3" => 28,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: ULTOSC" => %{
    "2023-06-02 14:36" => %{
      "ULTOSC" => "65.7262"
    },
  }
}
Link to this function

unemployment_rate()

Fetches the unemployment rate of the United States.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "3.7"
    },
  ],
  "interval" => "monthly",
  "name" => "Unemployment Rate",
  "unit" => "percent"
}
Link to this function

vwap(symbol, interval)

Fetches the volume weighted average price.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "IBM",
    "2: Indicator" => "Volume Weighted Average Price (VWAP)",
    "3: Last Refreshed" => "2023-06-28 19:45:00",
    "4: Interval" => "15min",
    "5: Time Zone" => "US/Eastern"
  },
  "Technical Analysis: VWAP" => %{
    "2023-06-28 19:45" => %{
      "VWAP" => "131.7526"
    },
  }
}
Link to this function

wheat(interval \\ "monthly")

Fetches the prices for wheat

required

Required

  • interval - The interval between two consecutive data points in the time series.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "299.44000625"
    },
  ],
  "interval" => "monthly",
  "name" => "Global Price of Wheat",
  "unit" => "dollar per metric ton"
}
Link to this function

willr(symbol, interval, time_period)

Fetches the Williams' %R values.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each Williams' %R value.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Williams' %R (WILLR)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 60,
    "6: Time Zone" => "US/Eastern Time"
  },
  "Technical Analysis: WILLR" => %{
    "2023-06-02 14:36" => %{
      "WILLR" => "-29.5775"
    },
  }
}
Link to this function

wma(symbol, interval, time_period, series_type)

Fetches weighted moving average values for a given symbol.

required

Required

  • symbol - The stock symbol to fetch the data for.
  • interval - The time interval between two consecutive data points in the time series.
  • time_period - The number of data points used to calculate each moving average value.
  • series_type - The desired price type in the time series.

response

Response

%{
  "Meta Data" => %{
    "1: Symbol" => "AAPL",
    "2: Indicator" => "Weighted Moving Average (WMA)",
    "3: Last Refreshed" => "2023-06-28 19:59:00",
    "4: Interval" => "1min",
    "5: Time Period" => 20,
    "6: Series Type" => "high",
    "7: Time Zone" => "US/Eastern"
  },
  "Technical Analysis: WMA" => %{
    "2023-06-02 14:36" => %{
      "WMA" => "180.5467"
    },
  }
}
Link to this function

wti(interval \\ "monthly")

Fetches the prices for WTI crude oil.

required

Required

  • interval - The interval between two consecutive data points in the time series.

response

Response

%{
  "data" => [
    %{
      "date" => "2023-05-01",
      "value" => "71.58"
    },
  ],
  "interval" => "monthly",
  "name" => "Crude Oil Prices WTI",
  "unit" => "dollars per barrel"
}