S&P Global · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LLM-ready Market Cap API

2 actions 2 updates phrasing extends openapi/sp-global-market-cap-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for S&P Global's API. It is a proposal applied on top of the contract, not a document S&P Global publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/api/v1/market_cap/{company_id}/{start_date}/{end_date}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for LLM-ready Market Cap API
  version: 1.0.0
extends: openapi/sp-global-market-cap-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/api/v1/market_cap/{company_id}/{start_date}/{end_date}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's market cap history
      effect: read
      questions:
      - What was a company's market capitalization over the past year?
      - Can I get total enterprise value and shares outstanding by date?
      instructions:
      - text: Get market caps for company {company_id} from {start_date} to {end_date}.
        slots:
          company_id: path.company_id
          start_date: path.start_date
          end_date: path.end_date
      - text: Show market cap, TEV and shares outstanding for company {company_id} between {start_date} and {end_date}.
        slots:
          company_id: path.company_id
          start_date: path.start_date
          end_date: path.end_date
      method: generated
      generated: '2026-10-01'