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