# 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 Ticker Groups API
  version: 1.0.0
extends: openapi/sp-global-ticker-groups-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: 7
- target: $.paths['/api/v1/ticker_groups/exchange/{exchange_code}'].get
  update:
    x-apievangelist-phrasing:
      intent: List tickers traded on an exchange
      effect: read
      questions:
      - Which tickers trade on the NYSE?
      - Can I get every ticker listed on a particular exchange code?
      instructions:
      - text: List tickers traded on exchange {exchange_code}.
        slots:
          exchange_code: path.exchange_code
      - text: Get all ticker symbols on exchange {exchange_code}.
        slots:
          exchange_code: path.exchange_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/ticker_groups/filters/geo/{iso_code}/{state}/simple/{simple_industry}/exchange/{exchange_code}'].get
  update:
    x-apievangelist-phrasing:
      intent: Screen tickers by country, state, industry and exchange
      effect: read
      questions:
      - Can I find software tickers on NASDAQ for companies based in California?
      - How do I combine location, industry and exchange filters to screen tickers?
      instructions:
      - text: List tickers in {iso_code} state {state}, industry {simple_industry}, trading on {exchange_code}.
        slots:
          iso_code: path.iso_code
          state: path.state
          simple_industry: path.simple_industry
          exchange_code: path.exchange_code
      - text: Screen for {simple_industry} tickers on {exchange_code} from companies in {state}, {iso_code}.
        slots:
          simple_industry: path.simple_industry
          exchange_code: path.exchange_code
          state: path.state
          iso_code: path.iso_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/ticker_groups/geo/country/{iso_code}'].get
  update:
    x-apievangelist-phrasing:
      intent: List tickers of companies in a country
      effect: read
      questions:
      - Which tickers belong to companies based in France?
      - Can I list every ticker for a country using its ISO code?
      instructions:
      - text: List tickers for companies based in country {iso_code}.
        slots:
          iso_code: path.iso_code
      - text: Get all tickers headquartered in {iso_code}, nationwide.
        slots:
          iso_code: path.iso_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/ticker_groups/geo/country/{iso_code}/{state}'].get
  update:
    x-apievangelist-phrasing:
      intent: List tickers of companies in a state or province
      effect: read
      questions:
      - Which tickers are for companies based in Texas?
      - Can I narrow tickers down to a single province within a country?
      instructions:
      - text: List tickers for companies in state {state} of {iso_code}.
        slots:
          state: path.state
          iso_code: path.iso_code
      - text: Get tickers for businesses located in subdivision {state}, country {iso_code}.
        slots:
          state: path.state
          iso_code: path.iso_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/ticker_groups/industry/{industry_classification}/{industry_code}'].get
  update:
    x-apievangelist-phrasing:
      intent: List tickers by an industry classification code
      effect: read
      questions:
      - Which tickers fall under a given NAICS code?
      - Can I get tickers with their ID triples for a code in a chosen classification system?
      instructions:
      - text: List tickers with {industry_classification} code {industry_code}.
        slots:
          industry_classification: path.industry_classification
          industry_code: path.industry_code
      - text: Get ticker ID triples classified as {industry_code} under {industry_classification}.
        slots:
          industry_code: path.industry_code
          industry_classification: path.industry_classification
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/ticker_groups/industry/gics/{gics_code}'].get
  update:
    x-apievangelist-phrasing:
      intent: List tickers in a GICS sector or industry
      effect: read
      questions:
      - What tickers are in the GICS Energy sector?
      - Can I list tickers for an 8-digit GICS sub-industry?
      instructions:
      - text: List tickers with GICS code {gics_code}.
        slots:
          gics_code: path.gics_code
      - text: Get the ticker triples classified under GICS {gics_code}.
        slots:
          gics_code: path.gics_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/ticker_groups/industry/simple/{simple_industry}'].get
  update:
    x-apievangelist-phrasing:
      intent: List tickers in a simple industry
      effect: read
      questions:
      - What tickers are in the Biotechnology industry?
      - How do I get tradable tickers by plain-language industry name?
      instructions:
      - text: List tickers in the {simple_industry} industry.
        slots:
          simple_industry: path.simple_industry
      - text: Get ticker IDs for all {simple_industry} companies.
        slots:
          simple_industry: path.simple_industry
      method: generated
      generated: '2026-10-01'