Twelve Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twelve Data Analysis API

10 actions 10 updates phrasing extends openapi/twelvedata-analysis-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Twelve Data's API. It is a proposal applied on top of the contract, not a document Twelve Data publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/analyst_ratings/light'].get
$.paths['/analyst_ratings/us_equities'].get
$.paths['/earnings_estimate'].get
$.paths['/eps_revisions'].get
$.paths['/eps_trend'].get
$.paths['/growth_estimates'].get
$.paths['/price_target'].get
$.paths['/recommendations'].get
$.paths['/revenue_estimate'].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 Twelve Data Analysis API
  version: 1.0.0
extends: openapi/twelvedata-analysis-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: 9
- target: $.paths['/analyst_ratings/light'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an analyst ratings snapshot for a stock
      effect: read
      questions:
      - What is the quick summary of analyst buy, hold and sell ratings on a stock outside the US?
      - Can I get a lightweight analyst ratings snapshot filtered by country?
      instructions:
      - text: Get the analyst ratings snapshot for {symbol}.
        slots:
          symbol: query.symbol
      - text: Show the latest analyst ratings snapshot for {symbol} listed in {country}.
        slots:
          symbol: query.symbol
          country: query.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analyst_ratings/us_equities'].get
  update:
    x-apievangelist-phrasing:
      intent: Get detailed analyst ratings for a US stock
      effect: read
      questions:
      - Which analyst firms have rated this US stock, and did they upgrade or downgrade it?
      - Can I filter US equity analyst ratings to only show upgrades or downgrades?
      instructions:
      - text: List the detailed US analyst ratings issued on {symbol}, firm by firm.
        slots:
          symbol: query.symbol
      - text: Show only {rating_change} rating actions by analyst firms on US stock {symbol}.
        slots:
          rating_change: query.rating_change
          symbol: query.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/earnings_estimate'].get
  update:
    x-apievangelist-phrasing:
      intent: Get analyst EPS estimates for a company
      effect: read
      questions:
      - What EPS are analysts expecting for this company next quarter and next year?
      - Where can I find consensus earnings per share forecasts for upcoming periods?
      instructions:
      - text: Get the analyst earnings per share estimates for {symbol}.
        slots:
          symbol: query.symbol
      - text: Show projected quarterly and annual EPS for {symbol} on {exchange}.
        slots:
          symbol: query.symbol
          exchange: query.exchange
      method: generated
      generated: '2026-10-01'
- target: $.paths['/eps_revisions'].get
  update:
    x-apievangelist-phrasing:
      intent: Track recent analyst EPS forecast revisions
      effect: read
      questions:
      - Have analysts raised or cut their EPS forecasts for this stock over the past week or month?
      - How many analysts revised their earnings estimate up versus down recently?
      instructions:
      - text: Show the recent EPS revisions for {symbol}.
        slots:
          symbol: query.symbol
      - text: Pull last week's and last month's upward and downward EPS revisions for {symbol}.
        slots:
          symbol: query.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/eps_trend'].get
  update:
    x-apievangelist-phrasing:
      intent: See how EPS estimates have trended over time
      effect: read
      questions:
      - How has the consensus EPS estimate for a company moved over the last 90 days?
      - What did analysts expect for earnings per share 7, 30 and 60 days ago?
      instructions:
      - text: Get the EPS estimate trend for {symbol}.
        slots:
          symbol: query.symbol
      - text: Compare current and past consensus EPS estimates for {symbol} traded in {country}.
        slots:
          symbol: query.symbol
          country: query.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/growth_estimates'].get
  update:
    x-apievangelist-phrasing:
      intent: Get consensus growth rate projections
      effect: read
      questions:
      - What growth rate do analysts project for this company over the next five years?
      - Can I see consensus earnings growth expectations for the current and next year?
      instructions:
      - text: Get the analyst growth estimates for {symbol}.
        slots:
          symbol: query.symbol
      - text: Show consensus growth projections for {symbol} using ISIN {isin}.
        slots:
          symbol: query.symbol
          isin: query.isin
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price_target'].get
  update:
    x-apievangelist-phrasing:
      intent: Get analyst price targets for a security
      effect: read
      questions:
      - What is the average analyst price target for this stock?
      - Which is the highest and lowest price target analysts have set?
      instructions:
      - text: Get the analyst price target range for {symbol}.
        slots:
          symbol: query.symbol
      - text: Show the high, low and average price targets for {symbol} on {mic_code}.
        slots:
          symbol: query.symbol
          mic_code: query.mic_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/recommendations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the average analyst recommendation
      effect: read
      questions:
      - Is the overall analyst consensus on this stock a strong buy, buy, hold or sell?
      - Does Twelve Data give a numerical recommendation score for a stock?
      instructions:
      - text: Get the consensus analyst recommendation and score for {symbol}.
        slots:
          symbol: query.symbol
      - text: Tell me whether analysts currently rate {symbol} a buy or a sell on average.
        slots:
          symbol: query.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/revenue_estimate'].get
  update:
    x-apievangelist-phrasing:
      intent: Get analyst revenue forecasts for a company
      effect: read
      questions:
      - What revenue are analysts forecasting for this company this quarter and this year?
      - Can I compare projected sales with last year's revenue for a stock?
      instructions:
      - text: Get the analyst revenue estimates for {symbol}.
        slots:
          symbol: query.symbol
      - text: Show projected quarterly and annual revenue for {symbol} rounded to {dp} decimals.
        slots:
          symbol: query.symbol
          dp: query.dp
      method: generated
      generated: '2026-10-01'