Twelve Data · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Twelve Data Etfs API
9 actions
9 updates
phrasing
extends
openapi/twelvedata-etfs-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.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/etfs/family'].get
$.paths['/etfs/list'].get
$.paths['/etfs/type'].get
$.paths['/etfs/world'].get
$.paths['/etfs/world/composition'].get
$.paths['/etfs/world/performance'].get
$.paths['/etfs/world/risk'].get
$.paths['/etfs/world/summary'].get
OpenAPI Overlay
# 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 Etfs API
version: 1.0.0
extends: openapi/twelvedata-etfs-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: 8
- target: $.paths['/etfs/family'].get
update:
x-apievangelist-phrasing:
intent: List ETF fund families
effect: read
questions:
- Which ETF fund families are available in a given country?
- What issuers or fund families group the ETFs in the catalog?
instructions:
- text: List the ETF fund families in {country}.
slots:
country: query.country
- text: Check whether {fund_family} appears as an ETF family.
slots:
fund_family: query.fund_family
method: generated
generated: '2026-10-01'
- target: $.paths['/etfs/list'].get
update:
x-apievangelist-phrasing:
intent: Browse the ETF directory ranked by assets
effect: read
questions:
- Which are the largest ETFs by total assets?
- Can I filter the ETF directory by fund family or fund type?
instructions:
- text: List ETFs in {country}, largest by total assets first.
slots:
country: query.country
- text: Show the ETF directory entries for fund family {fund_family}.
slots:
fund_family: query.fund_family
- text: Page through the ETF directory for fund type {fund_type}, page {page}.
slots:
fund_type: query.fund_type
page: query.page
method: generated
generated: '2026-10-01'
- target: $.paths['/etfs/type'].get
update:
x-apievangelist-phrasing:
intent: List ETF categories by market
effect: read
questions:
- What ETF categories like Large Blend or Equity Precious Metals exist in Singapore?
- Which ETF types can I use to filter funds in a country?
instructions:
- text: List the ETF types available in {country}.
slots:
country: query.country
- text: Check whether the ETF type {fund_type} exists.
slots:
fund_type: query.fund_type
method: generated
generated: '2026-10-01'
- target: $.paths['/etfs/world'].get
update:
x-apievangelist-phrasing:
intent: Get full data for a global ETF
effect: read
questions:
- Can I get an ETF's summary, performance, risk and holdings in a single response?
- Where do I get everything known about one ETF at once?
instructions:
- text: Get the complete ETF profile for {symbol}.
slots:
symbol: query.symbol
- text: Pull full summary, performance, risk and composition data for ETF {symbol}.
slots:
symbol: query.symbol
method: generated
generated: '2026-10-01'
- target: $.paths['/etfs/world/composition'].get
update:
x-apievangelist-phrasing:
intent: See an ETF's holdings and sector weights
effect: read
questions:
- What stocks does this ETF hold and what are their weights?
- Which sectors is this ETF most exposed to?
instructions:
- text: Show the holdings and sector breakdown of ETF {symbol}.
slots:
symbol: query.symbol
- text: List the top weighted components inside ETF {symbol}.
slots:
symbol: query.symbol
method: generated
generated: '2026-10-01'
- target: $.paths['/etfs/world/performance'].get
update:
x-apievangelist-phrasing:
intent: Get trailing and annual returns for an ETF
effect: read
questions:
- How has this ETF performed over the past one, three and five years?
- What were an ETF's annual returns year by year?
instructions:
- text: Get the trailing and annual returns for ETF {symbol}.
slots:
symbol: query.symbol
- text: Show ETF {symbol}'s historical performance with {dp} decimal places.
slots:
symbol: query.symbol
dp: query.dp
method: generated
generated: '2026-10-01'
- target: $.paths['/etfs/world/risk'].get
update:
x-apievangelist-phrasing:
intent: Get volatility and beta risk metrics for an ETF
effect: read
questions:
- How volatile is this ETF and what is its beta?
- What risk measures are reported for an exchange-traded fund?
instructions:
- text: Get the risk metrics for ETF {symbol}.
slots:
symbol: query.symbol
- text: Show volatility and beta for the ETF with ISIN {isin}.
slots:
isin: query.isin
method: generated
generated: '2026-10-01'
- target: $.paths['/etfs/world/summary'].get
update:
x-apievangelist-phrasing:
intent: Get a quick overview of an ETF
effect: read
questions:
- What is the short overview of an ETF, like its name and current value?
- Can I see just the headline summary of a fund without holdings or returns?
instructions:
- text: Give me the summary overview of ETF {symbol}.
slots:
symbol: query.symbol
- text: Show the key facts summary for ETF {symbol} in {country}.
slots:
symbol: query.symbol
country: query.country
method: generated
generated: '2026-10-01'