Skip to content

api_reference.md

Latest commit

 

History

History
986 lines (980 loc) · 90.8 KB

api_reference.md

File metadata and controls

986 lines (980 loc) · 90.8 KB
Raw

API Endpoints

All URIs are relative to https://api.twelvedata.com

Class Method HTTP request Description
AdvancedAPI Advanced Post /batch Batches
AdvancedAPI GetApiUsage Get /api_usage API usage
AnalysisAPI GetAnalystRatingsLight Get /analyst_ratings/light Analyst ratings snapshot
AnalysisAPI GetAnalystRatingsUsEquities Get /analyst_ratings/us_equities Analyst ratings US equities
AnalysisAPI GetEarningsEstimate Get /earnings_estimate Earnings estimate
AnalysisAPI GetEpsRevisions Get /eps_revisions EPS revisions
AnalysisAPI GetEpsTrend Get /eps_trend EPS trend
AnalysisAPI GetGrowthEstimates Get /growth_estimates Growth estimates
AnalysisAPI GetPriceTarget Get /price_target Price target
AnalysisAPI GetRecommendations Get /recommendations Recommendations
AnalysisAPI GetRevenueEstimate Get /revenue_estimate Revenue estimate
CurrenciesAPI GetCurrencyConversion Get /currency_conversion Currency conversion
CurrenciesAPI GetExchangeRate Get /exchange_rate Exchange rate
EtfsAPI GetETFsFamily Get /etfs/family ETFs families
EtfsAPI GetETFsList Get /etfs/list ETFs directory
EtfsAPI GetETFsType Get /etfs/type ETFs types
EtfsAPI GetETFsWorld Get /etfs/world ETF full data
EtfsAPI GetETFsWorldComposition Get /etfs/world/composition Composition
EtfsAPI GetETFsWorldPerformance Get /etfs/world/performance Performance
EtfsAPI GetETFsWorldRisk Get /etfs/world/risk Risk
EtfsAPI GetETFsWorldSummary Get /etfs/world/summary Summary
FundamentalsAPI GetBalanceSheet Get /balance_sheet Balance sheet
FundamentalsAPI GetBalanceSheetConsolidated Get /balance_sheet/consolidated Balance sheet consolidated
FundamentalsAPI GetCashFlow Get /cash_flow Cash flow
FundamentalsAPI GetCashFlowConsolidated Get /cash_flow/consolidated Cash flow consolidated
FundamentalsAPI GetDividends Get /dividends Dividends
FundamentalsAPI GetDividendsCalendar Get /dividends_calendar Dividends calendar
FundamentalsAPI GetEarnings Get /earnings Earnings
FundamentalsAPI GetEarningsCalendar Get /earnings_calendar Earnings calendar
FundamentalsAPI GetIncomeStatement Get /income_statement Income statement
FundamentalsAPI GetIncomeStatementConsolidated Get /income_statement/consolidated Income statement consolidated
FundamentalsAPI GetIpoCalendar Get /ipo_calendar IPO calendar
FundamentalsAPI GetKeyExecutives Get /key_executives Key executives
FundamentalsAPI GetLastChanges Get /last_change/{endpoint} Last changes
FundamentalsAPI GetLogo Get /logo Logo
FundamentalsAPI GetMarketCap Get /market_cap Market capitalization
FundamentalsAPI GetProfile Get /profile Profile
FundamentalsAPI GetSplits Get /splits Splits
FundamentalsAPI GetSplitsCalendar Get /splits_calendar Splits calendar
FundamentalsAPI GetStatistics Get /statistics Statistics
FundamentalsAPI PressReleasesListParameters Get /press_releases Press releases
MarketDataAPI GetEod Get /eod End of day price
MarketDataAPI GetMarketMovers Get /market_movers/{market} Market movers
MarketDataAPI GetPrice Get /price Latest price
MarketDataAPI GetQuote Get /quote Quote
MarketDataAPI GetTimeSeries Get /time_series Time series
MarketDataAPI GetTimeSeriesCross Get /time_series/cross Time series cross
MutualFundsAPI GetMutualFundsFamily Get /mutual_funds/family MFs families
MutualFundsAPI GetMutualFundsList Get /mutual_funds/list MFs directory
MutualFundsAPI GetMutualFundsType Get /mutual_funds/type MFs types
MutualFundsAPI GetMutualFundsWorld Get /mutual_funds/world MF full data
MutualFundsAPI GetMutualFundsWorldComposition Get /mutual_funds/world/composition Composition
MutualFundsAPI GetMutualFundsWorldPerformance Get /mutual_funds/world/performance Performance
MutualFundsAPI GetMutualFundsWorldPurchaseInfo Get /mutual_funds/world/purchase_info Purchase info
MutualFundsAPI GetMutualFundsWorldRatings Get /mutual_funds/world/ratings Ratings
MutualFundsAPI GetMutualFundsWorldRisk Get /mutual_funds/world/risk Risk
MutualFundsAPI GetMutualFundsWorldSummary Get /mutual_funds/world/summary Summary
MutualFundsAPI GetMutualFundsWorldSustainability Get /mutual_funds/world/sustainability Sustainability
ReferenceDataAPI GetBonds Get /bonds Fixed income
ReferenceDataAPI GetCommodities Get /commodities Commodities
ReferenceDataAPI GetCountries Get /countries Countries
ReferenceDataAPI GetCrossListings Get /cross_listings Cross listings
ReferenceDataAPI GetCryptocurrencies Get /cryptocurrencies Cryptocurrency pairs
ReferenceDataAPI GetCryptocurrencyExchanges Get /cryptocurrency_exchanges Cryptocurrency exchanges
ReferenceDataAPI GetEarliestTimestamp Get /earliest_timestamp Earliest timestamp
ReferenceDataAPI GetEtf Get /etfs ETFs
ReferenceDataAPI GetExchangeSchedule Get /exchange_schedule Exchanges schedule
ReferenceDataAPI GetExchanges Get /exchanges Exchanges
ReferenceDataAPI GetForexPairs Get /forex_pairs Forex pairs
ReferenceDataAPI GetFunds Get /funds Funds
ReferenceDataAPI GetInstrumentType Get /instrument_type Instrument type
ReferenceDataAPI GetIntervals Get /intervals Intervals List
ReferenceDataAPI GetMarketState Get /market_state Market state
ReferenceDataAPI GetStocks Get /stocks Stocks
ReferenceDataAPI GetSymbolSearch Get /symbol_search Symbol search
ReferenceDataAPI GetTechnicalIndicators Get /technical_indicators Technical indicators
RegulatoryAPI GetDirectHolders Get /direct_holders Direct holders
RegulatoryAPI GetEdgarFilingsArchive Get /edgar_filings/archive EDGAR fillings
RegulatoryAPI GetFundHolders Get /fund_holders Fund holders
RegulatoryAPI GetInsiderTransactions Get /insider_transactions Insider transaction
RegulatoryAPI GetInstitutionalHolders Get /institutional_holders Institutional holders
RegulatoryAPI GetSourceSanctionedEntities Get /sanctions/{source} Sanctioned entities
RegulatoryAPI GetTaxInfo Get /tax_info Tax information
TechnicalIndicatorAPI GetTimeSeriesAd Get /ad Accumulation/distribution
TechnicalIndicatorAPI GetTimeSeriesAdOsc Get /adosc Accumulation/distribution oscillator
TechnicalIndicatorAPI GetTimeSeriesAdd Get /add Addition
TechnicalIndicatorAPI GetTimeSeriesAdx Get /adx Average directional index
TechnicalIndicatorAPI GetTimeSeriesAdxr Get /adxr Average directional movement index rating
TechnicalIndicatorAPI GetTimeSeriesApo Get /apo Absolute price oscillator
TechnicalIndicatorAPI GetTimeSeriesAroon Get /aroon Aroon indicator
TechnicalIndicatorAPI GetTimeSeriesAroonOsc Get /aroonosc Aroon oscillator
TechnicalIndicatorAPI GetTimeSeriesAtr Get /atr Average true range
TechnicalIndicatorAPI GetTimeSeriesAvg Get /avg Average
TechnicalIndicatorAPI GetTimeSeriesAvgPrice Get /avgprice Average price
TechnicalIndicatorAPI GetTimeSeriesBBands Get /bbands Bollinger bands
TechnicalIndicatorAPI GetTimeSeriesBeta Get /beta Beta indicator
TechnicalIndicatorAPI GetTimeSeriesBop Get /bop Balance of power
TechnicalIndicatorAPI GetTimeSeriesCci Get /cci Commodity channel index
TechnicalIndicatorAPI GetTimeSeriesCeil Get /ceil Ceiling
TechnicalIndicatorAPI GetTimeSeriesCmo Get /cmo Chande momentum oscillator
TechnicalIndicatorAPI GetTimeSeriesCoppock Get /coppock Coppock curve
TechnicalIndicatorAPI GetTimeSeriesCorrel Get /correl Correlation
TechnicalIndicatorAPI GetTimeSeriesCrsi Get /crsi Connors relative strength index
TechnicalIndicatorAPI GetTimeSeriesDema Get /dema Double exponential moving average
TechnicalIndicatorAPI GetTimeSeriesDiv Get /div Division
TechnicalIndicatorAPI GetTimeSeriesDpo Get /dpo Detrended price oscillator
TechnicalIndicatorAPI GetTimeSeriesDx Get /dx Directional movement index
TechnicalIndicatorAPI GetTimeSeriesEma Get /ema Exponential moving average
TechnicalIndicatorAPI GetTimeSeriesExp Get /exp Exponential
TechnicalIndicatorAPI GetTimeSeriesFloor Get /floor Floor
TechnicalIndicatorAPI GetTimeSeriesHeikinashiCandles Get /heikinashicandles Heikinashi candles
TechnicalIndicatorAPI GetTimeSeriesHlc3 Get /hlc3 High, low, close average
TechnicalIndicatorAPI GetTimeSeriesHtDcPeriod Get /ht_dcperiod Hilbert transform dominant cycle period
TechnicalIndicatorAPI GetTimeSeriesHtDcPhase Get /ht_dcphase Hilbert transform dominant cycle phase
TechnicalIndicatorAPI GetTimeSeriesHtPhasor Get /ht_phasor Hilbert transform phasor components
TechnicalIndicatorAPI GetTimeSeriesHtSine Get /ht_sine Hilbert transform sine wave
TechnicalIndicatorAPI GetTimeSeriesHtTrendMode Get /ht_trendmode Hilbert transform trend vs cycle mode
TechnicalIndicatorAPI GetTimeSeriesHtTrendline Get /ht_trendline Hilbert transform instantaneous trendline
TechnicalIndicatorAPI GetTimeSeriesIchimoku Get /ichimoku Ichimoku cloud
TechnicalIndicatorAPI GetTimeSeriesKama Get /kama Kaufman adaptive moving average
TechnicalIndicatorAPI GetTimeSeriesKeltner Get /keltner Keltner channel
TechnicalIndicatorAPI GetTimeSeriesKst Get /kst Know sure thing
TechnicalIndicatorAPI GetTimeSeriesLinearReg Get /linearreg Linear regression
TechnicalIndicatorAPI GetTimeSeriesLinearRegAngle Get /linearregangle Linear regression angle
TechnicalIndicatorAPI GetTimeSeriesLinearRegIntercept Get /linearregintercept Linear regression intercept
TechnicalIndicatorAPI GetTimeSeriesLinearRegSlope Get /linearregslope Linear regression slope
TechnicalIndicatorAPI GetTimeSeriesLn Get /ln Natural logarithm
TechnicalIndicatorAPI GetTimeSeriesLog10 Get /log10 Base-10 logarithm
TechnicalIndicatorAPI GetTimeSeriesMa Get /ma Moving average
TechnicalIndicatorAPI GetTimeSeriesMacd Get /macd Moving average convergence divergence
TechnicalIndicatorAPI GetTimeSeriesMacdExt Get /macdext Moving average convergence divergence extension
TechnicalIndicatorAPI GetTimeSeriesMacdSlope Get /macd_slope Moving average convergence divergence slope
TechnicalIndicatorAPI GetTimeSeriesMama Get /mama MESA adaptive moving average
TechnicalIndicatorAPI GetTimeSeriesMax Get /max Maximum
TechnicalIndicatorAPI GetTimeSeriesMaxIndex Get /maxindex Maximum Index
TechnicalIndicatorAPI GetTimeSeriesMcGinleyDynamic Get /mcginley_dynamic McGinley dynamic indicator
TechnicalIndicatorAPI GetTimeSeriesMedPrice Get /medprice Median price
TechnicalIndicatorAPI GetTimeSeriesMfi Get /mfi Money flow index
TechnicalIndicatorAPI GetTimeSeriesMidPoint Get /midpoint Midpoint
TechnicalIndicatorAPI GetTimeSeriesMidPrice Get /midprice Midprice
TechnicalIndicatorAPI GetTimeSeriesMin Get /min Minimum
TechnicalIndicatorAPI GetTimeSeriesMinIndex Get /minindex Minimum index
TechnicalIndicatorAPI GetTimeSeriesMinMax Get /minmax Minimum and maximum
TechnicalIndicatorAPI GetTimeSeriesMinMaxIndex Get /minmaxindex Minimum and maximum index
TechnicalIndicatorAPI GetTimeSeriesMinusDI Get /minus_di Minus directional indicator
TechnicalIndicatorAPI GetTimeSeriesMinusDM Get /minus_dm Minus directional movement
TechnicalIndicatorAPI GetTimeSeriesMom Get /mom Momentum
TechnicalIndicatorAPI GetTimeSeriesMult Get /mult Multiplication
TechnicalIndicatorAPI GetTimeSeriesNatr Get /natr Normalized average true range
TechnicalIndicatorAPI GetTimeSeriesObv Get /obv On balance volume
TechnicalIndicatorAPI GetTimeSeriesPercentB Get /percent_b Percent B
TechnicalIndicatorAPI GetTimeSeriesPivotPointsHL Get /pivot_points_hl Pivot points high low
TechnicalIndicatorAPI GetTimeSeriesPlusDI Get /plus_di Plus directional indicator
TechnicalIndicatorAPI GetTimeSeriesPlusDM Get /plus_dm Plus directional movement
TechnicalIndicatorAPI GetTimeSeriesPpo Get /ppo Percentage price oscillator
TechnicalIndicatorAPI GetTimeSeriesRoc Get /roc Rate of change
TechnicalIndicatorAPI GetTimeSeriesRocp Get /rocp Rate of change percentage
TechnicalIndicatorAPI GetTimeSeriesRocr Get /rocr Rate of change ratio
TechnicalIndicatorAPI GetTimeSeriesRocr100 Get /rocr100 Rate of change ratio 100
TechnicalIndicatorAPI GetTimeSeriesRsi Get /rsi Relative strength index
TechnicalIndicatorAPI GetTimeSeriesRvol Get /rvol Relative volume
TechnicalIndicatorAPI GetTimeSeriesSar Get /sar Parabolic stop and reverse
TechnicalIndicatorAPI GetTimeSeriesSarExt Get /sarext Parabolic stop and reverse extended
TechnicalIndicatorAPI GetTimeSeriesSma Get /sma Simple moving average
TechnicalIndicatorAPI GetTimeSeriesSqrt Get /sqrt Square root
TechnicalIndicatorAPI GetTimeSeriesStdDev Get /stddev Standard deviation
TechnicalIndicatorAPI GetTimeSeriesStoch Get /stoch Stochastic oscillator
TechnicalIndicatorAPI GetTimeSeriesStochF Get /stochf Stochastic fast
TechnicalIndicatorAPI GetTimeSeriesStochRsi Get /stochrsi Stochastic relative strength index
TechnicalIndicatorAPI GetTimeSeriesSub Get /sub Subtraction
TechnicalIndicatorAPI GetTimeSeriesSum Get /sum Summation
TechnicalIndicatorAPI GetTimeSeriesSuperTrend Get /supertrend Supertrend
TechnicalIndicatorAPI GetTimeSeriesSuperTrendHeikinAshiCandles Get /supertrend_heikinashicandles Supertrend Heikin Ashi candles
TechnicalIndicatorAPI GetTimeSeriesT3ma Get /t3ma Triple exponential moving average
TechnicalIndicatorAPI GetTimeSeriesTRange Get /trange True range
TechnicalIndicatorAPI GetTimeSeriesTema Get /tema Triple exponential moving average
TechnicalIndicatorAPI GetTimeSeriesTrima Get /trima Triangular moving average
TechnicalIndicatorAPI GetTimeSeriesTsf Get /tsf Time series forecast
TechnicalIndicatorAPI GetTimeSeriesTypPrice Get /typprice Typical price
TechnicalIndicatorAPI GetTimeSeriesUltOsc Get /ultosc Ultimate oscillator endpoint
TechnicalIndicatorAPI GetTimeSeriesVar Get /var Variance
TechnicalIndicatorAPI GetTimeSeriesVwap Get /vwap Volume weighted average price
TechnicalIndicatorAPI GetTimeSeriesWclPrice Get /wclprice Weighted close price
TechnicalIndicatorAPI GetTimeSeriesWillR Get /willr Williams %R
TechnicalIndicatorAPI GetTimeSeriesWma Get /wma Weighted moving average

Models