GetStocks
Retrieve updated stock symbols and metadata using parameters like ticker, ISIN, or exchange. Filter by country, asset type, or market identifier for precise financial market data.
Instructions
This API call returns an array of symbols available at Twelve Data API. This list is updated daily.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Input Schema (JSON Schema)
{
"$defs": {
"GetStocksRequest": {
"description": "This API call returns an array of symbols available at Twelve Data API. This list is updated daily.",
"properties": {
"apikey": {
"default": "demo",
"description": "API key",
"examples": [
"demo"
],
"title": "Apikey",
"type": "string"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by country name or alpha code, e.g., `United States` or `US`",
"examples": [
"United States"
],
"title": "Country"
},
"cusip": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The CUSIP of an instrument for which data is requested",
"examples": [
"594918104"
],
"title": "Cusip"
},
"delimiter": {
"default": ";",
"description": "The separator used in the CSV response data",
"title": "Delimiter",
"type": "string"
},
"exchange": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by exchange name",
"examples": [
"NASDAQ"
],
"title": "Exchange"
},
"figi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by financial instrument global identifier (FIGI)",
"examples": [
"BBG000B9Y5X2"
],
"title": "Figi"
},
"format": {
"default": "JSON",
"description": "The format of the response data",
"examples": [
"JSON",
"CSV"
],
"title": "Format",
"type": "string"
},
"include_delisted": {
"default": false,
"description": "Include delisted identifiers",
"title": "Include Delisted",
"type": "boolean"
},
"isin": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by international securities identification number (ISIN)",
"examples": [
"US0378331005"
],
"title": "Isin"
},
"mic_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by market identifier code (MIC) under ISO 10383 standard",
"examples": [
"XNGS"
],
"title": "Mic Code"
},
"outputsize": {
"default": 10,
"description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `10` when no date parameters are set, otherwise set to maximum",
"examples": [
10
],
"title": "Outputsize",
"type": "integer"
},
"show_plan": {
"default": false,
"description": "Adds info on which plan symbol is available",
"title": "Show Plan",
"type": "boolean"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ticker symbol of an instrument for which data is requested",
"examples": [
"AAPL"
],
"title": "Symbol"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The asset class to which the instrument belongs",
"examples": [
"Common Stock",
"American Depositary Receipt",
"Bond",
"Bond Fund",
"Closed-end Fund",
"Common Stock",
"Depositary Receipt",
"Digital Currency",
"ETF",
"Exchange-Traded Note",
"Global Depositary Receipt",
"Index",
"Limited Partnership",
"Mutual Fund",
"Physical Currency",
"Preferred Stock",
"REIT",
"Right",
"Structured Product",
"Trust",
"Unit",
"Warrant"
],
"title": "Type"
}
},
"title": "GetStocksRequest",
"type": "object"
}
},
"properties": {
"params": {
"$ref": "#/$defs/GetStocksRequest"
}
},
"required": [
"params"
],
"title": "GetStocksArguments",
"type": "object"
}