S&P Global · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LLM-ready ID API

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

$.info
$.paths['/api/v1/id/{cusip}'].get
$.paths['/api/v1/id/{isin}'].get
$.paths['/api/v1/id/{ticker}'].get
$.paths['/api/v1/id/{ticker}/exchange_code/{exchange_code}'].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 ID API
  version: 1.0.0
extends: openapi/sp-global-id-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: 4
- target: $.paths['/api/v1/id/{cusip}'].get
  update:
    x-apievangelist-phrasing:
      intent: Resolve a CUSIP to company and security IDs
      effect: read
      questions:
      - How do I turn a CUSIP into a company ID, security ID and trading item ID?
      - Which company does this CUSIP belong to?
      instructions:
      - text: Resolve CUSIP {cusip} to its identification triple.
        slots:
          cusip: path.cusip
      - text: Find the company, security and trading item for CUSIP {cusip}.
        slots:
          cusip: path.cusip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/id/{isin}'].get
  update:
    x-apievangelist-phrasing:
      intent: Resolve an ISIN to company and security IDs
      effect: read
      questions:
      - Can I map an ISIN to S&P company, security and trading item IDs?
      - Which company issued the security with this ISIN?
      instructions:
      - text: Resolve ISIN {isin} to its identification triple.
        slots:
          isin: path.isin
      - text: Find the company and trading item behind ISIN {isin}.
        slots:
          isin: path.isin
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/id/{ticker}'].get
  update:
    x-apievangelist-phrasing:
      intent: Resolve a ticker symbol to company IDs
      effect: read
      questions:
      - What company ID corresponds to the ticker AAPL?
      - Can I look up IDs from a ticker without specifying an exchange?
      instructions:
      - text: Resolve ticker {ticker} to its company, security and trading item IDs.
        slots:
          ticker: path.ticker
      - text: Get the most likely company ID for ticker symbol {ticker}.
        slots:
          ticker: path.ticker
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/id/{ticker}/exchange_code/{exchange_code}'].get
  update:
    x-apievangelist-phrasing:
      intent: Resolve a ticker on a specific exchange to IDs
      effect: read
      questions:
      - How do I disambiguate a ticker that trades on more than one exchange?
      - Can I resolve a ticker scoped to a particular exchange code?
      instructions:
      - text: Resolve ticker {ticker} on exchange {exchange_code} to its identification triple.
        slots:
          ticker: path.ticker
          exchange_code: path.exchange_code
      - text: Find the trading item for {ticker} listed on {exchange_code}.
        slots:
          ticker: path.ticker
          exchange_code: path.exchange_code
      method: generated
      generated: '2026-10-01'