openapi: 3.2.0
info:
description: "## Overview\n\nWelcome to Twelve Data developer docs — your gateway to comprehensive financial market data through a powerful and easy-to-use API.\nTwelve Data provides access to financial markets across over 50 global countries, covering more than 1 million public instruments, including stocks, forex, ETFs, mutual funds, commodities, and cryptocurrencies.\n\n## Quickstart\n\nTo get started, you'll need to sign up for an API key. Once you have your API key, you can start making requests to the API.\n\n### Step 1: Create Twelve Data account\n\nSign up on the Twelve Data website to create your account [here](https://twelvedata.com/register). This gives you access to the API dashboard and your API key.\n\n### Step 2: Get your API key\n\nAfter signing in, navigate to your [dashboard](https://twelvedata.com/account/api-keys) to find your unique API key. This key is required to authenticate all API and WebSocket requests.\n\n### Step 3: Make your first request\n\nTry a simple API call with cURL to fetch the latest price for Apple (AAPL):\n\n```\ncurl \"https://api.twelvedata.com/price?symbol=AAPL&apikey=your_api_key\"\n```\n\n### Step 4: Make a request from Python or Javascript\n\nUse our client libraries or standard HTTP clients to make API calls programmatically. Here’s an example in [Python](https://github.com/twelvedata/twelvedata-python) and [Node.js](https://github.com/twelvedata/twelvedata-node):\n\n#### Python (using official Twelve Data SDK):\n\n```python\nfrom twelvedata import TDClient\n\n# Initialize client with your API key\ntd = TDClient(apikey=\"your_api_key\")\n\n# Get latest price for Apple\nprice = td.price(symbol=\"AAPL\").as_json()\n\nprint(price)\n```\n\n#### JavaScript (Node.js):\n\n```javascript\nimport { MarketDataApi, CreateConfig } from \"@twelvedata/twelvedata-node\";\n\nconst config = CreateConfig('your_api_key');\nconst api = new MarketDataApi(config);\n\nasync function main() {\n const response = await api.getPrice({\n symbol: \"AAPL\",\n });\n console.log(response.data);\n}\n\nmain().catch(console.error);\n```\n\n### Step 5: Perform correlation analysis between Tesla and Microsoft prices\n\nFetch historical price data for Tesla (TSLA) and Microsoft (MSFT) and calculate the correlation of their closing prices:\n\n```python\nfrom twelvedata import TDClient\nimport pandas as pd\n\n# Initialize client with your API key\ntd = TDClient(apikey=\"your_api_key\")\n\n# Fetch historical price data for Tesla\ntsla_ts = td.time_series(\n symbol=\"TSLA\",\n interval=\"1day\",\n outputsize=100\n).as_pandas()\n\n# Fetch historical price data for Microsoft\nmsft_ts = td.time_series(\n symbol=\"MSFT\",\n interval=\"1day\",\n outputsize=100\n).as_pandas()\n\n# Align data on datetime index\ncombined = pd.concat(\n [tsla_ts['close'].astype(float), msft_ts['close'].astype(float)],\n axis=1,\n keys=[\"TSLA\", \"MSFT\"]\n).dropna()\n\n# Calculate correlation\ncorrelation = combined[\"TSLA\"].corr(combined[\"MSFT\"])\nprint(f\"Correlation of closing prices between TSLA and MSFT: {correlation:.2f}\")\n```\n\n### Authentication\n\nAuthenticate your requests using one of these methods:\n\n#### Query parameter method\n```\nGET https://api.twelvedata.com/endpoint?symbol=AAPL&apikey=your_api_key\n```\n\n#### HTTP header method (recommended)\n```\nAuthorization: apikey your_api_key\n```\n\n##### API key useful information\n
\n- Demo API key (
apikey=demo) available for demo requests \n- Personal API key required for full access
\n- Premium endpoints and data require higher-tier plans (testable with trial symbols)
\n
\n\n### API endpoints\n\n Service | Base URL |\n---------|----------|\n REST API | `https://api.twelvedata.com` |\n WebSocket | `wss://ws.twelvedata.com` |\n\n### Parameter guidelines\n\n- Separator: Use
& to separate multiple parameters \n- Case sensitivity: Parameter names are case-insensitive (
symbol=AAPL = symbol=aapl) \n- Multiple values: Separate with commas where supported
\n
\n\n### Response handling\n\n#### Default format\nAll responses return JSON format by default unless otherwise specified.\n\n#### Null values\nImportant: Some response fields may contain `null` values when data is unavailable for specific metrics. This is expected behavior, not an error.\n\n##### Best Practices:\n\n- Always implement
null value handling in your application \n- Use defensive programming techniques for data processing
\n- Consider fallback values or error handling for critical metrics
\n
\n\n#### Error handling\nStructure your code to gracefully handle:\n\n- Network timeouts
\n- Rate limiting responses
\n- Invalid parameter errors
\n- Data unavailability periods
\n
\n\n##### Best practices\n\n- Rate limits: Adhere to your plan’s rate limits to avoid throttling. Check your dashboard for details.
\n- Error handling: Implement retry logic for transient errors (e.g.,
429 Too Many Requests). \n- Caching: Cache responses for frequently accessed data to reduce API calls and improve performance.
\n- Secure storage: Store your API key securely and never expose it in client-side code or public repositories.
\n
\n\n## Errors\n\nTwelve Data API employs a standardized error response format, delivering a JSON object with `code`, `message`, and `status` keys for clear and consistent error communication.\n\n### Codes\n\nBelow is a table of possible error codes, their HTTP status, meanings, and resolution steps:\n\n Code | status | Meaning | Resolution |\n --- | --- | --- | --- |\n **400** | Bad Request | Invalid or incorrect parameter(s) provided. | Check the `message` in the response for details. Refer to the API Documentation to correct the input. |\n **401** | Unauthorized | Invalid or incorrect API key. | Verify your API key is correct. Sign up for a key here. |\n **403** | Forbidden | API key lacks permissions for the requested resource (upgrade required). | Upgrade your plan here. |\n **404** | Not Found | Requested data could not be found. | Adjust parameters to be less strict as they may be too restrictive. |\n **414** | Parameter Too Long | Input parameter array exceeds the allowed length. | Follow the `message` guidance to adjust the parameter length. |\n **429** | Too Many Requests | API request limit reached for your key. | Wait briefly or upgrade your plan here. |\n **500** | Internal Server Error | Server-side issue occurred; retry later. | Contact support here for assistance. |\n\n### Example error response\n\nConsider the following invalid request:\n\n```\nhttps://api.twelvedata.com/time_series?symbol=AAPL&interval=0.99min&apikey=your_api_key\n```\n\nDue to the incorrect `interval` value, the API returns:\n\n```json\n{\n \"code\": 400,\n \"message\": \"Invalid **interval** provided: 0.99min. Supported intervals: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month\",\n \"status\": \"error\"\n}\n```\n\nRefer to the API Documentation for valid parameter values to resolve such errors.\n\n## Libraries\n\nTwelve Data provides a growing ecosystem of libraries and integrations to help you build faster and smarter in your preferred environment. Official libraries are actively maintained by the Twelve Data team, while selected community-built libraries offer additional flexibility.\n\nA full list is available on our [GitHub profile](https://github.com/search?q=twelvedata).\n\n### Official SDKs\n\n\n### AI integrations\n\n- Twelve Data MCP Server: Repository — Model Context Protocol (MCP) server that provides seamless integration with AI assistants and language models, enabling direct access to Twelve Data's financial market data within conversational interfaces and AI workflows.
\n- Twelve Data integration for OpenClaw: Clawhub skill — Integration for the OpenClaw platform, allowing users to leverage Twelve Data's API within their OpenClaw applications.
\n- Twelve Data NEAR Agent: NEAR Agent — Access Twelve Data's API directly from NEAR's AI agent platform, enabling users to retrieve financial data and insights within their NEAR AI agent workflows.
\n
\n\n### Spreadsheet add-ons\n\n\n### Community libraries\n\nThe community has developed libraries in several popular languages. You can explore more community libraries on [GitHub](https://github.com/search?q=twelvedata).\n\n\n### Other Twelve Data repositories\n\n- searchindex (Go): Repository — In-memory search index by strings
\n- ws-tools (Python): Repository — Utility tools for WebSocket stream handling
\n
\n\n### API specification\n\n- OpenAPI / Swagger: Access the complete API specification in OpenAPI format. You can use this file to automatically generate client libraries in your preferred programming language, explore the API interactively via Swagger tools, or integrate Twelve Data seamlessly into your AI and LLM workflows.
\n
"
title: Twelve Data Mutual Funds API
version: 0.0.1
servers:
- url: https://api.twelvedata.com/
security:
- authorizationHeader:
- '[]'
- queryParameter:
- '[]'
tags:
- name: mutual_funds
paths:
/mutual_funds/family:
get:
description: The mutual funds family endpoint provides a comprehensive list of MF families, which are groups of mutual funds managed by the same investment company. This data is useful for users looking to explore or compare different fund families, understand the range of investment options offered by each, and identify potential investment opportunities within specific fund families.
operationId: GetMutualFundsFamily
parameters:
- description: Filter by investment company that manages the fund
in: query
name: fund_family
schema:
type: string
x-go-name: FundFamily
x-order: '20'
x-go-name: FundFamily
x-order: '20'
example: Jackson National
- description: Filter by country name or alpha code, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '10'
x-go-name: Country
x-order: '10'
example: United States
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetMutualFundsFamily_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: MFs families
tags:
- mutual_funds
x-api-credits-cost: '1'
x-api-credits-type: request
x-group: Mutual funds
x-order: '100'
x-url-hash: mutual-fund-family-list
/mutual_funds/list:
get:
description: The mutual funds directory endpoint provides a daily updated list of mutual funds, sorted in descending order by their total assets value. This endpoint is useful for retrieving an organized overview of available mutual funds.
operationId: GetMutualFundsList
parameters:
- description: Filter by symbol
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-go-name: Symbol
x-order: '10'
example: 1535462D
- description: Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-go-name: Figi
x-order: '20'
example: BBG00HMMLCH1
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-go-name: Isin
x-order: '25'
example: LU1206782309
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-go-name: Cusip
x-order: '26'
example: '120678230'
- description: The CIK of an instrument for which data is requested
in: query
name: cik
schema:
type: string
x-go-name: Cik
x-order: '28'
x-go-name: Cik
x-order: '28'
example: '95953'
- description: Filter by country name or alpha code, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '30'
x-go-name: Country
x-order: '30'
example: United States
- description: Filter by investment company that manages the fund
in: query
name: fund_family
schema:
type: string
x-go-name: FundFamily
x-order: '40'
x-go-name: FundFamily
x-order: '40'
example: Jackson National
- description: Filter by the type of fund
in: query
name: fund_type
schema:
type: string
x-go-name: FundType
x-order: '50'
x-go-name: FundType
x-order: '50'
example: Small Blend
- description: Filter by performance rating from `0` to `5`
in: query
name: performance_rating
schema:
format: int64
type: integer
x-go-name: PerformanceRating
x-order: '60'
x-go-name: PerformanceRating
x-order: '60'
example: 4
- description: Filter by risk rating from `0` to `5`
in: query
name: risk_rating
schema:
format: int64
type: integer
x-go-name: RiskRating
x-order: '70'
x-go-name: RiskRating
x-order: '70'
example: 4
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '72'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '74'
x-go-name: Delimiter
x-order: '74'
- description: Number of decimal places for floating values
in: query
name: dp
schema:
default: 5
format: int64
type: integer
x-go-name: Dp
x-order: '76'
x-go-name: Dp
x-order: '76'
- description: Page number
in: query
name: page
schema:
default: 1
format: int64
type: integer
x-go-name: Page
x-order: '80'
x-go-name: Page
x-order: '80'
- description: Number of records in response
in: query
name: outputsize
schema:
default: 100
format: int64
type: integer
x-go-name: PageSize
x-order: '90'
x-go-name: PageSize
x-order: '90'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetMutualFundsList_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: MFs directory
tags:
- mutual_funds
x-additional-notes: Basic, Grow, and Pro plans (individual) and Venture plan (business) return up to 50 records. For complete data on over 140,000 Mutual Funds, upgrade to the Ultra plan (individual), Enterprise (business), or Custom plan (business).
x-api-credits-cost: '1'
x-api-credits-type: request
x-badge: Useful
x-group: Mutual funds
x-order: '10'
x-starting-plan: ultra,enterprise
x-url-hash: mutual-funds-list
/mutual_funds/type:
get:
description: This endpoint provides detailed information on various types of mutual funds, such as equity, bond, and balanced funds, allowing users to understand the different investment options available.
operationId: GetMutualFundsType
parameters:
- description: Filter by the type of fund
in: query
name: fund_type
schema:
type: string
x-go-name: FundType
x-order: '20'
x-go-name: FundType
x-order: '20'
example: Jackson National
- description: Filter by country name or alpha code, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '10'
x-go-name: Country
x-order: '10'
example: United States
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetMutualFundsType_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: MFs types
tags:
- mutual_funds
x-api-credits-cost: '1'
x-api-credits-type: request
x-group: Mutual funds
x-order: '110'
x-url-hash: mutual-fund-type-list
/mutual_funds/world:
get:
description: The mutual full data endpoint provides detailed information about global mutual funds. It returns a comprehensive dataset that includes a summary of the fund, its performance metrics, risk assessment, ratings, asset composition, purchase details, and sustainability factors. This endpoint is essential for users seeking in-depth insights into mutual funds on a global scale, allowing them to evaluate various aspects such as investment performance, risk levels, and environmental impact.
operationId: GetMutualFundsWorld
parameters:
- description: Symbol ticker of mutual fund
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: 1535462D
- description: Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG00HMMLCH1
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '30'
x-required-group: symbol
x-go-name: Isin
x-order: '30'
x-required-group: symbol
example: LU1206782309
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
example: '120678230'
- description: Filter by country name or alpha code, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '40'
x-go-name: Country
x-order: '40'
example: United States
- description: Number of decimal places for floating values. Accepts value in range [0,11]
in: query
name: dp
schema:
default: 5
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '50'
x-go-name: DecimalPlaces
x-order: '50'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: MF full data
tags:
- mutual_funds
x-api-credits-cost: '1000'
x-api-credits-type: request
x-badge: High demand
x-group: Mutual funds
x-order: '20'
x-starting-plan: ultra,enterprise
x-url-hash: mf-all-data
x-required:
anyOf:
- required:
- symbol
- figi
- isin
- cusip
/mutual_funds/world/composition:
get:
description: The mutual funds compositions endpoint provides detailed information about the portfolio composition of a specified mutual fund. It returns data on sector allocations, individual holdings, and their respective weighted exposures. This endpoint is useful for users seeking to understand the investment distribution and risk profile of a mutual fund.
operationId: GetMutualFundsWorldComposition
parameters:
- description: Symbol ticker of mutual fund
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: 1535462D
- description: Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG00HMMLCH1
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '30'
x-required-group: symbol
x-go-name: Isin
x-order: '30'
x-required-group: symbol
example: LU1206782309
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
example: '120678230'
- description: Filter by country name or alpha code, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '40'
x-go-name: Country
x-order: '40'
example: United States
- description: Number of decimal places for floating values. Accepts value in range [0,11]
in: query
name: dp
schema:
default: 5
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '50'
x-go-name: DecimalPlaces
x-order: '50'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetMutualFundsWorldComposition_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Composition
tags:
- mutual_funds
x-api-credits-cost: '200'
x-api-credits-type: request
x-badge: High demand
x-group: Mutual funds
x-order: '70'
x-starting-plan: ultra,enterprise
x-url-hash: mf-composition
x-required:
anyOf:
- required:
- symbol
- figi
- isin
- cusip
/mutual_funds/world/performance:
get:
description: The mutual funds performances endpoint provides comprehensive performance data for mutual funds globally. It returns metrics such as trailing returns, annual returns, quarterly returns, and load-adjusted returns.
operationId: GetMutualFundsWorldPerformance
parameters:
- description: Symbol ticker of mutual fund
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: 1535462D
- description: Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG00HMMLCH1
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '30'
x-required-group: symbol
x-go-name: Isin
x-order: '30'
x-required-group: symbol
example: LU1206782309
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
example: '120678230'
- description: Filter by country name or alpha code, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '40'
x-go-name: Country
x-order: '40'
example: United States
- description: Number of decimal places for floating values. Accepts value in range [0,11]
in: query
name: dp
schema:
default: 5
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '50'
x-go-name: DecimalPlaces
x-order: '50'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetMutualFundsWorldPerformance_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Performance
tags:
- mutual_funds
x-api-credits-cost: '200'
x-api-credits-type: request
x-badge: High demand
x-group: Mutual funds
x-order: '40'
x-starting-plan: ultra,enterprise
x-url-hash: mf-performance
x-required:
anyOf:
- required:
- symbol
- figi
- isin
- cusip
/mutual_funds/world/purchase_info:
get:
description: The mutual funds purchase information endpoint provides detailed purchasing details for global mutual funds. It returns data on minimum investment requirements, current pricing, and a list of brokerages where the mutual fund can be purchased. This endpoint is useful for users looking to understand the entry requirements and options available for investing in specific mutual funds.
operationId: GetMutualFundsWorldPurchaseInfo
parameters:
- description: Symbol ticker of mutual fund
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: 1535462D
- description: Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG00HMMLCH1
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '30'
x-required-group: symbol
x-go-name: Isin
x-order: '30'
x-required-group: symbol
example: LU1206782309
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
example: '120678230'
- description: Filter by country name or alpha code, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '40'
x-go-name: Country
x-order: '40'
example: United States
- description: Number of decimal places for floating values. Accepts value in range [0,11]
in: query
name: dp
schema:
default: 5
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '50'
x-go-name: DecimalPlaces
x-order: '50'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetMutualFundsWorldPurchaseInfo_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Purchase info
tags:
- mutual_funds
x-api-credits-cost: '200'
x-api-credits-type: request
x-group: Mutual funds
x-order: '80'
x-starting-plan: ultra,enterprise
x-url-hash: mf-purchase-info
x-required:
anyOf:
- required:
- symbol
- figi
- isin
- cusip
/mutual_funds/world/ratings:
get:
description: The mutual funds ratings endpoint provides detailed ratings for mutual funds across global markets. It returns data on the performance and quality of mutual funds, including ratings calculated in-house by Twelve Data and from various financial institutions.
operationId: GetMutualFundsWorldRatings
parameters:
- description: Symbol ticker of mutual fund
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: 1535462D
- description: Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG00HMMLCH1
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '30'
x-required-group: symbol
x-go-name: Isin
x-order: '30'
x-required-group: symbol
example: LU1206782309
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
example: '120678230'
- description: Filter by country name or alpha code, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '40'
x-go-name: Country
x-order: '40'
example: United States
- description: Number of decimal places for floating values. Accepts value in range [0,11]
in: query
name: dp
schema:
default: 5
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '50'
x-go-name: DecimalPlaces
x-order: '50'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetMutualFundsWorldRatings_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Ratings
tags:
- mutual_funds
x-api-credits-cost: '200'
x-api-credits-type: request
x-group: Mutual funds
x-order: '60'
x-starting-plan: ultra,enterprise
x-url-hash: mf-ratings
x-required:
anyOf:
- required:
- symbol
- figi
- isin
- cusip
/mutual_funds/world/risk:
get:
description: The mutual funds risk endpoint provides detailed risk metrics for global mutual funds. It returns data such as standard deviation, beta, and Sharpe ratio, which help assess the volatility and risk profile of mutual funds across different markets.
operationId: GetMutualFundsWorldRisk
parameters:
- description: Symbol ticker of mutual fund
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: 1535462D
- description: Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG00HMMLCH1
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '30'
x-required-group: symbol
x-go-name: Isin
x-order: '30'
x-required-group: symbol
example: LU1206782309
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
example: '120678230'
- description: Filter by country name or alpha code, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '40'
x-go-name: Country
x-order: '40'
example: United States
- description: Number of decimal places for floating values. Accepts value in range [0,11]
in: query
name: dp
schema:
default: 5
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '50'
x-go-name: DecimalPlaces
x-order: '50'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetMutualFundsWorldRisk_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Risk
tags:
- mutual_funds
x-api-credits-cost: '200'
x-api-credits-type: request
x-group: Mutual funds
x-order: '50'
x-starting-plan: ultra,enterprise
x-url-hash: mf-risk
x-required:
anyOf:
- required:
- symbol
- figi
- isin
- cusip
/mutual_funds/world/summary:
get:
description: The mutual funds summary endpoint provides a concise overview of global mutual funds, including key details such as fund name, symbol, asset class, and region. This endpoint is useful for quickly obtaining essential information about various mutual funds worldwide, aiding in the comparison and selection of funds for investment portfolios.
operationId: GetMutualFundsWorldSummary
parameters:
- description: Symbol ticker of mutual fund
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: 1535462D
- description: Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG00HMMLCH1
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '30'
x-required-group: symbol
x-go-name: Isin
x-order: '30'
x-required-group: symbol
example: LU1206782309
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
example: '120678230'
- description: Filter by country name or alpha code, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '40'
x-go-name: Country
x-order: '40'
example: United States
- description: Number of decimal places for floating values. Accepts value in range [0,11]
in: query
name: dp
schema:
default: 5
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '50'
x-go-name: DecimalPlaces
x-order: '50'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetMutualFundsWorldSummary_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Summary
tags:
- mutual_funds
x-api-credits-cost: '200'
x-api-credits-type: request
x-group: Mutual funds
x-order: '30'
x-starting-plan: ultra,enterprise
x-url-hash: mf-summary
x-required:
anyOf:
- required:
- symbol
- figi
- isin
- cusip
/mutual_funds/world/sustainability:
get:
description: The mutual funds sustainability endpoint provides detailed information on the sustainability and Environmental, Social, and Governance (ESG) ratings of global mutual funds. It returns data such as ESG scores, sustainability metrics, and fund identifiers.
operationId: GetMutualFundsWorldSustainability
parameters:
- description: Symbol ticker of mutual fund
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: 1535462D
- description: Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG00HMMLCH1
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '30'
x-required-group: symbol
x-go-name: Isin
x-order: '30'
x-required-group: symbol
example: LU1206782309
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
x-go-name: Cusip
x-order: '31'
x-required-group: symbol
example: '120678230'
- description: Filter by country name or alpha code, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '40'
x-go-name: Country
x-order: '40'
example: United States
- description: Number of decimal places for floating values. Accepts value in range [0,11]
in: query
name: dp
schema:
default: 5
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '50'
x-go-name: DecimalPlaces
x-order: '50'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetMutualFundsWorldSustainability_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Sustainability
tags:
- mutual_funds
x-api-credits-cost: '200'
x-api-credits-type: request
x-group: Mutual funds
x-order: '90'
x-starting-plan: ultra,enterprise
x-url-hash: mf-sustainability
x-required:
anyOf:
- required:
- symbol
- figi
- isin
- cusip
components:
schemas:
GetMutualFundsWorld_200_response_mutual_fund_performance_annual_total_returns_inner:
properties:
year:
description: Year of total returns
examples:
- 2024
format: int64
type: integer
x-go-name: Year
x-order: 10
share_class_return:
description: Fund total returns (%) generated over a given year
examples:
- 0.08546
format: double
type: number
x-go-name: ShareClassReturn
x-order: 20
category_return:
description: Same category average total returns (%) generated over a given year
examples:
- 0.1119
format: double
type: number
x-go-name: CategoryReturn
x-order: 30
type: object
GetMutualFundsWorld_200_response_mutual_fund_purchase_info_pricing:
description: Pricing information for the mutual fund
properties:
nav:
description: 'Net Asset Value: fund value minus liabilities'
examples:
- 10.09
format: double
type: number
x-go-name: Nav
x-order: 10
12_month_low:
description: Lowest price of the fund over the last year
examples:
- 9.630000114441
format: double
type: number
x-go-name: TwelveMonthLow
x-order: 20
12_month_high:
description: Highest price of the fund over the last year
examples:
- 12.10000038147
format: double
type: number
x-go-name: TwelveMonthHigh
x-order: 30
last_month:
description: Fund price at the end of the last month
examples:
- 11.050000190735
format: double
type: number
x-go-name: LastMonth
x-order: 40
type: object
x-go-name: Pricing
x-order: 30
GetMutualFundsWorld_200_response_mutual_fund_purchase_info_expenses:
description: Costs associated with investing in the mutual fund, including gross and net expense ratios
properties:
expense_ratio_gross:
description: Cost of investing in a mutual fund
examples:
- 0.0022
format: double
type: number
x-go-name: ExpenseRatioGross
x-order: 10
expense_ratio_net:
description: Percentage of mutual fund assets steered toward a fund's operating expenses and fund management fees
examples:
- 0.001
format: double
type: number
x-go-name: ExpenseRatioNet
x-order: 20
type: object
x-go-name: Expenses
x-order: 10
GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown:
description: Breakdown of the fund’s bond holdings by maturity, duration, and credit quality
properties:
average_maturity:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown_average_maturity'
average_duration:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown_average_duration'
credit_quality:
description: Breakdown of the fund’s bond holdings by credit rating and their respective portfolio weights
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown_credit_quality_inner'
type: array
x-go-name: CreditQuality
x-order: 20
type: object
x-go-name: BondBreakdown
x-order: 30
GetMutualFundsWorld_200_response_mutual_fund_sustainability_corporate_esg_pillars:
description: Corporate ESG pillars
properties:
environmental:
description: ESG environmental score
examples:
- 3.73
format: double
type: number
x-go-name: Environmental
x-order: 10
social:
description: ESG social score
examples:
- 10.44
format: double
type: number
x-go-name: Social
x-order: 20
governance:
description: ESG governance score
examples:
- 7.86
format: double
type: number
x-go-name: Governance
x-order: 30
type: object
x-go-name: CorporateEsgPillars
x-order: 20
GetMutualFundsWorldComposition_200_response_mutual_fund:
description: Mutual fund information
properties:
composition:
$ref: '#/components/schemas/ResponseMutualFundWorldComposition'
type: object
x-go-name: MutualFund
x-order: 10
GetMutualFundsWorldPurchaseInfo_200_response_mutual_fund:
description: Mutual fund information
properties:
purchase_info:
$ref: '#/components/schemas/ResponseMutualFundWorldPurchaseInfo'
type: object
x-go-name: MutualFund
x-order: 10
ResponseMutualFundWorldPerformance:
description: Detailed performance of a mutual fund
properties:
trailing_returns:
description: Trailing returns of the fund
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_trailing_returns_inner'
type: array
x-go-name: TrailingReturns
x-order: 10
annual_total_returns:
description: Annual total returns of the fund
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_annual_total_returns_inner'
type: array
x-go-name: AnnualTotalReturns
x-order: 20
quarterly_total_returns:
description: Quarterly total returns of the fund
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_quarterly_total_returns_inner'
type: array
x-go-name: QuarterlyTotalReturns
x-order: 30
load_adjusted_return:
description: Load adjusted return of the fund
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_load_adjusted_return_inner'
type: array
x-go-name: LoadAdjustedReturn
x-order: 40
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/model/repository
GetMutualFundsWorldSummary_200_response_mutual_fund:
description: Mutual fund information
properties:
summary:
$ref: '#/components/schemas/ResponseMutualFundWorldSummary'
type: object
x-go-name: MutualFund
x-order: 10
GetMutualFundsList_200_response:
properties:
result:
$ref: '#/components/schemas/GetMutualFundsList_200_response_result'
status:
description: Response status
examples:
- ok
type: string
x-go-name: Status
required:
- status
type: object
GetMutualFundsWorld_200_response_mutual_fund_purchase_info:
description: Purchase information of a mutual fund
properties:
expenses:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_purchase_info_expenses'
minimums:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_purchase_info_minimums'
pricing:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_purchase_info_pricing'
brokerages:
description: List of brokerages where mutual fund can be purchased
examples:
- []
items:
type: string
type: array
x-go-name: Brokerages
x-order: 40
type: object
x-go-name: PurchaseInfo
x-order: 60
GetMutualFundsWorld_200_response_mutual_fund_risk:
description: Risk metrics of a mutual fund
properties:
volatility_measures:
description: Volatility statistics of the fund
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_risk_volatility_measures_inner'
type: array
x-go-name: VolatilityMeasures
x-order: 10
valuation_metrics:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_risk_valuation_metrics'
type: object
x-go-name: Risk
x-order: 30
GetMutualFundsWorldRisk_200_response_mutual_fund:
description: Mutual fund information
properties:
risk:
$ref: '#/components/schemas/ResponseMutualFundWorldRisk'
type: object
x-go-name: MutualFund
x-order: 10
GetMutualFundsWorld_200_response_mutual_fund_risk_volatility_measures_inner:
properties:
period:
description: Period of a measure
examples:
- 3_year
type: string
x-go-name: Period
x-order: 10
alpha:
description: Alpha score of a fund
examples:
- -9.12
format: double
type: number
x-go-name: Alpha
x-order: 20
alpha_category:
description: Average alpha score of a fund's category
examples:
- -0.0939
format: double
type: number
x-go-name: AlphaCategory
x-order: 30
beta:
description: Beta score of a fund
examples:
- 1
format: double
type: number
x-go-name: Beta
x-order: 40
beta_category:
description: Average beta score of a fund's category
examples:
- 0.0126
format: double
type: number
x-go-name: BetaCategory
x-order: 50
mean_annual_return:
description: Mean annual return of a fund
examples:
- 0.45
format: double
type: number
x-go-name: MeanAnnualReturn
x-order: 60
mean_annual_return_category:
description: Average mean annual return of a fund's category
examples:
- 0.0117
format: double
type: number
x-go-name: MeanAnnualReturnCategory
x-order: 70
r_squared:
description: R-squared metric of a fund
examples:
- 69
format: double
type: number
x-go-name: RSquared
x-order: 80
r_squared_category:
description: Average r-squared metric of a fund's category
examples:
- 0.8309
format: double
type: number
x-go-name: RSquaredCategory
x-order: 90
std:
description: Standard deviation of a fund
examples:
- 23.15
format: double
type: number
x-go-name: Std
x-order: 100
std_category:
description: Average standard deviation of a fund's category
examples:
- 0.2554
format: double
type: number
x-go-name: StdCategory
x-order: 110
sharpe_ratio:
description: Sharpe ratio of a fund
examples:
- 0.04
format: double
type: number
x-go-name: SharpeRatio
x-order: 120
sharpe_ratio_category:
description: Average sharpe ratio of a fund's category
examples:
- 0.005
format: double
type: number
x-go-name: SharpeRatioCategory
x-order: 130
treynor_ratio:
description: Treynor ratio of a fund
examples:
- -1.41
format: double
type: number
x-go-name: TreynorRatio
x-order: 140
treynor_ratio_category:
description: Average treynor ratio of a fund's category
examples:
- 0.0806
format: double
type: number
x-go-name: TreynorRatioCategory
x-order: 150
type: object
ResponseMutualFundWorldRatings:
description: Ratings of a mutual fund
properties:
performance_rating:
description: Performance rating from 0 to 5
examples:
- 2
format: int64
type: integer
x-go-name: PerformanceRating
x-order: 10
risk_rating:
description: Risk rating from 0 to 5
examples:
- 4
format: int64
type: integer
x-go-name: RiskRating
x-order: 20
return_rating:
description: Return rating from 0 to 5
examples:
- 0
format: int64
type: integer
x-go-name: ReturnRating
x-order: 30
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/model/repository
ApiInternalServerErrorResponseBody:
properties:
code:
description: Error code
examples:
- 500
format: int64
type: integer
x-go-name: Code
message:
description: Error message
examples:
- Internal server error
type: string
x-go-name: Message
status:
description: Error status
examples:
- error
type: string
x-go-name: Status
required:
- code
- message
- status
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/route/description
ResponseMutualFundWorldRisk:
description: Risk and volatility statistics of the fund and its category over different periods
properties:
volatility_measures:
description: Volatility statistics of the fund
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_risk_volatility_measures_inner'
type: array
x-go-name: VolatilityMeasures
x-order: 10
valuation_metrics:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_risk_valuation_metrics'
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/model/repository
GetMutualFundsWorldSummary_200_response:
properties:
mutual_fund:
$ref: '#/components/schemas/GetMutualFundsWorldSummary_200_response_mutual_fund'
status:
description: Status of the response
examples:
- ok
type: string
x-go-name: Status
x-order: 20
required:
- mutual_fund
- status
type: object
GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown_credit_quality_inner:
properties:
grade:
description: Rating of bond holding of a fund from AAA to below B
examples:
- U.S. Government
type: string
x-go-name: Grade
x-order: 10
weight:
description: Weight of bond holding in fund portfolio
examples:
- 0
format: double
type: number
x-go-name: Weight
x-order: 20
type: object
GetMutualFundsWorld_200_response_mutual_fund_composition_asset_allocation:
description: Asset allocation of the fund by different asset classes and their respective weights
properties:
cash:
description: Percentage of overall portfolio composition in cash
examples:
- 0.0043
format: double
type: number
x-go-name: Cash
x-order: 10
stocks:
description: Percentage of overall portfolio composition in stocks
examples:
- 0.9956
format: double
type: number
x-go-name: Stocks
x-order: 20
preferred_stocks:
description: Percentage of overall portfolio composition in preferred stocks
examples:
- 0
format: double
type: number
x-go-name: PreferredStocks
x-order: 30
convertables:
description: Percentage of overall portfolio composition in convertable securities
examples:
- 0
format: double
type: number
x-go-name: Convertables
x-order: 40
bonds:
description: Percentage of overall portfolio composition in bond
examples:
- 0
format: double
type: number
x-go-name: Bonds
x-order: 50
others:
description: Percentage of overall portfolio composition in other forms of holding
examples:
- 0
format: double
type: number
x-go-name: Others
x-order: 60
type: object
x-go-name: AssetAllocation
x-order: 20
GetMutualFundsWorld_200_response_mutual_fund_performance:
description: Detailed performance of a mutual fund
properties:
trailing_returns:
description: Trailing returns of the fund
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_trailing_returns_inner'
type: array
x-go-name: TrailingReturns
x-order: 10
annual_total_returns:
description: Annual total returns of the fund
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_annual_total_returns_inner'
type: array
x-go-name: AnnualTotalReturns
x-order: 20
quarterly_total_returns:
description: Quarterly total returns of the fund
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_quarterly_total_returns_inner'
type: array
x-go-name: QuarterlyTotalReturns
x-order: 30
load_adjusted_return:
description: Load adjusted return of the fund
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_load_adjusted_return_inner'
type: array
x-go-name: LoadAdjustedReturn
x-order: 40
type: object
x-go-name: Performance
x-order: 20
ApiParameterTooLongErrorResponseBody:
properties:
code:
description: Error code
examples:
- 414
format: int64
type: integer
x-go-name: Code
message:
description: Error message
examples:
- Input parameter array exceeds the allowed length
type: string
x-go-name: Message
status:
description: Error status
examples:
- error
type: string
x-go-name: Status
required:
- code
- message
- status
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/route/description
ApiForbiddenErrorResponseBody:
properties:
code:
description: Error code
examples:
- 403
format: int64
type: integer
x-go-name: Code
message:
description: Error message
examples:
- API key lacks permissions for the requested resource
type: string
x-go-name: Message
status:
description: Error status
examples:
- error
type: string
x-go-name: Status
required:
- code
- message
- status
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/route/description
GetMutualFundsWorldRisk_200_response:
properties:
mutual_fund:
$ref: '#/components/schemas/GetMutualFundsWorldRisk_200_response_mutual_fund'
status:
description: Status of the response
examples:
- ok
type: string
x-go-name: Status
x-order: 20
required:
- mutual_fund
- status
type: object
GetMutualFundsWorld_200_response_mutual_fund:
description: Mutual fund information
properties:
summary:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_summary'
performance:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance'
risk:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_risk'
ratings:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_ratings'
composition:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition'
purchase_info:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_purchase_info'
sustainability:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_sustainability'
type: object
x-go-name: MutualFund
x-order: 10
GetMutualFundsWorldSustainability_200_response_mutual_fund:
description: Mutual fund information
properties:
sustainability:
$ref: '#/components/schemas/ResponseMutualFundWorldSustainability'
type: object
x-go-name: Sustainability
x-order: 10
GetMutualFundsWorldPerformance_200_response_mutual_fund:
description: Mutual fund information
properties:
performance:
$ref: '#/components/schemas/ResponseMutualFundWorldPerformance'
type: object
x-go-name: MutualFund
x-order: 10
GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown_average_duration:
description: Average duration of bond holdings for the fund and its category
properties:
fund:
description: Average duration of bond holding of a fund
format: double
type: number
x-go-name: Fund
x-order: 10
category:
description: Average duration of bond holding of funds in the same category
examples:
- 1.64
format: double
type: number
x-go-name: Category
x-order: 20
type: object
x-go-name: AverageDuration
x-order: 20
GetMutualFundsWorld_200_response_mutual_fund_purchase_info_minimums:
description: Minimum investment amounts required to purchase or add to the mutual fund, including IRA minimums
properties:
initial_investment:
description: Investment minimum
examples:
- 0
format: int64
type: integer
x-go-name: InitialInvestment
x-order: 10
additional_investment:
description: Minimum amount of additional investment
examples:
- 0
format: int64
type: integer
x-go-name: AdditionalInvestment
x-order: 20
initial_ira_investment:
description: Investment minimum for IRA
format: int64
type: integer
x-go-name: InitialIraInvestment
x-order: 30
additional_ira_investment:
description: Minimum amount of additional investment for IRA
format: int64
type: integer
x-go-name: AdditionalIraInvestment
x-order: 40
type: object
x-go-name: Minimums
x-order: 20
GetMutualFundsList_200_response_result:
description: Response result
properties:
count:
description: Total number of matching funds
examples:
- 1000
format: int64
type: integer
x-go-name: Count
x-order: 10
list:
description: List of mutual funds
items:
$ref: '#/components/schemas/MutualFundsListResponseListItem'
type: array
x-go-name: Data
x-order: 20
required:
- count
- list
type: object
x-go-name: Result
GetMutualFundsWorld_200_response_mutual_fund_summary_people_inner:
properties:
name:
description: Manager name
examples:
- John Doe
type: string
x-go-name: Name
x-order: 10
tenure_since:
description: Manager tenuring date
examples:
- '2018-01-01'
type: string
x-go-name: TenureSince
x-order: 20
type: object
GetMutualFundsWorld_200_response_mutual_fund_performance_load_adjusted_return_inner:
properties:
period:
description: Period of a load adjusted return
examples:
- 1_year
type: string
x-go-name: Period
x-order: 10
return:
description: Actual return (%) an investor sees after accounting for fees and sales charges are deducted from a mutual fund's performance
examples:
- 0.06139
format: double
type: number
x-go-name: Return
x-order: 20
type: object
GetMutualFundsWorld_200_response_mutual_fund_composition:
description: Composition of a mutual fund
properties:
major_market_sectors:
description: Breakdown of the fund’s portfolio by major industry sectors and their respective weights
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_major_market_sectors_inner'
type: array
x-go-name: MajorMarketSectors
x-order: 10
asset_allocation:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_asset_allocation'
top_holdings:
description: Top holdings of the fund with their respective weights in the overall portfolio composition
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_top_holdings_inner'
type: array
x-go-name: TopHoldings
x-order: 20
bond_breakdown:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown'
type: object
x-go-name: Composition
x-order: 50
ResponseMutualFundWorldSustainability:
description: Sustainability score and ESG (Environmental, Social, Governance) metrics for the fund
properties:
score:
description: 'Sustainability score: asset-weighted average of normalized company-level ESG Scores for the covered holdings in the portfolio from `0` to `100`'
examples:
- 22
format: int64
type: integer
x-go-name: Score
x-order: 10
corporate_esg_pillars:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_sustainability_corporate_esg_pillars'
sustainable_investment:
description: Indication that the fund discloses in their prospectus that they employ socially responsible or ESG principles in their investment selection processes
examples:
- false
type: boolean
x-go-name: SustainableInvestment
x-order: 30
corporate_aum:
description: Percentage of AUM used to calculate sustainability score
examples:
- 0.99486
format: double
type: number
x-go-name: CorporateAum
x-order: 40
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/model/repository
GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown_average_maturity:
description: Average maturity of bond holdings for the fund and its category
properties:
fund:
description: Average maturity of bond holding of a fund
format: double
type: number
x-go-name: Fund
x-order: 10
category:
description: Average maturity of bond holding of funds in the same category
examples:
- 1.97
format: double
type: number
x-go-name: Category
x-order: 20
type: object
x-go-name: AverageMaturity
x-order: 10
FormatEnum:
default: JSON
enum:
- JSON
- CSV
type: string
x-go-name: Format
x-order: '90'
GetMutualFundsWorld_200_response_mutual_fund_performance_quarterly_total_returns_inner:
properties:
year:
description: Year of a fund quarter return
examples:
- 2024
format: int64
type: integer
x-go-name: Year
x-order: 10
q1:
description: Total return (%) of a fund in the first quarter
examples:
- 0.02358
format: double
type: number
x-go-name: Q1
x-order: 20
q2:
description: Total return (%) of a fund in the second quarter
examples:
- -0.03071
format: double
type: number
x-go-name: Q2
x-order: 30
q3:
description: Total return (%) of a fund in the third quarter
examples:
- 0.10099
format: double
type: number
x-go-name: Q3
x-order: 40
q4:
description: Total return (%) of a fund in the fourth quarter
examples:
- -0.00629
format: double
type: number
x-go-name: Q4
x-order: 50
type: object
MutualFundsListResponseListItem:
properties:
symbol:
description: Fund symbol ticker
examples:
- 0P0001LCQ3
type: string
x-go-name: Symbol
x-order: 10
name:
description: Fund name
examples:
- JNL Small Cap Index Fund (I)
type: string
x-go-name: Name
x-order: 20
country:
description: Country of fund incorporation
examples:
- United States
type: string
x-go-name: Country
x-order: 30
fund_family:
description: Investment company that manages the fund
examples:
- Jackson National
type: string
x-go-name: FundFamily
x-order: 40
fund_type:
description: Type of fund
examples:
- Small Blend
type: string
x-go-name: FundType
x-order: 50
performance_rating:
description: Performance rating from `0` to `5`
examples:
- 2
format: int64
type: integer
x-go-name: PerformanceRating
x-order: 60
risk_rating:
description: Risk rating from `0` to `5`
examples:
- 4
format: int64
type: integer
x-go-name: RiskRating
x-order: 70
currency:
description: Currency code in which the fund is denominated
examples:
- USD
type: string
x-go-name: Currency
x-order: 80
exchange:
description: Exchange name where the fund is listed
examples:
- OTC
type: string
x-go-name: Exchange
x-order: 90
mic_code:
description: Market identifier code (MIC) under ISO 10383 standard
examples:
- OTCM
type: string
x-go-name: MicCode
x-order: 100
required:
- country
- currency
- exchange
- fund_family
- fund_type
- mic_code
- name
- symbol
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/route/description
GetMutualFundsWorld_200_response_mutual_fund_sustainability:
description: Sustainability information of a mutual fund
properties:
score:
description: 'Sustainability score: asset-weighted average of normalized company-level ESG Scores for the covered holdings in the portfolio from `0` to `100`'
examples:
- 22
format: int64
type: integer
x-go-name: Score
x-order: 10
corporate_esg_pillars:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_sustainability_corporate_esg_pillars'
sustainable_investment:
description: Indication that the fund discloses in their prospectus that they employ socially responsible or ESG principles in their investment selection processes
examples:
- false
type: boolean
x-go-name: SustainableInvestment
x-order: 30
corporate_aum:
description: Percentage of AUM used to calculate sustainability score
examples:
- 0.99486
format: double
type: number
x-go-name: CorporateAum
x-order: 40
type: object
x-go-name: Sustainability
x-order: 70
GetMutualFundsWorld_200_response_mutual_fund_composition_top_holdings_inner:
properties:
symbol:
description: Symbol ticker of a holding instrument
examples:
- BBWI
type: string
x-go-name: Symbol
x-order: 10
name:
description: Name of a holding instrument
examples:
- Bath & Body Works Inc
type: string
x-go-name: Name
x-order: 20
exchange:
description: Exchange where instrument is traded
examples:
- NASDAQ
type: string
x-go-name: Exchange
x-order: 30
mic_code:
description: Market Identifier Code (MIC) under ISO 10383 standard
examples:
- XNAS
type: string
x-go-name: MicCode
x-order: 40
weight:
description: Weight of a holding instrument in overall portfolio composition
examples:
- 0.00624
format: double
type: number
x-go-name: Weight
x-order: 50
type: object
ResponseMutualFundWorldSummary:
description: A brief summary of a mutual fund
properties:
symbol:
description: All available fund types segmented by country
examples:
- 0P0001LCQ3
type: string
x-go-name: Symbol
x-order: 10
name:
description: Fund name
examples:
- JNL Small Cap Index Fund (I)
type: string
x-go-name: Name
x-order: 20
fund_family:
description: Investment company that manages the fund
examples:
- Jackson National
type: string
x-go-name: FundFamily
x-order: 30
fund_type:
description: Type of the fund
examples:
- Small Blend
type: string
x-go-name: FundType
x-order: 40
currency:
description: Currency of fund price
examples:
- USD
type: string
x-go-name: Currency
x-order: 50
share_class_inception_date:
description: The date from which the fund started operations and the returns are calculated
examples:
- '2021-04-26'
type: string
x-go-name: ShareClassInceptionDate
x-order: 60
ytd_return:
description: Percentage of profit of the fund since the first trading day of the current calendar year
examples:
- -0.02986
format: double
type: number
x-go-name: YtdReturn
x-order: 70
expense_ratio_net:
description: Percentage of mutual fund assets steered toward a fund's operating expenses and fund management fees
examples:
- 0.001
format: double
type: number
x-go-name: ExpenseRatioNet
x-order: 80
yield:
description: Income returned to its investors through interest and dividends generated by the fund's investments
examples:
- 0
format: double
type: number
x-go-name: Yield
x-order: 90
nav:
description: 'Net Asset Value: fund value minus liabilities'
examples:
- 10.09
format: double
type: number
x-go-name: Nav
x-order: 100
min_investment:
description: Investment minimum
examples:
- 0
format: int64
type: integer
x-go-name: MinInvestment
x-order: 110
turnover_rate:
description: Percentage rate at which mutual fund replaces its holdings on investment every year
examples:
- 0.32
format: double
type: number
x-go-name: TurnoverRate
x-order: 120
net_assets:
description: Total assets of a fund minus its total liabilities
examples:
- 2400762112
format: int64
type: integer
x-go-name: NetAssets
x-order: 130
overview:
description: Description of the fund
examples:
- The fund invests, normally, at least 80% of its assets in the stocks...
type: string
x-go-name: Overview
x-order: 140
people:
description: Information about the fund’s managers
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_summary_people_inner'
type: array
x-go-name: People
x-order: 150
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/model/repository
GetMutualFundsWorld_200_response_mutual_fund_composition_major_market_sectors_inner:
properties:
sector:
description: Sector category of a fund exposure
examples:
- Industrials
type: string
x-go-name: Sector
x-order: 10
weight:
description: Weight of a fund exposure in a sector
examples:
- 0.1742
format: double
type: number
x-go-name: Weight
x-order: 20
type: object
ApiNotFoundErrorResponseBody:
properties:
code:
description: Error code
examples:
- 404
format: int64
type: integer
x-go-name: Code
message:
description: Error message
examples:
- symbol or figi parameter is missing or invalid
type: string
x-go-name: Message
status:
description: Error status
examples:
- error
type: string
x-go-name: Status
required:
- code
- message
- status
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/route/description
GetMutualFundsWorld_200_response_mutual_fund_performance_trailing_returns_inner:
properties:
period:
description: Period of trailing returns
examples:
- ytd
type: string
x-go-name: Period
x-order: 10
share_class_return:
description: Fund returns (%) generated over a given period
examples:
- -0.02986
format: double
type: number
x-go-name: ShareClassReturn
x-order: 20
category_return:
description: Same category average returns (%) generated over a given period
examples:
- 0.2019
format: double
type: number
x-go-name: CategoryReturn
x-order: 30
rank_in_category:
description: Rank of a fund in category by total returns
examples:
- 76
format: int64
type: integer
x-go-name: RankInCategory
x-order: 40
type: object
ApiTooManyRequestsErrorResponseBody:
properties:
code:
description: Error code
examples:
- 429
format: int64
type: integer
x-go-name: Code
message:
description: Error message
examples:
- You have run out of API credits for the current minute. 1000 API credits were used, with the current limit being 987. Wait for the next minute or consider upgrading your plan at https://twelvedata.com/pricing
type: string
x-go-name: Message
status:
description: Error status
examples:
- error
type: string
x-go-name: Status
required:
- code
- message
- status
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/route/description
GetMutualFundsWorldRatings_200_response:
properties:
mutual_fund:
$ref: '#/components/schemas/GetMutualFundsWorldRatings_200_response_mutual_fund'
status:
description: Status of the response
examples:
- ok
type: string
x-go-name: Status
x-order: 20
required:
- mutual_fund
- status
type: object
GetMutualFundsWorld_200_response_mutual_fund_risk_valuation_metrics:
description: Valuation ratios and metrics of the fund and its category
properties:
price_to_earnings:
description: Fund price to earnings metric
examples:
- 0.05695
format: double
type: number
x-go-name: PriceToEarnings
x-order: 10
price_to_earnings_category:
description: Average price to earnings metric of funds in the same category
examples:
- 20.63
format: double
type: number
x-go-name: PriceToEarningsCategory
x-order: 20
price_to_book:
description: Fund price to book metric
examples:
- 0.55626
format: double
type: number
x-go-name: PriceToBook
x-order: 30
price_to_book_category:
description: Average price to book metric of funds in the same category
examples:
- 2.87
format: double
type: number
x-go-name: PriceToBookCategory
x-order: 40
price_to_sales:
description: Fund price to sales metric
examples:
- 0.97803
format: double
type: number
x-go-name: PriceToSales
x-order: 50
price_to_sales_category:
description: Average price to sales metric of funds in the same category
examples:
- 1.34
format: double
type: number
x-go-name: PriceToSalesCategory
x-order: 60
price_to_cashflow:
description: Fund price to cashflow metric
examples:
- 0.10564
format: double
type: number
x-go-name: PriceToCashflow
x-order: 70
price_to_cashflow_category:
description: Average price to cashflow metric of funds in the same category
examples:
- 11.81
format: double
type: number
x-go-name: PriceToCashflowCategory
x-order: 80
median_market_capitalization:
description: Median market capitalization of a fund
examples:
- 2965
format: int64
type: integer
x-go-name: MedianMarketCapitalization
x-order: 90
median_market_capitalization_category:
description: Median market capitalization of funds in the same category
examples:
- 4925
format: int64
type: integer
x-go-name: MedianMarketCapitalizationCategory
x-order: 100
3_year_earnings_growth:
description: Earnings growth over the last three years
examples:
- 16.32
format: double
type: number
x-go-name: ThreeYearEarningsGrowth
x-order: 110
3_year_earnings_growths_category:
description: Earnings growth over the last three years of funds in the same category
examples:
- 10.55
format: double
type: number
x-go-name: ThreeYearEarningsGrowthCategory
x-order: 120
type: object
x-go-name: ValuationMetrics
x-order: 20
GetMutualFundsWorldPurchaseInfo_200_response:
properties:
mutual_fund:
$ref: '#/components/schemas/GetMutualFundsWorldPurchaseInfo_200_response_mutual_fund'
status:
description: Status of the response
examples:
- ok
type: string
x-go-name: Status
x-order: 20
required:
- mutual_fund
- status
type: object
ResponseMutualFundWorldPurchaseInfo:
description: Purchase information for the mutual fund
properties:
expenses:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_purchase_info_expenses'
minimums:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_purchase_info_minimums'
pricing:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_purchase_info_pricing'
brokerages:
description: List of brokerages where mutual fund can be purchased
examples:
- []
items:
type: string
type: array
x-go-name: Brokerages
x-order: 40
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/model/repository
GetMutualFundsWorldComposition_200_response:
properties:
mutual_fund:
$ref: '#/components/schemas/GetMutualFundsWorldComposition_200_response_mutual_fund'
status:
description: Status of the response
examples:
- ok
type: string
x-go-name: Status
x-order: 20
required:
- mutual_fund
- status
type: object
GetMutualFundsWorldSustainability_200_response:
properties:
mutual_fund:
$ref: '#/components/schemas/GetMutualFundsWorldSustainability_200_response_mutual_fund'
status:
description: Status of the response
examples:
- ok
type: string
x-go-name: Status
x-order: 20
required:
- mutual_fund
- status
type: object
ResponseMutualFundWorldComposition:
description: Mutual fund composition
properties:
major_market_sectors:
description: Breakdown of the fund’s portfolio by major industry sectors and their respective weights
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_major_market_sectors_inner'
type: array
x-go-name: MajorMarketSectors
x-order: 10
asset_allocation:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_asset_allocation'
top_holdings:
description: Top holdings of the fund with their respective weights in the overall portfolio composition
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_top_holdings_inner'
type: array
x-go-name: TopHoldings
x-order: 20
bond_breakdown:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown'
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/model/repository
GetMutualFundsWorld_200_response_mutual_fund_ratings:
description: Ratings of a mutual fund
properties:
performance_rating:
description: Performance rating from 0 to 5
examples:
- 2
format: int64
type: integer
x-go-name: PerformanceRating
x-order: 10
risk_rating:
description: Risk rating from 0 to 5
examples:
- 4
format: int64
type: integer
x-go-name: RiskRating
x-order: 20
return_rating:
description: Return rating from 0 to 5
examples:
- 0
format: int64
type: integer
x-go-name: ReturnRating
x-order: 30
type: object
x-go-name: Ratings
x-order: 40
GetMutualFundsWorld_200_response:
properties:
mutual_fund:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund'
status:
description: Status of the response
examples:
- ok
type: string
x-go-name: Status
x-order: 20
required:
- mutual_fund
- status
type: object
ApiBadRequestErrorResponseBody:
properties:
code:
description: Error code
examples:
- 400
format: int64
type: integer
x-go-name: Code
message:
description: Error message
examples:
- Invalid request
type: string
x-go-name: Message
status:
description: Error status
examples:
- error
type: string
x-go-name: Status
required:
- code
- message
- status
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/route/description
GetMutualFundsType_200_response:
properties:
result:
additionalProperties:
items:
type: string
type: array
description: List of fund types by country
examples:
- Singapore:
- Property - Indirect Asia
- Sector Equity Water
- SGD Bond
- Singapore Equity
- Taiwan Large-Cap Equity
United States:
- Asia-Pacific ex-Japan Equity
- EUR Flexible Allocation - Global
- Euro Short Bond PP
- Large Blend
- Other Allocation
type: object
x-go-name: Result
x-order: 10
status:
description: Response status
examples:
- ok
type: string
x-go-name: Status
x-order: 20
required:
- result
- status
type: object
GetMutualFundsWorldPerformance_200_response:
properties:
mutual_fund:
$ref: '#/components/schemas/GetMutualFundsWorldPerformance_200_response_mutual_fund'
status:
description: Status of the response
examples:
- ok
type: string
x-go-name: Status
x-order: 20
required:
- mutual_fund
- status
type: object
GetMutualFundsFamily_200_response:
properties:
result:
additionalProperties:
items:
type: string
type: array
description: List of fund families by country
examples:
- India:
- Aberdeen Standard Fund Managers Limited
- Aditya Birla Sun Life AMC Ltd
United States:
- Aegon Asset Management UK PLC
- Ampega Investment GmbH
- Aviva SpA
type: object
x-go-name: Result
x-order: 10
status:
description: Response status
examples:
- ok
type: string
x-go-name: Status
x-order: 20
required:
- result
- status
type: object
GetMutualFundsWorldRatings_200_response_mutual_fund:
description: Mutual fund information
properties:
ratings:
$ref: '#/components/schemas/ResponseMutualFundWorldRatings'
type: object
x-go-name: MutualFund
x-order: 10
ApiUnauthorizedErrorResponseBody:
properties:
code:
description: Error code
examples:
- 401
format: int64
type: integer
x-go-name: Code
message:
description: Error message
examples:
- apikey parameter is incorrect or not specified
type: string
x-go-name: Message
status:
description: Error status
examples:
- error
type: string
x-go-name: Status
required:
- code
- message
- status
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/route/description
GetMutualFundsWorld_200_response_mutual_fund_summary:
description: A brief summary of a mutual fund
properties:
symbol:
description: All available fund types segmented by country
examples:
- 0P0001LCQ3
type: string
x-go-name: Symbol
x-order: 10
name:
description: Fund name
examples:
- JNL Small Cap Index Fund (I)
type: string
x-go-name: Name
x-order: 20
fund_family:
description: Investment company that manages the fund
examples:
- Jackson National
type: string
x-go-name: FundFamily
x-order: 30
fund_type:
description: Type of the fund
examples:
- Small Blend
type: string
x-go-name: FundType
x-order: 40
currency:
description: Currency of fund price
examples:
- USD
type: string
x-go-name: Currency
x-order: 50
share_class_inception_date:
description: The date from which the fund started operations and the returns are calculated
examples:
- '2021-04-26'
type: string
x-go-name: ShareClassInceptionDate
x-order: 60
ytd_return:
description: Percentage of profit of the fund since the first trading day of the current calendar year
examples:
- -0.02986
format: double
type: number
x-go-name: YtdReturn
x-order: 70
expense_ratio_net:
description: Percentage of mutual fund assets steered toward a fund's operating expenses and fund management fees
examples:
- 0.001
format: double
type: number
x-go-name: ExpenseRatioNet
x-order: 80
yield:
description: Income returned to its investors through interest and dividends generated by the fund's investments
examples:
- 0
format: double
type: number
x-go-name: Yield
x-order: 90
nav:
description: 'Net Asset Value: fund value minus liabilities'
examples:
- 10.09
format: double
type: number
x-go-name: Nav
x-order: 100
min_investment:
description: Investment minimum
examples:
- 0
format: int64
type: integer
x-go-name: MinInvestment
x-order: 110
turnover_rate:
description: Percentage rate at which mutual fund replaces its holdings on investment every year
examples:
- 0.32
format: double
type: number
x-go-name: TurnoverRate
x-order: 120
net_assets:
description: Total assets of a fund minus its total liabilities
examples:
- 2400762112
format: int64
type: integer
x-go-name: NetAssets
x-order: 130
overview:
description: Description of the fund
examples:
- The fund invests, normally, at least 80% of its assets in the stocks...
type: string
x-go-name: Overview
x-order: 140
people:
description: Information about the fund’s managers
items:
$ref: '#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_summary_people_inner'
type: array
x-go-name: People
x-order: 150
type: object
x-go-name: Summary
x-order: 10
securitySchemes:
authorizationHeader:
description: Enter the token with the `apikey ` prefix, e.g. "apikey abcde12345".
in: header
name: Authorization
type: apiKey
queryParameter:
in: query
name: apikey
type: apiKey
x-group-list:
- description: Access real-time and historical market prices—time series and exchange rates—for equities, forex, cryptocurrencies, ETFs, and more. These endpoints form the foundation for any trading or data-driven application.
name: Market data
order: 10
- children:
- description: Asset Catalog endpoints are your starting point. They return the complete inventory of tradeable instruments available through Twelve Data — over 1,000,000 symbols across 50+ countries. You query a catalog first to discover which symbols exist, then pass those symbols to price, fundamental, or indicator endpoints.
name: Asset catalogs
order: 10
- description: Discovery endpoints help you find instruments when you don't already know the exact identifier. The Asset Catalog is the phone book; Discovery is the search engine on top of it.
name: Discovery
order: 20
- description: 'Market endpoints answer operational questions about exchanges themselves: which ones are open right now, what are their trading hours, and how far back does data go for a given instrument?'
name: Markets
order: 30
- description: 'Metadata endpoints return the lookup tables and enumerations that define valid parameter values across the entire API. They answer: what instrument types exist? What intervals are supported? Which countries are covered? What technical indicators can I use?'
name: Supporting metadata
order: 40
description: Lookup static metadata—symbol lists, exchange details, currency information-to filter, validate, and contextualize your core data calls. Ideal for building dropdowns, mappings, and ensuring data consistency.
name: Reference data
order: 20
- description: In-depth company and fund financials—income statements, balance sheets, cash flows, profiles, corporate events, and key ratios. Unlock comprehensive datasets for valuation, screening, and fundamental research.
name: Fundamentals
order: 30
- name: Currencies
order: 35
- description: 'ETF-focused metadata and analytics: universe lists, family and type groupings, NAV snapshots, performance metrics, risk measures, and current fund composition. Tailored to the unique characteristics and reporting cadence of exchange-traded funds.'
name: ETFs
order: 40
- description: 'Mutual-fund-specific listings and snapshots: fund directories, issuer families, fund types, NAV history, dividend records, key ratios, and portfolio holdings. Ideal for long-term performance analysis and portfolio attribution.'
name: Mutual funds
order: 50
- description: 'Money-market-fund directories and full-data snapshots: fund listings ranked by fund size, plus screener metrics (fund size, liquidity, weighted average maturity), yields, key facts, and risk indicators. Focused on short-term, low-risk cash-management instruments for liquidity and capital-preservation analysis.'
name: Money market funds
order: 55
- children:
- description: Plotted directly on the price chart to smooth or envelope price data, highlighting trend direction, support/resistance, and mean-reversion levels (e.g. moving averages, Bollinger Bands, Parabolic SAR, Ichimoku Cloud, Keltner Channels, McGinley Dynamic).
name: Overlap studies
order: 10
- description: Oscillators that measure the speed or strength of price movement, helping detect overbought/oversold conditions, divergences, and shifts in trend momentum (e.g. RSI, MACD, ROC, Stochastics, ADX, CCI, Coppock Curve, TRIX).
name: Momentum indicators
order: 20
- description: Use trading volume to confirm price moves or warn of exhaustion—volume and price in tandem suggest trend strength, while divergences can signal reversals (e.g. OBV, Chaikin AD, Accumulation/Distribution Oscillator).
name: Volume indicators
order: 30
- description: Quantify the range or dispersion of price over time to gauge risk, size stops, or identify breakouts (e.g. ATR, NATR, True Range) and adaptive overlays like SuperTrend.
name: Volatility indicators
order: 40
- description: Convert raw OHLC data into derived series or aggregated values to feed other indicators or reveal different perspectives on price (e.g. typical price, HLC3, weighted close, arithmetic transforms like SUM, AVG, LOG, SQRT).
name: Price transform
order: 50
- description: Detect and follow recurring periodic patterns in price action using Hilbert Transform–based measures of cycle period and phase (e.g. HT_SINE, HT_DCPERIOD, HT_DCPHASE, HT_PHASOR, HT_TRENDMODE).
name: Cycle indicators
order: 60
- description: Scan bars or bar‐groups for predefined candlestick patterns that historically signal continuation or reversal setups (e.g. Doji, Hammer, Engulfing, Three Black Crows, Morning Star, Dark Cloud Cover, etc.).
name: Pattern recognition
order: 70
- description: Compute fundamental statistical metrics on price series—dispersion, regression, correlation, and forecasting components—for standalone analysis or as inputs to other models (e.g. STDDEV, VAR, LINEARREG, CORREL, TSF, BETA).
name: Statistic functions
order: 80
- name: Math transform
order: 90
description: On-demand calculation of popular indicators (SMA, EMA, RSI, MACD, Bollinger Bands, etc.) over any supported time series. Streamline chart overlays, signal generation, and backtesting without external libraries.
name: Technical indicators
order: 60
- description: Forward-looking and consensus analytics—earnings and revenue estimates, EPS trends and revisions, growth projections, analyst recommendations and ratings, price targets, and other consensus metrics. Perfect for incorporating expert forecasts and sentiment into your models and dashboards.
name: Analysis
order: 70
- description: 'Compliance and filings data: insider transactions, SEC reports, governance documents, and more. Critical for audit trails, due-diligence workflows, and risk-management integrations.'
name: Regulatory
order: 80
- description: High-throughput and management endpoints for power users—submit and monitor batch jobs to pull large datasets asynchronously, track your API usage and quotas programmatically, and access other developer-focused tools for automating and scaling your data workflows.
name: Advanced
order: 90
x-original-swagger-version: '2.0'