Skip to content

Commit cec8b74

Browse files
ssnyder-intriniossnyder-intrinio
committed
No release notes for this build
1 parent 21740d4 commit cec8b74

14 files changed

+148
-202
lines changed

‎NAMESPACE

-1
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,6 @@ export(Fundamental)
194194
export(FundamentalSummary)
195195
export(HistoricalData)
196196
export(IchimokuKinkoHyoTechnicalValue)
197-
export(IndexConstituents)
198197
export(InsiderTransaction)
199198
export(InsiderTransactionFiling)
200199
export(InstitutionalHolding)

‎R/ApiResponseIndexConstituents.r

+15-6
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ ApiResponseIndexConstituents <- R6::R6Class(
2222
`index` = NA,
2323
`date` = NA,
2424
`constituents` = NA,
25+
`constituents_data_frame` = NULL,
2526
initialize = function(`index`, `date`, `constituents`){
2627
if (!missing(`index`)) {
2728
self$`index` <- `index`
@@ -108,13 +109,22 @@ ApiResponseIndexConstituents <- R6::R6Class(
108109

109110

110111

112+
self$`constituents` <- lapply(listObject$`constituents`, function(x) {
113+
SecuritySummaryObject <- SecuritySummary$new()
114+
SecuritySummaryObject$setFromList(x)
115+
return(SecuritySummaryObject)
116+
})
117+
118+
constituents_list <- lapply(self$`constituents`, function(x) {
119+
return(x$getAsList())
120+
})
121+
122+
self$`constituents_data_frame` <- do.call(rbind, lapply(constituents_list, data.frame))
111123

112124

113125

114126

115127

116-
self$`constituents` <- IndexConstituents$new()
117-
self$`constituents`$setFromList(listObject$`constituents`)
118128

119129
},
120130
getAsList = function() {
@@ -134,14 +144,13 @@ ApiResponseIndexConstituents <- R6::R6Class(
134144

135145

136146

147+
# listObject[["constituents"]] <- lapply(self$`constituents`, function(o) {
148+
# return(o$getAsList())
149+
# })
137150

138151

139152

140153

141-
constituents_list <- self$`constituents`$getAsList()
142-
for (x in names(constituents_list)) {
143-
listObject[[paste("constituents_",x, sep = "")]] <- self$`constituents`[[x]]
144-
}
145154

146155
return(listObject)
147156
}

‎R/IndexConstituents.r

-43
This file was deleted.

‎README.md

-1
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,6 @@ Class | Method | HTTP request | Description
527527
- [IntrinioSDK::FundamentalSummary](docs/FundamentalSummary.md)
528528
- [IntrinioSDK::HistoricalData](docs/HistoricalData.md)
529529
- [IntrinioSDK::IchimokuKinkoHyoTechnicalValue](docs/IchimokuKinkoHyoTechnicalValue.md)
530-
- [IntrinioSDK::IndexConstituents](docs/IndexConstituents.md)
531530
- [IntrinioSDK::InsiderTransaction](docs/InsiderTransaction.md)
532531
- [IntrinioSDK::InsiderTransactionFiling](docs/InsiderTransactionFiling.md)
533532
- [IntrinioSDK::InstitutionalHolding](docs/InstitutionalHolding.md)

‎docs/ApiResponseIndexConstituents.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Name | Type | Description
1212
------------ | ------------- | -------------
1313
**index** | [**ApiResponseIndex**](ApiResponseIndex.md) | The index &nbsp;
1414
**date** | [**Date**](Date.md) | The date when an update was last received for the index constituents &nbsp;
15-
**constituents** | [**IndexConstituents**](IndexConstituents.md) | &nbsp;
15+
**constituents** | [**List of SecuritySummary**](SecuritySummary.md) | &nbsp;
16+
**constituents_data_frame** | Data Frame | Data frame representation of constituents
1617

1718
[//]: # (END_DEFINITION)
1819

@@ -23,7 +24,7 @@ Name | Type | Description
2324
[//]: # (CONTAINED_CLASS:IntrinioSDK::Date)
2425

2526

26-
[//]: # (CONTAINED_CLASS:IntrinioSDK::IndexConstituents)
27+
[//]: # (CONTAINED_CLASS:IntrinioSDK::SecuritySummary)
2728

2829

2930
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/CompanyApi.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -639,8 +639,8 @@ client$configuration$allowRetries <- TRUE
639639
CompanyApi <- IntrinioSDK::CompanyApi$new(client)
640640

641641
# Required params
642-
identifier <- "$$v2_company_data_point_identifier_default$$"
643-
tag <- "$$v2_company_data_point_item_number_default$$"
642+
identifier <- "AAPL"
643+
tag <- "marketcap"
644644

645645
response <- CompanyApi$get_company_data_point_number(identifier, tag)
646646

@@ -659,8 +659,8 @@ print(response$content)
659659

660660
Name | Type | Description | Notes
661661
------------- | ------------- | ------------- | -------------
662-
**identifier** | Character| $$v2_company_data_point_identifier_description$$ | &nbsp;
663-
**tag** | Character| $$v2_company_data_point_item_description$$ | &nbsp;
662+
**identifier** | Character| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | &nbsp;
663+
**tag** | Character| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp;
664664
<br/>
665665

666666
[//]: # (END_PARAMETERS)
@@ -722,8 +722,8 @@ client$configuration$allowRetries <- TRUE
722722
CompanyApi <- IntrinioSDK::CompanyApi$new(client)
723723

724724
# Required params
725-
identifier <- "$$v2_company_data_point_identifier_default$$"
726-
tag <- "$$v2_company_data_point_item_text_default$$"
725+
identifier <- "AAPL"
726+
tag <- "ceo"
727727

728728
response <- CompanyApi$get_company_data_point_text(identifier, tag)
729729

@@ -742,8 +742,8 @@ print(response$content)
742742

743743
Name | Type | Description | Notes
744744
------------- | ------------- | ------------- | -------------
745-
**identifier** | Character| $$v2_company_data_point_identifier_description$$ | &nbsp;
746-
**tag** | Character| $$v2_company_data_point_item_description$$ | &nbsp;
745+
**identifier** | Character| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | &nbsp;
746+
**tag** | Character| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp;
747747
<br/>
748748

749749
[//]: # (END_PARAMETERS)
@@ -990,7 +990,7 @@ Name | Type | Description | Notes
990990
#### Historical Data for Company
991991

992992

993-
$$v2_company_historical_data_description$$
993+
Returns historical values for the given `tag` and the Company with the given `identifier`
994994

995995
[//]: # (END_OVERVIEW)
996996

@@ -1011,8 +1011,8 @@ client$configuration$allowRetries <- TRUE
10111011
CompanyApi <- IntrinioSDK::CompanyApi$new(client)
10121012

10131013
# Required params
1014-
identifier <- "$$v2_company_historical_data_identifier_default$$"
1015-
tag <- "$$v2_company_historical_data_item_default$$"
1014+
identifier <- "AAPL"
1015+
tag <- "marketcap"
10161016

10171017
# Optional params
10181018
opts <- list(
@@ -1042,8 +1042,8 @@ print(response$content)
10421042

10431043
Name | Type | Description | Notes
10441044
------------- | ------------- | ------------- | -------------
1045-
**identifier** | Character| $$v2_company_historical_data_identifier_description$$ | &nbsp;
1046-
**tag** | Character| $$v2_company_historical_data_item_description$$ | &nbsp;
1045+
**identifier** | Character| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | &nbsp;
1046+
**tag** | Character| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp;
10471047
**frequency** | Character| Return historical data in the given frequency | [optional] [default to daily] &nbsp;
10481048
**type** | Character| Return historical data for given fiscal period type | [optional] &nbsp;
10491049
**start_date** | Date| Return historical data on or after this date | [optional] &nbsp;

‎docs/DataPointApi.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Method | HTTP request | Description
3838
#### Data Point (Number)
3939

4040

41-
$$v2_data_point_number_description$$
41+
Returns a numeric value for the given `tag` and the entity with the given `identifier`
4242

4343
[//]: # (END_OVERVIEW)
4444

@@ -59,8 +59,8 @@ client$configuration$allowRetries <- TRUE
5959
DataPointApi <- IntrinioSDK::DataPointApi$new(client)
6060

6161
# Required params
62-
identifier <- "$$v2_data_point_identifier_default$$"
63-
tag <- "$$v2_data_point_item_number_default$$"
62+
identifier <- "AAPL"
63+
tag <- "marketcap"
6464

6565
response <- DataPointApi$get_data_point_number(identifier, tag)
6666

@@ -79,8 +79,8 @@ print(response$content)
7979

8080
Name | Type | Description | Notes
8181
------------- | ------------- | ------------- | -------------
82-
**identifier** | Character| $$v2_data_point_identifier_description$$ | &nbsp;
83-
**tag** | Character| $$v2_data_point_item_description$$ | &nbsp;
82+
**identifier** | Character| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) | &nbsp;
83+
**tag** | Character| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp;
8484
<br/>
8585

8686
[//]: # (END_PARAMETERS)
@@ -121,7 +121,7 @@ Name | Type | Description | Notes
121121
#### Data Point (Text)
122122

123123

124-
$$v2_data_point_text_description$$
124+
Returns a text value for the given `tag` for the Security with the given `identifier`
125125

126126
[//]: # (END_OVERVIEW)
127127

@@ -142,8 +142,8 @@ client$configuration$allowRetries <- TRUE
142142
DataPointApi <- IntrinioSDK::DataPointApi$new(client)
143143

144144
# Required params
145-
identifier <- "$$v2_data_point_identifier_default$$"
146-
tag <- "$$v2_data_point_item_text_default$$"
145+
identifier <- "AAPL"
146+
tag <- "ceo"
147147

148148
response <- DataPointApi$get_data_point_text(identifier, tag)
149149

@@ -162,8 +162,8 @@ print(response$content)
162162

163163
Name | Type | Description | Notes
164164
------------- | ------------- | ------------- | -------------
165-
**identifier** | Character| $$v2_data_point_identifier_description$$ | &nbsp;
166-
**tag** | Character| $$v2_data_point_item_description$$ | &nbsp;
165+
**identifier** | Character| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) | &nbsp;
166+
**tag** | Character| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp;
167167
<br/>
168168

169169
[//]: # (END_PARAMETERS)

‎docs/FundamentalsApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ FundamentalsApi <- IntrinioSDK::FundamentalsApi$new(client)
414414

415415
# Required params
416416
id <- "AAPL-income_statement-2020-FY"
417-
tag <- "$$v2_data_point_item_text_default$$"
417+
tag <- "ceo"
418418

419419
response <- FundamentalsApi$get_fundamental_standardized_financials_dimensions(id, tag)
420420

@@ -434,7 +434,7 @@ print(response$content)
434434
Name | Type | Description | Notes
435435
------------- | ------------- | ------------- | -------------
436436
**id** | Character| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental | &nbsp;
437-
**tag** | Character| $$v2_data_point_item_description$$ | &nbsp;
437+
**tag** | Character| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp;
438438
<br/>
439439

440440
[//]: # (END_PARAMETERS)

‎docs/HistoricalDataApi.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Method | HTTP request | Description
3737
#### Historical Data
3838

3939

40-
$$v2_historical_data_description$$
40+
Returns historical values for the given `tag` and the entity represented by the given `identifier`
4141

4242
[//]: # (END_OVERVIEW)
4343

@@ -58,8 +58,8 @@ client$configuration$allowRetries <- TRUE
5858
HistoricalDataApi <- IntrinioSDK::HistoricalDataApi$new(client)
5959

6060
# Required params
61-
identifier <- "$$v2_historical_data_identifier_default$$"
62-
tag <- "$$v2_historical_data_item_default$$"
61+
identifier <- "AAPL"
62+
tag <- "marketcap"
6363

6464
# Optional params
6565
opts <- list(
@@ -89,8 +89,8 @@ print(response$content)
8989

9090
Name | Type | Description | Notes
9191
------------- | ------------- | ------------- | -------------
92-
**identifier** | Character| $$v2_historical_data_identifier_description$$ | &nbsp;
93-
**tag** | Character| $$v2_historical_data_item_description$$ | &nbsp;
92+
**identifier** | Character| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) | &nbsp;
93+
**tag** | Character| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp;
9494
**frequency** | Character| Return historical data in the given frequency | [optional] [default to daily] &nbsp;
9595
**type** | Character| Filter by type, when applicable | [optional] &nbsp;
9696
**start_date** | Date| Get historical data on or after this date | [optional] &nbsp;

‎docs/IndexConstituents.md

-19
This file was deleted.

0 commit comments

Comments
 (0)