docs/CompanyApi.md in intrinio-sdk-5.6.0 vs docs/CompanyApi.md in intrinio-sdk-5.6.1
- old
+ new
@@ -315,11 +315,11 @@
> Float get_company_data_point_number(identifier, tag)
#### Data Point (Number) for Company
-$$v2_company_data_point_number_description$$
+Returns a numeric value for the given `tag` for the Company with the given `identifier`
[//]: # (END_OVERVIEW)
### Example
@@ -335,13 +335,13 @@
config.api_key['api_key'] = 'YOUR_API_KEY'
end
company_api = Intrinio::CompanyApi.new
-identifier = "$$v2_company_data_point_identifier_default$$" # String | $$v2_company_data_point_identifier_description$$
+identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-tag = "$$v2_company_data_point_item_number_default$$" # String | $$v2_company_data_point_item_description$$
+tag = "marketcap" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
begin
result = company_api.get_company_data_point_number(identifier, tag)
pp result
@@ -359,12 +359,12 @@
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **identifier** | String| $$v2_company_data_point_identifier_description$$ |
- **tag** | String| $$v2_company_data_point_item_description$$ |
+ **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |
+ **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |
[//]: # (END_PARAMETERS)
### Return type
@@ -400,11 +400,11 @@
> String get_company_data_point_text(identifier, tag)
#### Data Point (Text) for Company
-$$v2_company_data_point_text_description$$
+Returns a text value for the given `tag` for the Company with the given `identifier`
[//]: # (END_OVERVIEW)
### Example
@@ -420,13 +420,13 @@
config.api_key['api_key'] = 'YOUR_API_KEY'
end
company_api = Intrinio::CompanyApi.new
-identifier = "$$v2_company_data_point_identifier_default$$" # String | $$v2_company_data_point_identifier_description$$
+identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-tag = "$$v2_company_data_point_item_text_default$$" # String | $$v2_company_data_point_item_description$$
+tag = "ceo" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
begin
result = company_api.get_company_data_point_text(identifier, tag)
pp result
@@ -444,12 +444,12 @@
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **identifier** | String| $$v2_company_data_point_identifier_description$$ |
- **tag** | String| $$v2_company_data_point_item_description$$ |
+ **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |
+ **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |
[//]: # (END_PARAMETERS)
### Return type
@@ -683,11 +683,11 @@
> ApiResponseCompanyHistoricalData get_company_historical_data(identifier, tag, opts)
#### Historical Data for Company
-$$v2_company_historical_data_description$$
+Returns historical values for the given `tag` and the Company with the given `identifier`
[//]: # (END_OVERVIEW)
### Example
@@ -703,13 +703,13 @@
config.api_key['api_key'] = 'YOUR_API_KEY'
end
company_api = Intrinio::CompanyApi.new
-identifier = "$$v2_company_historical_data_identifier_default$$" # String | $$v2_company_historical_data_identifier_description$$
+identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
-tag = "$$v2_company_historical_data_item_default$$" # String | $$v2_company_historical_data_item_description$$
+tag = "marketcap" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
opts = {
frequency: "daily", # String | Return historical data in the given frequency
type: nil, # String | Return historical data for given fiscal period type
start_date: Date.parse("2018-01-01"), # Date | Return historical data on or after this date
@@ -736,11 +736,11 @@
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **identifier** | String| $$v2_company_historical_data_identifier_description$$ |
- **tag** | String| $$v2_company_historical_data_item_description$$ |
+ **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |
+ **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |
**frequency** | String| Return historical data in the given frequency | [optional] [default to daily]
**type** | String| Return historical data for given fiscal period type | [optional]
**start_date** | Date| Return historical data on or after this date | [optional]
**end_date** | Date| Return historical data on or before this date | [optional]
**sort_order** | String| Sort by date `asc` or `desc` | [optional] [default to desc]