docs/SecurityApi.md in intrinio-sdk-5.0.0 vs docs/SecurityApi.md in intrinio-sdk-5.1.0
- old
+ new
@@ -160,11 +160,10 @@
**share_class_figi** | String| Return securities with the given Global Share Class FIGI (<a href=\"https://www.openfigi.com/about\" target=\"_blank\">reference</a>). | [optional]
**figi_unique_id** | String| Return securities with the given FIGI Unique ID (<a href=\"https://www.openfigi.com/about\" target=\"_blank\">reference</a>). | [optional]
**include_non_figi** | BOOLEAN| When true, include securities that do not have a FIGI. By default, this is false. If this parameter is not specified, only securities with a FIGI are returned. | [optional] [default to false]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -243,11 +242,10 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -329,11 +327,10 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
**tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -415,11 +412,10 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
**tag** | String| An Intrinio data tag ID or code-name |
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -517,11 +513,10 @@
**start_date** | Date| Get historical data on or after this date | [optional]
**end_date** | Date| Get historical date on or before this date | [optional]
**sort_order** | String| Sort by date `asc` or `desc` | [optional] [default to desc]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -616,11 +611,10 @@
**start_time** | String| Return intraday prices starting at the specified time on the `start_date` (timezone is UTC) | [optional]
**end_date** | Date| Return intraday prices stopping at the specified date | [optional]
**end_time** | String| Return intraday prices stopping at the specified time on the `end_date` (timezone is UTC) | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -699,11 +693,10 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -782,11 +775,10 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -875,11 +867,10 @@
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -970,11 +961,10 @@
**period** | Integer| The number of observations, per period, to calculate Average Daily Trading Volume | [optional] [default to 22]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -1065,11 +1055,10 @@
**period** | Integer| The number of observations, per period, to calculate Average Directional Index | [optional] [default to 14]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -1162,11 +1151,10 @@
**long_period** | Integer| The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator | [optional] [default to 34]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -1257,11 +1245,10 @@
**period** | Integer| The number of observations, per period, to calculate Average True Range | [optional] [default to 14]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -1356,11 +1343,10 @@
**price_key** | String| The Stock Price field to use when calculating Bollinger Bands | [optional] [default to close]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -1453,11 +1439,10 @@
**constant** | Float| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 0.015]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -1548,11 +1533,10 @@
**period** | Integer| The number of observations, per period, to calculate Chaikin Money Flow | [optional] [default to 20]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -1645,11 +1629,10 @@
**price_key** | String| The Stock Price field to use when calculating Donchian Channel | [optional] [default to close]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -1742,11 +1725,10 @@
**price_key** | String| The Stock Price field to use when calculating Detrended Price Oscillator | [optional] [default to close]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -1837,11 +1819,10 @@
**period** | Integer| The number of observations, per period, to calculate Ease of Movement | [optional] [default to 20]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -1930,11 +1911,10 @@
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -2029,11 +2009,10 @@
**high_period** | Integer| The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo | [optional] [default to 52]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -2124,11 +2103,10 @@
**period** | Integer| The number of observations, per period, to calculate Kelter Channel | [optional] [default to 10]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -2235,11 +2213,10 @@
**price_key** | String| The Stock Price field to use when calculating Know Sure Thing | [optional] [default to close]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -2336,11 +2313,10 @@
**price_key** | String| The Stock Price field to use when calculating Moving Average Convergence Divergence | [optional] [default to close]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -2431,11 +2407,10 @@
**period** | Integer| The number of observations, per period, to calculate Money Flow Index | [optional] [default to 14]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -2528,11 +2503,10 @@
**sum_period** | Integer| The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index | [optional] [default to 25]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -2621,11 +2595,10 @@
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -2714,11 +2687,10 @@
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -2809,11 +2781,10 @@
**period** | Integer| The number of observations, per period, to calculate On-balance Volume Mean | [optional] [default to 10]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -2906,11 +2877,10 @@
**price_key** | String| The Stock Price field to use when calculating Relative Strength Index | [optional] [default to close]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -3003,11 +2973,10 @@
**price_key** | String| The Stock Price field to use when calculating Simple Moving Average | [optional] [default to close]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -3100,11 +3069,10 @@
**signal_period** | Integer| The number of observations, per period, to calculate the %D (the Simple Moving Average of %K) as a signal line for Stochastic Oscillator | [optional] [default to 3]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -3195,11 +3163,10 @@
**period** | Integer| The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average | [optional] [default to 15]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -3294,11 +3261,10 @@
**price_key** | String| The Stock Price field to use when calculating True Strength Index | [optional] [default to close]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -3399,11 +3365,10 @@
**long_weight** | Float| The weight of long Buying Pressure average for Ultimate Oscillator | [optional] [default to 1.0]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -3494,11 +3459,10 @@
**period** | Integer| The number of observations, per period, to calculate Vortex Indicator | [optional] [default to 14]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -3587,11 +3551,10 @@
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -3680,11 +3643,10 @@
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -3775,11 +3737,10 @@
**period** | Integer| The number of observations, per period, to look-back when calculating Williams %R | [optional] [default to 14]
**start_date** | String| Return technical indicator values on or after the date | [optional]
**end_date** | String| Return technical indicator values on or before the date | [optional]
**page_size** | Float| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -3862,11 +3823,10 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
**source** | String| Return the realtime price from the specified data source. If no source is specified, the best source available is used. | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -3955,11 +3915,10 @@
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
**start_date** | Date| Return price adjustments on or after the date | [optional]
**end_date** | Date| Return price adjustments on or before the date | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -4050,11 +4009,10 @@
**start_date** | Date| Return prices on or after the date | [optional]
**end_date** | Date| Return prices on or before the date | [optional]
**frequency** | String| Return stock prices in the given frequency | [optional] [default to daily]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -4169,11 +4127,10 @@
**strong_sells_greater** | Integer| Return only records with more than this many Strong Sell recommendations | [optional]
**strong_sells_less** | Integer| Return only records with fewer than this many Strong Sell recommendations | [optional]
**total_greater** | Integer| Return only records with more than this many recommendations, regardless of type | [optional]
**total_less** | Integer| Return only records with fewer than this many recommendations, regardless of type | [optional]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -4256,11 +4213,10 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
**date** | String| Lookup a historical snapshot on the given date | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -4345,11 +4301,10 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -4434,11 +4389,10 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
**page_size** | Integer| The number of results to return | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -4526,11 +4480,10 @@
**logic** | [**SecurityScreenGroup**](SecurityScreenGroup.md)| The logic to screen with, consisting of operators, clauses, and nested groups.<br/> See <a href=\"https://docs.intrinio.com/documentation/screener_v2\" target=\"_blank\">screener documentation</a> for details on how to construct conditions. | [optional]
**order_column** | String| Results returned sorted by this column | [optional]
**order_direction** | String| Sort order to use with the order_column | [optional] [default to asc]
**primary_only** | BOOLEAN| Return only primary securities | [optional] [default to false]
**page_size** | Integer| The number of results to return. Maximum for this endpoint is 50000. | [optional] [default to 100]
-<br/>
[//]: # (END_PARAMETERS)
### Return type
@@ -4613,10 +4566,9 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**query** | String| |
**page_size** | Integer| The number of results to return | [optional] [default to 100]
-<br/>
[//]: # (END_PARAMETERS)
### Return type