/twelvedata-market-data | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
twelvedata_market_data_get_api_usage | API usage |
twelvedata_market_data_get_currency_conversion | Currency conversion |
twelvedata_market_data_get_eod | End of day price |
twelvedata_market_data_get_exchange_rate | Exchange rate |
twelvedata_market_data_get_movers | Market movers |
twelvedata_market_data_get_price | Latest price |
twelvedata_market_data_get_quote | Quote |
twelvedata_market_data_get_time_series | Time series |
twelvedata_market_data_get_time_series_cross | Time series cross |
twelvedata_market_data_get_api_usage
API usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
format | string | No | — | Output format |
delimiter | string | No | — | Specify the delimiter used when downloading the CSV file |
timezone | string | No | — | Timezone at which output datetime will be displayed. Supports: <ul> <li>1. <code>UTC</code> for datetime at universal UTC standard</li> <li>2. Timezone name according to the IANA Time Zone Database. E.g. <code>America/New_York</code>, <code>Asia/Singapore</code>. Full list of timezones can be found <a href=“https://en.wikipedia.org/wiki/List_of_tz_database_time_zones” target=“blank”>here</a>.</li> </ul> <i>Take note that the IANA Timezone name is case-sensitive</i> |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"format": {
"type": "string",
"description": "Output format",
"enum": [
"JSON",
"CSV"
]
},
"delimiter": {
"type": "string",
"description": "Specify the delimiter used when downloading the CSV file"
},
"timezone": {
"type": "string",
"description": "Timezone at which output datetime will be displayed. Supports: <ul> <li>1. <code>UTC</code> for datetime at universal UTC standard</li> <li>2. Timezone name according to the IANA Time Zone Database. E.g. <code>America/New_York</code>, <code>Asia/Singapore</code>. Full list of timezones can be found <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\" target=\"blank\">here</a>.</li> </ul> <i>Take note that the IANA Timezone name is case-sensitive</i>"
}
},
"required": [
"PCID"
]
}
twelvedata_market_data_get_currency_conversion
Currency conversion Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
symbol | string | Yes | — | The currency pair you want to request can be either forex or cryptocurrency. Slash(/) delimiter is used. E.g. EUR/USD or BTC/ETH will be correct |
amount | number | Yes | — | Amount of base currency to be converted into quote currency. Supports values in the range from 0 and above |
date | string | No | — | If not null, will use exchange rate from a specific date or time. Format 2006-01-02 or 2006-01-02T15:04:05. Is set in the local exchange time zone, use timezone parameter to specify a specific time zone |
format | string | No | — | Value can be JSON or CSV. Default JSON |
delimiter | string | No | — | Specify the delimiter used when downloading the CSV file. Default semicolon ; |
dp | integer | No | — | The number of decimal places for the data |
timezone | string | No | — | Timezone at which output datetime will be displayed. Supports: <ul> <li>1. <code>Exchange</code> for local exchange time</li> <li>2. <code>UTC</code> for datetime at universal UTC standard</li> <li>3. Timezone name according to the IANA Time Zone Database. E.g. <code>America/New_York</code>, <code>Asia/Singapore</code>. Full list of timezones can be found <a href=“https://en.wikipedia.org/wiki/List_of_tz_database_time_zones” target=“blank”>here</a>.</li> </ul> <i>Take note that the IANA Timezone name is case-sensitive</i> |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"symbol": {
"type": "string",
"description": "The currency pair you want to request can be either forex or cryptocurrency. Slash(`/`) delimiter is used. E.g. `EUR/USD` or `BTC/ETH` will be correct"
},
"amount": {
"type": "number",
"description": "Amount of base currency to be converted into quote currency. Supports values in the range from `0` and above"
},
"date": {
"type": "string",
"description": "If not null, will use exchange rate from a specific date or time. Format `2006-01-02` or `2006-01-02T15:04:05`. Is set in the local exchange time zone, use timezone parameter to specify a specific time zone"
},
"format": {
"type": "string",
"description": "Value can be `JSON` or `CSV`. Default `JSON`",
"enum": [
"JSON",
"CSV"
]
},
"delimiter": {
"type": "string",
"description": "Specify the delimiter used when downloading the `CSV` file. Default semicolon `;`"
},
"dp": {
"type": "integer",
"description": "The number of decimal places for the data"
},
"timezone": {
"type": "string",
"description": "Timezone at which output datetime will be displayed. Supports: <ul> <li>1. <code>Exchange</code> for local exchange time</li> <li>2. <code>UTC</code> for datetime at universal UTC standard</li> <li>3. Timezone name according to the IANA Time Zone Database. E.g. <code>America/New_York</code>, <code>Asia/Singapore</code>. Full list of timezones can be found <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\" target=\"blank\">here</a>.</li> </ul> <i>Take note that the IANA Timezone name is case-sensitive</i>"
}
},
"required": [
"PCID",
"symbol",
"amount"
]
}
twelvedata_market_data_get_eod
End of day price Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
symbol | string | No | — | Symbol ticker of the instrument |
figi | string | No | — | Filter by financial instrument global identifier (FIGI). This parameter is available on the <a href=“https://twelvedata.com/pricing”>Ultra</a> plan (individual) and the <a href=“https://twelvedata.com/pricing-business”>Enterprise</a> plan (business) and above. |
isin | string | No | — | Filter by international securities identification number (ISIN). ISIN access is activating in the <a href=“https://twelvedata.com/account/add-ons”>Data add-ons</a> section |
cusip | string | No | — | The CUSIP of an instrument for which data is requested. CUSIP access is activating in the <a href=“https://twelvedata.com/account/add-ons”>Data add-ons</a> section |
exchange | string | No | — | Exchange where instrument is traded |
mic_code | string | No | — | Market Identifier Code (MIC) under ISO 10383 standard |
country | string | No | — | Country where instrument is traded, e.g., United States or US |
type | string | No | — | The asset class to which the instrument belongs |
date | string | No | — | If not null, then return data from a specific date |
prepost | boolean | No | — | Parameter is optional. Only for the Pro plan (individual) and Venture plan (business) and above. Available at the 1min, 5min, 15min, and 30min intervals for US equities. Open, high, low, close values are supplied without volume |
dp | integer | No | — | Specifies the number of decimal places for floating values Should be in range [0,11] inclusive |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"symbol": {
"type": "string",
"description": "Symbol ticker of the instrument"
},
"figi": {
"type": "string",
"description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the <a href=\"https://twelvedata.com/pricing\">Ultra</a> plan (individual) and the <a href=\"https://twelvedata.com/pricing-business\">Enterprise</a> plan (business) and above."
},
"isin": {
"type": "string",
"description": "Filter by international securities identification number (ISIN). ISIN access is activating in the <a href=\"https://twelvedata.com/account/add-ons\">Data add-ons</a> section"
},
"cusip": {
"type": "string",
"description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the <a href=\"https://twelvedata.com/account/add-ons\">Data add-ons</a> section"
},
"exchange": {
"type": "string",
"description": "Exchange where instrument is traded"
},
"mic_code": {
"type": "string",
"description": "Market Identifier Code (MIC) under ISO 10383 standard"
},
"country": {
"type": "string",
"description": "Country where instrument is traded, e.g., `United States` or `US`"
},
"type": {
"type": "string",
"description": "The asset class to which the instrument belongs",
"enum": [
"American Depositary Receipt",
"Bond",
"Bond Fund",
"Closed-end Fund",
"Common Stock",
"Depositary Receipt",
"Digital Currency",
"ETF",
"Exchange-Traded Note",
"Global Depositary Receipt",
"Limited Partnership",
"Mutual Fund",
"Physical Currency",
"Preferred Stock",
"REIT",
"Right",
"Structured Product",
"Trust",
"Unit",
"Warrant"
]
},
"date": {
"type": "string",
"description": "If not null, then return data from a specific date"
},
"prepost": {
"type": "boolean",
"description": "Parameter is optional. Only for the `Pro` plan (individual) and `Venture` plan (business) and above. Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities. Open, high, low, close values are supplied without volume"
},
"dp": {
"type": "integer",
"description": "Specifies the number of decimal places for floating values Should be in range [0,11] inclusive"
}
},
"required": [
"PCID"
]
}
twelvedata_market_data_get_exchange_rate
Exchange rate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
symbol | string | Yes | — | The currency pair you want to request can be either forex or cryptocurrency. Slash(/) delimiter is used. E.g. EUR/USD or BTC/ETH will be correct |
date | string | No | — | If not null, will use exchange rate from a specific date or time. Format 2006-01-02 or 2006-01-02T15:04:05. Is set in the local exchange time zone, use timezone parameter to specify a specific time zone |
format | string | No | — | Value can be JSON or CSV. Default JSON |
delimiter | string | No | — | Specify the delimiter used when downloading the CSV file. Default semicolon ; |
dp | integer | No | — | The number of decimal places for the data |
timezone | string | No | — | Timezone at which output datetime will be displayed. Supports: <ul> <li>1. <code>Exchange</code> for local exchange time</li> <li>2. <code>UTC</code> for datetime at universal UTC standard</li> <li>3. Timezone name according to the IANA Time Zone Database. E.g. <code>America/New_York</code>, <code>Asia/Singapore</code>. Full list of timezones can be found <a href=“https://en.wikipedia.org/wiki/List_of_tz_database_time_zones” target=“blank”>here</a>.</li> </ul> <i>Take note that the IANA Timezone name is case-sensitive</i> |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"symbol": {
"type": "string",
"description": "The currency pair you want to request can be either forex or cryptocurrency. Slash(`/`) delimiter is used. E.g. `EUR/USD` or `BTC/ETH` will be correct"
},
"date": {
"type": "string",
"description": "If not null, will use exchange rate from a specific date or time. Format `2006-01-02` or `2006-01-02T15:04:05`. Is set in the local exchange time zone, use timezone parameter to specify a specific time zone"
},
"format": {
"type": "string",
"description": "Value can be `JSON` or `CSV`. Default `JSON`",
"enum": [
"JSON",
"CSV"
]
},
"delimiter": {
"type": "string",
"description": "Specify the delimiter used when downloading the `CSV` file. Default semicolon `;`"
},
"dp": {
"type": "integer",
"description": "The number of decimal places for the data"
},
"timezone": {
"type": "string",
"description": "Timezone at which output datetime will be displayed. Supports: <ul> <li>1. <code>Exchange</code> for local exchange time</li> <li>2. <code>UTC</code> for datetime at universal UTC standard</li> <li>3. Timezone name according to the IANA Time Zone Database. E.g. <code>America/New_York</code>, <code>Asia/Singapore</code>. Full list of timezones can be found <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\" target=\"blank\">here</a>.</li> </ul> <i>Take note that the IANA Timezone name is case-sensitive</i>"
}
},
"required": [
"PCID",
"symbol"
]
}
twelvedata_market_data_get_movers
Market movers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
market | string | Yes | — | Market type |
direction | string | No | — | Specifies direction of the snapshot gainers or losers |
outputsize | integer | No | — | Specifies the size of the snapshot. Can be in a range from 1 to 50 |
country | string | No | — | Country of the snapshot, applicable to non-currencies only. Takes country name or alpha code |
price_greater_than | string | No | — | Takes values with price grater than specified value |
dp | string | No | — | Specifies the number of decimal places for floating values. Should be in range [0,11] inclusive |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"market": {
"type": "string",
"description": "Market type",
"enum": [
"stocks",
"etf",
"mutual_funds",
"forex",
"crypto"
]
},
"direction": {
"type": "string",
"description": "Specifies direction of the snapshot gainers or losers",
"enum": [
"gainers",
"losers"
]
},
"outputsize": {
"type": "integer",
"description": "Specifies the size of the snapshot. Can be in a range from `1` to `50`"
},
"country": {
"type": "string",
"description": "Country of the snapshot, applicable to non-currencies only. Takes country name or alpha code"
},
"price_greater_than": {
"type": "string",
"description": "Takes values with price grater than specified value"
},
"dp": {
"type": "string",
"description": "Specifies the number of decimal places for floating values. Should be in range [0,11] inclusive"
}
},
"required": [
"PCID",
"market"
]
}
twelvedata_market_data_get_price
Latest price Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
symbol | string | No | — | Symbol ticker of the instrument |
figi | string | No | — | Filter by financial instrument global identifier (FIGI). This parameter is available on the <a href=“https://twelvedata.com/pricing”>Ultra</a> plan (individual) and the <a href=“https://twelvedata.com/pricing-business”>Enterprise</a> plan (business) and above. |
isin | string | No | — | Filter by international securities identification number (ISIN). ISIN access is activating in the <a href=“https://twelvedata.com/account/add-ons”>Data add-ons</a> section |
cusip | string | No | — | The CUSIP of an instrument for which data is requested. CUSIP access is activating in the <a href=“https://twelvedata.com/account/add-ons”>Data add-ons</a> section |
exchange | string | No | — | Exchange where instrument is traded |
mic_code | string | No | — | Market Identifier Code (MIC) under ISO 10383 standard |
country | string | No | — | Country where instrument is traded, e.g., United States or US |
type | string | No | — | The asset class to which the instrument belongs |
format | string | No | — | Value can be JSON or CSV |
delimiter | string | No | — | Specify the delimiter used when downloading the CSV file |
prepost | boolean | No | — | Parameter is optional. Only for Pro or Venture, and above plans. Available at the 1min, 5min, 15min, and 30min intervals for US equities. Open, high, low, close values are supplied without volume. |
dp | integer | No | — | Specifies the number of decimal places for floating values. Should be in range [0,11] inclusive |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"symbol": {
"type": "string",
"description": "Symbol ticker of the instrument"
},
"figi": {
"type": "string",
"description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the <a href=\"https://twelvedata.com/pricing\">Ultra</a> plan (individual) and the <a href=\"https://twelvedata.com/pricing-business\">Enterprise</a> plan (business) and above."
},
"isin": {
"type": "string",
"description": "Filter by international securities identification number (ISIN). ISIN access is activating in the <a href=\"https://twelvedata.com/account/add-ons\">Data add-ons</a> section"
},
"cusip": {
"type": "string",
"description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the <a href=\"https://twelvedata.com/account/add-ons\">Data add-ons</a> section"
},
"exchange": {
"type": "string",
"description": "Exchange where instrument is traded"
},
"mic_code": {
"type": "string",
"description": "Market Identifier Code (MIC) under ISO 10383 standard"
},
"country": {
"type": "string",
"description": "Country where instrument is traded, e.g., `United States` or `US`"
},
"type": {
"type": "string",
"description": "The asset class to which the instrument belongs",
"enum": [
"American Depositary Receipt",
"Bond",
"Bond Fund",
"Closed-end Fund",
"Common Stock",
"Depositary Receipt",
"Digital Currency",
"ETF",
"Exchange-Traded Note",
"Global Depositary Receipt",
"Limited Partnership",
"Mutual Fund",
"Physical Currency",
"Preferred Stock",
"REIT",
"Right",
"Structured Product",
"Trust",
"Unit",
"Warrant"
]
},
"format": {
"type": "string",
"description": "Value can be JSON or CSV",
"enum": [
"JSON",
"CSV"
]
},
"delimiter": {
"type": "string",
"description": "Specify the delimiter used when downloading the CSV file"
},
"prepost": {
"type": "boolean",
"description": "Parameter is optional. Only for Pro or Venture, and above plans. Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities. Open, high, low, close values are supplied without volume."
},
"dp": {
"type": "integer",
"description": "Specifies the number of decimal places for floating values. Should be in range [0,11] inclusive"
}
},
"required": [
"PCID"
]
}
twelvedata_market_data_get_quote
Quote Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
symbol | string | No | — | Symbol ticker of the instrument |
figi | string | No | — | Filter by financial instrument global identifier (FIGI). This parameter is available on the <a href=“https://twelvedata.com/pricing”>Ultra</a> plan (individual) and the <a href=“https://twelvedata.com/pricing-business”>Enterprise</a> plan (business) and above. |
isin | string | No | — | Filter by international securities identification number (ISIN). ISIN access is activating in the <a href=“https://twelvedata.com/account/add-ons”>Data add-ons</a> section |
cusip | string | No | — | The CUSIP of an instrument for which data is requested. CUSIP access is activating in the <a href=“https://twelvedata.com/account/add-ons”>Data add-ons</a> section |
interval | string | No | — | Interval of the quote |
exchange | string | No | — | Exchange where instrument is traded |
mic_code | string | No | — | Market Identifier Code (MIC) under ISO 10383 standard |
country | string | No | — | Country where instrument is traded, e.g., United States or US |
volume_time_period | integer | No | — | Number of periods for Average Volume |
type | string | No | — | The asset class to which the instrument belongs |
format | string | No | — | Value can be JSON or CSV Default JSON |
delimiter | string | No | — | Specify the delimiter used when downloading the CSV file |
prepost | boolean | No | — | Parameter is optional. Only for the Pro plan (individual) and Venture plan (business) and above. Available at the 1min, 5min, 15min, and 30min intervals for US equities. Open, high, low, close values are supplied without volume. |
eod | boolean | No | — | If true, then return data for closed day |
rolling_period | integer | No | — | Number of hours for calculate rolling change at period. By default set to 24, it can be in range [1, 168]. |
dp | integer | No | — | Specifies the number of decimal places for floating values Should be in range [0,11] inclusive |
timezone | string | No | — | Timezone at which output datetime will be displayed. Supports: <ul> <li>1. <code>Exchange</code> for local exchange time</li> <li>2. <code>UTC</code> for datetime at universal UTC standard</li> <li>3. Timezone name according to the IANA Time Zone Database. E.g. <code>America/New_York</code>, <code>Asia/Singapore</code>. Full list of timezones can be found <a href=“https://en.wikipedia.org/wiki/List_of_tz_database_time_zones” target=“blank”>here</a>.</li> </ul> <p>Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.</p> <i>Take note that the IANA Timezone name is case-sensitive</i> |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"symbol": {
"type": "string",
"description": "Symbol ticker of the instrument"
},
"figi": {
"type": "string",
"description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the <a href=\"https://twelvedata.com/pricing\">Ultra</a> plan (individual) and the <a href=\"https://twelvedata.com/pricing-business\">Enterprise</a> plan (business) and above."
},
"isin": {
"type": "string",
"description": "Filter by international securities identification number (ISIN). ISIN access is activating in the <a href=\"https://twelvedata.com/account/add-ons\">Data add-ons</a> section"
},
"cusip": {
"type": "string",
"description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the <a href=\"https://twelvedata.com/account/add-ons\">Data add-ons</a> section"
},
"interval": {
"type": "string",
"description": "Interval of the quote",
"enum": [
"1min",
"5min",
"15min",
"30min",
"45min",
"1h",
"2h",
"4h",
"8h",
"1day",
"1week",
"1month"
]
},
"exchange": {
"type": "string",
"description": "Exchange where instrument is traded"
},
"mic_code": {
"type": "string",
"description": "Market Identifier Code (MIC) under ISO 10383 standard"
},
"country": {
"type": "string",
"description": "Country where instrument is traded, e.g., `United States` or `US`"
},
"volume_time_period": {
"type": "integer",
"description": "Number of periods for Average Volume"
},
"type": {
"type": "string",
"description": "The asset class to which the instrument belongs",
"enum": [
"American Depositary Receipt",
"Bond",
"Bond Fund",
"Closed-end Fund",
"Common Stock",
"Depositary Receipt",
"Digital Currency",
"ETF",
"Exchange-Traded Note",
"Global Depositary Receipt",
"Limited Partnership",
"Mutual Fund",
"Physical Currency",
"Preferred Stock",
"REIT",
"Right",
"Structured Product",
"Trust",
"Unit",
"Warrant"
]
},
"format": {
"type": "string",
"description": "Value can be JSON or CSV Default JSON",
"enum": [
"JSON",
"CSV"
]
},
"delimiter": {
"type": "string",
"description": "Specify the delimiter used when downloading the CSV file"
},
"prepost": {
"type": "boolean",
"description": "Parameter is optional. Only for the `Pro` plan (individual) and `Venture` plan (business) and above. Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities. Open, high, low, close values are supplied without volume."
},
"eod": {
"type": "boolean",
"description": "If true, then return data for closed day"
},
"rolling_period": {
"type": "integer",
"description": "Number of hours for calculate rolling change at period. By default set to 24, it can be in range [1, 168]."
},
"dp": {
"type": "integer",
"description": "Specifies the number of decimal places for floating values Should be in range [0,11] inclusive"
},
"timezone": {
"type": "string",
"description": "Timezone at which output datetime will be displayed. Supports: <ul> <li>1. <code>Exchange</code> for local exchange time</li> <li>2. <code>UTC</code> for datetime at universal UTC standard</li> <li>3. Timezone name according to the IANA Time Zone Database. E.g. <code>America/New_York</code>, <code>Asia/Singapore</code>. Full list of timezones can be found <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\" target=\"blank\">here</a>.</li> </ul> <p>Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.</p> <i>Take note that the IANA Timezone name is case-sensitive</i>"
}
},
"required": [
"PCID"
]
}
twelvedata_market_data_get_time_series
Time series Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
symbol | string | No | — | Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, … |
isin | string | No | — | Filter by international securities identification number (ISIN). ISIN access is activating in the <a href=“https://twelvedata.com/account/add-ons”>Data add-ons</a> section |
figi | string | No | — | The FIGI of an instrument for which data is requested. This parameter is available on the <a href=“https://twelvedata.com/pricing”>Ultra</a> plan (individual) and the <a href=“https://twelvedata.com/pricing-business”>Enterprise</a> plan (business) and above. |
cusip | string | No | — | The CUSIP of an instrument for which data is requested. CUSIP access is activating in the <a href=“https://twelvedata.com/account/add-ons”>Data add-ons</a> section |
interval | string | Yes | — | Interval between two consecutive points in time series |
outputsize | integer | No | — | Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set, otherwise set to maximum |
exchange | string | No | — | Exchange where instrument is traded |
mic_code | string | No | — | Market Identifier Code (MIC) under ISO 10383 standard |
country | string | No | — | The country where the instrument is traded, e.g., United States or US |
type | string | No | — | The asset class to which the instrument belongs |
timezone | string | No | — | Timezone at which output datetime will be displayed. Supports: <ul> <li>1. <code>Exchange</code> for local exchange time</li> <li>2. <code>UTC</code> for datetime at universal UTC standard</li> <li>3. Timezone name according to the IANA Time Zone Database. E.g. <code>America/New_York</code>, <code>Asia/Singapore</code>. Full list of timezones can be found <a href=“https://en.wikipedia.org/wiki/List_of_tz_database_time_zones” target=“blank”>here</a></li> </ul> <p>Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.</p> <i>Take note that the IANA Timezone name is case-sensitive</i> |
start_date | string | No | — | Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05 Default location: <ul> <li>Forex and Cryptocurrencies - <code>UTC</code></li> <li>Stocks - where exchange is located (e.g. for AAPL it will be <code>America/New_York</code>)</li> </ul> Both parameters take into account if <code>timezone</code> parameter is provided.<br/> If <code>timezone</code> is given then, <code>start_date</code> and <code>end_date</code> will be used in the specified location Examples: <ul> <li>1. <code>&symbol=AAPL&start_date=2019-08-09T15:50:00&…</code><br/> Returns all records starting from 2019-08-09T15:50:00 New York time up to current date</li> <li>2. <code>&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…</code><br/> Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date</li> <li>3. <code>&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&…</code><br/> Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00</li> </ul> |
end_date | string | No | — | The ending date and time for data selection, see start_date description for details. |
date | string | No | — | Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday |
order | string | No | — | Sorting order of the output |
prepost | boolean | No | — | Returns quotes that include pre-market and post-market data. Only for the Pro plan (individual) and Venture plan (business) and above. Available at the 1min, 5min, 15min, and 30min intervals for US equities. Open, high, low, close values are supplied without volume |
format | string | No | — | The format of the response data |
delimiter | string | No | — | The separator used in the CSV response data |
dp | integer | No | — | Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided |
previous_close | boolean | No | — | A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object |
adjust | string | No | — | Adjusting mode for prices |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"symbol": {
"type": "string",
"description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ..."
},
"isin": {
"type": "string",
"description": "Filter by international securities identification number (ISIN). ISIN access is activating in the <a href=\"https://twelvedata.com/account/add-ons\">Data add-ons</a> section"
},
"figi": {
"type": "string",
"description": "The FIGI of an instrument for which data is requested. This parameter is available on the <a href=\"https://twelvedata.com/pricing\">Ultra</a> plan (individual) and the <a href=\"https://twelvedata.com/pricing-business\">Enterprise</a> plan (business) and above."
},
"cusip": {
"type": "string",
"description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the <a href=\"https://twelvedata.com/account/add-ons\">Data add-ons</a> section"
},
"interval": {
"type": "string",
"description": "Interval between two consecutive points in time series",
"enum": [
"1min",
"5min",
"15min",
"30min",
"45min",
"1h",
"2h",
"4h",
"8h",
"1day",
"1week",
"1month"
]
},
"outputsize": {
"type": "integer",
"description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum"
},
"exchange": {
"type": "string",
"description": "Exchange where instrument is traded"
},
"mic_code": {
"type": "string",
"description": "Market Identifier Code (MIC) under ISO 10383 standard"
},
"country": {
"type": "string",
"description": "The country where the instrument is traded, e.g., `United States` or `US`"
},
"type": {
"type": "string",
"description": "The asset class to which the instrument belongs",
"enum": [
"American Depositary Receipt",
"Bond",
"Bond Fund",
"Closed-end Fund",
"Common Stock",
"Depositary Receipt",
"Digital Currency",
"ETF",
"Exchange-Traded Note",
"Global Depositary Receipt",
"Limited Partnership",
"Mutual Fund",
"Physical Currency",
"Preferred Stock",
"REIT",
"Right",
"Structured Product",
"Trust",
"Unit",
"Warrant"
]
},
"timezone": {
"type": "string",
"description": "Timezone at which output datetime will be displayed. Supports: <ul> <li>1. <code>Exchange</code> for local exchange time</li> <li>2. <code>UTC</code> for datetime at universal UTC standard</li> <li>3. Timezone name according to the IANA Time Zone Database. E.g. <code>America/New_York</code>, <code>Asia/Singapore</code>. Full list of timezones can be found <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\" target=\"blank\">here</a></li> </ul> <p>Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.</p> <i>Take note that the IANA Timezone name is case-sensitive</i>"
},
"start_date": {
"type": "string",
"description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05` Default location: <ul> <li>Forex and Cryptocurrencies - <code>UTC</code></li> <li>Stocks - where exchange is located (e.g. for AAPL it will be <code>America/New_York</code>)</li> </ul> Both parameters take into account if <code>timezone</code> parameter is provided.<br/> If <code>timezone</code> is given then, <code>start_date</code> and <code>end_date</code> will be used in the specified location Examples: <ul> <li>1. <code>&symbol=AAPL&start_date=2019-08-09T15:50:00&…</code><br/> Returns all records starting from 2019-08-09T15:50:00 New York time up to current date</li> <li>2. <code>&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…</code><br/> Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date</li> <li>3. <code>&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...</code><br/> Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00</li> </ul>"
},
"end_date": {
"type": "string",
"description": "The ending date and time for data selection, see `start_date` description for details."
},
"date": {
"type": "string",
"description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`"
},
"order": {
"type": "string",
"description": "Sorting order of the output",
"enum": [
"asc",
"desc"
]
},
"prepost": {
"type": "boolean",
"description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above. Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities. Open, high, low, close values are supplied without volume"
},
"format": {
"type": "string",
"description": "The format of the response data",
"enum": [
"JSON",
"CSV"
]
},
"delimiter": {
"type": "string",
"description": "The separator used in the CSV response data"
},
"dp": {
"type": "integer",
"description": "Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided"
},
"previous_close": {
"type": "boolean",
"description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object"
},
"adjust": {
"type": "string",
"description": "Adjusting mode for prices",
"enum": [
"all",
"splits",
"dividends",
"none"
]
}
},
"required": [
"PCID",
"interval"
]
}
twelvedata_market_data_get_time_series_cross
Time series cross Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
base | string | Yes | — | Base currency symbol |
base_type | string | No | — | Base instrument type according to the /instrument_type endpoint |
base_exchange | string | No | — | Base exchange |
base_mic_code | string | No | — | Base MIC code |
quote | string | Yes | — | Quote currency symbol |
quote_type | string | No | — | Quote instrument type according to the /instrument_type endpoint |
quote_exchange | string | No | — | Quote exchange |
quote_mic_code | string | No | — | Quote MIC code |
interval | string | Yes | — | Interval between two consecutive points in time series |
outputsize | integer | No | — | Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set, otherwise set to maximum |
format | string | No | — | Format of the response data |
delimiter | string | No | — | Delimiter used in CSV file |
prepost | boolean | No | — | Only for the Pro plan (individual) and Venture plan (business) and above. Available at the 1min, 5min, 15min, and 30min intervals for US equities. Open, high, low, close values are supplied without volume. |
start_date | string | No | — | Start date for the time series data |
end_date | string | No | — | End date for the time series data |
adjust | boolean | No | — | Specifies if there should be an adjustment |
dp | integer | No | — | Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. |
timezone | string | No | — | Timezone at which output datetime will be displayed. Supports: <ul> <li>1. <code>Exchange</code> for local exchange time</li> <li>2. <code>UTC</code> for datetime at universal UTC standard</li> <li>3. Timezone name according to the IANA Time Zone Database. E.g. <code>America/New_York</code>, <code>Asia/Singapore</code>. Full list of timezones can be found <a href=“https://en.wikipedia.org/wiki/List_of_tz_database_time_zones” target=“blank”>here</a>.</li> </ul> <i>Take note that the IANA Timezone name is case-sensitive</i> |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"base": {
"type": "string",
"description": "Base currency symbol"
},
"base_type": {
"type": "string",
"description": "Base instrument type according to the `/instrument_type` endpoint"
},
"base_exchange": {
"type": "string",
"description": "Base exchange"
},
"base_mic_code": {
"type": "string",
"description": "Base MIC code"
},
"quote": {
"type": "string",
"description": "Quote currency symbol"
},
"quote_type": {
"type": "string",
"description": "Quote instrument type according to the `/instrument_type` endpoint"
},
"quote_exchange": {
"type": "string",
"description": "Quote exchange"
},
"quote_mic_code": {
"type": "string",
"description": "Quote MIC code"
},
"interval": {
"type": "string",
"description": "Interval between two consecutive points in time series",
"enum": [
"1min",
"5min",
"15min",
"30min",
"45min",
"1h",
"2h",
"4h",
"8h",
"1day",
"1week",
"1month"
]
},
"outputsize": {
"type": "integer",
"description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum"
},
"format": {
"type": "string",
"description": "Format of the response data",
"enum": [
"JSON",
"CSV"
]
},
"delimiter": {
"type": "string",
"description": "Delimiter used in CSV file"
},
"prepost": {
"type": "boolean",
"description": "Only for the `Pro` plan (individual) and `Venture` plan (business) and above. Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities. Open, high, low, close values are supplied without volume."
},
"start_date": {
"type": "string",
"description": "Start date for the time series data"
},
"end_date": {
"type": "string",
"description": "End date for the time series data"
},
"adjust": {
"type": "boolean",
"description": "Specifies if there should be an adjustment"
},
"dp": {
"type": "integer",
"description": "Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive."
},
"timezone": {
"type": "string",
"description": "Timezone at which output datetime will be displayed. Supports: <ul> <li>1. <code>Exchange</code> for local exchange time</li> <li>2. <code>UTC</code> for datetime at universal UTC standard</li> <li>3. Timezone name according to the IANA Time Zone Database. E.g. <code>America/New_York</code>, <code>Asia/Singapore</code>. Full list of timezones can be found <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\" target=\"blank\">here</a>.</li> </ul> <i>Take note that the IANA Timezone name is case-sensitive</i>"
}
},
"required": [
"PCID",
"base",
"quote",
"interval"
]
}