Correlation

The Correlation (CORREL) endpoint calculates the statistical relationship between two securities over a specified time period, returning a correlation coefficient. This coefficient ranges from -1 to 1, indicating the strength and direction of their linear relationship. A value close to 1 suggests a strong positive correlation, while a value near -1 indicates a strong negative correlation. This data is useful for identifying securities that move together or in opposite directions, aiding in strategies like diversification or pairs trading.

byTwelve Data API (Market Data)

1212calls

N/Alatency

Discover -> Inspect -> Call

Call setup

Tool IDtwelvedata.correl.retrieve.v1.77848a56

Request parametersJSON

Before this Call

2.37 credits / call

The final charge is settled from actual provider usage and will appear in Usage.

Field reference

symbolstringOptional

Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...

isinstringOptional

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

figistringOptional

The FIGI of an instrument for which data is requested. This request parameter is available starting with the <a href="https://twelvedata.com/pricing">Ultra<a> plan

cusipstringOptional

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

intervalstringRequired

Interval between two consecutive points in time series

outputsizeintegerOptional

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

exchangestringOptional

Exchange where instrument is traded

mic_codestringOptional

Market Identifier Code (MIC) under ISO 10383 standard

countrystringOptional

The country where the instrument is traded, e.g., `United States` or `US`

typestringOptional

The asset class to which the instrument belongs

timezonestringOptional

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> Take note that the IANA Timezone name is case-sensitive

start_datestringOptional

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. 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> 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> 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> Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00</li> </ul>

end_datestringOptional

The ending date and time for data selection, see `start_date` description for details.

datestringOptional

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`

orderstringOptional

Sorting order of the output

prepostbooleanOptional

Returns quotes that include pre-market and post-market data. Only for `Pro` and above plans. Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities. Open, high, low, close values are supplied without volume

formatstringOptional

The format of the response data

delimiterstringOptional

The separator used in the CSV response data

dpintegerOptional

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_closebooleanOptional

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

adjuststringOptional

Adjusting mode for prices

series_type_1stringOptional

Price type used as the first part of technical indicator

series_type_2stringOptional

Price type used as the second part of technical indicator

time_periodintegerOptional

Number of periods to average over. Takes values in the range from `1` to `800`

include_ohlcbooleanOptional

Specify if OHLC values should be added in the output

Correlation

byTwelve Data API (Market Data)

1212calls

N/Alatency