docs/SecurityApi.md in intrinio-sdk-4.0.0 vs docs/SecurityApi.md in intrinio-sdk-5.0.0
- old
+ new
@@ -105,11 +105,11 @@
security_api = Intrinio::SecurityApi.new
opts = {
active: true, # BOOLEAN | When true, return securities that are active. When false, return securities that are not active. A security is considered active if it has traded or has had a corporate action in the past 30 days, and has not been merged into another security (such as due to ticker changes or corporate restructurings).
delisted: false, # BOOLEAN | When true, return securities that have been delisted from their exchange. Note that there may be a newer security for the same company that has been relisted on a differente exchange. When false, return securities that have not been delisted.
- code: nil, # String | Return securities classified with the given code (<a href=\"/documentation/security_codes\" target=\"_blank\">reference</a>).
+ code: nil, # String | Return securities classified with the given code (<a href=\"https://docs.intrinio.com/documentation/security_codes\" target=\"_blank\">reference</a>).
currency: nil, # String | Return securities traded in the given 3-digit ISO 4217 currency code (<a href=\"https://en.wikipedia.org/wiki/ISO_4217\" target=\"_blank\">reference</a>).
ticker: nil, # String | Return securities traded with the given ticker. Note that securities across the world (and through time) may trade with the same ticker but represent different companies. Use this in conjuction with other parameters for more specificity.
name: nil, # String | Return securities with the given text in their name (not case sensitive).
composite_mic: nil, # String | Return securities classified under the composite exchange with the given Market Identification Code (MIC). A composite exchange may or may not be a real exchange. For example, the USCOMP exchange (our only composite exchange to date) is a combination of exchanges with the following MICs: ARCX, XASE, XPOR, FINR, XCIS, XNAS, XNYS, BATS. This composite grouping is done for user convenience. At this time, all US securities are classified under the composite exchange with MIC USCOMP. To query for specific US exchanges, use the exchange_mic parameter below.
exchange_mic: nil, # String | The MIC code of the exchange where the security is actually traded.
@@ -144,11 +144,11 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**active** | BOOLEAN| When true, return securities that are active. When false, return securities that are not active. A security is considered active if it has traded or has had a corporate action in the past 30 days, and has not been merged into another security (such as due to ticker changes or corporate restructurings). | [optional]
**delisted** | BOOLEAN| When true, return securities that have been delisted from their exchange. Note that there may be a newer security for the same company that has been relisted on a differente exchange. When false, return securities that have not been delisted. | [optional]
- **code** | String| Return securities classified with the given code (<a href=\"/documentation/security_codes\" target=\"_blank\">reference</a>). | [optional]
+ **code** | String| Return securities classified with the given code (<a href=\"https://docs.intrinio.com/documentation/security_codes\" target=\"_blank\">reference</a>). | [optional]
**currency** | String| Return securities traded in the given 3-digit ISO 4217 currency code (<a href=\"https://en.wikipedia.org/wiki/ISO_4217\" target=\"_blank\">reference</a>). | [optional]
**ticker** | String| Return securities traded with the given ticker. Note that securities across the world (and through time) may trade with the same ticker but represent different companies. Use this in conjuction with other parameters for more specificity. | [optional]
**name** | String| Return securities with the given text in their name (not case sensitive). | [optional]
**composite_mic** | String| Return securities classified under the composite exchange with the given Market Identification Code (MIC). A composite exchange may or may not be a real exchange. For example, the USCOMP exchange (our only composite exchange to date) is a combination of exchanges with the following MICs: ARCX, XASE, XPOR, FINR, XCIS, XNAS, XNYS, BATS. This composite grouping is done for user convenience. At this time, all US securities are classified under the composite exchange with MIC USCOMP. To query for specific US exchanges, use the exchange_mic parameter below. | [optional]
**exchange_mic** | String| The MIC code of the exchange where the security is actually traded. | [optional]
@@ -581,14 +581,16 @@
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
opts = {
source: nil, # String | Return intraday prices from the specified data source
- start_date: Date.parse("2018-01-01"), # Date | Return intraday prices starting at the specified date
- start_time: "4200", # String | Return intraday prices starting at the specified time on the `start_date` (timezone is UTC)
- end_date: Date.parse("2018-01-01"), # Date | Return intraday prices stopping at the specified date
- end_time: "4200" # String | Return intraday prices stopping at the specified time on the `end_date` (timezone is UTC)
+ start_date: nil, # Date | Return intraday prices starting at the specified date
+ start_time: nil, # String | Return intraday prices starting at the specified time on the `start_date` (timezone is UTC)
+ end_date: nil, # Date | Return intraday prices stopping at the specified date
+ end_time: nil, # String | Return intraday prices stopping at the specified time on the `end_date` (timezone is UTC)
+ page_size: 100, # Integer | The number of results to return
+ next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = security_api.get_security_intraday_prices(identifier, opts)
pp result
@@ -612,10 +614,12 @@
**source** | String| Return intraday prices from the specified data source | [optional]
**start_date** | Date| Return intraday prices starting at the specified date | [optional]
**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
@@ -4491,12 +4495,12 @@
end
security_api = Intrinio::SecurityApi.new
opts = {
- logic: Intrinio::SecurityScreenGroup.new, # SecurityScreenGroup | The logic to screen with, consisting of operators, clauses, and nested groups.<br/> See <a href=\"/documentation/screener_v2\" target=\"_blank\">screener documentation</a> for details on how to construct conditions.
- order_column: "order_column_example", # String | Results returned sorted by this column
+ logic: Intrinio::SecurityScreenGroup.new, # SecurityScreenGroup | 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.
+ order_column: "marketcap", # String | Results returned sorted by this column
order_direction: "asc", # String | Sort order to use with the order_column
primary_only: false, # BOOLEAN | Return only primary securities
page_size: 100 # Integer | The number of results to return. Maximum for this endpoint is 50000.
}
@@ -4517,10 +4521,10 @@
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **logic** | [**SecurityScreenGroup**](SecurityScreenGroup.md)| The logic to screen with, consisting of operators, clauses, and nested groups.<br/> See <a href=\"/documentation/screener_v2\" target=\"_blank\">screener documentation</a> for details on how to construct conditions. | [optional]
+ **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/>