Equity Rank Stocks API

openapi: 3.2.0
info:
  title: Equity Rank Com Stocks API
  version: 0.1.0
  description: 'Operations tagged stocks across 2 of this provider''s published API definitions: openapi.json, equity-rank-com-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Stocks
paths:
  /api/stocks/search:
    get:
      tags:
      - Stocks
      summary: Search Symbols
      description: 'Search for stocks by ticker symbol or company name.


        Returns up to 10 Common Stock / ETP matches from AlphaVantage SYMBOL_SEARCH, ordered with

        exact ticker matches first. No subscription required — this is a

        discovery endpoint used by the search-as-you-type input.


        `sector` is set when the query names a sector or industry ("mining stocks",

        "semis", "regional banks"): {label, total, results}, largest companies

        first, from screener_cache. It is null otherwise. `results` is unchanged.'
      operationId: search_symbols_api_stocks_search_get
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 50
          description: Ticker or company name
          default: ''
          title: Q
        description: Ticker or company name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Search Symbols Api Stocks Search Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/stocks/{symbol}/snapshot:
    get:
      tags:
      - Stocks
      summary: Get Stock Snapshot
      description: 'Lightweight: price + score only, no full analysis detail.

        No auth required — used by the Portfolio Tracker for batch refreshes.'
      operationId: get_stock_snapshot_api_stocks__symbol__snapshot_get
      parameters:
      - name: symbol
        in: path
        required: true
        schema:
          type: string
          description: US equity ticker, e.g. AAPL
          title: Symbol
        description: US equity ticker, e.g. AAPL
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Stock Snapshot Api Stocks  Symbol  Snapshot Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/stocks/{symbol}/sentiment:
    get:
      tags:
      - Stocks
      summary: Get Stock Sentiment
      description: 'Returns employee sentiment for a stock, synthesized from Reddit and Glassdoor.

        Requires an active or trialing Stripe subscription.

        Results cached 24h.'
      operationId: get_stock_sentiment_api_stocks__symbol__sentiment_get
      security:
      - HTTPBearer: []
      parameters:
      - name: symbol
        in: path
        required: true
        schema:
          type: string
          description: US equity ticker, e.g. AAPL
          title: Symbol
        description: US equity ticker, e.g. AAPL
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Stock Sentiment Api Stocks  Symbol  Sentiment Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/stocks/{symbol}/ai-disruption:
    get:
      tags:
      - Stocks
      summary: Get Stock Ai Disruption
      description: 'Returns the LLM-generated AI disruption exposure for a stock.


        Regenerated quarterly at each company''s earnings. If no LLM row exists yet,

        returns a minimal payload with only the rule-based fallback score and a

        source flag so the client can show a "pending first refresh" placeholder.

        Informational only, not investment advice.'
      operationId: get_stock_ai_disruption_api_stocks__symbol__ai_disruption_get
      security:
      - HTTPBearer: []
      parameters:
      - name: symbol
        in: path
        required: true
        schema:
          type: string
          description: US equity ticker, e.g. AAPL
          title: Symbol
        description: US equity ticker, e.g. AAPL
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Stock Ai Disruption Api Stocks  Symbol  Ai Disruption Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/stocks/{symbol}/save:
    post:
      tags:
      - Stocks
      summary: Run Save Analysis
      description: 'Run SAVE (Sentiment-Adjusted Valuation Engine) analysis for a stock.

        Makes 5 real-time web searches via Claude Sonnet + 1 scoring pass.

        Results stored in save_history for prospective backtesting.


        Query param `as_of` (YYYY-MM-DD): frame queries historically for backtesting.

        Query param `force` (bool): skip the 6-hour staleness cache and always re-run.'
      operationId: run_save_analysis_api_stocks__symbol__save_post
      security:
      - HTTPBearer: []
      parameters:
      - name: symbol
        in: path
        required: true
        schema:
          type: string
          title: Symbol
      - name: as_of
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: As Of
      - name: force
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Force
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Run Save Analysis Api Stocks  Symbol  Save Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/stocks/{symbol}/save/history:
    get:
      tags:
      - Stocks
      summary: Get Save History
      description: 'Return historical SAVE scores for charting.

        Use `timeframe` for preset windows (1w/1m/3m/1y/3y/5y/all) or

        `days` for an exact day count. `timeframe` takes precedence when provided.'
      operationId: get_save_history_api_stocks__symbol__save_history_get
      security:
      - HTTPBearer: []
      parameters:
      - name: symbol
        in: path
        required: true
        schema:
          type: string
          title: Symbol
      - name: days
        in: query
        required: false
        schema:
          type: integer
          default: 90
          title: Days
      - name: timeframe
        in: query
        required: false
        schema:
          type: string
          description: 'Preset window: 1w | 1m | 3m | 1y | 3y | 5y | all'
          default: 3m
          title: Timeframe
        description: 'Preset window: 1w | 1m | 3m | 1y | 3y | 5y | all'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Save History Api Stocks  Symbol  Save History Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/stocks/{symbol}/social-attention:
    get:
      tags:
      - Stocks
      summary: Get Social Attention
      description: 'Measured crowd attention for the SAVE tab: Reddit mentions (ApeWisdom),

        Wikipedia page views, StockTwits posts and author tags. Read-only from

        social_attention_daily; display only, feeds no score.'
      operationId: get_social_attention_api_stocks__symbol__social_attention_get
      security:
      - HTTPBearer: []
      parameters:
      - name: symbol
        in: path
        required: true
        schema:
          type: string
          title: Symbol
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Social Attention Api Stocks  Symbol  Social Attention Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/stocks/{symbol}/candles:
    get:
      tags:
      - Stocks
      summary: Get Stock Candles
      description: 'Return OHLCV candlestick data for the PriceChart widget.

        Primary source: AlphaVantage TIME_SERIES_DAILY.

        Response shape: {s, t, o, h, l, c, v} (standard OHLCV format), plus an

        optional `benchmark` object ({symbol, t, c}) when `benchmark=SPY|SECTOR`

        is requested — served from a dedicated cache slot (see `_fetch_benchmark_series`).

        When the benchmark can''t be resolved, `benchmark` is null and

        `benchmark_reason` explains why — never a 500.

        No subscription required — chart is shown in the free modal header.'
      operationId: get_stock_candles_api_stocks__symbol__candles_get
      parameters:
      - name: symbol
        in: path
        required: true
        schema:
          type: string
          description: US equity ticker, e.g. AAPL
          title: Symbol
        description: US equity ticker, e.g. AAPL
      - name: resolution
        in: query
        required: false
        schema:
          type: string
          description: Bar resolution (D = daily)
          default: D
          title: Resolution
        description: Bar resolution (D = daily)
      - name: from
        in: query
        required: true
        schema:
          type: integer
          description: Start timestamp (Unix seconds)
          title: From
        description: Start timestamp (Unix seconds)
      - name: to
        in: query
        required: true
        schema:
          type: integer
          description: End timestamp (Unix seconds)
          title: To
        description: End timestamp (Unix seconds)
      - name: benchmark
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^(SPY|SECTOR)$
          - type: 'null'
          description: 'Optional chart overlay: SPY, or SECTOR (resolved from screener_cache)'
          title: Benchmark
        description: 'Optional chart overlay: SPY, or SECTOR (resolved from screener_cache)'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Stock Candles Api Stocks  Symbol  Candles Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/stocks/{symbol}:
    get:
      tags:
      - Stocks
      summary: Get Stock Analysis
      description: 'Returns full EquityRank analysis for a single ticker.

        Requires an active/trialing subscription — OR, when the no-card free tier

        is live, a free-plan account within its 3-distinct-symbols/month quota

        (this is the metering ANCHOR for the stock page).'
      operationId: get_stock_analysis_api_stocks__symbol__get
      security:
      - HTTPBearer: []
      parameters:
      - name: symbol
        in: path
        required: true
        schema:
          type: string
          title: Symbol
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Stock Analysis Api Stocks  Symbol  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- equity-rank-com-openapi.yml