Sugra API
Sugra API gives your code direct access to Sugra Data with one key. Sugra Data is the data service behind both products, Sugra API and Sugra MCP: equities,…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Sugra API gives your code direct access to Sugra Data with one key. Sugra Data is the data service behind both products, Sugra API and Sugra MCP: equities, macroeconomics, commodities, crypto, forex, weather, climate, fundamentals, prediction markets, digital economy, and more, delivered through a single normalized JSON envelope. Built for software, pipelines and any AI that calls HTTP, without per-source plumbing.
Directions of Sugra Data
Sugra Data is organized into seven directions. On Sugra API all of them sit under the same key and envelope (volume-only pricing, no feature gating):
- Sugra Finance - markets: equities, options, crypto, commodities, forex, technical indicators, filings-grade fundamentals
- Sugra Macro - economic policy and official statistics: central banks, national statistical agencies, global trade, public finance
- Sugra Entity - compliance and KYB: sanctions, PEP and adverse-media screening, LEI/VAT resolution
- Sugra NetAtlas - network intelligence Sugra builds itself: IP, ASN, BGP, RPKI, Tor, a daily atlas from primary sources, not resold
- Sugra News - news and events: curated feeds on a 5-minute cadence plus GDELT global events
- Sugra Earth - physical world: weather, climate, disasters, energy, satellite
- Sugra Research - scholarly and development data: preprints to a century of growth statistics
Sugra API page: sugra.systems/api. The x-tagGroups extension of this spec groups endpoint tags by direction.
Use and licensing
Commercial and professional use is permitted on every tier including Free. Trading, investing, compliance, risk management, financial research, consulting, payment processing, lending, and other revenue-generating applications are explicit permitted uses. See the Data Use Policy for what is NOT permitted (redistribution of raw Data as a standalone product, re-aggregation). See the Terms of Service for the full agreement.
Authentication
Pass your API key in the x-api-key header:
curl -H "x-api-key: YOUR_KEY" "https://sugra.ai/api/v1/forex/latest?symbols=USD,GBP"Get a key at app.sugra.ai/register. Free: 50 requests/day. Dev: 5,000 requests/day ($25/mo or $250/yr). Pro: 50,000 requests/day ($59/mo or $588/yr). Dev and Pro also work through Sugra MCP.
Rate limits
Every response to a data call made with an accepted key includes these headers, though a 500 for an unexpected server error can come without them:
X-RateLimit-Limit- your account's daily quota, shared by all of its keysX-RateLimit-Remaining- requests left todayX-RateLimit-Reset- reset timestamp (ISO 8601, UTC)
A call that stops before the key is accepted and a system endpoint carry none.
When quota is exhausted, the API returns 429 Too Many Requests.
A response that also carries X-RateLimit-Refunded: 1 failed on our side (a 5xx, or a 429 that is not your daily quota), and its request was given back to your daily quota.
Response envelope
All /api/v1/* endpoints return the same shape:
{
"data": { "...": "source-specific payload" },
"meta": {
"endpoint": "/api/v1/macro/us/cpi",
"data_time": "2026-04-16T14:30:00Z",
"response_time": "2026-04-16T14:30:12Z",
"provider": "Sugra API v1.0.1",
"source": "fred",
"fallback_used": false,
"fallback_chain": ["fred"],
"cached": false
}
}meta.data_time is the timestamp of the source data, not the request time. meta.source identifies the upstream provider used. meta.fallback_chain lists sources attempted in order (first one that succeeded is at the end). meta.cached indicates whether the response came from the internal cache.
Errors
| Code | Meaning |
|---|---|
| 401 | Missing or invalid x-api-key |
| 404 | Unknown endpoint or resource |
| 429 | Daily rate limit exceeded |
| 500 | Internal error |
| 503 | Upstream source temporarily unavailable |
Base URL
Versioning
Endpoints are versioned in the path: /api/v1/, and /api/v2/ where a newer schema exists. The unversioned /api/ alias is deprecated: its responses carry Deprecation: true and a Sunset header dated 2026-09-01. Use the versioned path.
Quickstart
Python
import httpx
r = httpx.get(
"https://sugra.ai/api/v1/crypto/bitcoin/price",
headers={"x-api-key": "YOUR_KEY"},
)
print(r.json()["data"]["current_price"])JavaScript
const r = await fetch(
"https://sugra.ai/api/v1/crypto/bitcoin/price",
{ headers: { "x-api-key": "YOUR_KEY" } },
);
const body = await r.json();
console.log(body.data.current_price);Sugra MCP
Sugra MCP connects Claude, Claude Code, ChatGPT, Codex, Grok, Cursor, Antigravity, GitHub Copilot, VS Code, Zed, Cline, Continue and any MCP client to Sugra Data. Its address is…
Endpoints 400
Finance
- POSTMap identifiers to FIGIs
/api/v1/openfigi/mappingMap ticker, ISIN, CUSIP, SEDOL, or other IDs to Financial Instrument Global Identifiers. Batch up to 100 jobs. - POSTSearch instruments by keyword
/api/v1/openfigi/searchSearch for financial instruments by name/ticker. Filter by exchange, market sector, security type. Paginated. - POSTFilter instruments (with total count)
/api/v1/openfigi/filterFilter instruments alphabetically by FIGI. Returns total count. Paginated. - GETEnum values for mapping properties
/api/v1/openfigi/values/:keyGet valid values for: idType, exchCode, micCode, currency, marketSecDes, securityType, securityType2, stateCode. - GETShort interest positions (bi-weekly)
/api/v1/short-interest/positionsConsolidated short interest from FINRA. Shows how many shares are sold short for each stock, with days-to-cover (days of average daily share volume needed to… - GETShort interest history for a stock
/api/v1/short-interest/symbol/:symbolBi-weekly short interest history for a specific stock. Track how short positions change over time. - GETDaily short volume (Reg SHO)
/api/v1/short-interest/daily-volumeDaily short sale volume vs total volume per stock, from the FINRA Reg SHO daily files. Covers off-exchange trades reported to FINRA only, not consolidated… - GETDaily short volume for a stock
/api/v1/short-interest/daily-volume/:symbolDaily short volume history for a specific stock. Track short selling activity day by day. - GETSearch short interest
/api/v1/short-interest/search?q=NVDASearch for a stock in FINRA short interest data by symbol. - GETMarket fails-to-deliver leaderboard (latest SEC period)
/api/v1/short-side/fails-to-deliverTop fails-to-deliver across the market for the most recent SEC reporting period, ranked by failed-share quantity descending. A fail-to-deliver (FTD) is a… - GETFails-to-deliver timeseries for one security
/api/v1/short-side/fails-to-deliver/:symbolFull fails-to-deliver settlement history for one ticker, ascending by settlement date. Each record carries the date, failed-share quantity, prior-day closing… - GETMarket-structure leaderboard (latest SEC day)
/api/v1/market-structureSecurities with the most non-displayed (hidden) executed volume on the most recent SEC market-structure day. SEC Market Structure (MIDAS) metrics describe how… - GETDaily market-microstructure timeseries for one security
/api/v1/market-structure/:symbolPer-security daily lit-microstructure history (hidden/odd-lot/cancel/trade-to-order rates, average trade size, volume, deciles), ascending by date. Use limit… - GETAll 46 market metrics (latest values)
/api/v1/multpl/currentSnapshot of all 46 metrics: S&P 500 valuation (PE, CAPE, earnings yield, dividend yield, P/B, P/S, EPS, prices), Treasury rates (1M-30Y + real rates), US… - GETS&P 500 valuation metrics
/api/v1/multpl/sp50017 S&P 500 metrics: PE Ratio, Shiller PE (CAPE), Earnings Yield, Dividend Yield, Price to Book, Price to Sales, Historical Price, Inflation-Adjusted Price,… - GETUS Treasury rates
/api/v1/multpl/treasury13 Treasury rates: 1-Month through 30-Year yields, plus 5/10/20/30-Year real (inflation-adjusted) interest rates. - GETHistorical series for one metric
/api/v1/multpl/metric/:slugFull historical data for a specific metric. Use /multpl/current to see all available slugs. Examples: shiller-pe, 10-year-treasury-rate, s-p-500-pe-ratio,… - GETVIX (Fear Gauge)
/api/v1/cboe/vixS&P 500 Volatility Index (VIX) - daily OHLC history since 1990. VIX < 15: low fear. VIX 15-25: normal. VIX 25-35: elevated. VIX > 35: extreme fear. The most… - GETVIX term structure (contango/backwardation)
/api/v1/cboe/vix-term-structureVIX across timeframes: 1-day, 9-day, 30-day, 3-month, 6-month, 1-year. Contango (long > short) = normal. Backwardation (short > long) = market stress. Key… - GETAll volatility indices
/api/v1/cboe/volatilityLatest values for all tracked volatility indices: VIX (S&P 500), RVX (Russell 2000), VVIX (vol of vol), GVZ (gold), OVX (oil), plus VIX term structure… - GETFull index catalog (2000+ indices)
/api/v1/cboe/indices/allThe FULL index-definitions catalog - every listed index with name, description, currency, delay, family and launch date - paged (limit/offset,… - GETIndex history (any catalog symbol)
/api/v1/cboe/index/:symbolDaily OHLC history for any index of the full catalog (see /indices/all; 2000+ symbols) - the curated quick set (VIX, SPX, RUT, BXM, PUT, ...) resolves… - GETAvailable volatility-index catalog
/api/v1/cboe/indicesCatalog of all 35 tracked indices: volatility (9), market (8), strategy (13+). - GETDelayed options with Greeks
/api/v1/cboe/options/:symbol15-minute delayed options quotes with full Greeks: delta, gamma, vega, theta, rho, implied volatility, theoretical price. Available for any US optionable… - GETOne-minute intraday bars with per-minute options flow
/api/v1/cboe/intraday/:symbolThe latest session's one-minute bars for any optionable US symbol: price OHLC plus PER-MINUTE options flow (calls_volume / puts_volume / total_options_volume)… - GETDaily put/call ratios (exchange-wide)
/api/v1/cboe/put-call-ratioEXCHANGE-WIDE daily options statistics for the latest session: all published put/call ratios (total, index, equity, etp, vix, spx, and every other listed… - GETPut/call ratio history (20-year stitched series)
/api/v1/cboe/put-call-ratio/history?family=totalEXCHANGE-WIDE daily put/call series per family (total, index, equity, etp, vix, spx), stitched from the frozen ratio archives (from 2006; spx from 2010) and… - GETFama-French risk factors
/api/v1/fama-french/factorsAcademic finance risk factors for asset pricing and portfolio analysis. 3-Factor (1926+): Mkt-RF (market premium), SMB (small minus big), HML (value).… - GETAny Fama-French dataset
/api/v1/fama-french/dataset/:keyAccess any of 23 Fama-French datasets by key. Industry portfolios (5/10/12/17/30/48/49), size/value portfolios (6/25/100), momentum portfolios (10),… - GETAvailable Fama-French datasets
/api/v1/fama-french/catalogCatalog of all 23 Fama-French datasets: factors (3/5/momentum/reversal, monthly and daily), industry portfolios (5 to 49 industries), size/value portfolios… - GETFama-French US portfolio returns
/api/v1/fama-french/us-portfolioUS-equity sorted/industry portfolio returns from the Ken French Data Library. Pick a portfolio file (e.g. portfolios_formed_on_me, 6_portfolios_2x3,… - GETFama-French regional portfolio returns
/api/v1/fama-french/regional-portfolioRegional sorted-portfolio returns (Developed, Developed ex US, Emerging Markets, Europe, Japan, North America, Asia Pacific ex Japan) from the Ken French Data… - GETFama-French NYSE breakpoints
/api/v1/fama-french/breakpointsNYSE breakpoint percentiles used to construct the Fama-French sorts. breakpoint_type: me (size), be-me (value), op (profitability), inv (investment), e-p… - GETFama-French international country portfolio returns
/api/v1/fama-french/country-portfolioSingle-country sorted-portfolio data for 21 developed markets (Austria, Australia, Belgium, Canada, Denmark, Finland, France, Germany, Hong Kong, Ireland,… - GETFama-French international index portfolio returns
/api/v1/fama-french/international-indexRegional-index sorted-portfolio data for 6 indices (uk, scandinavia, europe, europe_ex_uk, asia_pacific, all) from the Ken French Data Library. Same measure /… - GETFama-French portfolio / breakpoint selectors
/api/v1/fama-french/portfolio-catalogDiscovery: the 119 US portfolio labels, 121 regional portfolio labels, 8 breakpoint types, the 21 country and 6 international-index labels, and the measure /… - GETCurrent price
/api/v2/quotes/:symbol/priceReturns the current quote for a symbol: last price, change and change percent, volume, open, day high and low, previous close, bid and ask, market cap, 50 and… - GETDetailed company info
/api/v2/quotes/:symbol/infoReturns the detailed company profile of a symbol: address, website, sector and industry, business summary, employee count, officers, governance risk scores… - GETPrice history
/api/v2/quotes/:symbol/historicalOHLCV historical data. Use period OR start/end, not both. Supports intraday intervals (1m, 2m, 5m, 15m, 30m, 60m, 90m, 1h) and daily+ (1d, 5d, 1wk, 1mo, 3mo).… - GETOptions expiration dates
/api/v2/quotes/:symbol/optionsList available option expiration dates for a symbol. - GETOptions chain
/api/v2/quotes/:symbol/options/:dateCalls and puts for a specific expiration date. Contract fields use snake_case; the seven historical camelCase names (contractSymbol, lastPrice, percentChange,… - GETEarnings calendar
/api/v2/quotes/:symbol/calendarUpcoming earnings dates and dividend events. - GETNews
/api/v2/quotes/:symbol/newsLatest news articles for a symbol. - GETDividend data
/api/v2/quotes/:symbol/dividendReturns the dividend profile of a symbol: dividend rate and yield, ex-dividend and payment dates, payout ratio, five-year average yield and the trailing… - GETIncome statement
/api/v2/quotes/:symbol/:periodicity/income-statementRevenue, gross profit, operating income, net income, EPS. Annual, quarterly, or trailing. - GETBalance sheet
/api/v2/quotes/:symbol/:periodicity/balance-sheetAssets, liabilities, equity, cash, debt. Annual or quarterly. - GETCash flow statement
/api/v2/quotes/:symbol/:periodicity/cash-flowOperating, investing, financing flows, FCF, capex. Annual, quarterly, or trailing. - GETEarnings history
/api/v2/quotes/:symbol/earnings-historyReturns the reported earnings history of a symbol by quarter: date, actual EPS, estimated EPS, the difference and the surprise percent. The limit parameter… - GETForward estimates
/api/v2/quotes/:symbol/forward-estimatesReturns analyst forward estimates for a symbol: the earnings estimate, the revenue estimate, the EPS trend and the EPS revisions. - GETAnalyst price targets
/api/v2/quotes/:symbol/analyst-targetsReturns the analyst price target summary for a symbol: current price, low, high, mean and median targets, the number of analysts and the consensus… - GETResearch insights
/api/v2/quotes/:symbol/insightsTechnical events, key technicals, valuation, significant developments, SEC reports. - GETAnalyst ratings
/api/v2/quotes/:symbol/ratingsReturns analyst rating data for a symbol: the rating direction, the rating and price-target fields, and the financial score. Fields are returned as delivered… - GETMarket analytics data
/api/v2/quotes/:symbol/analystAnalyst consensus, price target distribution, estimate revisions. - GETAI price insights
/api/v2/quotes/:symbol/price-insightsFair value estimate, anomaly detection, AI commentary. - GETEarnings call events
/api/v2/quotes/:symbol/earnings-eventsList of earnings call events for a symbol. - GETEarnings call transcript
/api/v2/quotes/:symbol/transcript/:event_idFull earnings call transcript by event ID. - GETInstitutional holders
/api/v2/quotes/:symbol/institutional-holdersLists the institutional holders of a symbol with shares held, value, report date, percent of shares held and percent change since the previous report. - GETMutual fund holders
/api/v2/quotes/:symbol/mutualfund-holdersLists the mutual funds that hold a symbol with shares held, value, report date, percent of shares held and percent change since the previous report. - GETMajor holders breakdown
/api/v2/quotes/:symbol/major-holdersReturns the ownership breakdown of a symbol: percent of shares held by insiders, percent held by institutions, percent of float held by institutions and the… - GETInsider roster
/api/v2/quotes/:symbol/insider-rosterInsider roster of the company, one record per insider: name, position, text and date of the most recent transaction, and shares owned directly and indirectly.… - GETInsider transactions
/api/v2/quotes/:symbol/insider-transactionsIndividual insider transactions of the company, one record per transaction: insider, position, transaction text, start date, shares, value and ownership. This… - GETAnalyst recommendations
/api/v2/quotes/:symbol/recommendationsReturns the analyst recommendation counts for a symbol by period: strong buy, buy, hold, sell and strong sell. - GETUpgrades and downgrades
/api/v2/quotes/:symbol/upgrades-downgradesLists analyst rating changes for a symbol, newest first, with the date, the firm, the new and previous grade and the action taken. - GETCorporate actions - dividends + splits
/api/v2/quotes/:symbol/actionsLists corporate actions for a symbol, dividends and splits, with date, amount and type. The days parameter sets the look-back window (default 365, 0 returns… - GETHistorical stock splits
/api/v2/quotes/:symbol/splitsLists the full stock split history of a symbol, newest first, with the split date and the numerator and denominator of the ratio. The limit parameter returns… - GETSEC filings
/api/v2/quotes/:symbol/sec-filingsLists recent SEC filings for a symbol with their dates and links. The days parameter sets the look-back window (default 30, 0 returns all). - GETETF/Fund profile
/api/v2/quotes/:symbol/fund-profileReturns the profile of an ETF or mutual fund: quote type, description, fund overview, asset class mix, top holdings and sector weightings. Symbols that are… - GETBatch price/info for multiple symbols
/api/v2/quotes/:symbol/multiplePrice or profile data for up to 10 symbols in one request. Pass the symbols as a comma-separated path segment, for example… - GETTechnical indicators
/api/v2/quotes/:symbol/technical-analysisClassical technical indicators computed from the symbol's daily OHLCV history: SMA (20/50/200), EMA (12/26), MACD (12-26-9), RSI (14), Bollinger Bands (20,… - GETTrailing returns (one_day .. max)
/api/v2/quotes/:symbol/recent-performanceTrailing return percentages computed from the symbol's full daily price history (adj_close total-return basis): one_day, wtd, one_week, mtd, one_month, qtd,… - GETFundamental timeseries (any of 974+ fields)
/api/v2/quotes/:symbol/timeseries?type=TotalRevenue,NetIncomeReturns fundamental time series for a symbol. The required type parameter takes up to 50 comma-separated field keys, for example TotalRevenue,NetIncome.… - GETCompany logo (Wikidata)
/api/v2/quotes/:symbol/logoResolves a company logo for a ticker through Wikidata. The response carries the Wikidata id, the company label, the logo image file and URL, the official… - GETCompany executives + officers
/api/v2/quotes/:symbol/executivesReturns the company officers and executive team of a symbol, together with the full-time employee count and the compensation and governance risk fields. - GETPress releases (Form 8-K Exhibit 99.x)
/api/v2/quotes/:symbol/press-releasesLists press releases filed by a company as Form 8-K filings, newest first. The days parameter sets the look-back window (default 180, maximum 730) and limit… - GETFund summary (ETF or mutual fund)
/api/v2/quotes/:symbol/fund-summaryReturns a short summary of an ETF or mutual fund: category, fund family, legal type, currency, total assets, NAV price, year-to-date return, expense ratio,… - GETFund composition (top holdings, sectors, asset classes)
/api/v2/quotes/:symbol/fund-compositionReturns what an ETF or mutual fund holds: asset class mix, sector weightings, top holdings and the fund overview. Symbols that are not funds return 404. - GETFund performance (YTD, 3y, 5y avg returns, P/E, NAV ranges)
/api/v2/quotes/:symbol/fund-performanceReturns performance fields of an ETF or mutual fund: year-to-date, three-year and five-year average returns, last dividend, trailing and forward P/E, NAV… - GETFund risk metrics (beta, volume, 52-week range, fund risk rating when present)
/api/v2/quotes/:symbol/fund-riskReturns risk fields of an ETF or mutual fund: beta, three-year beta, average volume, fund risk rating when present, 52-week range and 52-week change percent.… - GETFund purchase info (expense ratio, sales loads, turnover, yield)
/api/v2/quotes/:symbol/fund-purchase-infoReturns what it costs to buy and hold an ETF or mutual fund: expense ratio, front-end and deferred sales loads, annual holdings turnover, total assets,… - GETCross-listings (same security on multiple exchanges)
/api/v2/quotes/:symbol/cross-listingsLists every stock exchange listing of the company that holds the given ticker, resolved through Wikidata. The response carries the company label, its Wikidata… - GETEarliest available OHLC timestamp per interval
/api/v2/quotes/:symbol/earliest-timestampReturns the earliest and the latest available price bar for a symbol at a chosen interval, with the number of bars, the exchange and the currency. Intraday… - GETInstitutional holders (top 10)
/api/v2/quotes/:symbol/holders/institutionalReturns the top 10 institutional holders of a symbol with shares held, value, percent of shares held and percent change, plus the holder count. - GETMutual fund holders (top 10)
/api/v2/quotes/:symbol/holders/fundsReturns the top 10 mutual fund holders of a symbol with shares held, value, percent of shares held and percent change, plus the holder count. - GETInsider holders + recent transactions (Form 4)
/api/v2/quotes/:symbol/holders/insidersInsider roster and insider transactions in one response. roster is the full /api/v2/quotes/{symbol}/insider-roster list; transactions is the… - GETHolders summary (major + top-N each category)
/api/v2/quotes/:symbol/holders/summaryReturns one combined snapshot of who owns a symbol: the ownership breakdown percentages plus the top 3 institutional holders, top 3 funds and top 3 insiders. - GETKey financial statistics (curated /info subset, grouped)
/api/v2/quotes/:symbol/statisticsReturns a curated set of key financial statistics for a symbol in ten groups: valuation, profitability, balance sheet, income, per share, shares, ownership,… - GETMarket capitalization with size category
/api/v2/quotes/:symbol/market-capReturns the market capitalization of a symbol with its basis, enterprise value, shares outstanding, the implied share count, the currency and a size category… - GETMarket status
/api/v2/market/statusReturns the open or closed status of the US market from Sugra Finance. Responses are cached for 5 minutes. - GETMarket summary - major indices
/api/v2/market/summaryReturns a snapshot of the major US market indices: for each, the symbol, name, price, change, change percent, market state and exchange. Responses are cached… - GETTrending tickers
/api/v2/market/trendingLists the trending tickers for a quote type. The count parameter sets the number of tickers (default 10, maximum 25) and quote_type is one of EQUITY, ETF,… - GETSearch tickers and news
/api/v2/market/search?q=appleSearches tickers and news headlines for the text in q. The quotes_count parameter caps the ticker matches (default 6, maximum 20) and news_count caps the… - GETMarket calendar (earnings, dividends, splits, economic events)
/api/v2/market/calendarReturns the market calendar for a date range of up to 31 days, defaulting to the next 7 days: earnings, dividends, splits and economic events. Choose the… - GETBatch price quotes (up to 20 symbols)
/api/v2/market/batch-quotes?symbols=AAPL,MSFT,NVDAReturns quotes for up to 20 comma-separated symbols in one call: price, change, volume, day and 52-week ranges, exchange and market state. The optional fields… - GETOHLCV chart data
/api/v2/market/chart/:symbolReturns OHLCV price bars for a symbol. Choose the interval (1m, 5m, 15m, 30m, 1h, 1d, 1wk or 1mo) and either a range such as 1mo or 1y, or an explicit period… - GETSparklines batch for dashboards
/api/v2/market/spark?symbols=AAPL,MSFT,NVDAReturns compact sparkline series for up to 20 comma-separated symbols: previous close, current price and the close values with their timestamps, for… - GETScreener investment themes and ideas
/api/v2/market/screener/discoverLists screener themes and investment ideas that can be explored further. The count parameter sets the number of ideas (default 5, maximum 20) and modules… - GETScreener available column definitions
/api/v2/market/screener/columnsLists the columns available for building a custom screener query, grouped by category. The instrument parameter selects the instrument family, such as equity,… - GETPredefined screener (gainers, losers, most active, etc.)
/api/v2/market/screener/:scr_idRuns a predefined screener, such as most actives, day gainers or day losers, and returns its records with the total, start and count. The count parameter caps… - POSTCustom screener query
/api/v2/market/screenerRuns a custom screener. The request body carries the required query plus optional paging and sort fields. The response returns the matching records with the… - POSTVisualization / heatmap data
/api/v2/market/visualizationReturns visualization and heatmap data for a custom query. The request body carries the required query plus optional fields. The response returns the tables… - GETInstrument type resolution
/api/v2/market/quote-type/:symbolResolves the instrument type of a symbol, for example equity or ETF, together with its exchange, short and long names, exchange timezone and market. - GETMarket IDs (commodities, currencies, etc.)
/api/v2/market/idsReturns the market identifiers for commodities and currencies by default. The modules parameter takes comma-separated group names to choose which groups are… - GETPrediction market events
/api/v2/market/predictions/eventsLists prediction market events. The count parameter sets the number of events (default 10, maximum 50), featured keeps only featured events, tag_slug selects… - GETPrediction market price history
/api/v2/market/predictions/prices?markets=KXELECPRES-24NOV05Returns the historical implied-probability price series for one or more prediction markets. The markets parameter is required; start_ts, interval and fidelity… - GETPrediction market tags
/api/v2/market/predictions/tagsLists the topic tags that can be used to filter prediction market events. Responses are cached for 1 day. - GETMarket analytics / insights
/api/v2/market/analytics/:symbolReturns analytics and insight modules for a symbol. The modules parameter takes comma-separated module keys and defaults to sec_reports. - GETStock recommendations
/api/v2/market/stock-recommender/:symbolReturns stock recommendations for the given symbol, the other symbols that the recommender links to it. Responses are cached for 5 minutes. - GETUpcoming dividends calendar (market-wide)
/api/v2/market/calendar/dividendsLists upcoming dividends across all symbols for a date range of up to 31 days, defaulting to the next 7 days: ex-dividend, payment, record and announcement… - GETUpcoming stock splits calendar (market-wide)
/api/v2/market/calendar/splitsLists upcoming stock splits across all symbols for a date range of up to 31 days, defaulting to the next 7 days, with the execution dates and ratios. The… - GETUpcoming earnings calendar (market-wide)
/api/v2/market/calendar/earningsEvery earnings report scheduled in the range, which in reporting season runs long. Narrow it with q (symbol or company name), limit and offset; a narrowed… - GETStocks catalog (US, SEC-registered)
/api/v2/market/catalog/stocksPages through the catalog of SEC-registered US stock tickers with their exchange. Page with limit and offset, and filter by exchange. The response carries the… - GETETFs catalog (US-listed)
/api/v2/market/catalog/etfsPages through the catalog of US-listed ETFs. Page with limit and offset. The response carries the total, the page count and the rows. - GETMutual funds catalog (US, SEC-registered)
/api/v2/market/catalog/fundsPages through the catalog of SEC-registered US mutual fund share classes. Page with limit and offset, and filter by SEC series id to list all share classes of… - GETUS Treasury securities catalog
/api/v2/market/catalog/bondsPages through the catalog of US Treasury securities, bills, notes, bonds, TIPS and floating rate notes, auctioned and upcoming. Page with limit and offset,… - GETSupported exchange codes
/api/v2/market/exchangesLists the supported exchange codes with their market identifier code and name. Use a code in the exchange schedule and holidays routes. - GETTrading hours + holiday calendar for an exchange
/api/v2/market/exchange/:code/scheduleReturns the trading hours of one exchange: its MIC, name, country, timezone, regular open and close, trading days, lunch break if any, currency and a link to… - GETExchange holiday dates (full closures + early closes)
/api/v2/market/exchange/:code/holidaysReturns the market holidays of one exchange for a calendar year, full closures and early closes, with the holiday count and a link to the official holiday… - GETFutures roots catalog
/api/v2/futures/rootsCurated futures roots with sector, exchange, currency and contract multiplier - including the volatility sector (settlement-basis roots). Filter by sector or… - GETFutures price history
/api/v2/futures/:root/historicalOHLCV history for a futures root. Returns the continuous front-month series by default, or a specific dated contract when 'expiration' (YYYY-MM) is supplied.… - GETFutures term-structure curve
/api/v2/futures/:root/curveTerm-structure (forward curve) snapshot: last price across consecutive expirations for a futures root, with a contango / backwardation label. Volatility roots… - GETFutures contract chain
/api/v2/futures/:root/contractsDated-contract chain for a futures root: expiration, last price, open interest and volume per contract, front to back. Volatility roots (VX) list monthly AND… - GETFutures contract info
/api/v2/futures/:root/infoEnriched metadata for a futures root: sector, exchange, currency, contract multiplier, and front-contract quote details. - GETResolve ambiguous ticker query to canonical symbol
/api/v2/quotes/resolve?q=9988Disambiguates ticker queries against a Blob-cached static map of 30+ primary-source publishers (Wikidata + OpenFIGI + per-exchange CSVs) rebuilt biweekly by… - GETBulk resolve up to 50 ticker queries to canonical symbols
/api/v2/quotes/resolve/bulk?q=AAPL,9988,7203,005930Comma-separated bulk variant of /resolve. Re-uses the same per-symbol 7-day cache as the single endpoint, so warmed entries are returned instantly (no… - GETCompany logo redirect (Wikidata + DuckDuckGo fallback)
/api/v2/quotes/:symbol/logo.pngReturns a 302 redirect to the best logo image URL for the given ticker. Resolution order: Wikidata P154 (company logo) -> Wikidata P18 (image) -> DuckDuckGo…
Technical Indicators
- GETSimple Moving Average (SMA)
/api/v1/indicators/sma?symbol=AAPL&time_period=20Simple Moving Average over the close price. Optionally accepts a comma-separated list of time_period values (max 5) to compute multiple SMAs in one request -… - GETExponential Moving Average (EMA)
/api/v1/indicators/ema?symbol=AAPL&time_period=20Exponential Moving Average over the close price. Reacts faster to recent price changes than SMA. Multi-period via comma-separated time_period. - GETWeighted Moving Average (WMA)
/api/v1/indicators/wma?symbol=AAPL&time_period=20Weighted Moving Average - linearly weighted by recency. Less smooth than EMA, more responsive than SMA. - GETDouble Exponential Moving Average (DEMA)
/api/v1/indicators/dema?symbol=AAPL&time_period=20DEMA = 2*EMA - EMA(EMA). Reduces lag inherent in standard EMA by subtracting the lag of EMA-of-EMA. - GETTriple Exponential Moving Average (TEMA)
/api/v1/indicators/tema?symbol=AAPL&time_period=20TEMA = 3*EMA - 3*EMA(EMA) + EMA(EMA(EMA)). Further reduces lag of DEMA. Smooth + responsive. - GETMidpoint over close (MIDPOINT)
/api/v1/indicators/midpoint?symbol=AAPL&time_period=14Midpoint = (highest_close + lowest_close) / 2 over a window. Centerline of close-price range. - GETMidprice over high+low (MIDPRICE)
/api/v1/indicators/midprice?symbol=AAPL&time_period=14Midprice = (highest_high + lowest_low) / 2 over a window. Centerline of high-low range, sensitive to wicks. - GETVolume Weighted Average Price (VWAP)
/api/v1/indicators/vwap?symbol=AAPL&time_period=14VWAP = sum(typical_price * volume) / sum(volume) over the window. Institutional benchmark for fair-price execution. - GETParabolic SAR (PSAR)
/api/v1/indicators/psar?symbol=AAPLParabolic Stop-And-Reverse - trailing stop indicator that flips above / below price as trend reverses. Step=0.02, max=0.2 (Wilder defaults). time_period is… - GETBollinger Bands (BBANDS)
/api/v1/indicators/bbands?symbol=AAPL&time_period=20Bollinger Bands - middle line is SMA(close, time_period), upper / lower are middle ±2 standard deviations. Each observation row contains all three lines so… - GETDonchian Channel (DONCHIAN)
/api/v1/indicators/donchian?symbol=AAPL&time_period=20Donchian Channel - upper = highest_high over window, lower = lowest_low, middle = (upper + lower) / 2. Classic breakout indicator (Turtle traders). - GETKeltner Channel (KC)
/api/v1/indicators/kc?symbol=AAPL&time_period=20Keltner Channel - middle = EMA(close), upper / lower = middle ± 2*ATR. Volatility-adaptive bands; tighter than Bollinger in low-vol regimes and wider in… - GETIchimoku Cloud (ICHIMOKU)
/api/v1/indicators/ichimoku?symbol=AAPL&time_period=9Ichimoku Cloud - four lines per observation: conversion_line (Tenkan-sen, fast), base_line (Kijun-sen, medium), senkou_span_a (leading A, midpoint of Tenkan +… - GETATR Bands (close ± 2*ATR)
/api/v1/indicators/atr_bands?symbol=AAPL&time_period=14Volatility envelope: middle = close, upper / lower = close ±2*ATR over time_period. Useful for trailing-stop placement and as a proxy for Bollinger Bands when… - GETFloor-trader pivot points (PIVOT)
/api/v1/indicators/pivot?symbol=AAPLClassic floor-trader pivot points. Each row contains pivot P plus three resistance levels (R1, R2, R3) and three support levels (S1, S2, S3). Levels for… - GETTriangular Moving Average (TRIMA)
/api/v1/indicators/trima?symbol=AAPL&time_period=20TRIMA = SMA(SMA(close, k), k) where k = ceil((time_period + 1) / 2). Smoother than SMA, double-smoothed. Matches TA-Lib convention. - GETTillson T3 Moving Average (T3)
/api/v1/indicators/t3?symbol=AAPL&time_period=20T3 by Tim Tillson - 6-EMA cascade with weighted polynomial sum, volume factor v=0.7. Smooth, low-lag alternative to DEMA / TEMA. - GETKaufman's Adaptive Moving Average (KAMA)
/api/v1/indicators/kama?symbol=AAPL&time_period=10KAMA - smoothing constant adapts to price efficiency ratio: trends faster (closer to fast EMA), ranges slower (closer to slow EMA). Defaults: fast=2, slow=30.… - GETSuperTrend (SUPERTREND)
/api/v1/indicators/supertrend?symbol=AAPL&time_period=10Direction-aware trailing stop based on ATR with multiplier=3.0. Returns the supertrend line: when below price the trend is up, when above price the trend is… - GETMESA Adaptive Moving Average (MAMA)
/api/v1/indicators/mama?symbol=AAPLJohn Ehlers' MESA Adaptive MA. Detects the dominant cycle period via Hilbert Transform Discriminator and adjusts smoothing alpha to the phase change of that… - GETHilbert Transform Trendline (HT_TRENDLINE)
/api/v1/indicators/ht_trendline?symbol=AAPLJohn Ehlers' Hilbert Transform Trendline - adaptive moving average centered over the detected dominant cycle period. Smoother than fixed-window MAs in… - GETRelative Strength Index (RSI)
/api/v1/indicators/rsi?symbol=AAPL&time_period=14Wilder's RSI. 0-100 oscillator measuring speed and magnitude of price changes. Above 70 commonly read as overbought, below 30 as oversold. Multi-period… - GETMoving Average Convergence Divergence (MACD)
/api/v1/indicators/macd?symbol=AAPLMACD with Appel defaults (fast=12, slow=26, signal=9). Each observation row contains macd, signal, hist (= macd - signal) so the lines are time-aligned for… - GETStochastic Oscillator (STOCH)
/api/v1/indicators/stoch?symbol=AAPL&time_period=14Lane's Stochastic with %D smoothing fixed at 3 bars. Returns %K (main line) and %D (signal). Both 0-100. Above 80 = overbought, below 20 = oversold.… - GETStochastic RSI (STOCHRSI)
/api/v1/indicators/stochrsi?symbol=AAPL&time_period=14Stochastic applied to RSI series - second-derivative momentum. Range 0-1 (note: smaller than %K's 0-100 because of the underlying RSI scale). Smoothing fixed… - GETWilliams %R (WILLR)
/api/v1/indicators/willr?symbol=AAPL&time_period=14Williams %R - inverted Stochastic, range -100..0. Above -20 = overbought, below -80 = oversold. Lookback time_period (default 14). - GETCommodity Channel Index (CCI)
/api/v1/indicators/cci?symbol=AAPL&time_period=20Lambert's CCI. Mean-deviation oscillator centered at 0. Above +100 = strong uptrend / overbought, below -100 = strong downtrend / oversold. Default… - GETAverage Directional Index (ADX)
/api/v1/indicators/adx?symbol=AAPL&time_period=14Wilder's ADX. Measures trend strength only - does not say up or down. Above 25 = trending market, below 20 = ranging. Pair with PLUS_DI / MINUS_DI (separate… - GETMoney Flow Index (MFI)
/api/v1/indicators/mfi?symbol=AAPL&time_period=14Volume-weighted RSI. Range 0-100. Above 80 = overbought, below 20 = oversold. Best on liquid securities; thin volume distorts. Default time_period=14. - GETPercentage Price Oscillator (PPO)
/api/v1/indicators/ppo?symbol=AAPLPPO is MACD expressed as a percentage of slow EMA, allowing comparison across instruments with different price levels. Appel defaults (fast=12, slow=26,… - GETAroon up / down (AROON)
/api/v1/indicators/aroon?symbol=AAPL&time_period=25Aroon up = bars since highest high, scaled 0-100; Aroon down = bars since lowest low, scaled 0-100. Strong uptrend when Aroon up is near 100 and Aroon down is… - GETVortex Indicator (VORTEX)
/api/v1/indicators/vortex?symbol=AAPL&time_period=14VI+ and VI- capture positive and negative trend movement relative to the true range over time_period bars. VI+ crossing above VI- signals an emerging uptrend;… - GETRate of Change (ROC)
/api/v1/indicators/roc?symbol=AAPL&time_period=12Percentage change of close over time_period bars: ((close - close[t-n]) / close[t-n]) * 100. Default 12. - GETRate of Change Percentage (ROCP)
/api/v1/indicators/rocp?symbol=AAPL&time_period=12Decimal form of ROC: (close - close[t-n]) / close[t-n]. Same as ROC / 100. - GETRate of Change Ratio (ROCR)
/api/v1/indicators/rocr?symbol=AAPL&time_period=12Multiplicative form: close / close[t-n]. Useful for compounding analysis. - GETMomentum (MOM)
/api/v1/indicators/mom?symbol=AAPL&time_period=10Raw momentum: close - close[t-n]. Pre-rate-of-change form. Default time_period=10. - GETTRIX
/api/v1/indicators/trix?symbol=AAPL&time_period=151-day rate of change of triple-smoothed EMA. Slow oscillator, filters noise. Default 15. - GETTrue Strength Index (TSI)
/api/v1/indicators/tsi?symbol=AAPL&time_period=13Double-smoothed momentum. time_period is the fast window; slow is fixed at 25. Default fast=13. - GETUltimate Oscillator (ULTOSC)
/api/v1/indicators/ultosc?symbol=AAPLWilliams' Ultimate Oscillator. Combines 3 lookback windows (7/14/28). time_period ignored. - GET+DI (Plus Directional Indicator)
/api/v1/indicators/plus_di?symbol=AAPL&time_period=14Bull-trend strength component of ADX. Pair with /minus_di for direction signal: +DI > -DI = uptrend. - GET-DI (Minus Directional Indicator)
/api/v1/indicators/minus_di?symbol=AAPL&time_period=14Bear-trend strength component of ADX. Pair with /plus_di: -DI > +DI = downtrend. - GET+DM (Plus Directional Movement)
/api/v1/indicators/plus_dm?symbol=AAPL&time_period=14Wilder-smoothed +DM raw component. Used internally by ADX; exposed separately for callers building custom directional systems. - GET-DM (Minus Directional Movement)
/api/v1/indicators/minus_dm?symbol=AAPL&time_period=14Wilder-smoothed -DM raw component. Used internally by ADX; exposed separately for callers building custom directional systems. - GETDirectional Index (DX)
/api/v1/indicators/dx?symbol=AAPL&time_period=14Pre-ADX raw value: |+DI - -DI| / (+DI + -DI) * 100. ADX is just smoothed DX. - GETADX Rating (ADXR)
/api/v1/indicators/adxr?symbol=AAPL&time_period=14Smoothed ADX = (ADX[t] + ADX[t-time_period]) / 2. Slower trend-strength signal than raw ADX. - GETAroon Oscillator (AROONOSC)
/api/v1/indicators/aroonosc?symbol=AAPL&time_period=25Aroon up - Aroon down. Range -100..+100. Positive = uptrend dominant. Default time_period=25. - GETBalance of Power (BOP)
/api/v1/indicators/bop?symbol=AAPL(close - open) / (high - low). Per-bar value, range typically -1..+1. time_period ignored. - GETChande Momentum Oscillator (CMO)
/api/v1/indicators/cmo?symbol=AAPL&time_period=14Symmetric momentum oscillator, range -100..+100. Like RSI but centered at 0. - GETFast Stochastic %K (STOCHF)
/api/v1/indicators/stochf?symbol=AAPL&time_period=14Raw fast %K (no smoothing). Returns single line. For smoothed %K + %D pair, use /stoch instead. - GETDetrended Price Oscillator (DPO)
/api/v1/indicators/dpo?symbol=AAPLRemoves long-term trend by subtracting a shifted SMA. Highlights short-term cycles. time_period=window (default 20). - GETKnow Sure Thing (KST)
/api/v1/indicators/kst?symbol=AAPLPring's KST momentum. Sum of 4 smoothed ROCs (10/15/20/30 with smoothings 10/10/10/15). 9-bar signal line. Multi-line: kst/signal/diff. time_period ignored… - GETBollinger %B (PERCENT_B)
/api/v1/indicators/percent_b?symbol=AAPL(close - lower band) / (upper - lower) on Bollinger Bands. >1.0 = above upper; <0.0 = below lower. time_period=BB window (default 20), std=2. - GETCoppock Curve (COPPOCK)
/api/v1/indicators/coppock?symbol=AAPLLong-term buy signal indicator: WMA(time_period) of ROC(11)+ROC(14). Default time_period=10. Buy signal when curve crosses above 0 from negative. - GETConnors RSI (CRSI)
/api/v1/indicators/crsi?symbol=AAPLComposite oscillator averaging RSI(close,N) + RSI(streak,2) + PercentRank(ROC1,100). Range 0-100. Default time_period=3 per Connors original spec. - GETMACD Slope (MACD_SLOPE)
/api/v1/indicators/macd_slope?symbol=AAPLSlope of the MACD line over time_period bars. MACD uses fixed Appel windows (12/26/9). time_period = look-back (default 5). - GETRate of Change Ratio scaled 100 (ROCR100)
/api/v1/indicators/rocr100?symbol=AAPL(close / close.shift(time_period)) * 100. Same as /rocr but in percentage form. Default time_period=10. - GETAccumulation / Distribution Line (AD)
/api/v1/indicators/ad?symbol=AAPLCumulative volume-flow indicator. Each bar adds Money Flow Volume = ((close-low) - (high-close)) / (high-low) × volume. Path-dependent and unbounded -… - GETChaikin A/D Oscillator (ADOSC)
/api/v1/indicators/adosc?symbol=AAPLEMA(AD, 3) - EMA(AD, 10) - Marc Chaikin's oscillator built on the Accumulation/Distribution Line. Bounded around zero, easier to read than raw AD. time_period… - GETOn-Balance Volume (OBV)
/api/v1/indicators/obv?symbol=AAPLJoe Granville's classic. Cumulative volume signed by close direction: +volume on up bars, -volume on down bars. Path-dependent and unbounded - interpret slope… - GETChaikin Money Flow (CMF)
/api/v1/indicators/cmf?symbol=AAPL&time_period=20Rolling-window money-flow ratio: sum of money_flow_volume over time_period bars divided by sum of volume. Range -1..+1. Above 0 = accumulation pressure, below… - GETRelative Volume (RVOL)
/api/v1/indicators/rvol?symbol=AAPLRelative volume: each bar's volume divided by the rolling average volume over time_period bars (default 20, current bar included). 1.0 equals the window… - GETAverage True Range (ATR)
/api/v1/indicators/atr?symbol=AAPL&time_period=14Wilder's ATR. Smoothed measure of price range covering gaps and intra-bar volatility. Default time_period=14. Used widely for stop-loss sizing and as a… - GETNormalized ATR (NATR)
/api/v1/indicators/natr?symbol=AAPL&time_period=14ATR expressed as a percentage of close: ATR / close * 100. Cross-instrument comparable, unlike raw ATR. Useful for portfolio-level volatility ranking. - GETTrue Range (TRANGE)
/api/v1/indicators/trange?symbol=AAPLPer-bar True Range = max(H - L, |H - C[-1]|, |L - C[-1]|). Building block for ATR. time_period ignored - TRANGE is per-bar. For smoothed version use /atr. - GETChoppiness Index (CHOPPINESS)
/api/v1/indicators/choppiness?symbol=AAPL&time_period=14Choppiness Index, range 0-100. Below 38 = strong trending market, above 61 = choppy / ranging. Useful as a regime filter - disable trend-following signals… - GETUlcer Index (ULCER)
/api/v1/indicators/ulcer?symbol=AAPL&time_period=14Peter Martin's Ulcer Index - RMS of percent drawdowns from rolling peak. Unlike ATR / stddev, asymmetric: only counts downside pain. Used in Ulcer Performance… - GETHT Dominant Cycle Period (HT_DCPERIOD)
/api/v1/indicators/ht_dcperiod?symbol=AAPLEhlers' Hilbert Transform Discriminator output: smoothed dominant cycle period in bars. Bounded to [6, 50]. Used for adaptive indicator tuning - feed into MA… - GETHT Dominant Cycle Phase (HT_DCPHASE)
/api/v1/indicators/ht_dcphase?symbol=AAPLPhase of the dominant cycle in degrees, derived from atan2(q, i). Range -180 to +180. Used for cycle-timing entries: enter long when phase crosses zero from… - GETHT Phasor Components (HT_PHASOR)
/api/v1/indicators/ht_phasor?symbol=AAPLIn-phase (i) and quadrature (q) components of the Hilbert Transform Discriminator. Vector representation of the dominant cycle: (i, q) traces an ellipse in… - GETHT SineWave (HT_SINE)
/api/v1/indicators/ht_sine?symbol=AAPLEhlers' SineWave indicator: sine = sin(phase), lead_sine = sin(phase + 45°). lead_sine crosses sine at cycle turning points - useful as buy / sell signal in… - GETHT Trend vs Cycle Mode (HT_TRENDMODE)
/api/v1/indicators/ht_trendmode?symbol=AAPLBinary regime classifier: 1 = trending, 0 = cycling. Heuristic based on dominant cycle period (long = trend) and SineWave separation (flat sine = trend). Use… - GETLinear Regression endpoint (LINEARREG)
/api/v1/indicators/linearreg?symbol=AAPL&time_period=14Fitted endpoint of rolling linear regression over time_period close values. - GETLinear Regression Slope (LINEARREG_SLOPE)
/api/v1/indicators/linearreg_slope?symbol=AAPL&time_period=14Slope of rolling linear regression. Positive = uptrend, negative = downtrend. - GETLinear Regression Intercept (LINEARREG_INTERCEPT)
/api/v1/indicators/linearreg_intercept?symbol=AAPL&time_period=14Y-intercept of rolling linear regression. Combined with slope gives full line equation. - GETLinear Regression Angle (LINEARREG_ANGLE)
/api/v1/indicators/linearreg_angle?symbol=AAPL&time_period=14Slope expressed as angle in degrees: arctan(slope) * 180/pi. Cross-instrument comparable trend strength. - GETTime Series Forecast (TSF)
/api/v1/indicators/tsf?symbol=AAPL&time_period=14Linear regression projected one bar ahead. Differs from LINEARREG (which is the last fitted point) by one slope-step. - GETStandard Deviation (STDDEV)
/api/v1/indicators/stddev?symbol=AAPL&time_period=20Rolling sample standard deviation of close. Building block for Bollinger Bands. - GETVariance (VAR)
/api/v1/indicators/var?symbol=AAPL&time_period=20Rolling sample variance of close. Squared standard deviation. - GETZ-Score (ZSCORE)
/api/v1/indicators/zscore?symbol=AAPL&time_period=20(close - SMA) / STDDEV. Number of standard deviations close is from rolling mean. Stationary substitute for raw price in ML features. - GETRaw Return (RETURN)
/api/v1/indicators/return?symbol=AAPL&time_period=1close - close[t-time_period]. Same value as MOM but tagged statistic for portfolio / return-distribution use. - GETPercentage Return (PCT_RETURN)
/api/v1/indicators/pct_return?symbol=AAPL&time_period=1(close - close[t-n]) / close[t-n]. Decimal form, same as ROCP. Used in return-distribution analysis. - GETLog Return (LOG_RETURN)
/api/v1/indicators/log_return?symbol=AAPL&time_period=1ln(close / close[t-n]). Standard quant return - additive across periods, near-normal distribution. Building block for Sharpe / Sortino / VaR. - GETBeta vs Benchmark (BETA)
/api/v1/indicators/beta?symbol=AAPL&time_period=60Rolling beta of symbol vs benchmark (default SPY). BETA = cov(sym_returns, bench_returns) / var(bench_returns). Beta=1 = moves with benchmark, >1 = amplifies,… - GETCorrelation vs Benchmark (CORREL)
/api/v1/indicators/correl?symbol=AAPL&time_period=60Rolling Pearson correlation of symbol log-returns vs benchmark (default SPY) log-returns over time_period bars. Range -1..+1. Useful for diversification… - GETRolling MAX (MAX)
/api/v1/indicators/max?symbol=AAPLRolling max of close over time_period bars. time_period required (default 14). - GETRolling MIN (MIN)
/api/v1/indicators/min?symbol=AAPLRolling min of close over time_period bars. time_period required (default 14). - GETRolling MAX position (MAXINDEX)
/api/v1/indicators/maxindex?symbol=AAPLPosition (0..time_period-1) of max within rolling window. 0 = oldest bar in window. TA-Lib semantics. - GETRolling MIN position (MININDEX)
/api/v1/indicators/minindex?symbol=AAPLPosition (0..time_period-1) of min within rolling window. See /maxindex. - GETRolling Annualized Volatility + percentile rank (ANNVOL)
/api/v1/indicators/annvol?symbol=AAPLRolling annualized volatility from LOG returns of CLOSE prices: r_t = ln(C_t / C_{t-1}), then rolling(vol_window).std(ddof=1) * sqrt(252). Returns the current… - POSTPairwise Correlation Matrix (CORRMATRIX)
/api/v1/indicators/corrmatrixNxN pairwise Pearson correlation of LOG returns of CLOSE prices over the last window common trading days (inner-joined on shared dates). Symbols are… - GETAverage Price (AVGPRICE)
/api/v1/indicators/avgprice?symbol=AAPL(open + high + low + close) / 4. Per-bar OHLC composite. Same as /ohlc4 - exposed under both names for TA-Lib / TradingView parity. - GETMedian Price (MEDPRICE)
/api/v1/indicators/medprice?symbol=AAPL(high + low) / 2 - midpoint of intra-bar range, used as anchor for Donchian / Keltner. - GETTypical Price (TYPPRICE)
/api/v1/indicators/typprice?symbol=AAPL(high + low + close) / 3. Used internally by CCI, MFI, VWAP. Same as /hlc3. - GETWeighted Close Price (WCLPRICE)
/api/v1/indicators/wclprice?symbol=AAPL(high + low + 2*close) / 4. Doubles the close weight versus typical price; gives extra emphasis to close in trending markets. - GETHLC3
/api/v1/indicators/hlc3?symbol=AAPL(high + low + close) / 3 - TradingView naming for typical price. Aliased /typprice. - GETOHLC4
/api/v1/indicators/ohlc4?symbol=AAPL(open + high + low + close) / 4 - TradingView naming for average price. Aliased /avgprice. - GETHeikin-Ashi candles (HEIKINASHI)
/api/v1/indicators/heikinashi?symbol=AAPLHeikin-Ashi candle transform. Smoothed OHLC for trend visualization. Multi-line: ha_open/ha_high/ha_low/ha_close. time_period ignored (per-bar). - GETArc cosine (ACOS)
/api/v1/indicators/acos?symbol=AAPLarccos(close); range [0, π]; NaN for close outside [-1, 1]. - GETArc sine (ASIN)
/api/v1/indicators/asin?symbol=AAPLarcsin(close); range [-π/2, π/2]; NaN for close outside [-1, 1]. - GETArc tangent (ATAN)
/api/v1/indicators/atan?symbol=AAPLarctan(close); range (-π/2, π/2); always defined. - GETCeiling (CEIL)
/api/v1/indicators/ceil?symbol=AAPLSmallest integer >= close. - GETFloor (FLOOR)
/api/v1/indicators/floor?symbol=AAPLLargest integer <= close. - GETCosine (COS)
/api/v1/indicators/cos?symbol=AAPLcos(close); close interpreted as radians. - GETHyperbolic cosine (COSH)
/api/v1/indicators/cosh?symbol=AAPLcosh(close); inf overflow for close > ~700. - GETSine (SIN)
/api/v1/indicators/sin?symbol=AAPLsin(close); close interpreted as radians. - GETHyperbolic sine (SINH)
/api/v1/indicators/sinh?symbol=AAPLsinh(close); inf overflow for close > ~700. - GETTangent (TAN)
/api/v1/indicators/tan?symbol=AAPLtan(close); inf at close = π/2 + n*π. - GETHyperbolic tangent (TANH)
/api/v1/indicators/tanh?symbol=AAPLtanh(close); range (-1, 1); always defined. - GETExponential (EXP)
/api/v1/indicators/exp?symbol=AAPLexp(close); inf overflow for close > ~700. - GETNatural log (LN)
/api/v1/indicators/ln?symbol=AAPLln(close); NaN for close <= 0. - GETBase-10 log (LOG10)
/api/v1/indicators/log10?symbol=AAPLlog10(close); NaN for close <= 0. - GETSquare root (SQRT)
/api/v1/indicators/sqrt?symbol=AAPLsqrt(close); NaN for close < 0. - GETCandlestick patterns + support/resistance
/api/v1/indicators/patterns?symbol=AAPLDetects ~16 classic candlestick patterns (doji, hammer, engulfing, harami, morning/evening star, piercing, dark cloud, marubozu, spinning top, ...) and…
Fundamentals
- GETCross-company ranking by XBRL concept
/api/v1/fundamentals/frames/:conceptRank ALL SEC-filing companies by a single XBRL metric for a given period. Returns up to top_n companies sorted by value. Covers 2000-6000 companies per… - GETFull-text search across SEC filings
/api/v1/fundamentals/search?q=goldSearch the full text of all SEC filings via EDGAR EFTS. Supports phrases (use quotes), form type filtering, and date ranges. Returns matching companies,… - GETFriendly named line item across tickers
/api/v1/fundamentals/line-item/:name?tickers=AAPL,MSFT,NVDAFetch one financial metric by FRIENDLY name (capex, revenue, free_cash_flow, operating_cash_flow, total_assets, ...) across up to 25 tickers in a single call… - GETCompany profile
/api/v1/fundamentals/:ticker/profileCompany metadata from SEC EDGAR: SIC industry classification, filer category, fiscal year end, state of incorporation, address, phone, tickers, exchanges,… - GETKey financial metrics overview
/api/v1/fundamentals/:ticker/overviewLatest key financial metrics: revenue, net income, EPS, assets, debt, cash flow. Foreign private issuers filing 20-F / 40-F under IFRS are covered (the annual… - GETAggregated financial ratios snapshot
/api/v1/fundamentals/:ticker/ratios~26 financial ratios computed from the latest SEC XBRL filing in one call: margins, returns (ROE/ROA/ROIC), leverage, liquidity, efficiency, per-share, and… - GETIncome statement
/api/v1/fundamentals/:ticker/incomeIncome statement: revenue, gross profit, operating income, net income, EPS. Annual (10-K) or quarterly (10-Q). Foreign private issuers who file their annual… - GETBalance sheet
/api/v1/fundamentals/:ticker/balanceBalance sheet: assets, liabilities, equity, cash, debt. Foreign private issuers filing 20-F / 40-F under IFRS are covered; an annual request auto-resolves to… - GETCash flow statement
/api/v1/fundamentals/:ticker/cashflowCash flow statement: operating, investing, financing flows, capex, free cash flow. Foreign private issuers filing 20-F / 40-F under IFRS are covered; an… - GETAvailable XBRL concepts
/api/v1/fundamentals/:ticker/conceptsAll available XBRL concepts for this company. Use to discover what data is available. - GETEBITDA (direct or computed)
/api/v1/fundamentals/:ticker/ebitdaEBITDA from direct XBRL tag or computed as operating_income + depreciation. Response includes computation method and components when computed. - GETTax detail
/api/v1/fundamentals/:ticker/taxesIncome tax breakdown: current/deferred, federal/state/foreign, effective rate, deferred tax assets/liabilities. - GETLease detail
/api/v1/fundamentals/:ticker/leasesOperating lease ROU assets, liabilities, costs, payments schedule (years 1-5+). - GETShares and equity compensation
/api/v1/fundamentals/:ticker/shares-detailShares authorized/issued/outstanding, weighted average, SBC, stock options, dividends per share. - GETAsset detail
/api/v1/fundamentals/:ticker/asset-detailGoodwill, intangible assets, PPE, inventory, receivables, equity investments. - GETDebt maturity schedule
/api/v1/fundamentals/:ticker/debt-maturityLong-term debt maturities by year (1-5 and after 5), current/noncurrent split, commercial paper. - GETAd-hoc XBRL concept lookup
/api/v1/fundamentals/:ticker/xbrl?concepts=Revenues,AssetsFetch any XBRL concepts by name. Use /{ticker}/concepts to discover available names. Max 20 concepts per request. - GETLong-term concept history
/api/v1/fundamentals/:ticker/history/:conceptFull time series for a single XBRL concept - up to 37+ years of history. Use /{ticker}/concepts to discover available concept names. Optionally filter by form… - GETBank and financial institution metrics
/api/v1/fundamentals/:ticker/bank-metricsSpecialized metrics for banks and financial institutions: loan portfolio, loss provisions, deposits, net interest income/margin, capital ratios (Tier 1, CET1,… - GETSEC filing history
/api/v1/fundamentals/:ticker/filingsList of SEC filings with direct document links, newest first. Filter by form type (10-K, 10-Q, 8-K, etc.) and date range. Filings older than SEC's recent… - GETEDINET document type reference
/api/v1/edinet/doc-typesAll 42 EDINET document types with codes, names (EN/JP), and families. - GETAll EDINET-registered companies
/api/v1/edinet/companies11,000+ Japanese companies registered with EDINET. Use ?listed=true for listed companies only. - GETSearch EDINET companies
/api/v1/edinet/search?q=toyotaSearch companies by name, ticker, or EDINET code. - GETAll EDINET filings for a date
/api/v1/edinet/filings?date=2024-06-15List all filings submitted on a given date. Use ?doc_type= to filter by document type code. - GETCompany filing list
/api/v1/edinet/:ticker/filingsRecent filings for a specific company by ticker (e.g. 7203 for Toyota). - GETAnnual financial report (parsed)
/api/v1/edinet/:ticker/financialsLatest annual securities report (Doc 120) with full financials: income, balance sheet, cash flow, ratios. - GETQuarterly report (parsed)
/api/v1/edinet/:ticker/quarterlyLatest quarterly or semi-annual report (Doc 140/160) with YTD financials. - GETLarge shareholding reports
/api/v1/edinet/:ticker/holdings5%+ ownership disclosures (Doc 350/370) for a company. - GETExtraordinary reports
/api/v1/edinet/:ticker/extraordinaryMaterial event reports (Doc 180) - M&A, management changes, restructuring. - GETTender offer filings
/api/v1/edinet/:ticker/tender-offersTender offer registrations and reports (Doc 240-340). - GETInternal control report (J-SOX)
/api/v1/edinet/:ticker/internal-controlLatest J-SOX internal control evaluation (Doc 235). - GETTreasury stock (share buyback) reports
/api/v1/edinet/:ticker/treasury-stockShare buyback authorization and execution status (Doc 220). - GETParse any EDINET document
/api/v1/edinet/:ticker/document/:doc_idFetch and parse any document by its EDINET document ID. Pass doc_type for typed parsing (e.g. 120=annual, 350=holdings). An annual report carries its… - GETSugra Model Forward Estimates (own-XBRL extrapolation)
/api/v1/estimates/:ticker/modelForward fiscal-year fundamentals for a company, projected from its OWN SEC XBRL history (up to 37+ years) by transparent damped-trend extrapolation. Positive…
Corporate Registry
- GETSearch LEI records by legal name, country, and status
/api/v1/gleif/lei-searchSearch the Legal Entity Identifier registry (~3.3M entities worldwide) with optional filters on legal name, country of registered address, and entity status.… - GETPaginated list of LEI records, newest updates first
/api/v1/gleif/lei-recordsFull catalog of the ~3.3M LEI records, sorted by registration.lastUpdateDate descending. Use page_size (1-200) and page_number to page through the most… - GETFull LEI record by identifier
/api/v1/gleif/lei-records/:leiFetch a single LEI record by its 20-character ISO 17442 identifier. Returns the entity block (legal name, other names, legal address, HQ address,… - GETImmediate parent company for a given LEI
/api/v1/gleif/lei-records/:lei/direct-parentFetch the direct (immediate) parent of an entity by LEI. Direct parent is the entity that owns or controls the subject via accounting consolidation (reported… - GETTop-of-chain ultimate parent for a given LEI
/api/v1/gleif/lei-records/:lei/ultimate-parentFetch the ultimate parent (top of the ownership chain) of an entity by LEI. Ultimate parent is the entity at the top of the accounting consolidation chain.… - GETISIN codes mapped to a LEI
/api/v1/gleif/lei-records/:lei/isinsList the ISO 6166 International Securities Identification Numbers (ISINs) mapped to a LEI. Issuers file ISIN-to-LEI mappings with GLEIF to support regulatory… - GETISO 3166-1 country catalog (250 entries)
/api/v1/gleif/countriesReturn the country catalog used across LEI record jurisdictions. Each entry carries the ISO 3166-1 alpha-2 code and the English-language name. 250 entries… - GETISO 3166-2 subnational region catalog (5,046 entries)
/api/v1/gleif/regionsReturn the subnational region catalog used across LEI record addresses. Each entry carries the ISO 3166-2 code (e.g. US-CA for California, DE-BY for Bavaria)… - GETNational business registry catalog (1,071 entries)
/api/v1/gleif/registration-authoritiesReturn the registry of business-registration authorities referenced by LEI records. Each entry carries the authority code (RA000001 through RA001071), English… - GETAccredited LEI issuer catalog (40 entries)
/api/v1/gleif/lei-issuersReturn the catalog of GLEIF-accredited LEI issuers (Local Operating Units). Each entry carries the issuer's own LEI, legal name, marketing brand, portal URL,… - GETFunds managed by this LEI
/api/v1/gleif/managed-funds/:leiList fund LEIs reported as managed by the subject entity. Each fund is returned as a full LEI record with entity and registration blocks. Applies to asset… - GETFuzzy legal-name match suggestions
/api/v1/gleif/fuzzy-search?q=MicrosoftReturn fuzzy-match completions for a legal name query, each linked to its underlying LEI record. Useful for name resolution where the exact spelling is… - GETParent and child relationship graph for a LEI
/api/v1/gleif/relationships/:leiReturn a one-hop ownership graph for an entity - its direct-parent relationship record (with validity periods and corroboration), its ultimate-parent… - GETField-level modification log for a LEI record
/api/v1/gleif/audit/:leiReturn the audit trail of field-level changes applied to a LEI record (and its linked relationship records). Each entry carries the modified field (XPath…
Crypto
- GETCurrent price and market data for a cryptocurrency
/api/v1/crypto/:coin_id/priceGet current price, market cap, 24h volume, and 24h change for a single coin. coin_id uses the coin slug convention (e.g. bitcoin, ethereum, solana). Prices… - GETTop cryptocurrencies by market cap
/api/v1/crypto/marketsGet market data for top cryptocurrencies, ranked by market cap. per_page: 1-250 (default 100) order: market_cap_desc, market_cap_asc, volume_desc, volume_asc… - GETHistorical price chart data
/api/v1/crypto/:coin_id/historyGet historical price, market cap, and volume for a coin. days: 1, 7, 14, 30, 90, 180, or 365 Auto-granularity: <=1d minutely, 1-90d hourly, >90d daily - GETDetailed coin information
/api/v1/crypto/:coin_id/infoGet detailed information for a coin: description, links, genesis date, market data. - GETTrending cryptocurrencies
/api/v1/crypto/trendingGet top trending coins by search activity over the last 24 hours. Useful as a sentiment signal - what users are paying attention to right now. - GETGlobal crypto market statistics
/api/v1/crypto/globalGet global crypto market statistics: total market cap (all currencies), 24h volume, BTC/ETH dominance, and number of active coins and markets. Updated every 5… - GETList all supported coins (id, symbol, name)
/api/v1/crypto/coinsGet the full directory of supported coins. Each entry returns id (slug), symbol, and name. Use the id value as coin_id when calling other /crypto endpoints.… - GETAssets covered by the crypto derivatives endpoints
/api/v1/crypto/derivatives/assetsList the assets the /crypto/derivatives/* endpoints cover: the most traded perpetual futures (BTC, ETH, SOL, XRP, DOGE). Each accepts its symbol or its coin… - GETCurrent perpetual funding rate for a crypto asset
/api/v1/crypto/derivatives/:asset/fundingCurrent funding rate of the asset's perpetual futures, normalized to an 8-hour period and weighted by each venue's open interest. A positive rate means long… - GETHistorical perpetual funding rate for a crypto asset
/api/v1/crypto/derivatives/:asset/funding/historyFunding rate history of the asset's perpetual futures, from the venues that publish an hourly funding rate. That is fewer venues than the current funding rate… - GETCurrent perpetual open interest for a crypto asset
/api/v1/crypto/derivatives/:asset/open-interestCurrent open interest of the asset's perpetual futures in USD, summed across venues: the value of all positions still open. Refreshes every 2 minutes. - GETHistorical perpetual open interest for a crypto asset
/api/v1/crypto/derivatives/:asset/open-interest/historyOpen interest history of the asset's perpetual futures in USD. Covers fewer venues than the current value: only those that publish a USD history. A reading is… - GETLong/short account ratio for a crypto asset
/api/v1/crypto/derivatives/:asset/long-shortLong/short account ratio of the asset's perpetual futures: the share of accounts holding a net long position against those holding a net short one, averaged… - GETPerpetual mark price and index price for a crypto asset
/api/v1/crypto/derivatives/:asset/mark-priceMark price of the asset's perpetual futures (the price positions are valued and liquidated at), weighted by open interest across venues, beside the spot index…
Showing 300 of 400 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://sugra.ai- Authentication
- An API key in the x-api-key header
- Operations
- 1671 operations on 1671 pathsGET 1656POST 15
10 marked deprecated - Main resources
- Central Banks & Monetary 274Statistical Agencies 233Environment 142Finance 125Technical Indicators 113Global Economy & Trade 105Hedge Fund Intelligence 67Public Finance & Government 66Sugra NetAtlas 65Digital Economy and Infrastructure 56
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1.0.1 - Links
- Documentation · OpenAPI document · Support
- Listed from
- Sugra's published OpenAPI description
How to test the Sugra API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Sugra API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the x-api-key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Map identifiers to FIGIs” (POST /api/v1/openfigi/mapping), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Sugra API?
Sugra API gives your code direct access to Sugra Data with one key. Sugra Data is the data service behind both products, Sugra API and Sugra MCP: equities,… It is listed under Finance & banking and has 1671 endpoints.
Who publishes the Sugra API?
It is listed from Sugra's public API description (an OpenAPI document), not published by Sugra on Swastik Codes. Anyone who controls sugra.ai can claim the profile by adding a DNS TXT record.
What is the base URL of the Sugra API?
Requests go to https://sugra.ai. Endpoint paths are added to this base URL.
How do I authenticate with the Sugra API?
With an API key in the x-api-key header.
How many endpoints does the Sugra API have?
1671 operations on 1671 paths (1656 GET, 15 POST). The largest groups are Central Banks & Monetary, Statistical Agencies, Environment, Finance. This listing's collection holds the first 400.
Is forking the Sugra API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.