Twelve Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twelve Data Regulatory API

8 actions 8 updates phrasing extends openapi/twelvedata-regulatory-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 8

$.info
$.paths['/direct_holders'].get
$.paths['/edgar_filings/archive'].get
$.paths['/fund_holders'].get
$.paths['/insider_transactions'].get
$.paths['/institutional_holders'].get
$.paths['/sanctions/{source}'].get
$.paths['/tax_info'].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 Regulatory API
  version: 1.0.0
extends: openapi/twelvedata-regulatory-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['/direct_holders'].get
  update:
    x-apievangelist-phrasing:
      intent: See who directly holds a company's shares
      effect: read
      questions:
      - Who holds shares directly on a company's share registry?
      - How is ownership spread among registered direct shareholders?
      instructions:
      - text: List the direct holders of {symbol}.
        slots:
          symbol: query.symbol
      - text: Show registered direct shareholders for {symbol} in {country}.
        slots:
          symbol: query.symbol
          country: query.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/edgar_filings/archive'].get
  update:
    x-apievangelist-phrasing:
      intent: Search a company's SEC EDGAR filings
      effect: read
      questions:
      - Where can I find a company's 10-K and 10-Q filings with the SEC?
      - Can I filter EDGAR filings by form type and filing date?
      instructions:
      - text: List EDGAR filings for {symbol}.
        slots:
          symbol: query.symbol
      - text: Show {symbol}'s {form_type} filings filed between {filled_from} and {filled_to}.
        slots:
          symbol: query.symbol
          form_type: query.form_type
          filled_from: query.filled_from
          filled_to: query.filled_to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fund_holders'].get
  update:
    x-apievangelist-phrasing:
      intent: See which mutual funds own a stock
      effect: read
      questions:
      - Which mutual funds hold this stock, and how many shares?
      - What percentage of a company is owned by mutual funds?
      instructions:
      - text: List the mutual fund holders of {symbol}.
        slots:
          symbol: query.symbol
      - text: Show which funds own {symbol} and their share of outstanding stock.
        slots:
          symbol: query.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/insider_transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get insider buying and selling for a stock
      effect: read
      questions:
      - Have executives or directors been buying or selling this stock?
      - When did insiders last trade shares of a company?
      instructions:
      - text: Show insider transactions for {symbol}.
        slots:
          symbol: query.symbol
      - text: List trades by {symbol}'s executives and directors.
        slots:
          symbol: query.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/institutional_holders'].get
  update:
    x-apievangelist-phrasing:
      intent: See which institutions own a stock
      effect: read
      questions:
      - Which pension funds and investment firms own this stock?
      - How much of a company is held by institutional investors?
      instructions:
      - text: List the institutional holders of {symbol}.
        slots:
          symbol: query.symbol
      - text: Show institutional ownership percentages for {symbol}.
        slots:
          symbol: query.symbol
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sanctions/{source}'].get
  update:
    x-apievangelist-phrasing:
      intent: List entities sanctioned by an authority
      effect: read
      questions:
      - Who is on the OFAC sanctions list?
      - Can I get the entities sanctioned by the UK or EU?
      instructions:
      - text: List entities sanctioned by {source}.
        slots:
          source: path.source
      - text: Show the sanctioned individuals and organizations on the {source} list.
        slots:
          source: path.source
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tax_info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tax rates and codes for an instrument
      effect: read
      questions:
      - What taxes apply when trading this security?
      - Which tax codes are associated with an instrument?
      instructions:
      - text: Get the tax information for {symbol}.
        slots:
          symbol: query.symbol
      - text: Show tax rates and codes for the instrument with ISIN {isin}.
        slots:
          isin: query.isin
      method: generated
      generated: '2026-10-01'