GetStocks
Fetch an updated daily list of stock symbols from Twelve Data API, filtering by symbol, exchange, country, or asset type to access metadata on stocks, forex pairs, and cryptocurrencies.
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",
"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",
"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"
},
"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"
],
"title": "Type"
}
},
"title": "GetStocksRequest",
"type": "object"
}
},
"properties": {
"params": {
"$ref": "#/$defs/GetStocksRequest"
}
},
"required": [
"params"
],
"title": "GetStocksArguments",
"type": "object"
}