{"openapi": "3.1.0", "info": {"title": "Sharemaestro Market Research API", "version": "1.0.0", "description": "Public JSON API for Sharemaestro weekly market research outputs. Educational and research use only."}, "servers": [{"url": "https://sharemaestro.com/api/"}], "x-sharemaestro-docs": "https://sharemaestro.com/api/docs/", "x-sharemaestro-rate-limit": {"requests": 240, "window_seconds": 60, "scope": "per client across public API endpoints", "headers": ["X-RateLimit-Limit", "X-RateLimit-Window", "X-RateLimit-Remaining", "Retry-After"]}, "x-sharemaestro-endpoint-groups": [{"group": "Discovery", "summary": "Entry points, schema, search, and machine-readable API metadata.", "endpoints": [{"label": "API index", "method": "GET", "url": "https://sharemaestro.com/api/", "cadence": "Live", "description": "Public API overview, terms, endpoint families, and usage boundaries."}, {"label": "API docs", "method": "GET", "url": "https://sharemaestro.com/api/docs/", "cadence": "Live", "description": "Human-readable API guide."}, {"label": "OpenAPI schema", "method": "GET", "url": "https://sharemaestro.com/api/schema/", "cadence": "Live", "description": "Machine-readable schema for the central API."}, {"label": "Search", "method": "GET", "url": "https://sharemaestro.com/api/search/?q=AAPL", "cadence": "Live", "description": "Search active traditional tickers and crypto assets."}]}, {"group": "Ticker Research", "summary": "Weekly chart data and top-level research outputs for active instruments.", "endpoints": [{"label": "Ticker detail", "method": "GET", "url": "https://sharemaestro.com/api/tickers/%7Buuid%7D/", "cadence": "Weekly", "description": "Ticker metadata, OHLCV, public signals, chart summary, and key points."}, {"label": "Equity report", "method": "GET", "url": "https://sharemaestro.com/terminal/%7Buuid%7D/report/api/", "cadence": "Weekly", "description": "Equity-only weekly report payload covering price, volume, signals, peers, sector/industry context, risk, and watch points."}, {"label": "Market news archive", "method": "GET", "url": "https://sharemaestro.com/news/", "cadence": "Hourly", "description": "Published Sharemaestro market research articles for US equities."}, {"label": "Market news RSS", "method": "GET", "url": "https://sharemaestro.com/news/feed/", "cadence": "Hourly", "description": "RSS feed for published market news articles."}, {"label": "Market news API", "method": "GET", "url": "https://sharemaestro.com/api/news/", "cadence": "Hourly", "description": "Published Sharemaestro market research article summaries, source URLs, ticker context, and feed links."}, {"label": "Market news article API", "method": "GET", "url": "https://sharemaestro.com/api/news/%7Bslug%7D/", "cadence": "Hourly", "description": "Single published article payload with body sections, key points, source links, ticker context, signals, and supporting research links."}]}, {"group": "Market Structure", "summary": "Country, sector, industry, and global market structure built from supported equities.", "endpoints": [{"label": "Country structure", "method": "GET", "url": "https://sharemaestro.com/api/structure/", "cadence": "Weekly", "description": "Country index summaries and links."}, {"label": "Country detail", "method": "GET", "url": "https://sharemaestro.com/api/structure/%7Bcountry_code%7D/", "cadence": "Weekly", "description": "Country index, leading sectors, leading industries, and chart data."}, {"label": "Sector detail", "method": "GET", "url": "https://sharemaestro.com/api/structure/%7Bcountry_code%7D/%7Bsector_slug%7D/", "cadence": "Weekly", "description": "Sector index, industry drilldowns, constituents, and chart data."}, {"label": "Industry detail", "method": "GET", "url": "https://sharemaestro.com/api/structure/%7Bcountry_code%7D/%7Bsector_slug%7D/%7Bindustry_slug%7D/", "cadence": "Weekly", "description": "Industry index, constituents, and chart data."}, {"label": "Global structure", "method": "GET", "url": "https://sharemaestro.com/api/global/", "cadence": "Weekly", "description": "SM Global Market Index, global sectors, global industries, and breadth."}, {"label": "Global search", "method": "GET", "url": "https://sharemaestro.com/api/global/search/?q=technology", "cadence": "Weekly", "description": "Search global sector and industry indexes."}]}, {"group": "Market Apps", "summary": "High-level market dashboards across crypto, commodities, indexes, radar, and prediction markets.", "endpoints": [{"label": "Crypto API", "method": "GET", "url": "https://sharemaestro.com/crypto/api/", "cadence": "Intraday/Daily", "description": "Crypto endpoint discovery, market index, assets, and search."}, {"label": "Commodities API", "method": "GET", "url": "https://sharemaestro.com/commodities/api/", "cadence": "Intraday/Daily", "description": "Commodity market overview, groups, assets, and search."}, {"label": "Indexes API", "method": "GET", "url": "https://sharemaestro.com/indexes/api/", "cadence": "Intraday/Daily", "description": "Major index market data and SM Global Index payloads."}, {"label": "Prediction markets", "method": "GET", "url": "https://sharemaestro.com/predictions/api/", "cadence": "Hourly", "description": "Prediction market dashboard, themes, and active market snapshots."}, {"label": "Market radar", "method": "GET", "url": "https://sharemaestro.com/market-radar/api/", "cadence": "Hourly", "description": "Global and country market radar sections."}]}, {"group": "ETF Radar", "summary": "ETF market, country, category, list, and detail endpoints.", "endpoints": [{"label": "ETF dashboard", "method": "GET", "url": "https://sharemaestro.com/etfs/api/", "cadence": "Weekly", "description": "ETF breadth, rotation, opportunities, risk, volume, and categories."}, {"label": "ETF country", "method": "GET", "url": "https://sharemaestro.com/etfs/%7Bcountry%7D/api/", "cadence": "Weekly", "description": "Country ETF radar and local lists."}, {"label": "ETF list", "method": "GET", "url": "https://sharemaestro.com/etfs/lists/%7Blist_key%7D/api/", "cadence": "Weekly", "description": "Ranked ETF lists such as opportunities, volume surges, breakouts, and risk watch."}, {"label": "ETF category", "method": "GET", "url": "https://sharemaestro.com/etfs/categories/%7Bcategory_slug%7D/api/", "cadence": "Weekly", "description": "Category constituents ranked by ETF radar score."}, {"label": "ETF detail", "method": "GET", "url": "https://sharemaestro.com/etfs/%7Bcountry%7D/%7Bexchange%7D/%7Bsymbol%7D/api/", "cadence": "Weekly", "description": "ETF summary, category peers, signals, risk, opportunity, and chart links."}]}, {"group": "Equity Research Apps", "summary": "Factor, quality, dividend, smart-money, and patient-capital research outputs.", "endpoints": [{"label": "Factors API", "method": "GET", "url": "https://sharemaestro.com/factors/api/", "cadence": "Weekly", "description": "Factor endpoint discovery, schema, universes, factors, presets, strategies, sectors, and ticker payloads."}, {"label": "SVQF API", "method": "GET", "url": "https://sharemaestro.com/svqf/api/", "cadence": "Weekly", "description": "Shareholder-value quality framework metadata, exchanges, screeners, sectors, runs, and ticker payloads."}, {"label": "Smart Money API", "method": "GET", "url": "https://sharemaestro.com/smart-money/api/", "cadence": "Weekly", "description": "Smart Money dashboard and ticker signal payloads."}, {"label": "Dividend Compounders API", "method": "GET", "url": "https://sharemaestro.com/dividend-compounders/api/", "cadence": "Weekly", "description": "Dividend reliability, sustainability, quality, valuation, and trend research."}, {"label": "Patient Capital API", "method": "GET", "url": "https://sharemaestro.com/patient-capital/api/", "cadence": "Weekly", "description": "Long-horizon equity candidates with patient-capital style ranking and screen context."}]}, {"group": "Signals and Screeners", "summary": "Public screeners and event filters for discovery workflows.", "endpoints": [{"label": "Signal filters", "method": "GET", "url": "https://sharemaestro.com/filters/api/", "cadence": "Weekly", "description": "Event-week filters for trend, dynamics, fair value, SMI, ROC, and confluence views."}, {"label": "CSI sectors", "method": "GET", "url": "https://sharemaestro.com/csiscreener/api/sectors/", "cadence": "Weekly", "description": "CSI screener sector options and related metadata."}, {"label": "CSI industries", "method": "GET", "url": "https://sharemaestro.com/csiscreener/api/industries/", "cadence": "Weekly", "description": "CSI screener industry options and related metadata."}]}], "x-sharemaestro-boundaries": ["Public payloads expose research outputs and plain-language terms, not private formulas or calculation internals.", "Use the values as educational market research, not investment, legal, tax, or trading advice.", "Market data may be delayed, adjusted, incomplete, or revised after vendor updates.", "Please cache responsibly and identify heavy integrations before scaling traffic."], "paths": {"/": {"get": {"summary": "API discovery", "responses": {"200": {"description": "API terms, endpoints, and disclaimer."}}}}, "/search/": {"get": {"summary": "Search active tickers by symbol or company name", "parameters": [{"name": "q", "in": "query", "required": true, "schema": {"type": "string"}, "description": "Ticker symbol or company name search term."}], "responses": {"200": {"description": "Ranked ticker search results."}}}}, "/tickers/{uuid}/": {"get": {"summary": "Ticker weekly chart data and research summary", "parameters": [{"name": "uuid", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "Ticker metadata, latest 156 weeks of OHLCV, Trend Line, Trend Signal, Activity Lines, Relative Strength, Rate of Change, Fair Value, Market Dynamics, Expectation, summary, and links."}}}}, "/news/": {"get": {"summary": "Published Sharemaestro market news articles", "parameters": [{"name": "limit", "in": "query", "required": false, "schema": {"type": "integer", "minimum": 1, "maximum": 100}, "description": "Maximum number of published articles to return. Defaults to 25."}], "responses": {"200": {"description": "Published news article summaries, source URLs, feed links, ticker context, and supporting research links."}}}}, "/news/{slug}/": {"get": {"summary": "Published Sharemaestro market news article detail", "parameters": [{"name": "slug", "in": "path", "required": true, "schema": {"type": "string"}, "description": "Published news article slug."}], "responses": {"200": {"description": "Single article body, key points, chart notes, source URLs, ticker context, signals, and supporting links."}}}}, "/structure/": {"get": {"summary": "Country market structure indexes", "responses": {"200": {"description": "Country index summaries and links."}}}}, "/structure/{country_code}/": {"get": {"summary": "Country sector and industry market structure", "responses": {"200": {"description": "Country index, leading sectors, leading industries, and summary."}}}}, "/structure/{country_code}/{sector_slug}/": {"get": {"summary": "Sector market structure", "responses": {"200": {"description": "Sector index, industry drilldowns, constituents, chart data, and summary."}}}}, "/structure/{country_code}/{sector_slug}/{industry_slug}/": {"get": {"summary": "Industry market structure", "responses": {"200": {"description": "Industry index, constituents, chart data, and summary."}}}}, "/global/": {"get": {"summary": "SM Global Market Index and global structure", "responses": {"200": {"description": "Global index, leading sectors, leading industries, chart data, and summary."}}}}, "/global/sectors/{sector_slug}/": {"get": {"summary": "Global sector structure", "responses": {"200": {"description": "Global sector index, industry drilldowns, constituents, chart data, and summary."}}}}, "/global/sectors/{sector_slug}/{industry_slug}/": {"get": {"summary": "Global industry structure", "responses": {"200": {"description": "Global industry index, constituents, chart data, and summary."}}}}, "/global/search/": {"get": {"summary": "Search global sectors and industries", "responses": {"200": {"description": "Matching global sector and industry indexes."}}}}}, "x-sharemaestro-terms": {"weekly_close": "Adjusted weekly close price.", "trend_line": "Primary long-term trend reference displayed on Sharemaestro charts.", "trend_signal": "Binary trend condition shown as 0 or 1.", "activity_lines": "Shorter-horizon activity references displayed on charts.", "relative_strength": "Benchmark-relative performance.", "rate_of_change": "Trend Line rate of change.", "fair_value": "Rolling fair value reference.", "market_dynamics": "Proprietary market behaviour indicator.", "expectation": "Directional probability reading derived from current market and indicator state."}}