Twelve Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twelvedata Fundamentals API

21 actions 21 updates phrasing extends openapi/twelvedata-fundamentals-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 21 · first 16 shown; the file carries all of them

$.info
$.paths['/balance_sheet'].get
$.paths['/balance_sheet/consolidated'].get
$.paths['/cash_flow'].get
$.paths['/cash_flow/consolidated'].get
$.paths['/dividends'].get
$.paths['/dividends_calendar'].get
$.paths['/earnings'].get
$.paths['/earnings_calendar'].get
$.paths['/income_statement'].get
$.paths['/income_statement/consolidated'].get
$.paths['/ipo_calendar'].get
$.paths['/key_executives'].get
$.paths['/last_change/{endpoint}'].get
$.paths['/logo'].get
$.paths['/market_cap'].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 Twelvedata Fundamentals API
  version: 1.0.0
extends: openapi/twelvedata-fundamentals-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: 20
- target: $.paths['/balance_sheet'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's balance sheet
      effect: read
      questions:
      - What are a company's total assets, liabilities and shareholders' equity?
      - Can I get quarterly instead of annual balance sheets?
      instructions:
      - text: Get the balance sheet for {symbol}.
        slots:
          symbol: query.symbol
      - text: Show {symbol}'s {period} balance sheets.
        slots:
          symbol: query.symbol
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/balance_sheet/consolidated'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's raw consolidated balance sheet
      effect: read
      questions:
      - Where can I get the raw consolidated balance sheet as the company reported it?
      - Is there an unstandardized, consolidated version of the balance sheet data?
      instructions:
      - text: Get the raw consolidated balance sheet for {symbol}.
        slots:
          symbol: query.symbol
      - text: Pull {symbol}'s consolidated balance sheets between {start_date} and {end_date}.
        slots:
          symbol: query.symbol
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cash_flow'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's cash flow statement
      effect: read
      questions:
      - How much cash did this company generate from operations last year?
      - What do a company's investing and financing cash flows look like by quarter?
      instructions:
      - text: Get the cash flow statement for {symbol}.
        slots:
          symbol: query.symbol
      - text: Show {symbol}'s {period} operating, investing and financing cash flows.
        slots:
          symbol: query.symbol
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cash_flow/consolidated'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's raw consolidated cash flow
      effect: read
      questions:
      - Can I see the consolidated cash flow statement in its raw reported form?
      - Which call returns unstandardized consolidated cash flow data?
      instructions:
      - text: Get the raw consolidated cash flow statement for {symbol}.
        slots:
          symbol: query.symbol
      - text: Pull {symbol}'s consolidated cash flows from {start_date} to {end_date}.
        slots:
          symbol: query.symbol
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dividends'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stock's dividend payment history
      effect: read
      questions:
      - How much has this stock paid in dividends over the last ten years?
      - When were the ex-dividend dates for a company's past payouts?
      instructions:
      - text: Show the dividend history for {symbol}.
        slots:
          symbol: query.symbol
      - text: List {symbol}'s dividends over the {range} range.
        slots:
          symbol: query.symbol
          range: query.range
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dividends_calendar'].get
  update:
    x-apievangelist-phrasing:
      intent: See upcoming and past dividends across companies
      effect: read
      questions:
      - Which companies go ex-dividend next week?
      - Can I see every dividend event scheduled within a date range?
      instructions:
      - text: Show the dividends calendar from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: List dividend events in {country} for the coming days.
        slots:
          country: query.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/earnings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's estimated vs actual EPS history
      effect: read
      questions:
      - Did this company beat or miss its EPS estimates in past quarters?
      - Where can I see a company's historical reported earnings per share?
      instructions:
      - text: Get the earnings history for {symbol}.
        slots:
          symbol: query.symbol
      - text: Show {symbol}'s estimated versus actual EPS for the last {outputsize} reports.
        slots:
          symbol: query.symbol
          outputsize: query.outputsize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/earnings_calendar'].get
  update:
    x-apievangelist-phrasing:
      intent: See which companies report earnings on given dates
      effect: read
      questions:
      - Which companies are announcing earnings today?
      - Can I list all earnings announcements scheduled for next week?
      instructions:
      - text: Show the earnings calendar from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: List today's earnings announcements on {exchange}.
        slots:
          exchange: query.exchange
      method: generated
      generated: '2026-10-01'
- target: $.paths['/income_statement'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's income statement
      effect: read
      questions:
      - What were this company's revenue, expenses and net income last year?
      - Can I get quarterly income statements for a stock?
      instructions:
      - text: Get the income statement for {symbol}.
        slots:
          symbol: query.symbol
      - text: Show {symbol}'s {period} revenue and net income.
        slots:
          symbol: query.symbol
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/income_statement/consolidated'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's raw consolidated income statement
      effect: read
      questions:
      - Is the consolidated income statement available in raw, as-reported form?
      - Which endpoint gives unstandardized consolidated revenue and net income?
      instructions:
      - text: Get the raw consolidated income statement for {symbol}.
        slots:
          symbol: query.symbol
      - text: Pull {symbol}'s consolidated income statements from {start_date} to {end_date}.
        slots:
          symbol: query.symbol
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ipo_calendar'].get
  update:
    x-apievangelist-phrasing:
      intent: See past and upcoming IPOs
      effect: read
      questions:
      - Which companies are going public this month?
      - What IPOs happened on a given exchange recently?
      instructions:
      - text: Show the IPO calendar from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: List upcoming IPOs in {country}.
        slots:
          country: query.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/key_executives'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's key executives
      effect: read
      questions:
      - Who are the top executives running this company?
      - What titles and roles do a company's leaders hold?
      instructions:
      - text: List the key executives of {symbol}.
        slots:
          symbol: query.symbol
      - text: Show names and titles of {symbol}'s leadership team.
        slots:
          symbol: query.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/last_change/{endpoint}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check when a fundamentals dataset last changed
      effect: read
      questions:
      - How do I know whether fundamental data has changed before re-fetching it?
      - When was a company's statistics or profile data last updated?
      instructions:
      - text: Show the last change timestamps for the {endpoint} dataset.
        slots:
          endpoint: path.endpoint
      - text: Check when {endpoint} data for {symbol} was last updated.
        slots:
          endpoint: path.endpoint
          symbol: query.symbol
      - text: List {endpoint} records changed since {start_date}.
        slots:
          endpoint: path.endpoint
          start_date: query.start_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/logo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the logo image for a company or asset
      effect: read
      questions:
      - Where can I get a company's official logo for my app?
      - Are logos available for crypto and forex pairs too?
      instructions:
      - text: Get the logo for {symbol}.
        slots:
          symbol: query.symbol
      - text: Fetch the logo of {symbol} as listed on {exchange}.
        slots:
          symbol: query.symbol
          exchange: query.exchange
      method: generated
      generated: '2026-10-01'
- target: $.paths['/market_cap'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's market capitalization history
      effect: read
      questions:
      - What was this company's market cap a year ago?
      - Can I chart how a company's market value has changed over time?
      instructions:
      - text: Get the market capitalization history for {symbol}.
        slots:
          symbol: query.symbol
      - text: Show {symbol}'s market cap between {start_date} and {end_date}.
        slots:
          symbol: query.symbol
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/press_releases'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's official press releases
      effect: read
      questions:
      - What press releases has this company published recently?
      - Can I filter corporate announcements by language and date?
      instructions:
      - text: List recent press releases from {symbol}.
        slots:
          symbol: query.symbol
      - text: Show {symbol}'s press releases in {language} since {start_date}.
        slots:
          symbol: query.symbol
          language: query.language
          start_date: query.start_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/profile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's business profile
      effect: read
      questions:
      - What industry and sector is this company in, and who is the CEO?
      - Where is a company headquartered?
      instructions:
      - text: Get the company profile for {symbol}.
        slots:
          symbol: query.symbol
      - text: Show the sector, industry and headquarters of {symbol}.
        slots:
          symbol: query.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/splits'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stock's split history
      effect: read
      questions:
      - Has this stock ever split, and by what factor?
      - When were a company's past stock splits?
      instructions:
      - text: Show the split history for {symbol}.
        slots:
          symbol: query.symbol
      - text: List {symbol}'s stock splits between {start_date} and {end_date}.
        slots:
          symbol: query.symbol
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/splits_calendar'].get
  update:
    x-apievangelist-phrasing:
      intent: See upcoming and past stock splits market-wide
      effect: read
      questions:
      - Which companies have stock splits scheduled this month?
      - Can I see all split events across the market within a date window?
      instructions:
      - text: Show the splits calendar from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: List upcoming stock splits on {exchange}.
        slots:
          exchange: query.exchange
      method: generated
      generated: '2026-10-01'
- target: $.paths['/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get key valuation and financial statistics
      effect: read
      questions:
      - What is this stock's P/E ratio, profit margin and other key stats?
      - Where can I get a one-shot snapshot of a company's valuation metrics?
      instructions:
      - text: Get the key statistics for {symbol}.
        slots:
          symbol: query.symbol
      - text: Show valuation metrics and margins for {symbol}.
        slots:
          symbol: query.symbol
      method: generated
      generated: '2026-10-01'