Skip to content

Commit f79c96d

Browse files
ssnyder-intriniossnyder-intrinio
committed
No release notes for this build
1 parent 2bd35e9 commit f79c96d

29 files changed

+222
-456
lines changed

‎README.md

-1
Original file line numberDiff line numberDiff line change
@@ -497,7 +497,6 @@ Class | Method | HTTP request | Description
497497
- [Intrinio::FundamentalSummary](docs/FundamentalSummary.md)
498498
- [Intrinio::HistoricalData](docs/HistoricalData.md)
499499
- [Intrinio::IchimokuKinkoHyoTechnicalValue](docs/IchimokuKinkoHyoTechnicalValue.md)
500-
- [Intrinio::IndexConstituents](docs/IndexConstituents.md)
501500
- [Intrinio::InsiderTransaction](docs/InsiderTransaction.md)
502501
- [Intrinio::InsiderTransactionFiling](docs/InsiderTransactionFiling.md)
503502
- [Intrinio::InstitutionalHolding](docs/InstitutionalHolding.md)

‎docs/ApiResponseIndexConstituents.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ Name | Type | Description
1414
------------ | ------------- | -------------
1515
**index** | [**ApiResponseIndex**](ApiResponseIndex.md) | The index  
1616
**date** | Date | The date when an update was last received for the index constituents  
17-
**constituents** | [**IndexConstituents**](IndexConstituents.md) |  
17+
**constituents** | [**Array<SecuritySummary>**](SecuritySummary.md) |  
1818

1919
[//]: # (END_DEFINITION)
2020

2121

2222
[//]: # (CONTAINED_CLASS:Intrinio::ApiResponseIndex)
2323

2424

25-
[//]: # (CONTAINED_CLASS:Intrinio::IndexConstituents)
25+
[//]: # (CONTAINED_CLASS:Intrinio::SecuritySummary)
2626

2727

2828

‎docs/CompanyApi.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -616,8 +616,8 @@ Intrinio.configure do |config|
616616
end
617617

618618
company_api = Intrinio::CompanyApi.new
619-
identifier = "$$v2_company_data_point_identifier_default$$"
620-
tag = "$$v2_company_data_point_item_number_default$$"
619+
identifier = "AAPL"
620+
tag = "marketcap"
621621

622622
result = company_api.get_company_data_point_number(identifier, tag)
623623
pp result
@@ -634,8 +634,8 @@ pp result
634634

635635
Name | Type | Description | Notes
636636
------------- | ------------- | ------------- | -------------
637-
**identifier** | String| $$v2_company_data_point_identifier_description$$ |  
638-
**tag** | String| $$v2_company_data_point_item_description$$ |  
637+
**identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |  
638+
**tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |  
639639

640640
[//]: # (END_PARAMETERS)
641641

@@ -695,8 +695,8 @@ Intrinio.configure do |config|
695695
end
696696

697697
company_api = Intrinio::CompanyApi.new
698-
identifier = "$$v2_company_data_point_identifier_default$$"
699-
tag = "$$v2_company_data_point_item_text_default$$"
698+
identifier = "AAPL"
699+
tag = "ceo"
700700

701701
result = company_api.get_company_data_point_text(identifier, tag)
702702
pp result
@@ -713,8 +713,8 @@ pp result
713713

714714
Name | Type | Description | Notes
715715
------------- | ------------- | ------------- | -------------
716-
**identifier** | String| $$v2_company_data_point_identifier_description$$ |  
717-
**tag** | String| $$v2_company_data_point_item_description$$ |  
716+
**identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |  
717+
**tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |  
718718

719719
[//]: # (END_PARAMETERS)
720720

@@ -950,7 +950,7 @@ Name | Type | Description | Notes
950950
#### Historical Data for Company
951951

952952

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

955955
[//]: # (END_OVERVIEW)
956956

@@ -970,8 +970,8 @@ Intrinio.configure do |config|
970970
end
971971

972972
company_api = Intrinio::CompanyApi.new
973-
identifier = "$$v2_company_historical_data_identifier_default$$"
974-
tag = "$$v2_company_historical_data_item_default$$"
973+
identifier = "AAPL"
974+
tag = "marketcap"
975975

976976
opts = {
977977
frequency: "daily",
@@ -998,8 +998,8 @@ pp result
998998

999999
Name | Type | Description | Notes
10001000
------------- | ------------- | ------------- | -------------
1001-
**identifier** | String| $$v2_company_historical_data_identifier_description$$ |  
1002-
**tag** | String| $$v2_company_historical_data_item_description$$ |  
1001+
**identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |  
1002+
**tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |  
10031003
**frequency** | String| Return historical data in the given frequency | [optional] [default to daily]  
10041004
**type** | String| Return historical data for given fiscal period type | [optional]  
10051005
**start_date** | Date| Return historical data on or after this date | [optional]  

‎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

@@ -58,8 +58,8 @@ Intrinio.configure do |config|
5858
end
5959

6060
dataPoint_api = Intrinio::DataPointApi.new
61-
identifier = "$$v2_data_point_identifier_default$$"
62-
tag = "$$v2_data_point_item_number_default$$"
61+
identifier = "AAPL"
62+
tag = "marketcap"
6363

6464
result = dataPoint_api.get_data_point_number(identifier, tag)
6565
pp result
@@ -76,8 +76,8 @@ pp result
7676

7777
Name | Type | Description | Notes
7878
------------- | ------------- | ------------- | -------------
79-
**identifier** | String| $$v2_data_point_identifier_description$$ |  
80-
**tag** | String| $$v2_data_point_item_description$$ |  
79+
**identifier** | String| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |  
80+
**tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |  
8181

8282
[//]: # (END_PARAMETERS)
8383

@@ -117,7 +117,7 @@ Name | Type | Description | Notes
117117
#### Data Point (Text)
118118

119119

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

122122
[//]: # (END_OVERVIEW)
123123

@@ -137,8 +137,8 @@ Intrinio.configure do |config|
137137
end
138138

139139
dataPoint_api = Intrinio::DataPointApi.new
140-
identifier = "$$v2_data_point_identifier_default$$"
141-
tag = "$$v2_data_point_item_text_default$$"
140+
identifier = "AAPL"
141+
tag = "ceo"
142142

143143
result = dataPoint_api.get_data_point_text(identifier, tag)
144144
pp result
@@ -155,8 +155,8 @@ pp result
155155

156156
Name | Type | Description | Notes
157157
------------- | ------------- | ------------- | -------------
158-
**identifier** | String| $$v2_data_point_identifier_description$$ |  
159-
**tag** | String| $$v2_data_point_item_description$$ |  
158+
**identifier** | String| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |  
159+
**tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |  
160160

161161
[//]: # (END_PARAMETERS)
162162

‎docs/FundamentalsApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ end
398398

399399
fundamentals_api = Intrinio::FundamentalsApi.new
400400
id = "AAPL-income_statement-2020-FY"
401-
tag = "$$v2_data_point_item_text_default$$"
401+
tag = "ceo"
402402

403403
result = fundamentals_api.get_fundamental_standardized_financials_dimensions(id, tag)
404404
pp result
@@ -416,7 +416,7 @@ pp result
416416
Name | Type | Description | Notes
417417
------------- | ------------- | ------------- | -------------
418418
**id** | String| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental |  
419-
**tag** | String| $$v2_data_point_item_description$$ |  
419+
**tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |  
420420

421421
[//]: # (END_PARAMETERS)
422422

‎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

@@ -57,8 +57,8 @@ Intrinio.configure do |config|
5757
end
5858

5959
historicalData_api = Intrinio::HistoricalDataApi.new
60-
identifier = "$$v2_historical_data_identifier_default$$"
61-
tag = "$$v2_historical_data_item_default$$"
60+
identifier = "AAPL"
61+
tag = "marketcap"
6262

6363
opts = {
6464
frequency: "daily",
@@ -85,8 +85,8 @@ pp result
8585

8686
Name | Type | Description | Notes
8787
------------- | ------------- | ------------- | -------------
88-
**identifier** | String| $$v2_historical_data_identifier_description$$ |  
89-
**tag** | String| $$v2_historical_data_item_description$$ |  
88+
**identifier** | String| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |  
89+
**tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |  
9090
**frequency** | String| Return historical data in the given frequency | [optional] [default to daily]  
9191
**type** | String| Filter by type, when applicable | [optional]  
9292
**start_date** | Date| Get historical data on or after this date | [optional]  

‎docs/IndexConstituents.md

-19
This file was deleted.

0 commit comments

Comments
 (0)