# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twelvedata Reference Data API
  version: 1.0.0
extends: openapi/twelvedata-reference-data-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: 19
- target: $.paths['/bonds'].get
  update:
    x-apievangelist-phrasing:
      intent: List available bonds
      effect: read
      questions:
      - Which bonds and fixed income instruments are available?
      - Can I filter the bond list by country?
      instructions:
      - text: List available bonds.
      - text: Show fixed income instruments in {country}.
        slots:
          country: query.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/commodities'].get
  update:
    x-apievangelist-phrasing:
      intent: List available commodity pairs
      effect: read
      questions:
      - What commodities can I get prices for, like gold or wheat?
      - Which commodity pairs fall under the precious metals category?
      instructions:
      - text: List all commodity pairs.
      - text: Show commodities in the {category} category.
        slots:
          category: query.category
      method: generated
      generated: '2026-10-01'
- target: $.paths['/countries'].get
  update:
    x-apievangelist-phrasing:
      intent: List countries with ISO codes and currencies
      effect: read
      questions:
      - What ISO country codes and currencies are supported?
      - Where can I get a list of countries with their capitals?
      instructions:
      - text: List all countries with their ISO codes.
      - text: Show each country's official name, capital and currency.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cross_listings'].get
  update:
    x-apievangelist-phrasing:
      intent: Find other exchanges where a security is listed
      effect: read
      questions:
      - On which other exchanges is this stock also traded?
      - Is this security cross-listed outside its home market?
      instructions:
      - text: Find cross-listings for {symbol}.
        slots:
          symbol: query.symbol
      - text: List every exchange where {symbol} from {exchange} also trades.
        slots:
          symbol: query.symbol
          exchange: query.exchange
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cryptocurrencies'].get
  update:
    x-apievangelist-phrasing:
      intent: List available cryptocurrency pairs
      effect: read
      questions:
      - Which crypto pairs quoted in USD are available?
      - What cryptocurrencies are supported on a given exchange?
      instructions:
      - text: List all cryptocurrency pairs.
      - text: Show crypto pairs with base {currency_base} and quote {currency_quote}.
        slots:
          currency_base: query.currency_base
          currency_quote: query.currency_quote
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cryptocurrency_exchanges'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported cryptocurrency exchanges
      effect: read
      questions:
      - Which crypto exchanges does the data come from?
      - Can I get the list of cryptocurrency exchanges as CSV?
      instructions:
      - text: List the supported cryptocurrency exchanges.
      - text: Export the crypto exchanges list in {format} format.
        slots:
          format: query.format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/earliest_timestamp'].get
  update:
    x-apievangelist-phrasing:
      intent: Find how far back data goes for an instrument
      effect: read
      questions:
      - How far back does 1-minute history go for this stock?
      - What is the first date available for an instrument's daily data?
      instructions:
      - text: Find the earliest {interval} timestamp for {symbol}.
        slots:
          interval: query.interval
          symbol: query.symbol
      - text: Tell me when {interval} history starts for {symbol} on {exchange}.
        slots:
          interval: query.interval
          symbol: query.symbol
          exchange: query.exchange
      method: generated
      generated: '2026-10-01'
- target: $.paths['/etfs'].get
  update:
    x-apievangelist-phrasing:
      intent: List all available ETFs
      effect: read
      questions:
      - Which ETFs are tradable on a particular exchange?
      - Can I include delisted ETFs in the reference list?
      instructions:
      - text: List all ETFs on {exchange}.
        slots:
          exchange: query.exchange
      - text: Show ETFs in {country} including delisted ones set to {include_delisted}.
        slots:
          country: query.country
          include_delisted: query.include_delisted
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exchange_schedule'].get
  update:
    x-apievangelist-phrasing:
      intent: Get exchange trading hours and days
      effect: read
      questions:
      - What are the trading hours of an exchange?
      - Is a given exchange open on a particular date?
      instructions:
      - text: Show the trading schedule for {mic_code}.
        slots:
          mic_code: query.mic_code
      - text: Get exchange hours in {country} on {date}.
        slots:
          country: query.country
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/exchanges'].get
  update:
    x-apievangelist-phrasing:
      intent: List available equity exchanges
      effect: read
      questions:
      - Which stock exchanges are covered, with their codes and timezones?
      - What equity exchanges are available in a given country?
      instructions:
      - text: List all equity exchanges.
      - text: Show equity exchanges in {country}.
        slots:
          country: query.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/forex_pairs'].get
  update:
    x-apievangelist-phrasing:
      intent: List available forex currency pairs
      effect: read
      questions:
      - Which currency pairs can I query?
      - Are pairs with the Japanese yen as the quote currency available?
      instructions:
      - text: List all forex pairs.
      - text: Show forex pairs with base currency {currency_base}.
        slots:
          currency_base: query.currency_base
      method: generated
      generated: '2026-10-01'
- target: $.paths['/funds'].get
  update:
    x-apievangelist-phrasing:
      intent: List available investment funds
      effect: read
      questions:
      - What investment funds are in the reference catalog?
      - Can I look up a fund by CIK or ISIN in the funds list?
      instructions:
      - text: List investment funds in {country}.
        slots:
          country: query.country
      - text: Find the fund with CIK {cik}.
        slots:
          cik: query.cik
      method: generated
      generated: '2026-10-01'
- target: $.paths['/instrument_type'].get
  update:
    x-apievangelist-phrasing:
      intent: List financial instrument types
      effect: read
      questions:
      - What instrument types are supported, like stocks, ETFs or crypto?
      - Which asset class values can I use as a type filter?
      instructions:
      - text: List all instrument types.
      - text: Show the available asset class categories.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/intervals'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported time intervals
      effect: read
      questions:
      - Which bar intervals can I request, like 1min or 1day?
      - Is a 45-minute interval supported for time series?
      instructions:
      - text: List the supported time intervals.
      - text: Show every interval I can use when querying price data.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/market_state'].get
  update:
    x-apievangelist-phrasing:
      intent: Check which exchanges are open and time to next session
      effect: read
      questions:
      - How long until a stock exchange opens?
      - Which exchanges in a country are trading at this moment?
      instructions:
      - text: Show the market state for {exchange}.
        slots:
          exchange: query.exchange
      - text: List open and closed exchanges in {country}.
        slots:
          country: query.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stocks'].get
  update:
    x-apievangelist-phrasing:
      intent: List available stock symbols
      effect: read
      questions:
      - Which stock symbols trade on a given exchange?
      - Can I get the full list of tickers including delisted ones?
      instructions:
      - text: List stocks on {exchange}.
        slots:
          exchange: query.exchange
      - text: Show stock symbols in {country} of type {type}.
        slots:
          country: query.country
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/symbol_search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search instruments by name or ticker
      effect: read
      questions:
      - What ticker does a company I only know by name trade under?
      - Can I search for instruments that match a partial name?
      instructions:
      - text: Search for instruments matching {symbol}.
        slots:
          symbol: query.symbol
      - text: Find the top {outputsize} symbols matching {symbol}.
        slots:
          outputsize: query.outputsize
          symbol: query.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/technical_indicators'].get
  update:
    x-apievangelist-phrasing:
      intent: List the technical indicator catalog
      effect: read
      questions:
      - Which technical analysis indicators are offered?
      - Where do I see each indicator's inputs and outputs?
      instructions:
      - text: List the available technical indicators.
      - text: Show each indicator and its configurable parameters.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/indices'].get
  update:
    x-apievangelist-phrasing:
      intent: List available market indices
      effect: read
      questions:
      - Which market indices are covered?
      - Can I get the catalog of stock indices?
      instructions:
      - text: List all available market indices.
      - text: Show the index catalog.
      method: generated
      generated: '2026-10-01'