Equity Rank Market API

openapi: 3.2.0
info:
  title: Equity Rank Com Market API
  version: 0.1.0
  description: 'Operations tagged market 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: Market
paths:
  /api/market/pulse:
    get:
      tags:
      - Market
      summary: Get Market Pulse
      description: 'Real-time market pulse using ETF proxies. Route-level 2-min cache so the

        dashboard bar doesn''t hammer AlphaVantage on every page load.

        Returns symbol, display label, price, absolute change, and percent change.'
      operationId: get_market_pulse_api_market_pulse_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  additionalProperties: true
                  type: object
                type: array
                title: Response Get Market Pulse Api Market Pulse Get
  /api/market/sectors:
    get:
      tags:
      - Market
      summary: Get Sector Performance
      description: 'Sector ETF performance. Route-level 3-min cache — sector rotation is

        a multi-day story, sub-minute freshness isn''t meaningful.'
      operationId: get_sector_performance_api_market_sectors_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  additionalProperties: true
                  type: object
                type: array
                title: Response Get Sector Performance Api Market Sectors Get
  /api/market/quotes:
    get:
      tags:
      - Market
      summary: Get Quotes
      description: 'Batch stock quotes for watchlist. Cached 30 seconds.

        Includes company_name from screener_cache when available.'
      operationId: get_quotes_api_market_quotes_get
      parameters:
      - name: symbols
        in: query
        required: true
        schema:
          type: string
          description: Comma-separated ticker symbols, max 20
          title: Symbols
        description: Comma-separated ticker symbols, max 20
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
                title: Response Get Quotes Api Market Quotes Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/market/commodities:
    get:
      tags:
      - Market
      summary: Get Commodity Spot
      description: 'Current spot prices for Gold, Silver, WTI, Brent, Copper, Natural Gas.

        Sourced via yfinance futures (GC=F, SI=F, CL=F, BZ=F, HG=F, NG=F). 5-min cache.'
      operationId: get_commodity_spot_api_market_commodities_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Get Commodity Spot Api Market Commodities Get
  /api/market/commodities/forecast:
    get:
      tags:
      - Market
      summary: Get Commodity Forecast
      description: 'Multi-factor macro model forecasts (bear / base / bull) for all commodities

        at 1M, 3M, and 6M horizons. GARCH vol bands. 4-hour cache — computation

        fetches ~500 days of history across 11 symbols and runs OLS + GARCH.

        Educational only — not investment advice.'
      operationId: get_commodity_forecast_api_market_commodities_forecast_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Get Commodity Forecast Api Market Commodities Forecast Get
  /api/market/commodities/history/{commodity}:
    get:
      tags:
      - Market
      summary: Get Commodity History
      description: 'Daily OHLCV for one commodity (GC=F futures proxy). Used for price chart.

        commodity: GOLD | SILVER | WTI | BRENT | COPPER | NATURAL_GAS | ALUMINUM, or any

        stored-only name in commodity_markets_service.COMMODITY_CATALOGUE (DB fallback).'
      operationId: get_commodity_history_api_market_commodities_history__commodity__get
      parameters:
      - name: commodity
        in: path
        required: true
        schema:
          type: string
          title: Commodity
      - name: days
        in: query
        required: false
        schema:
          type: integer
          maximum: 730
          minimum: 30
          default: 365
          title: Days
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
                title: Response Get Commodity History Api Market Commodities History  Commodity  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/market/commodities/carry:
    get:
      tags:
      - Market
      summary: Get Commodity Carry
      description: 'Latest futures-curve carry / term-structure signal per commodity

        (WTI, Natural Gas) from the front four Yahoo per-contract futures: roll

        yield, slope, z-score and backwardation / contango / flat regime. Refreshed

        daily by the Supabase-native pg_cron job (migration 062).

        Backwardation = positive carry. Informational only — not investment advice.

        30-min cache.'
      operationId: get_commodity_carry_api_market_commodities_carry_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Get Commodity Carry Api Market Commodities Carry Get
  /api/market/commodities/overview:
    get:
      tags:
      - Market
      summary: Get Commodities Overview
      description: 'Every tracked commodity (energy, precious and industrial metals, grains, US steel)

        with last close, 1m / 1y change, 5-year average / low / high, where today''s price

        sits in its own 5-year range, and futures-curve shape where tracked; plus four

        standard ratios. Read from Supabase functions maintained by pg_cron (migration 257).

        Informational only — feeds no score. 30-min cache.'
      operationId: get_commodities_overview_api_market_commodities_overview_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Get Commodities Overview Api Market Commodities Overview Get
  /api/market/commodities/{commodity}/linked-stocks:
    get:
      tags:
      - Market
      summary: Get Commodity Linked Stocks
      description: 'Listed stocks in the industries tied to one commodity, ranked by how closely their

        weekly returns have moved with it over the last 104 weeks (correlation + beta), with

        a per-industry summary. Equity Rank score and price-vs-value are included only for

        an active subscription (same gate as the full screener); everyone else gets the

        price-derived linkage only. Refreshed weekly in Supabase (migration 257).'
      operationId: get_commodity_linked_stocks_api_market_commodities__commodity__linked_stocks_get
      parameters:
      - name: commodity
        in: path
        required: true
        schema:
          type: string
          title: Commodity
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Commodity Linked Stocks Api Market Commodities  Commodity  Linked Stocks 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