intrinio-sdk 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +176 -0
- data/Rakefile +8 -0
- data/docs/ApiResponseCompanies.md +9 -0
- data/docs/ApiResponseCompanyFilings.md +10 -0
- data/docs/ApiResponseCompanyFundamentals.md +10 -0
- data/docs/ApiResponseCompanyHistoricalData.md +10 -0
- data/docs/ApiResponseCompanyNews.md +10 -0
- data/docs/ApiResponseCompanySecurities.md +10 -0
- data/docs/ApiResponseDataTags.md +9 -0
- data/docs/ApiResponseEconomicIndexHistoricalData.md +10 -0
- data/docs/ApiResponseEconomicIndices.md +9 -0
- data/docs/ApiResponseFilings.md +9 -0
- data/docs/ApiResponseHistoricalData.md +9 -0
- data/docs/ApiResponseNews.md +9 -0
- data/docs/ApiResponseReportedFinancials.md +10 -0
- data/docs/ApiResponseSICIndexHistoricalData.md +10 -0
- data/docs/ApiResponseSICIndices.md +9 -0
- data/docs/ApiResponseSecurities.md +9 -0
- data/docs/ApiResponseSecurityHistoricalData.md +10 -0
- data/docs/ApiResponseSecurityStockPriceAdjustments.md +10 -0
- data/docs/ApiResponseSecurityStockPrices.md +10 -0
- data/docs/ApiResponseStandardizedFinancials.md +10 -0
- data/docs/ApiResponseStockExchangeSecurities.md +10 -0
- data/docs/ApiResponseStockExchangeStockPriceAdjustments.md +10 -0
- data/docs/ApiResponseStockExchangeStockPrices.md +10 -0
- data/docs/ApiResponseStockExchanges.md +9 -0
- data/docs/ApiResponseStockMarketIndexHistoricalData.md +10 -0
- data/docs/ApiResponseStockMarketIndices.md +9 -0
- data/docs/Company.md +39 -0
- data/docs/CompanyApi.md +659 -0
- data/docs/CompanyFiling.md +17 -0
- data/docs/CompanyNews.md +13 -0
- data/docs/CompanyNewsSummary.md +12 -0
- data/docs/CompanySummary.md +12 -0
- data/docs/DataPointApi.md +96 -0
- data/docs/DataTag.md +17 -0
- data/docs/DataTagApi.md +184 -0
- data/docs/DataTagSummary.md +11 -0
- data/docs/EconomicIndex.md +19 -0
- data/docs/EconomicIndexSummary.md +18 -0
- data/docs/Filing.md +17 -0
- data/docs/FilingApi.md +142 -0
- data/docs/FilingSummary.md +16 -0
- data/docs/Fundamental.md +16 -0
- data/docs/FundamentalSummary.md +15 -0
- data/docs/FundamentalsApi.md +181 -0
- data/docs/HistoricalData.md +9 -0
- data/docs/HistoricalDataApi.md +64 -0
- data/docs/IndexApi.md +800 -0
- data/docs/ReportedFinancial.md +9 -0
- data/docs/ReportedTag.md +14 -0
- data/docs/SICIndex.md +12 -0
- data/docs/Security.md +34 -0
- data/docs/SecurityApi.md +420 -0
- data/docs/SecurityScreenClause.md +10 -0
- data/docs/SecurityScreenGroup.md +10 -0
- data/docs/SecurityScreenResult.md +9 -0
- data/docs/SecurityScreenResultData.md +10 -0
- data/docs/SecuritySummary.md +17 -0
- data/docs/StandardizedFinancial.md +9 -0
- data/docs/StockExchange.md +17 -0
- data/docs/StockExchangeApi.md +267 -0
- data/docs/StockMarketIndex.md +17 -0
- data/docs/StockMarketIndexSummary.md +16 -0
- data/docs/StockPrice.md +21 -0
- data/docs/StockPriceAdjustment.md +12 -0
- data/docs/StockPriceAdjustmentSummary.md +13 -0
- data/docs/StockPriceSummary.md +20 -0
- data/git_push.sh +55 -0
- data/intrinio-sdk.gemspec +45 -0
- data/lib/intrinio-sdk.rb +105 -0
- data/lib/intrinio-sdk/api/company_api.rb +885 -0
- data/lib/intrinio-sdk/api/data_point_api.rb +141 -0
- data/lib/intrinio-sdk/api/data_tag_api.rb +251 -0
- data/lib/intrinio-sdk/api/filing_api.rb +192 -0
- data/lib/intrinio-sdk/api/fundamentals_api.rb +261 -0
- data/lib/intrinio-sdk/api/historical_data_api.rb +100 -0
- data/lib/intrinio-sdk/api/index_api.rb +1079 -0
- data/lib/intrinio-sdk/api/security_api.rb +568 -0
- data/lib/intrinio-sdk/api/stock_exchange_api.rb +353 -0
- data/lib/intrinio-sdk/api_client.rb +389 -0
- data/lib/intrinio-sdk/api_error.rb +38 -0
- data/lib/intrinio-sdk/configuration.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_companies.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_company_filings.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_company_fundamentals.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_company_historical_data.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_company_news.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_company_securities.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_data_tags.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_economic_indices.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_filings.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_historical_data.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_news.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_reported_financials.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_securities.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_security_historical_data.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +211 -0
- data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +211 -0
- data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_sic_indices.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +211 -0
- data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +211 -0
- data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +211 -0
- data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +200 -0
- data/lib/intrinio-sdk/models/company.rb +498 -0
- data/lib/intrinio-sdk/models/company_filing.rb +278 -0
- data/lib/intrinio-sdk/models/company_news.rb +239 -0
- data/lib/intrinio-sdk/models/company_news_summary.rb +229 -0
- data/lib/intrinio-sdk/models/company_summary.rb +229 -0
- data/lib/intrinio-sdk/models/data_tag.rb +312 -0
- data/lib/intrinio-sdk/models/data_tag_summary.rb +219 -0
- data/lib/intrinio-sdk/models/economic_index.rb +299 -0
- data/lib/intrinio-sdk/models/economic_index_summary.rb +289 -0
- data/lib/intrinio-sdk/models/filing.rb +278 -0
- data/lib/intrinio-sdk/models/filing_summary.rb +269 -0
- data/lib/intrinio-sdk/models/fundamental.rb +302 -0
- data/lib/intrinio-sdk/models/fundamental_summary.rb +292 -0
- data/lib/intrinio-sdk/models/historical_data.rb +199 -0
- data/lib/intrinio-sdk/models/reported_financial.rb +198 -0
- data/lib/intrinio-sdk/models/reported_tag.rb +249 -0
- data/lib/intrinio-sdk/models/security.rb +453 -0
- data/lib/intrinio-sdk/models/security_screen_clause.rb +242 -0
- data/lib/intrinio-sdk/models/security_screen_group.rb +213 -0
- data/lib/intrinio-sdk/models/security_screen_result.rb +199 -0
- data/lib/intrinio-sdk/models/security_screen_result_data.rb +209 -0
- data/lib/intrinio-sdk/models/security_summary.rb +279 -0
- data/lib/intrinio-sdk/models/sic_index.rb +229 -0
- data/lib/intrinio-sdk/models/standardized_financial.rb +198 -0
- data/lib/intrinio-sdk/models/stock_exchange.rb +279 -0
- data/lib/intrinio-sdk/models/stock_market_index.rb +279 -0
- data/lib/intrinio-sdk/models/stock_market_index_summary.rb +269 -0
- data/lib/intrinio-sdk/models/stock_price.rb +352 -0
- data/lib/intrinio-sdk/models/stock_price_adjustment.rb +229 -0
- data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +239 -0
- data/lib/intrinio-sdk/models/stock_price_summary.rb +342 -0
- data/lib/intrinio-sdk/version.rb +15 -0
- data/spec/api/company_api_spec.rb +233 -0
- data/spec/api/data_point_api_spec.rb +61 -0
- data/spec/api/data_tag_api_spec.rb +88 -0
- data/spec/api/filing_api_spec.rb +75 -0
- data/spec/api/fundamentals_api_spec.rb +86 -0
- data/spec/api/historical_data_api_spec.rb +53 -0
- data/spec/api/index_api_spec.rb +275 -0
- data/spec/api/security_api_spec.rb +161 -0
- data/spec/api/stock_exchange_api_spec.rb +113 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/api_response_companies_spec.rb +48 -0
- data/spec/models/api_response_company_filings_spec.rb +54 -0
- data/spec/models/api_response_company_fundamentals_spec.rb +54 -0
- data/spec/models/api_response_company_historical_data_spec.rb +54 -0
- data/spec/models/api_response_company_news_spec.rb +54 -0
- data/spec/models/api_response_company_securities_spec.rb +54 -0
- data/spec/models/api_response_data_tags_spec.rb +48 -0
- data/spec/models/api_response_economic_index_historical_data_spec.rb +54 -0
- data/spec/models/api_response_economic_indices_spec.rb +48 -0
- data/spec/models/api_response_filings_spec.rb +48 -0
- data/spec/models/api_response_historical_data_spec.rb +48 -0
- data/spec/models/api_response_news_spec.rb +48 -0
- data/spec/models/api_response_reported_financials_spec.rb +54 -0
- data/spec/models/api_response_securities_spec.rb +48 -0
- data/spec/models/api_response_security_historical_data_spec.rb +54 -0
- data/spec/models/api_response_security_stock_price_adjustments_spec.rb +54 -0
- data/spec/models/api_response_security_stock_prices_spec.rb +54 -0
- data/spec/models/api_response_sic_index_historical_data_spec.rb +54 -0
- data/spec/models/api_response_sic_indices_spec.rb +48 -0
- data/spec/models/api_response_standardized_financials_spec.rb +54 -0
- data/spec/models/api_response_stock_exchange_securities_spec.rb +54 -0
- data/spec/models/api_response_stock_exchange_stock_price_adjustments_spec.rb +54 -0
- data/spec/models/api_response_stock_exchange_stock_prices_spec.rb +54 -0
- data/spec/models/api_response_stock_exchanges_spec.rb +48 -0
- data/spec/models/api_response_stock_market_index_historical_data_spec.rb +54 -0
- data/spec/models/api_response_stock_market_indices_spec.rb +48 -0
- data/spec/models/company_filing_spec.rb +96 -0
- data/spec/models/company_news_spec.rb +72 -0
- data/spec/models/company_news_summary_spec.rb +66 -0
- data/spec/models/company_spec.rb +228 -0
- data/spec/models/company_summary_spec.rb +66 -0
- data/spec/models/data_tag_spec.rb +100 -0
- data/spec/models/data_tag_summary_spec.rb +60 -0
- data/spec/models/economic_index_spec.rb +108 -0
- data/spec/models/economic_index_summary_spec.rb +102 -0
- data/spec/models/filing_spec.rb +96 -0
- data/spec/models/filing_summary_spec.rb +90 -0
- data/spec/models/fundamental_spec.rb +94 -0
- data/spec/models/fundamental_summary_spec.rb +88 -0
- data/spec/models/historical_data_spec.rb +48 -0
- data/spec/models/reported_financial_spec.rb +48 -0
- data/spec/models/reported_tag_spec.rb +78 -0
- data/spec/models/security_screen_clause_spec.rb +58 -0
- data/spec/models/security_screen_group_spec.rb +54 -0
- data/spec/models/security_screen_result_data_spec.rb +54 -0
- data/spec/models/security_screen_result_spec.rb +48 -0
- data/spec/models/security_spec.rb +198 -0
- data/spec/models/security_summary_spec.rb +96 -0
- data/spec/models/sic_index_spec.rb +66 -0
- data/spec/models/standardized_financial_spec.rb +48 -0
- data/spec/models/stock_exchange_spec.rb +96 -0
- data/spec/models/stock_market_index_spec.rb +96 -0
- data/spec/models/stock_market_index_summary_spec.rb +90 -0
- data/spec/models/stock_price_adjustment_spec.rb +66 -0
- data/spec/models/stock_price_adjustment_summary_spec.rb +72 -0
- data/spec/models/stock_price_spec.rb +124 -0
- data/spec/models/stock_price_summary_spec.rb +118 -0
- data/spec/spec_helper.rb +111 -0
- metadata +509 -0
@@ -0,0 +1,261 @@
|
|
1
|
+
=begin
|
2
|
+
#Intrinio API
|
3
|
+
|
4
|
+
#Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0.0
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.3.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require "uri"
|
14
|
+
|
15
|
+
module Intrinio
|
16
|
+
class FundamentalsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
|
23
|
+
# Get a Fundamental by ID
|
24
|
+
# Retrieves detailed fundamental data for the given `fundamental_id`.
|
25
|
+
# @param id The Intrinio ID for the Fundamental
|
26
|
+
# @param [Hash] opts the optional parameters
|
27
|
+
# @return [Fundamental]
|
28
|
+
def get_fundamental_by_id(id, opts = {})
|
29
|
+
data, _status_code, _headers = get_fundamental_by_id_with_http_info(id, opts)
|
30
|
+
return data
|
31
|
+
end
|
32
|
+
|
33
|
+
# Get a Fundamental by ID
|
34
|
+
# Retrieves detailed fundamental data for the given `fundamental_id`.
|
35
|
+
# @param id The Intrinio ID for the Fundamental
|
36
|
+
# @param [Hash] opts the optional parameters
|
37
|
+
# @return [Array<(Fundamental, Fixnum, Hash)>] Fundamental data, response status code and response headers
|
38
|
+
def get_fundamental_by_id_with_http_info(id, opts = {})
|
39
|
+
if @api_client.config.debugging
|
40
|
+
@api_client.config.logger.debug "Calling API: FundamentalsApi.get_fundamental_by_id ..."
|
41
|
+
end
|
42
|
+
# verify the required parameter 'id' is set
|
43
|
+
if @api_client.config.client_side_validation && id.nil?
|
44
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FundamentalsApi.get_fundamental_by_id"
|
45
|
+
end
|
46
|
+
# resource path
|
47
|
+
local_var_path = "/fundamentals/{id}".sub('{' + 'id' + '}', id.to_s)
|
48
|
+
|
49
|
+
# query parameters
|
50
|
+
query_params = {}
|
51
|
+
|
52
|
+
# header parameters
|
53
|
+
header_params = {}
|
54
|
+
# HTTP header 'Accept' (if needed)
|
55
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
56
|
+
|
57
|
+
# form parameters
|
58
|
+
form_params = {}
|
59
|
+
|
60
|
+
# http body (model)
|
61
|
+
post_body = nil
|
62
|
+
auth_names = ['ApiKeyAuth']
|
63
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
64
|
+
:header_params => header_params,
|
65
|
+
:query_params => query_params,
|
66
|
+
:form_params => form_params,
|
67
|
+
:body => post_body,
|
68
|
+
:auth_names => auth_names,
|
69
|
+
:return_type => 'Fundamental')
|
70
|
+
if @api_client.config.debugging
|
71
|
+
@api_client.config.logger.debug "API called: FundamentalsApi#get_fundamental_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
72
|
+
end
|
73
|
+
return data, status_code, headers
|
74
|
+
end
|
75
|
+
|
76
|
+
# Get Reported Financials for a Fundamental
|
77
|
+
# Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company
|
78
|
+
# @param id The Intrinio ID for the Fundamental
|
79
|
+
# @param [Hash] opts the optional parameters
|
80
|
+
# @return [ApiResponseReportedFinancials]
|
81
|
+
def get_fundamental_reported_financials(id, opts = {})
|
82
|
+
data, _status_code, _headers = get_fundamental_reported_financials_with_http_info(id, opts)
|
83
|
+
return data
|
84
|
+
end
|
85
|
+
|
86
|
+
# Get Reported Financials for a Fundamental
|
87
|
+
# Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company
|
88
|
+
# @param id The Intrinio ID for the Fundamental
|
89
|
+
# @param [Hash] opts the optional parameters
|
90
|
+
# @return [Array<(ApiResponseReportedFinancials, Fixnum, Hash)>] ApiResponseReportedFinancials data, response status code and response headers
|
91
|
+
def get_fundamental_reported_financials_with_http_info(id, opts = {})
|
92
|
+
if @api_client.config.debugging
|
93
|
+
@api_client.config.logger.debug "Calling API: FundamentalsApi.get_fundamental_reported_financials ..."
|
94
|
+
end
|
95
|
+
# verify the required parameter 'id' is set
|
96
|
+
if @api_client.config.client_side_validation && id.nil?
|
97
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FundamentalsApi.get_fundamental_reported_financials"
|
98
|
+
end
|
99
|
+
# resource path
|
100
|
+
local_var_path = "/fundamentals/{id}/reported_financials".sub('{' + 'id' + '}', id.to_s)
|
101
|
+
|
102
|
+
# query parameters
|
103
|
+
query_params = {}
|
104
|
+
|
105
|
+
# header parameters
|
106
|
+
header_params = {}
|
107
|
+
# HTTP header 'Accept' (if needed)
|
108
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
109
|
+
|
110
|
+
# form parameters
|
111
|
+
form_params = {}
|
112
|
+
|
113
|
+
# http body (model)
|
114
|
+
post_body = nil
|
115
|
+
auth_names = ['ApiKeyAuth']
|
116
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
117
|
+
:header_params => header_params,
|
118
|
+
:query_params => query_params,
|
119
|
+
:form_params => form_params,
|
120
|
+
:body => post_body,
|
121
|
+
:auth_names => auth_names,
|
122
|
+
:return_type => 'ApiResponseReportedFinancials')
|
123
|
+
if @api_client.config.debugging
|
124
|
+
@api_client.config.logger.debug "API called: FundamentalsApi#get_fundamental_reported_financials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
125
|
+
end
|
126
|
+
return data, status_code, headers
|
127
|
+
end
|
128
|
+
|
129
|
+
# Get Standardized Financials for a Fundamental
|
130
|
+
# Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies fundamentals. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as reported financial statements because of the inherent complexity of reporting standards.
|
131
|
+
# @param id The Intrinio ID for the Fundamental
|
132
|
+
# @param [Hash] opts the optional parameters
|
133
|
+
# @return [ApiResponseStandardizedFinancials]
|
134
|
+
def get_fundamental_standardized_financials(id, opts = {})
|
135
|
+
data, _status_code, _headers = get_fundamental_standardized_financials_with_http_info(id, opts)
|
136
|
+
return data
|
137
|
+
end
|
138
|
+
|
139
|
+
# Get Standardized Financials for a Fundamental
|
140
|
+
# Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies fundamentals. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as reported financial statements because of the inherent complexity of reporting standards.
|
141
|
+
# @param id The Intrinio ID for the Fundamental
|
142
|
+
# @param [Hash] opts the optional parameters
|
143
|
+
# @return [Array<(ApiResponseStandardizedFinancials, Fixnum, Hash)>] ApiResponseStandardizedFinancials data, response status code and response headers
|
144
|
+
def get_fundamental_standardized_financials_with_http_info(id, opts = {})
|
145
|
+
if @api_client.config.debugging
|
146
|
+
@api_client.config.logger.debug "Calling API: FundamentalsApi.get_fundamental_standardized_financials ..."
|
147
|
+
end
|
148
|
+
# verify the required parameter 'id' is set
|
149
|
+
if @api_client.config.client_side_validation && id.nil?
|
150
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FundamentalsApi.get_fundamental_standardized_financials"
|
151
|
+
end
|
152
|
+
# resource path
|
153
|
+
local_var_path = "/fundamentals/{id}/standardized_financials".sub('{' + 'id' + '}', id.to_s)
|
154
|
+
|
155
|
+
# query parameters
|
156
|
+
query_params = {}
|
157
|
+
|
158
|
+
# header parameters
|
159
|
+
header_params = {}
|
160
|
+
# HTTP header 'Accept' (if needed)
|
161
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
162
|
+
|
163
|
+
# form parameters
|
164
|
+
form_params = {}
|
165
|
+
|
166
|
+
# http body (model)
|
167
|
+
post_body = nil
|
168
|
+
auth_names = ['ApiKeyAuth']
|
169
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
170
|
+
:header_params => header_params,
|
171
|
+
:query_params => query_params,
|
172
|
+
:form_params => form_params,
|
173
|
+
:body => post_body,
|
174
|
+
:auth_names => auth_names,
|
175
|
+
:return_type => 'ApiResponseStandardizedFinancials')
|
176
|
+
if @api_client.config.debugging
|
177
|
+
@api_client.config.logger.debug "API called: FundamentalsApi#get_fundamental_standardized_financials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
178
|
+
end
|
179
|
+
return data, status_code, headers
|
180
|
+
end
|
181
|
+
|
182
|
+
# Lookup a Fundamental
|
183
|
+
# Returns the Fundamental for the Company with the given `identifier` and with the given parameters
|
184
|
+
# @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
|
185
|
+
# @param statement_code The statement code
|
186
|
+
# @param fiscal_year The fiscal year
|
187
|
+
# @param fiscal_period The fiscal period
|
188
|
+
# @param [Hash] opts the optional parameters
|
189
|
+
# @return [Fundamental]
|
190
|
+
def lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period, opts = {})
|
191
|
+
data, _status_code, _headers = lookup_fundamental_with_http_info(identifier, statement_code, fiscal_year, fiscal_period, opts)
|
192
|
+
return data
|
193
|
+
end
|
194
|
+
|
195
|
+
# Lookup a Fundamental
|
196
|
+
# Returns the Fundamental for the Company with the given `identifier` and with the given parameters
|
197
|
+
# @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
|
198
|
+
# @param statement_code The statement code
|
199
|
+
# @param fiscal_year The fiscal year
|
200
|
+
# @param fiscal_period The fiscal period
|
201
|
+
# @param [Hash] opts the optional parameters
|
202
|
+
# @return [Array<(Fundamental, Fixnum, Hash)>] Fundamental data, response status code and response headers
|
203
|
+
def lookup_fundamental_with_http_info(identifier, statement_code, fiscal_year, fiscal_period, opts = {})
|
204
|
+
if @api_client.config.debugging
|
205
|
+
@api_client.config.logger.debug "Calling API: FundamentalsApi.lookup_fundamental ..."
|
206
|
+
end
|
207
|
+
# verify the required parameter 'identifier' is set
|
208
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
209
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling FundamentalsApi.lookup_fundamental"
|
210
|
+
end
|
211
|
+
# verify the required parameter 'statement_code' is set
|
212
|
+
if @api_client.config.client_side_validation && statement_code.nil?
|
213
|
+
fail ArgumentError, "Missing the required parameter 'statement_code' when calling FundamentalsApi.lookup_fundamental"
|
214
|
+
end
|
215
|
+
# verify enum value
|
216
|
+
if @api_client.config.client_side_validation && !['income_statement', 'balance_sheet_statement', 'cash_flow_statement', 'calculations'].include?(statement_code)
|
217
|
+
fail ArgumentError, "invalid value for 'statement_code', must be one of income_statement, balance_sheet_statement, cash_flow_statement, calculations"
|
218
|
+
end
|
219
|
+
# verify the required parameter 'fiscal_year' is set
|
220
|
+
if @api_client.config.client_side_validation && fiscal_year.nil?
|
221
|
+
fail ArgumentError, "Missing the required parameter 'fiscal_year' when calling FundamentalsApi.lookup_fundamental"
|
222
|
+
end
|
223
|
+
# verify the required parameter 'fiscal_period' is set
|
224
|
+
if @api_client.config.client_side_validation && fiscal_period.nil?
|
225
|
+
fail ArgumentError, "Missing the required parameter 'fiscal_period' when calling FundamentalsApi.lookup_fundamental"
|
226
|
+
end
|
227
|
+
# verify enum value
|
228
|
+
if @api_client.config.client_side_validation && !['Q1TTM', 'Q2TTM', 'Q3TTM', 'FY', 'Q1', 'Q2', 'Q3', 'Q4', 'Q2YTD', 'Q3YTD'].include?(fiscal_period)
|
229
|
+
fail ArgumentError, "invalid value for 'fiscal_period', must be one of Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD"
|
230
|
+
end
|
231
|
+
# resource path
|
232
|
+
local_var_path = "/fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period}".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'statement_code' + '}', statement_code.to_s).sub('{' + 'fiscal_year' + '}', fiscal_year.to_s).sub('{' + 'fiscal_period' + '}', fiscal_period.to_s)
|
233
|
+
|
234
|
+
# query parameters
|
235
|
+
query_params = {}
|
236
|
+
|
237
|
+
# header parameters
|
238
|
+
header_params = {}
|
239
|
+
# HTTP header 'Accept' (if needed)
|
240
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
241
|
+
|
242
|
+
# form parameters
|
243
|
+
form_params = {}
|
244
|
+
|
245
|
+
# http body (model)
|
246
|
+
post_body = nil
|
247
|
+
auth_names = ['ApiKeyAuth']
|
248
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
249
|
+
:header_params => header_params,
|
250
|
+
:query_params => query_params,
|
251
|
+
:form_params => form_params,
|
252
|
+
:body => post_body,
|
253
|
+
:auth_names => auth_names,
|
254
|
+
:return_type => 'Fundamental')
|
255
|
+
if @api_client.config.debugging
|
256
|
+
@api_client.config.logger.debug "API called: FundamentalsApi#lookup_fundamental\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
257
|
+
end
|
258
|
+
return data, status_code, headers
|
259
|
+
end
|
260
|
+
end
|
261
|
+
end
|
@@ -0,0 +1,100 @@
|
|
1
|
+
=begin
|
2
|
+
#Intrinio API
|
3
|
+
|
4
|
+
#Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0.0
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.3.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require "uri"
|
14
|
+
|
15
|
+
module Intrinio
|
16
|
+
class HistoricalDataApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
|
23
|
+
# Get Historical Data
|
24
|
+
# Returns historical values for the given `tag` and the entity represented by the given `identifier`
|
25
|
+
# @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
|
26
|
+
# @param tag An Intrinio data tag ID or code-name
|
27
|
+
# @param [Hash] opts the optional parameters
|
28
|
+
# @option opts [String] :type Filter by type, when applicable
|
29
|
+
# @option opts [Date] :start_date Get historical data on or after this date
|
30
|
+
# @option opts [Date] :end_date Get historical date on or before this date
|
31
|
+
# @option opts [String] :sort_order Sort by date `asc` or `desc` (default to desc)
|
32
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
33
|
+
# @return [ApiResponseHistoricalData]
|
34
|
+
def get_historical_data(identifier, tag, opts = {})
|
35
|
+
data, _status_code, _headers = get_historical_data_with_http_info(identifier, tag, opts)
|
36
|
+
return data
|
37
|
+
end
|
38
|
+
|
39
|
+
# Get Historical Data
|
40
|
+
# Returns historical values for the given `tag` and the entity represented by the given `identifier`
|
41
|
+
# @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
|
42
|
+
# @param tag An Intrinio data tag ID or code-name
|
43
|
+
# @param [Hash] opts the optional parameters
|
44
|
+
# @option opts [String] :type Filter by type, when applicable
|
45
|
+
# @option opts [Date] :start_date Get historical data on or after this date
|
46
|
+
# @option opts [Date] :end_date Get historical date on or before this date
|
47
|
+
# @option opts [String] :sort_order Sort by date `asc` or `desc`
|
48
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
49
|
+
# @return [Array<(ApiResponseHistoricalData, Fixnum, Hash)>] ApiResponseHistoricalData data, response status code and response headers
|
50
|
+
def get_historical_data_with_http_info(identifier, tag, opts = {})
|
51
|
+
if @api_client.config.debugging
|
52
|
+
@api_client.config.logger.debug "Calling API: HistoricalDataApi.get_historical_data ..."
|
53
|
+
end
|
54
|
+
# verify the required parameter 'identifier' is set
|
55
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
56
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling HistoricalDataApi.get_historical_data"
|
57
|
+
end
|
58
|
+
# verify the required parameter 'tag' is set
|
59
|
+
if @api_client.config.client_side_validation && tag.nil?
|
60
|
+
fail ArgumentError, "Missing the required parameter 'tag' when calling HistoricalDataApi.get_historical_data"
|
61
|
+
end
|
62
|
+
if @api_client.config.client_side_validation && opts[:'sort_order'] && !['asc', 'desc'].include?(opts[:'sort_order'])
|
63
|
+
fail ArgumentError, 'invalid value for "sort_order", must be one of asc, desc'
|
64
|
+
end
|
65
|
+
# resource path
|
66
|
+
local_var_path = "/historical_data/{identifier}/{tag}".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)
|
67
|
+
|
68
|
+
# query parameters
|
69
|
+
query_params = {}
|
70
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
71
|
+
query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
72
|
+
query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
73
|
+
query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
|
74
|
+
query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
|
75
|
+
|
76
|
+
# header parameters
|
77
|
+
header_params = {}
|
78
|
+
# HTTP header 'Accept' (if needed)
|
79
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
80
|
+
|
81
|
+
# form parameters
|
82
|
+
form_params = {}
|
83
|
+
|
84
|
+
# http body (model)
|
85
|
+
post_body = nil
|
86
|
+
auth_names = ['ApiKeyAuth']
|
87
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
88
|
+
:header_params => header_params,
|
89
|
+
:query_params => query_params,
|
90
|
+
:form_params => form_params,
|
91
|
+
:body => post_body,
|
92
|
+
:auth_names => auth_names,
|
93
|
+
:return_type => 'ApiResponseHistoricalData')
|
94
|
+
if @api_client.config.debugging
|
95
|
+
@api_client.config.logger.debug "API called: HistoricalDataApi#get_historical_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
96
|
+
end
|
97
|
+
return data, status_code, headers
|
98
|
+
end
|
99
|
+
end
|
100
|
+
end
|
@@ -0,0 +1,1079 @@
|
|
1
|
+
=begin
|
2
|
+
#Intrinio API
|
3
|
+
|
4
|
+
#Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0.0
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.3.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require "uri"
|
14
|
+
|
15
|
+
module Intrinio
|
16
|
+
class IndexApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
|
23
|
+
# Get All Economic Indices
|
24
|
+
#
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
27
|
+
# @return [ApiResponseEconomicIndices]
|
28
|
+
def get_all_economic_indices(opts = {})
|
29
|
+
data, _status_code, _headers = get_all_economic_indices_with_http_info(opts)
|
30
|
+
return data
|
31
|
+
end
|
32
|
+
|
33
|
+
# Get All Economic Indices
|
34
|
+
#
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
37
|
+
# @return [Array<(ApiResponseEconomicIndices, Fixnum, Hash)>] ApiResponseEconomicIndices data, response status code and response headers
|
38
|
+
def get_all_economic_indices_with_http_info(opts = {})
|
39
|
+
if @api_client.config.debugging
|
40
|
+
@api_client.config.logger.debug "Calling API: IndexApi.get_all_economic_indices ..."
|
41
|
+
end
|
42
|
+
# resource path
|
43
|
+
local_var_path = "/indices/economic"
|
44
|
+
|
45
|
+
# query parameters
|
46
|
+
query_params = {}
|
47
|
+
query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
|
48
|
+
|
49
|
+
# header parameters
|
50
|
+
header_params = {}
|
51
|
+
# HTTP header 'Accept' (if needed)
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
53
|
+
|
54
|
+
# form parameters
|
55
|
+
form_params = {}
|
56
|
+
|
57
|
+
# http body (model)
|
58
|
+
post_body = nil
|
59
|
+
auth_names = ['ApiKeyAuth']
|
60
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
61
|
+
:header_params => header_params,
|
62
|
+
:query_params => query_params,
|
63
|
+
:form_params => form_params,
|
64
|
+
:body => post_body,
|
65
|
+
:auth_names => auth_names,
|
66
|
+
:return_type => 'ApiResponseEconomicIndices')
|
67
|
+
if @api_client.config.debugging
|
68
|
+
@api_client.config.logger.debug "API called: IndexApi#get_all_economic_indices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
69
|
+
end
|
70
|
+
return data, status_code, headers
|
71
|
+
end
|
72
|
+
|
73
|
+
# Get All SIC Indices
|
74
|
+
#
|
75
|
+
# @param [Hash] opts the optional parameters
|
76
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
77
|
+
# @return [ApiResponseSICIndices]
|
78
|
+
def get_all_sic_indices(opts = {})
|
79
|
+
data, _status_code, _headers = get_all_sic_indices_with_http_info(opts)
|
80
|
+
return data
|
81
|
+
end
|
82
|
+
|
83
|
+
# Get All SIC Indices
|
84
|
+
#
|
85
|
+
# @param [Hash] opts the optional parameters
|
86
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
87
|
+
# @return [Array<(ApiResponseSICIndices, Fixnum, Hash)>] ApiResponseSICIndices data, response status code and response headers
|
88
|
+
def get_all_sic_indices_with_http_info(opts = {})
|
89
|
+
if @api_client.config.debugging
|
90
|
+
@api_client.config.logger.debug "Calling API: IndexApi.get_all_sic_indices ..."
|
91
|
+
end
|
92
|
+
# resource path
|
93
|
+
local_var_path = "/indices/sic"
|
94
|
+
|
95
|
+
# query parameters
|
96
|
+
query_params = {}
|
97
|
+
query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
|
98
|
+
|
99
|
+
# header parameters
|
100
|
+
header_params = {}
|
101
|
+
# HTTP header 'Accept' (if needed)
|
102
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
103
|
+
|
104
|
+
# form parameters
|
105
|
+
form_params = {}
|
106
|
+
|
107
|
+
# http body (model)
|
108
|
+
post_body = nil
|
109
|
+
auth_names = ['ApiKeyAuth']
|
110
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
111
|
+
:header_params => header_params,
|
112
|
+
:query_params => query_params,
|
113
|
+
:form_params => form_params,
|
114
|
+
:body => post_body,
|
115
|
+
:auth_names => auth_names,
|
116
|
+
:return_type => 'ApiResponseSICIndices')
|
117
|
+
if @api_client.config.debugging
|
118
|
+
@api_client.config.logger.debug "API called: IndexApi#get_all_sic_indices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
119
|
+
end
|
120
|
+
return data, status_code, headers
|
121
|
+
end
|
122
|
+
|
123
|
+
# Get All Stock Market Indices
|
124
|
+
#
|
125
|
+
# @param [Hash] opts the optional parameters
|
126
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
127
|
+
# @return [ApiResponseStockMarketIndices]
|
128
|
+
def get_all_stock_market_indices(opts = {})
|
129
|
+
data, _status_code, _headers = get_all_stock_market_indices_with_http_info(opts)
|
130
|
+
return data
|
131
|
+
end
|
132
|
+
|
133
|
+
# Get All Stock Market Indices
|
134
|
+
#
|
135
|
+
# @param [Hash] opts the optional parameters
|
136
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
137
|
+
# @return [Array<(ApiResponseStockMarketIndices, Fixnum, Hash)>] ApiResponseStockMarketIndices data, response status code and response headers
|
138
|
+
def get_all_stock_market_indices_with_http_info(opts = {})
|
139
|
+
if @api_client.config.debugging
|
140
|
+
@api_client.config.logger.debug "Calling API: IndexApi.get_all_stock_market_indices ..."
|
141
|
+
end
|
142
|
+
# resource path
|
143
|
+
local_var_path = "/indices/stock_market"
|
144
|
+
|
145
|
+
# query parameters
|
146
|
+
query_params = {}
|
147
|
+
query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
|
148
|
+
|
149
|
+
# header parameters
|
150
|
+
header_params = {}
|
151
|
+
# HTTP header 'Accept' (if needed)
|
152
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
153
|
+
|
154
|
+
# form parameters
|
155
|
+
form_params = {}
|
156
|
+
|
157
|
+
# http body (model)
|
158
|
+
post_body = nil
|
159
|
+
auth_names = ['ApiKeyAuth']
|
160
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
161
|
+
:header_params => header_params,
|
162
|
+
:query_params => query_params,
|
163
|
+
:form_params => form_params,
|
164
|
+
:body => post_body,
|
165
|
+
:auth_names => auth_names,
|
166
|
+
:return_type => 'ApiResponseStockMarketIndices')
|
167
|
+
if @api_client.config.debugging
|
168
|
+
@api_client.config.logger.debug "API called: IndexApi#get_all_stock_market_indices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
169
|
+
end
|
170
|
+
return data, status_code, headers
|
171
|
+
end
|
172
|
+
|
173
|
+
# Get an Economic Index by ID
|
174
|
+
#
|
175
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
176
|
+
# @param [Hash] opts the optional parameters
|
177
|
+
# @return [EconomicIndex]
|
178
|
+
def get_economic_index_by_id(identifier, opts = {})
|
179
|
+
data, _status_code, _headers = get_economic_index_by_id_with_http_info(identifier, opts)
|
180
|
+
return data
|
181
|
+
end
|
182
|
+
|
183
|
+
# Get an Economic Index by ID
|
184
|
+
#
|
185
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
186
|
+
# @param [Hash] opts the optional parameters
|
187
|
+
# @return [Array<(EconomicIndex, Fixnum, Hash)>] EconomicIndex data, response status code and response headers
|
188
|
+
def get_economic_index_by_id_with_http_info(identifier, opts = {})
|
189
|
+
if @api_client.config.debugging
|
190
|
+
@api_client.config.logger.debug "Calling API: IndexApi.get_economic_index_by_id ..."
|
191
|
+
end
|
192
|
+
# verify the required parameter 'identifier' is set
|
193
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
194
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_economic_index_by_id"
|
195
|
+
end
|
196
|
+
# resource path
|
197
|
+
local_var_path = "/indices/economic/{identifier}".sub('{' + 'identifier' + '}', identifier.to_s)
|
198
|
+
|
199
|
+
# query parameters
|
200
|
+
query_params = {}
|
201
|
+
|
202
|
+
# header parameters
|
203
|
+
header_params = {}
|
204
|
+
# HTTP header 'Accept' (if needed)
|
205
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
206
|
+
|
207
|
+
# form parameters
|
208
|
+
form_params = {}
|
209
|
+
|
210
|
+
# http body (model)
|
211
|
+
post_body = nil
|
212
|
+
auth_names = ['ApiKeyAuth']
|
213
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
214
|
+
:header_params => header_params,
|
215
|
+
:query_params => query_params,
|
216
|
+
:form_params => form_params,
|
217
|
+
:body => post_body,
|
218
|
+
:auth_names => auth_names,
|
219
|
+
:return_type => 'EconomicIndex')
|
220
|
+
if @api_client.config.debugging
|
221
|
+
@api_client.config.logger.debug "API called: IndexApi#get_economic_index_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
222
|
+
end
|
223
|
+
return data, status_code, headers
|
224
|
+
end
|
225
|
+
|
226
|
+
# Get Economic Index Data Point (Number)
|
227
|
+
# Returns a numeric value for the given `tag` for the Economic Index with the given `identifier`
|
228
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
229
|
+
# @param tag An Intrinio data tag ID or code-name
|
230
|
+
# @param [Hash] opts the optional parameters
|
231
|
+
# @return [Float]
|
232
|
+
def get_economic_index_data_point_number(identifier, tag, opts = {})
|
233
|
+
data, _status_code, _headers = get_economic_index_data_point_number_with_http_info(identifier, tag, opts)
|
234
|
+
return data
|
235
|
+
end
|
236
|
+
|
237
|
+
# Get Economic Index Data Point (Number)
|
238
|
+
# Returns a numeric value for the given `tag` for the Economic Index with the given `identifier`
|
239
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
240
|
+
# @param tag An Intrinio data tag ID or code-name
|
241
|
+
# @param [Hash] opts the optional parameters
|
242
|
+
# @return [Array<(Float, Fixnum, Hash)>] Float data, response status code and response headers
|
243
|
+
def get_economic_index_data_point_number_with_http_info(identifier, tag, opts = {})
|
244
|
+
if @api_client.config.debugging
|
245
|
+
@api_client.config.logger.debug "Calling API: IndexApi.get_economic_index_data_point_number ..."
|
246
|
+
end
|
247
|
+
# verify the required parameter 'identifier' is set
|
248
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
249
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_economic_index_data_point_number"
|
250
|
+
end
|
251
|
+
# verify the required parameter 'tag' is set
|
252
|
+
if @api_client.config.client_side_validation && tag.nil?
|
253
|
+
fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_economic_index_data_point_number"
|
254
|
+
end
|
255
|
+
# resource path
|
256
|
+
local_var_path = "/indices/economic/{identifier}/data_point/{tag}/number".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)
|
257
|
+
|
258
|
+
# query parameters
|
259
|
+
query_params = {}
|
260
|
+
|
261
|
+
# header parameters
|
262
|
+
header_params = {}
|
263
|
+
# HTTP header 'Accept' (if needed)
|
264
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])
|
265
|
+
|
266
|
+
# form parameters
|
267
|
+
form_params = {}
|
268
|
+
|
269
|
+
# http body (model)
|
270
|
+
post_body = nil
|
271
|
+
auth_names = ['ApiKeyAuth']
|
272
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
273
|
+
:header_params => header_params,
|
274
|
+
:query_params => query_params,
|
275
|
+
:form_params => form_params,
|
276
|
+
:body => post_body,
|
277
|
+
:auth_names => auth_names,
|
278
|
+
:return_type => 'Float')
|
279
|
+
if @api_client.config.debugging
|
280
|
+
@api_client.config.logger.debug "API called: IndexApi#get_economic_index_data_point_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
281
|
+
end
|
282
|
+
return data, status_code, headers
|
283
|
+
end
|
284
|
+
|
285
|
+
# Get Economic Index Data Point (Text)
|
286
|
+
# Returns a text value for the given `tag` for the Economic Index with the given `identifier`
|
287
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
288
|
+
# @param tag An Intrinio data tag ID or code-name
|
289
|
+
# @param [Hash] opts the optional parameters
|
290
|
+
# @return [String]
|
291
|
+
def get_economic_index_data_point_text(identifier, tag, opts = {})
|
292
|
+
data, _status_code, _headers = get_economic_index_data_point_text_with_http_info(identifier, tag, opts)
|
293
|
+
return data
|
294
|
+
end
|
295
|
+
|
296
|
+
# Get Economic Index Data Point (Text)
|
297
|
+
# Returns a text value for the given `tag` for the Economic Index with the given `identifier`
|
298
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
299
|
+
# @param tag An Intrinio data tag ID or code-name
|
300
|
+
# @param [Hash] opts the optional parameters
|
301
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
302
|
+
def get_economic_index_data_point_text_with_http_info(identifier, tag, opts = {})
|
303
|
+
if @api_client.config.debugging
|
304
|
+
@api_client.config.logger.debug "Calling API: IndexApi.get_economic_index_data_point_text ..."
|
305
|
+
end
|
306
|
+
# verify the required parameter 'identifier' is set
|
307
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
308
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_economic_index_data_point_text"
|
309
|
+
end
|
310
|
+
# verify the required parameter 'tag' is set
|
311
|
+
if @api_client.config.client_side_validation && tag.nil?
|
312
|
+
fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_economic_index_data_point_text"
|
313
|
+
end
|
314
|
+
# resource path
|
315
|
+
local_var_path = "/indices/economic/{identifier}/data_point/{tag}/text".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)
|
316
|
+
|
317
|
+
# query parameters
|
318
|
+
query_params = {}
|
319
|
+
|
320
|
+
# header parameters
|
321
|
+
header_params = {}
|
322
|
+
# HTTP header 'Accept' (if needed)
|
323
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])
|
324
|
+
|
325
|
+
# form parameters
|
326
|
+
form_params = {}
|
327
|
+
|
328
|
+
# http body (model)
|
329
|
+
post_body = nil
|
330
|
+
auth_names = ['ApiKeyAuth']
|
331
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
332
|
+
:header_params => header_params,
|
333
|
+
:query_params => query_params,
|
334
|
+
:form_params => form_params,
|
335
|
+
:body => post_body,
|
336
|
+
:auth_names => auth_names,
|
337
|
+
:return_type => 'String')
|
338
|
+
if @api_client.config.debugging
|
339
|
+
@api_client.config.logger.debug "API called: IndexApi#get_economic_index_data_point_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
340
|
+
end
|
341
|
+
return data, status_code, headers
|
342
|
+
end
|
343
|
+
|
344
|
+
# Get Economic Index Historical Data
|
345
|
+
# Returns historical values for the given `tag` and the Economic Index with the given `identifier`
|
346
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
347
|
+
# @param tag An Intrinio data tag ID or code-name
|
348
|
+
# @param [Hash] opts the optional parameters
|
349
|
+
# @option opts [String] :type Filter by type, when applicable
|
350
|
+
# @option opts [Date] :start_date Get historical data on or after this date
|
351
|
+
# @option opts [Date] :end_date Get historical data on or before this date
|
352
|
+
# @option opts [String] :sort_order Sort by date `asc` or `desc` (default to desc)
|
353
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
354
|
+
# @return [ApiResponseEconomicIndexHistoricalData]
|
355
|
+
def get_economic_index_historical_data(identifier, tag, opts = {})
|
356
|
+
data, _status_code, _headers = get_economic_index_historical_data_with_http_info(identifier, tag, opts)
|
357
|
+
return data
|
358
|
+
end
|
359
|
+
|
360
|
+
# Get Economic Index Historical Data
|
361
|
+
# Returns historical values for the given `tag` and the Economic Index with the given `identifier`
|
362
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
363
|
+
# @param tag An Intrinio data tag ID or code-name
|
364
|
+
# @param [Hash] opts the optional parameters
|
365
|
+
# @option opts [String] :type Filter by type, when applicable
|
366
|
+
# @option opts [Date] :start_date Get historical data on or after this date
|
367
|
+
# @option opts [Date] :end_date Get historical data on or before this date
|
368
|
+
# @option opts [String] :sort_order Sort by date `asc` or `desc`
|
369
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
370
|
+
# @return [Array<(ApiResponseEconomicIndexHistoricalData, Fixnum, Hash)>] ApiResponseEconomicIndexHistoricalData data, response status code and response headers
|
371
|
+
def get_economic_index_historical_data_with_http_info(identifier, tag, opts = {})
|
372
|
+
if @api_client.config.debugging
|
373
|
+
@api_client.config.logger.debug "Calling API: IndexApi.get_economic_index_historical_data ..."
|
374
|
+
end
|
375
|
+
# verify the required parameter 'identifier' is set
|
376
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
377
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_economic_index_historical_data"
|
378
|
+
end
|
379
|
+
# verify the required parameter 'tag' is set
|
380
|
+
if @api_client.config.client_side_validation && tag.nil?
|
381
|
+
fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_economic_index_historical_data"
|
382
|
+
end
|
383
|
+
if @api_client.config.client_side_validation && opts[:'sort_order'] && !['asc', 'desc'].include?(opts[:'sort_order'])
|
384
|
+
fail ArgumentError, 'invalid value for "sort_order", must be one of asc, desc'
|
385
|
+
end
|
386
|
+
# resource path
|
387
|
+
local_var_path = "/indices/economic/{identifier}/historical_data/{tag}".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)
|
388
|
+
|
389
|
+
# query parameters
|
390
|
+
query_params = {}
|
391
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
392
|
+
query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
393
|
+
query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
394
|
+
query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
|
395
|
+
query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
|
396
|
+
|
397
|
+
# header parameters
|
398
|
+
header_params = {}
|
399
|
+
# HTTP header 'Accept' (if needed)
|
400
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
401
|
+
|
402
|
+
# form parameters
|
403
|
+
form_params = {}
|
404
|
+
|
405
|
+
# http body (model)
|
406
|
+
post_body = nil
|
407
|
+
auth_names = ['ApiKeyAuth']
|
408
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
409
|
+
:header_params => header_params,
|
410
|
+
:query_params => query_params,
|
411
|
+
:form_params => form_params,
|
412
|
+
:body => post_body,
|
413
|
+
:auth_names => auth_names,
|
414
|
+
:return_type => 'ApiResponseEconomicIndexHistoricalData')
|
415
|
+
if @api_client.config.debugging
|
416
|
+
@api_client.config.logger.debug "API called: IndexApi#get_economic_index_historical_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
417
|
+
end
|
418
|
+
return data, status_code, headers
|
419
|
+
end
|
420
|
+
|
421
|
+
# Get an SIC Index by ID
|
422
|
+
#
|
423
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
424
|
+
# @param [Hash] opts the optional parameters
|
425
|
+
# @return [SICIndex]
|
426
|
+
def get_sic_index_by_id(identifier, opts = {})
|
427
|
+
data, _status_code, _headers = get_sic_index_by_id_with_http_info(identifier, opts)
|
428
|
+
return data
|
429
|
+
end
|
430
|
+
|
431
|
+
# Get an SIC Index by ID
|
432
|
+
#
|
433
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
434
|
+
# @param [Hash] opts the optional parameters
|
435
|
+
# @return [Array<(SICIndex, Fixnum, Hash)>] SICIndex data, response status code and response headers
|
436
|
+
def get_sic_index_by_id_with_http_info(identifier, opts = {})
|
437
|
+
if @api_client.config.debugging
|
438
|
+
@api_client.config.logger.debug "Calling API: IndexApi.get_sic_index_by_id ..."
|
439
|
+
end
|
440
|
+
# verify the required parameter 'identifier' is set
|
441
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
442
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_sic_index_by_id"
|
443
|
+
end
|
444
|
+
# resource path
|
445
|
+
local_var_path = "/indices/sic/{identifier}".sub('{' + 'identifier' + '}', identifier.to_s)
|
446
|
+
|
447
|
+
# query parameters
|
448
|
+
query_params = {}
|
449
|
+
|
450
|
+
# header parameters
|
451
|
+
header_params = {}
|
452
|
+
# HTTP header 'Accept' (if needed)
|
453
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
454
|
+
|
455
|
+
# form parameters
|
456
|
+
form_params = {}
|
457
|
+
|
458
|
+
# http body (model)
|
459
|
+
post_body = nil
|
460
|
+
auth_names = ['ApiKeyAuth']
|
461
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
462
|
+
:header_params => header_params,
|
463
|
+
:query_params => query_params,
|
464
|
+
:form_params => form_params,
|
465
|
+
:body => post_body,
|
466
|
+
:auth_names => auth_names,
|
467
|
+
:return_type => 'SICIndex')
|
468
|
+
if @api_client.config.debugging
|
469
|
+
@api_client.config.logger.debug "API called: IndexApi#get_sic_index_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
470
|
+
end
|
471
|
+
return data, status_code, headers
|
472
|
+
end
|
473
|
+
|
474
|
+
# Get SIC Index Data Point (Number)
|
475
|
+
# Returns a numeric value for the given `tag` for the SIC Index with the given `identifier`
|
476
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
477
|
+
# @param tag An Intrinio data tag ID or code-name
|
478
|
+
# @param [Hash] opts the optional parameters
|
479
|
+
# @return [Float]
|
480
|
+
def get_sic_index_data_point_number(identifier, tag, opts = {})
|
481
|
+
data, _status_code, _headers = get_sic_index_data_point_number_with_http_info(identifier, tag, opts)
|
482
|
+
return data
|
483
|
+
end
|
484
|
+
|
485
|
+
# Get SIC Index Data Point (Number)
|
486
|
+
# Returns a numeric value for the given `tag` for the SIC Index with the given `identifier`
|
487
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
488
|
+
# @param tag An Intrinio data tag ID or code-name
|
489
|
+
# @param [Hash] opts the optional parameters
|
490
|
+
# @return [Array<(Float, Fixnum, Hash)>] Float data, response status code and response headers
|
491
|
+
def get_sic_index_data_point_number_with_http_info(identifier, tag, opts = {})
|
492
|
+
if @api_client.config.debugging
|
493
|
+
@api_client.config.logger.debug "Calling API: IndexApi.get_sic_index_data_point_number ..."
|
494
|
+
end
|
495
|
+
# verify the required parameter 'identifier' is set
|
496
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
497
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_sic_index_data_point_number"
|
498
|
+
end
|
499
|
+
# verify the required parameter 'tag' is set
|
500
|
+
if @api_client.config.client_side_validation && tag.nil?
|
501
|
+
fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_sic_index_data_point_number"
|
502
|
+
end
|
503
|
+
# resource path
|
504
|
+
local_var_path = "/indices/sic/{identifier}/data_point/{tag}/number".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)
|
505
|
+
|
506
|
+
# query parameters
|
507
|
+
query_params = {}
|
508
|
+
|
509
|
+
# header parameters
|
510
|
+
header_params = {}
|
511
|
+
# HTTP header 'Accept' (if needed)
|
512
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])
|
513
|
+
|
514
|
+
# form parameters
|
515
|
+
form_params = {}
|
516
|
+
|
517
|
+
# http body (model)
|
518
|
+
post_body = nil
|
519
|
+
auth_names = ['ApiKeyAuth']
|
520
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
521
|
+
:header_params => header_params,
|
522
|
+
:query_params => query_params,
|
523
|
+
:form_params => form_params,
|
524
|
+
:body => post_body,
|
525
|
+
:auth_names => auth_names,
|
526
|
+
:return_type => 'Float')
|
527
|
+
if @api_client.config.debugging
|
528
|
+
@api_client.config.logger.debug "API called: IndexApi#get_sic_index_data_point_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
529
|
+
end
|
530
|
+
return data, status_code, headers
|
531
|
+
end
|
532
|
+
|
533
|
+
# Get SIC Index Data Point (Text)
|
534
|
+
# Returns a text value for the given `tag` for the SIC Index with the given `identifier`
|
535
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
536
|
+
# @param tag An Intrinio data tag ID or code-name
|
537
|
+
# @param [Hash] opts the optional parameters
|
538
|
+
# @return [String]
|
539
|
+
def get_sic_index_data_point_text(identifier, tag, opts = {})
|
540
|
+
data, _status_code, _headers = get_sic_index_data_point_text_with_http_info(identifier, tag, opts)
|
541
|
+
return data
|
542
|
+
end
|
543
|
+
|
544
|
+
# Get SIC Index Data Point (Text)
|
545
|
+
# Returns a text value for the given `tag` for the SIC Index with the given `identifier`
|
546
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
547
|
+
# @param tag An Intrinio data tag ID or code-name
|
548
|
+
# @param [Hash] opts the optional parameters
|
549
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
550
|
+
def get_sic_index_data_point_text_with_http_info(identifier, tag, opts = {})
|
551
|
+
if @api_client.config.debugging
|
552
|
+
@api_client.config.logger.debug "Calling API: IndexApi.get_sic_index_data_point_text ..."
|
553
|
+
end
|
554
|
+
# verify the required parameter 'identifier' is set
|
555
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
556
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_sic_index_data_point_text"
|
557
|
+
end
|
558
|
+
# verify the required parameter 'tag' is set
|
559
|
+
if @api_client.config.client_side_validation && tag.nil?
|
560
|
+
fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_sic_index_data_point_text"
|
561
|
+
end
|
562
|
+
# resource path
|
563
|
+
local_var_path = "/indices/sic/{identifier}/data_point/{tag}/text".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)
|
564
|
+
|
565
|
+
# query parameters
|
566
|
+
query_params = {}
|
567
|
+
|
568
|
+
# header parameters
|
569
|
+
header_params = {}
|
570
|
+
# HTTP header 'Accept' (if needed)
|
571
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])
|
572
|
+
|
573
|
+
# form parameters
|
574
|
+
form_params = {}
|
575
|
+
|
576
|
+
# http body (model)
|
577
|
+
post_body = nil
|
578
|
+
auth_names = ['ApiKeyAuth']
|
579
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
580
|
+
:header_params => header_params,
|
581
|
+
:query_params => query_params,
|
582
|
+
:form_params => form_params,
|
583
|
+
:body => post_body,
|
584
|
+
:auth_names => auth_names,
|
585
|
+
:return_type => 'String')
|
586
|
+
if @api_client.config.debugging
|
587
|
+
@api_client.config.logger.debug "API called: IndexApi#get_sic_index_data_point_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
588
|
+
end
|
589
|
+
return data, status_code, headers
|
590
|
+
end
|
591
|
+
|
592
|
+
# Get SIC Index Historical Data
|
593
|
+
# Returns historical values for the given `tag` and the SIC Index with the given `identifier`
|
594
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
595
|
+
# @param tag An Intrinio data tag ID or code-name
|
596
|
+
# @param [Hash] opts the optional parameters
|
597
|
+
# @option opts [String] :type Filter by type, when applicable
|
598
|
+
# @option opts [Date] :start_date Get historical data on or after this date
|
599
|
+
# @option opts [Date] :end_date Get historical data on or before this date
|
600
|
+
# @option opts [String] :sort_order Sort by date `asc` or `desc` (default to desc)
|
601
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
602
|
+
# @return [ApiResponseSICIndexHistoricalData]
|
603
|
+
def get_sic_index_historical_data(identifier, tag, opts = {})
|
604
|
+
data, _status_code, _headers = get_sic_index_historical_data_with_http_info(identifier, tag, opts)
|
605
|
+
return data
|
606
|
+
end
|
607
|
+
|
608
|
+
# Get SIC Index Historical Data
|
609
|
+
# Returns historical values for the given `tag` and the SIC Index with the given `identifier`
|
610
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
611
|
+
# @param tag An Intrinio data tag ID or code-name
|
612
|
+
# @param [Hash] opts the optional parameters
|
613
|
+
# @option opts [String] :type Filter by type, when applicable
|
614
|
+
# @option opts [Date] :start_date Get historical data on or after this date
|
615
|
+
# @option opts [Date] :end_date Get historical data on or before this date
|
616
|
+
# @option opts [String] :sort_order Sort by date `asc` or `desc`
|
617
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
618
|
+
# @return [Array<(ApiResponseSICIndexHistoricalData, Fixnum, Hash)>] ApiResponseSICIndexHistoricalData data, response status code and response headers
|
619
|
+
def get_sic_index_historical_data_with_http_info(identifier, tag, opts = {})
|
620
|
+
if @api_client.config.debugging
|
621
|
+
@api_client.config.logger.debug "Calling API: IndexApi.get_sic_index_historical_data ..."
|
622
|
+
end
|
623
|
+
# verify the required parameter 'identifier' is set
|
624
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
625
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_sic_index_historical_data"
|
626
|
+
end
|
627
|
+
# verify the required parameter 'tag' is set
|
628
|
+
if @api_client.config.client_side_validation && tag.nil?
|
629
|
+
fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_sic_index_historical_data"
|
630
|
+
end
|
631
|
+
if @api_client.config.client_side_validation && opts[:'sort_order'] && !['asc', 'desc'].include?(opts[:'sort_order'])
|
632
|
+
fail ArgumentError, 'invalid value for "sort_order", must be one of asc, desc'
|
633
|
+
end
|
634
|
+
# resource path
|
635
|
+
local_var_path = "/indices/sic/{identifier}/historical_data/{tag}".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)
|
636
|
+
|
637
|
+
# query parameters
|
638
|
+
query_params = {}
|
639
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
640
|
+
query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
641
|
+
query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
642
|
+
query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
|
643
|
+
query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
|
644
|
+
|
645
|
+
# header parameters
|
646
|
+
header_params = {}
|
647
|
+
# HTTP header 'Accept' (if needed)
|
648
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
649
|
+
|
650
|
+
# form parameters
|
651
|
+
form_params = {}
|
652
|
+
|
653
|
+
# http body (model)
|
654
|
+
post_body = nil
|
655
|
+
auth_names = ['ApiKeyAuth']
|
656
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
657
|
+
:header_params => header_params,
|
658
|
+
:query_params => query_params,
|
659
|
+
:form_params => form_params,
|
660
|
+
:body => post_body,
|
661
|
+
:auth_names => auth_names,
|
662
|
+
:return_type => 'ApiResponseSICIndexHistoricalData')
|
663
|
+
if @api_client.config.debugging
|
664
|
+
@api_client.config.logger.debug "API called: IndexApi#get_sic_index_historical_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
665
|
+
end
|
666
|
+
return data, status_code, headers
|
667
|
+
end
|
668
|
+
|
669
|
+
# Get a Stock Market Index by ID
|
670
|
+
#
|
671
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
672
|
+
# @param [Hash] opts the optional parameters
|
673
|
+
# @return [StockMarketIndex]
|
674
|
+
def get_stock_market_index_by_id(identifier, opts = {})
|
675
|
+
data, _status_code, _headers = get_stock_market_index_by_id_with_http_info(identifier, opts)
|
676
|
+
return data
|
677
|
+
end
|
678
|
+
|
679
|
+
# Get a Stock Market Index by ID
|
680
|
+
#
|
681
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
682
|
+
# @param [Hash] opts the optional parameters
|
683
|
+
# @return [Array<(StockMarketIndex, Fixnum, Hash)>] StockMarketIndex data, response status code and response headers
|
684
|
+
def get_stock_market_index_by_id_with_http_info(identifier, opts = {})
|
685
|
+
if @api_client.config.debugging
|
686
|
+
@api_client.config.logger.debug "Calling API: IndexApi.get_stock_market_index_by_id ..."
|
687
|
+
end
|
688
|
+
# verify the required parameter 'identifier' is set
|
689
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
690
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_stock_market_index_by_id"
|
691
|
+
end
|
692
|
+
# resource path
|
693
|
+
local_var_path = "/indices/stock_market/{identifier}".sub('{' + 'identifier' + '}', identifier.to_s)
|
694
|
+
|
695
|
+
# query parameters
|
696
|
+
query_params = {}
|
697
|
+
|
698
|
+
# header parameters
|
699
|
+
header_params = {}
|
700
|
+
# HTTP header 'Accept' (if needed)
|
701
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
702
|
+
|
703
|
+
# form parameters
|
704
|
+
form_params = {}
|
705
|
+
|
706
|
+
# http body (model)
|
707
|
+
post_body = nil
|
708
|
+
auth_names = ['ApiKeyAuth']
|
709
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
710
|
+
:header_params => header_params,
|
711
|
+
:query_params => query_params,
|
712
|
+
:form_params => form_params,
|
713
|
+
:body => post_body,
|
714
|
+
:auth_names => auth_names,
|
715
|
+
:return_type => 'StockMarketIndex')
|
716
|
+
if @api_client.config.debugging
|
717
|
+
@api_client.config.logger.debug "API called: IndexApi#get_stock_market_index_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
718
|
+
end
|
719
|
+
return data, status_code, headers
|
720
|
+
end
|
721
|
+
|
722
|
+
# Get Stock Market Index Data Point (Number)
|
723
|
+
# Returns a numeric value for the given `tag` for the Stock Market Index with the given `identifier`
|
724
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
725
|
+
# @param tag An Intrinio data tag ID or code-name
|
726
|
+
# @param [Hash] opts the optional parameters
|
727
|
+
# @return [Float]
|
728
|
+
def get_stock_market_index_data_point_number(identifier, tag, opts = {})
|
729
|
+
data, _status_code, _headers = get_stock_market_index_data_point_number_with_http_info(identifier, tag, opts)
|
730
|
+
return data
|
731
|
+
end
|
732
|
+
|
733
|
+
# Get Stock Market Index Data Point (Number)
|
734
|
+
# Returns a numeric value for the given `tag` for the Stock Market Index with the given `identifier`
|
735
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
736
|
+
# @param tag An Intrinio data tag ID or code-name
|
737
|
+
# @param [Hash] opts the optional parameters
|
738
|
+
# @return [Array<(Float, Fixnum, Hash)>] Float data, response status code and response headers
|
739
|
+
def get_stock_market_index_data_point_number_with_http_info(identifier, tag, opts = {})
|
740
|
+
if @api_client.config.debugging
|
741
|
+
@api_client.config.logger.debug "Calling API: IndexApi.get_stock_market_index_data_point_number ..."
|
742
|
+
end
|
743
|
+
# verify the required parameter 'identifier' is set
|
744
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
745
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_stock_market_index_data_point_number"
|
746
|
+
end
|
747
|
+
# verify the required parameter 'tag' is set
|
748
|
+
if @api_client.config.client_side_validation && tag.nil?
|
749
|
+
fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_stock_market_index_data_point_number"
|
750
|
+
end
|
751
|
+
# resource path
|
752
|
+
local_var_path = "/indices/stock_market/{identifier}/data_point/{tag}/number".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)
|
753
|
+
|
754
|
+
# query parameters
|
755
|
+
query_params = {}
|
756
|
+
|
757
|
+
# header parameters
|
758
|
+
header_params = {}
|
759
|
+
# HTTP header 'Accept' (if needed)
|
760
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])
|
761
|
+
|
762
|
+
# form parameters
|
763
|
+
form_params = {}
|
764
|
+
|
765
|
+
# http body (model)
|
766
|
+
post_body = nil
|
767
|
+
auth_names = ['ApiKeyAuth']
|
768
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
769
|
+
:header_params => header_params,
|
770
|
+
:query_params => query_params,
|
771
|
+
:form_params => form_params,
|
772
|
+
:body => post_body,
|
773
|
+
:auth_names => auth_names,
|
774
|
+
:return_type => 'Float')
|
775
|
+
if @api_client.config.debugging
|
776
|
+
@api_client.config.logger.debug "API called: IndexApi#get_stock_market_index_data_point_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
777
|
+
end
|
778
|
+
return data, status_code, headers
|
779
|
+
end
|
780
|
+
|
781
|
+
# Get Stock Market Index Data Point (Text)
|
782
|
+
# Returns a text value for the given `tag` for the Stock Market Index with the given `identifier`
|
783
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
784
|
+
# @param tag An Intrinio data tag ID or code-name
|
785
|
+
# @param [Hash] opts the optional parameters
|
786
|
+
# @return [String]
|
787
|
+
def get_stock_market_index_data_point_text(identifier, tag, opts = {})
|
788
|
+
data, _status_code, _headers = get_stock_market_index_data_point_text_with_http_info(identifier, tag, opts)
|
789
|
+
return data
|
790
|
+
end
|
791
|
+
|
792
|
+
# Get Stock Market Index Data Point (Text)
|
793
|
+
# Returns a text value for the given `tag` for the Stock Market Index with the given `identifier`
|
794
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
795
|
+
# @param tag An Intrinio data tag ID or code-name
|
796
|
+
# @param [Hash] opts the optional parameters
|
797
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
798
|
+
def get_stock_market_index_data_point_text_with_http_info(identifier, tag, opts = {})
|
799
|
+
if @api_client.config.debugging
|
800
|
+
@api_client.config.logger.debug "Calling API: IndexApi.get_stock_market_index_data_point_text ..."
|
801
|
+
end
|
802
|
+
# verify the required parameter 'identifier' is set
|
803
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
804
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_stock_market_index_data_point_text"
|
805
|
+
end
|
806
|
+
# verify the required parameter 'tag' is set
|
807
|
+
if @api_client.config.client_side_validation && tag.nil?
|
808
|
+
fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_stock_market_index_data_point_text"
|
809
|
+
end
|
810
|
+
# resource path
|
811
|
+
local_var_path = "/indices/stock_market/{identifier}/data_point/{tag}/text".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)
|
812
|
+
|
813
|
+
# query parameters
|
814
|
+
query_params = {}
|
815
|
+
|
816
|
+
# header parameters
|
817
|
+
header_params = {}
|
818
|
+
# HTTP header 'Accept' (if needed)
|
819
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])
|
820
|
+
|
821
|
+
# form parameters
|
822
|
+
form_params = {}
|
823
|
+
|
824
|
+
# http body (model)
|
825
|
+
post_body = nil
|
826
|
+
auth_names = ['ApiKeyAuth']
|
827
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
828
|
+
:header_params => header_params,
|
829
|
+
:query_params => query_params,
|
830
|
+
:form_params => form_params,
|
831
|
+
:body => post_body,
|
832
|
+
:auth_names => auth_names,
|
833
|
+
:return_type => 'String')
|
834
|
+
if @api_client.config.debugging
|
835
|
+
@api_client.config.logger.debug "API called: IndexApi#get_stock_market_index_data_point_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
836
|
+
end
|
837
|
+
return data, status_code, headers
|
838
|
+
end
|
839
|
+
|
840
|
+
# Get Stock Market Index Historical Data
|
841
|
+
# Returns historical values for the given `tag` and the Stock Market Index with the given `identifier`
|
842
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
843
|
+
# @param tag An Intrinio data tag ID or code-name
|
844
|
+
# @param [Hash] opts the optional parameters
|
845
|
+
# @option opts [String] :type Filter by type, when applicable
|
846
|
+
# @option opts [Date] :start_date Get historical data on or after this date
|
847
|
+
# @option opts [Date] :end_date Get historical data on or before this date
|
848
|
+
# @option opts [String] :sort_order Sort by date `asc` or `desc` (default to desc)
|
849
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
850
|
+
# @return [ApiResponseStockMarketIndexHistoricalData]
|
851
|
+
def get_stock_market_index_historical_data(identifier, tag, opts = {})
|
852
|
+
data, _status_code, _headers = get_stock_market_index_historical_data_with_http_info(identifier, tag, opts)
|
853
|
+
return data
|
854
|
+
end
|
855
|
+
|
856
|
+
# Get Stock Market Index Historical Data
|
857
|
+
# Returns historical values for the given `tag` and the Stock Market Index with the given `identifier`
|
858
|
+
# @param identifier An Index Identifier (symbol, Intrinio ID)
|
859
|
+
# @param tag An Intrinio data tag ID or code-name
|
860
|
+
# @param [Hash] opts the optional parameters
|
861
|
+
# @option opts [String] :type Filter by type, when applicable
|
862
|
+
# @option opts [Date] :start_date Get historical data on or after this date
|
863
|
+
# @option opts [Date] :end_date Get historical data on or before this date
|
864
|
+
# @option opts [String] :sort_order Sort by date `asc` or `desc`
|
865
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
866
|
+
# @return [Array<(ApiResponseStockMarketIndexHistoricalData, Fixnum, Hash)>] ApiResponseStockMarketIndexHistoricalData data, response status code and response headers
|
867
|
+
def get_stock_market_index_historical_data_with_http_info(identifier, tag, opts = {})
|
868
|
+
if @api_client.config.debugging
|
869
|
+
@api_client.config.logger.debug "Calling API: IndexApi.get_stock_market_index_historical_data ..."
|
870
|
+
end
|
871
|
+
# verify the required parameter 'identifier' is set
|
872
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
873
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_stock_market_index_historical_data"
|
874
|
+
end
|
875
|
+
# verify the required parameter 'tag' is set
|
876
|
+
if @api_client.config.client_side_validation && tag.nil?
|
877
|
+
fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_stock_market_index_historical_data"
|
878
|
+
end
|
879
|
+
if @api_client.config.client_side_validation && opts[:'sort_order'] && !['asc', 'desc'].include?(opts[:'sort_order'])
|
880
|
+
fail ArgumentError, 'invalid value for "sort_order", must be one of asc, desc'
|
881
|
+
end
|
882
|
+
# resource path
|
883
|
+
local_var_path = "/indices/stock_market/{identifier}/historical_data/{tag}".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)
|
884
|
+
|
885
|
+
# query parameters
|
886
|
+
query_params = {}
|
887
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
888
|
+
query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
889
|
+
query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
890
|
+
query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
|
891
|
+
query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
|
892
|
+
|
893
|
+
# header parameters
|
894
|
+
header_params = {}
|
895
|
+
# HTTP header 'Accept' (if needed)
|
896
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
897
|
+
|
898
|
+
# form parameters
|
899
|
+
form_params = {}
|
900
|
+
|
901
|
+
# http body (model)
|
902
|
+
post_body = nil
|
903
|
+
auth_names = ['ApiKeyAuth']
|
904
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
905
|
+
:header_params => header_params,
|
906
|
+
:query_params => query_params,
|
907
|
+
:form_params => form_params,
|
908
|
+
:body => post_body,
|
909
|
+
:auth_names => auth_names,
|
910
|
+
:return_type => 'ApiResponseStockMarketIndexHistoricalData')
|
911
|
+
if @api_client.config.debugging
|
912
|
+
@api_client.config.logger.debug "API called: IndexApi#get_stock_market_index_historical_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
913
|
+
end
|
914
|
+
return data, status_code, headers
|
915
|
+
end
|
916
|
+
|
917
|
+
# Search Economic Indices
|
918
|
+
# Searches for indices using the text in `query`
|
919
|
+
# @param query Search query
|
920
|
+
# @param [Hash] opts the optional parameters
|
921
|
+
# @return [ApiResponseEconomicIndices]
|
922
|
+
def search_economic_indices(query, opts = {})
|
923
|
+
data, _status_code, _headers = search_economic_indices_with_http_info(query, opts)
|
924
|
+
return data
|
925
|
+
end
|
926
|
+
|
927
|
+
# Search Economic Indices
|
928
|
+
# Searches for indices using the text in `query`
|
929
|
+
# @param query Search query
|
930
|
+
# @param [Hash] opts the optional parameters
|
931
|
+
# @return [Array<(ApiResponseEconomicIndices, Fixnum, Hash)>] ApiResponseEconomicIndices data, response status code and response headers
|
932
|
+
def search_economic_indices_with_http_info(query, opts = {})
|
933
|
+
if @api_client.config.debugging
|
934
|
+
@api_client.config.logger.debug "Calling API: IndexApi.search_economic_indices ..."
|
935
|
+
end
|
936
|
+
# verify the required parameter 'query' is set
|
937
|
+
if @api_client.config.client_side_validation && query.nil?
|
938
|
+
fail ArgumentError, "Missing the required parameter 'query' when calling IndexApi.search_economic_indices"
|
939
|
+
end
|
940
|
+
# resource path
|
941
|
+
local_var_path = "/indices/economic/search"
|
942
|
+
|
943
|
+
# query parameters
|
944
|
+
query_params = {}
|
945
|
+
query_params[:'query'] = query
|
946
|
+
|
947
|
+
# header parameters
|
948
|
+
header_params = {}
|
949
|
+
# HTTP header 'Accept' (if needed)
|
950
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
951
|
+
|
952
|
+
# form parameters
|
953
|
+
form_params = {}
|
954
|
+
|
955
|
+
# http body (model)
|
956
|
+
post_body = nil
|
957
|
+
auth_names = ['ApiKeyAuth']
|
958
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
959
|
+
:header_params => header_params,
|
960
|
+
:query_params => query_params,
|
961
|
+
:form_params => form_params,
|
962
|
+
:body => post_body,
|
963
|
+
:auth_names => auth_names,
|
964
|
+
:return_type => 'ApiResponseEconomicIndices')
|
965
|
+
if @api_client.config.debugging
|
966
|
+
@api_client.config.logger.debug "API called: IndexApi#search_economic_indices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
967
|
+
end
|
968
|
+
return data, status_code, headers
|
969
|
+
end
|
970
|
+
|
971
|
+
# Search SIC Indices
|
972
|
+
# Searches for indices using the text in `query`
|
973
|
+
# @param query Search query
|
974
|
+
# @param [Hash] opts the optional parameters
|
975
|
+
# @return [ApiResponseSICIndices]
|
976
|
+
def search_sic_indices(query, opts = {})
|
977
|
+
data, _status_code, _headers = search_sic_indices_with_http_info(query, opts)
|
978
|
+
return data
|
979
|
+
end
|
980
|
+
|
981
|
+
# Search SIC Indices
|
982
|
+
# Searches for indices using the text in `query`
|
983
|
+
# @param query Search query
|
984
|
+
# @param [Hash] opts the optional parameters
|
985
|
+
# @return [Array<(ApiResponseSICIndices, Fixnum, Hash)>] ApiResponseSICIndices data, response status code and response headers
|
986
|
+
def search_sic_indices_with_http_info(query, opts = {})
|
987
|
+
if @api_client.config.debugging
|
988
|
+
@api_client.config.logger.debug "Calling API: IndexApi.search_sic_indices ..."
|
989
|
+
end
|
990
|
+
# verify the required parameter 'query' is set
|
991
|
+
if @api_client.config.client_side_validation && query.nil?
|
992
|
+
fail ArgumentError, "Missing the required parameter 'query' when calling IndexApi.search_sic_indices"
|
993
|
+
end
|
994
|
+
# resource path
|
995
|
+
local_var_path = "/indices/sic/search"
|
996
|
+
|
997
|
+
# query parameters
|
998
|
+
query_params = {}
|
999
|
+
query_params[:'query'] = query
|
1000
|
+
|
1001
|
+
# header parameters
|
1002
|
+
header_params = {}
|
1003
|
+
# HTTP header 'Accept' (if needed)
|
1004
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1005
|
+
|
1006
|
+
# form parameters
|
1007
|
+
form_params = {}
|
1008
|
+
|
1009
|
+
# http body (model)
|
1010
|
+
post_body = nil
|
1011
|
+
auth_names = ['ApiKeyAuth']
|
1012
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1013
|
+
:header_params => header_params,
|
1014
|
+
:query_params => query_params,
|
1015
|
+
:form_params => form_params,
|
1016
|
+
:body => post_body,
|
1017
|
+
:auth_names => auth_names,
|
1018
|
+
:return_type => 'ApiResponseSICIndices')
|
1019
|
+
if @api_client.config.debugging
|
1020
|
+
@api_client.config.logger.debug "API called: IndexApi#search_sic_indices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1021
|
+
end
|
1022
|
+
return data, status_code, headers
|
1023
|
+
end
|
1024
|
+
|
1025
|
+
# Search Stock Market Indices
|
1026
|
+
# Searches for indices using the text in `query`
|
1027
|
+
# @param query Search query
|
1028
|
+
# @param [Hash] opts the optional parameters
|
1029
|
+
# @return [ApiResponseStockMarketIndices]
|
1030
|
+
def search_stock_markets_indices(query, opts = {})
|
1031
|
+
data, _status_code, _headers = search_stock_markets_indices_with_http_info(query, opts)
|
1032
|
+
return data
|
1033
|
+
end
|
1034
|
+
|
1035
|
+
# Search Stock Market Indices
|
1036
|
+
# Searches for indices using the text in `query`
|
1037
|
+
# @param query Search query
|
1038
|
+
# @param [Hash] opts the optional parameters
|
1039
|
+
# @return [Array<(ApiResponseStockMarketIndices, Fixnum, Hash)>] ApiResponseStockMarketIndices data, response status code and response headers
|
1040
|
+
def search_stock_markets_indices_with_http_info(query, opts = {})
|
1041
|
+
if @api_client.config.debugging
|
1042
|
+
@api_client.config.logger.debug "Calling API: IndexApi.search_stock_markets_indices ..."
|
1043
|
+
end
|
1044
|
+
# verify the required parameter 'query' is set
|
1045
|
+
if @api_client.config.client_side_validation && query.nil?
|
1046
|
+
fail ArgumentError, "Missing the required parameter 'query' when calling IndexApi.search_stock_markets_indices"
|
1047
|
+
end
|
1048
|
+
# resource path
|
1049
|
+
local_var_path = "/indices/stock_market/search"
|
1050
|
+
|
1051
|
+
# query parameters
|
1052
|
+
query_params = {}
|
1053
|
+
query_params[:'query'] = query
|
1054
|
+
|
1055
|
+
# header parameters
|
1056
|
+
header_params = {}
|
1057
|
+
# HTTP header 'Accept' (if needed)
|
1058
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1059
|
+
|
1060
|
+
# form parameters
|
1061
|
+
form_params = {}
|
1062
|
+
|
1063
|
+
# http body (model)
|
1064
|
+
post_body = nil
|
1065
|
+
auth_names = ['ApiKeyAuth']
|
1066
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1067
|
+
:header_params => header_params,
|
1068
|
+
:query_params => query_params,
|
1069
|
+
:form_params => form_params,
|
1070
|
+
:body => post_body,
|
1071
|
+
:auth_names => auth_names,
|
1072
|
+
:return_type => 'ApiResponseStockMarketIndices')
|
1073
|
+
if @api_client.config.debugging
|
1074
|
+
@api_client.config.logger.debug "API called: IndexApi#search_stock_markets_indices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1075
|
+
end
|
1076
|
+
return data, status_code, headers
|
1077
|
+
end
|
1078
|
+
end
|
1079
|
+
end
|