S&P Global · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LLM-ready Earnings API

3 actions 3 updates phrasing extends openapi/sp-global-earnings-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 3

$.info
$.paths['/api/v1/earnings/{company_id}'].get
$.paths['/api/v1/earnings/{company_id}/dates'].get

OpenAPI Overlay

Raw ↑
# 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 Earnings API
  version: 1.0.0
extends: openapi/sp-global-earnings-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: 2
- target: $.paths['/api/v1/earnings/{company_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's earnings calls
      effect: read
      questions:
      - Which earnings calls has a company held, and which are coming up?
      - Where do I get the key dev ID needed to pull an earnings call transcript?
      instructions:
      - text: List the earnings calls, with names and key dev IDs, for company {company_id}.
        slots:
          company_id: path.company_id
      - text: Show past and upcoming earnings call details for company {company_id}.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/earnings/{company_id}/dates'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the dates of a company's earnings calls
      effect: read
      questions:
      - When are a company's earnings calls scheduled, in UTC?
      - Can I get just the dates and times of earnings calls without other details?
      instructions:
      - text: Get the earnings call dates for company {company_id}.
        slots:
          company_id: path.company_id
      - text: List only the UTC datetimes of company {company_id}'s earnings calls.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'