intrinio-sdk 1.1.1 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +18 -8
- data/docs/ApiResponseCompaniesSearch.md +8 -0
- data/docs/ApiResponseDataTagsSearch.md +8 -0
- data/docs/ApiResponseEconomicIndicesSearch.md +8 -0
- data/docs/ApiResponseMunicipalities.md +9 -0
- data/docs/ApiResponseMunicipalitiyFinancials.md +9 -0
- data/docs/ApiResponseSICIndicesSearch.md +8 -0
- data/docs/ApiResponseSecuritiesSearch.md +8 -0
- data/docs/ApiResponseSecurityIntradayPrices.md +11 -0
- data/docs/ApiResponseStockMarketIndicesSearch.md +8 -0
- data/docs/CompanyApi.md +44 -115
- data/docs/DataTagApi.md +15 -51
- data/docs/FilingApi.md +19 -97
- data/docs/FundamentalSummary.md +1 -1
- data/docs/HistoricalDataApi.md +2 -0
- data/docs/IndexApi.md +33 -9
- data/docs/IntradayStockPrice.md +15 -0
- data/docs/Municipality.md +26 -0
- data/docs/MunicipalityApi.md +158 -0
- data/docs/MunicipalityFinancial.md +49 -0
- data/docs/RealtimeStockPrice.md +1 -1
- data/docs/SecurityApi.md +71 -4
- data/docs/StockExchangeApi.md +17 -42
- data/intrinio-sdk.gemspec +1 -1
- data/lib/intrinio-sdk.rb +14 -1
- data/lib/intrinio-sdk/api/company_api.rb +97 -154
- data/lib/intrinio-sdk/api/data_point_api.rb +1 -1
- data/lib/intrinio-sdk/api/data_tag_api.rb +27 -63
- data/lib/intrinio-sdk/api/filing_api.rb +42 -121
- data/lib/intrinio-sdk/api/fundamentals_api.rb +1 -1
- data/lib/intrinio-sdk/api/historical_data_api.rb +8 -1
- data/lib/intrinio-sdk/api/index_api.rb +73 -10
- data/lib/intrinio-sdk/api/municipality_api.rb +221 -0
- data/lib/intrinio-sdk/api/security_api.rb +117 -4
- data/lib/intrinio-sdk/api/stock_exchange_api.rb +45 -57
- data/lib/intrinio-sdk/api_client.rb +1 -1
- data/lib/intrinio-sdk/api_error.rb +1 -1
- data/lib/intrinio-sdk/configuration.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_companies.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_companies_search.rb +190 -0
- data/lib/intrinio-sdk/models/api_response_company_filings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_company_fundamentals.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_company_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_company_news.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_company_securities.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_data_tags.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_data_tags_search.rb +190 -0
- data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_economic_indices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_economic_indices_search.rb +190 -0
- data/lib/intrinio-sdk/models/api_response_filing_notes.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_filing_notes_search.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_filings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_municipalities.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_municipalitiy_financials.rb +199 -0
- data/lib/intrinio-sdk/models/api_response_news.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_reported_financials.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_securities.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_securities_search.rb +190 -0
- data/lib/intrinio-sdk/models/api_response_security_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_intraday_prices.rb +254 -0
- data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_sic_indices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_sic_indices_search.rb +190 -0
- data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_market_indices_search.rb +190 -0
- data/lib/intrinio-sdk/models/company.rb +1 -1
- data/lib/intrinio-sdk/models/company_filing.rb +1 -1
- data/lib/intrinio-sdk/models/company_news.rb +1 -1
- data/lib/intrinio-sdk/models/company_news_summary.rb +1 -1
- data/lib/intrinio-sdk/models/company_summary.rb +1 -1
- data/lib/intrinio-sdk/models/data_tag.rb +1 -1
- data/lib/intrinio-sdk/models/data_tag_summary.rb +1 -1
- data/lib/intrinio-sdk/models/dividend_record.rb +1 -1
- data/lib/intrinio-sdk/models/earnings_record.rb +1 -1
- data/lib/intrinio-sdk/models/economic_index.rb +1 -1
- data/lib/intrinio-sdk/models/economic_index_summary.rb +1 -1
- data/lib/intrinio-sdk/models/filing.rb +1 -1
- data/lib/intrinio-sdk/models/filing_note.rb +1 -1
- data/lib/intrinio-sdk/models/filing_note_filing.rb +1 -1
- data/lib/intrinio-sdk/models/filing_note_summary.rb +1 -1
- data/lib/intrinio-sdk/models/filing_summary.rb +1 -1
- data/lib/intrinio-sdk/models/fundamental.rb +1 -1
- data/lib/intrinio-sdk/models/fundamental_summary.rb +2 -2
- data/lib/intrinio-sdk/models/historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/intraday_stock_price.rb +259 -0
- data/lib/intrinio-sdk/models/municipality.rb +369 -0
- data/lib/intrinio-sdk/models/municipality_financial.rb +599 -0
- data/lib/intrinio-sdk/models/realtime_stock_price.rb +2 -2
- data/lib/intrinio-sdk/models/realtime_stock_price_security.rb +1 -1
- data/lib/intrinio-sdk/models/reported_financial.rb +1 -1
- data/lib/intrinio-sdk/models/reported_tag.rb +1 -1
- data/lib/intrinio-sdk/models/security.rb +1 -1
- data/lib/intrinio-sdk/models/security_screen_clause.rb +1 -1
- data/lib/intrinio-sdk/models/security_screen_group.rb +1 -1
- data/lib/intrinio-sdk/models/security_screen_result.rb +1 -1
- data/lib/intrinio-sdk/models/security_screen_result_data.rb +1 -1
- data/lib/intrinio-sdk/models/security_summary.rb +1 -1
- data/lib/intrinio-sdk/models/sic_index.rb +1 -1
- data/lib/intrinio-sdk/models/standardized_financial.rb +1 -1
- data/lib/intrinio-sdk/models/stock_exchange.rb +1 -1
- data/lib/intrinio-sdk/models/stock_market_index.rb +1 -1
- data/lib/intrinio-sdk/models/stock_market_index_summary.rb +1 -1
- data/lib/intrinio-sdk/models/stock_price.rb +1 -1
- data/lib/intrinio-sdk/models/stock_price_adjustment.rb +1 -1
- data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +1 -1
- data/lib/intrinio-sdk/models/stock_price_summary.rb +1 -1
- data/lib/intrinio-sdk/version.rb +2 -2
- data/spec/api/company_api_spec.rb +37 -54
- data/spec/api/data_point_api_spec.rb +3 -3
- data/spec/api/data_tag_api_spec.rb +9 -19
- data/spec/api/filing_api_spec.rb +73 -12
- data/spec/api/fundamentals_api_spec.rb +6 -6
- data/spec/api/historical_data_api_spec.rb +3 -2
- data/spec/api/index_api_spec.rb +28 -19
- data/spec/api/municipality_api_spec.rb +84 -0
- data/spec/api/security_api_spec.rb +74 -13
- data/spec/api/stock_exchange_api_spec.rb +31 -23
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/api_response_companies_search_spec.rb +42 -0
- data/spec/models/api_response_companies_spec.rb +1 -1
- data/spec/models/api_response_company_filings_spec.rb +1 -1
- data/spec/models/api_response_company_fundamentals_spec.rb +1 -1
- data/spec/models/api_response_company_historical_data_spec.rb +1 -1
- data/spec/models/api_response_company_news_spec.rb +1 -1
- data/spec/models/api_response_company_securities_spec.rb +1 -1
- data/spec/models/api_response_data_tags_search_spec.rb +42 -0
- data/spec/models/api_response_data_tags_spec.rb +1 -1
- data/spec/models/api_response_economic_index_historical_data_spec.rb +1 -1
- data/spec/models/api_response_economic_indices_search_spec.rb +42 -0
- data/spec/models/api_response_economic_indices_spec.rb +1 -1
- data/spec/models/api_response_filings_spec.rb +1 -1
- data/spec/models/api_response_historical_data_spec.rb +1 -1
- data/spec/models/api_response_municipalities_spec.rb +48 -0
- data/spec/models/api_response_municipalitiy_financials_spec.rb +48 -0
- data/spec/models/api_response_news_spec.rb +1 -1
- data/spec/models/api_response_reported_financials_spec.rb +1 -1
- data/spec/models/api_response_securities_search_spec.rb +42 -0
- data/spec/models/api_response_securities_spec.rb +1 -1
- data/spec/models/api_response_security_historical_data_spec.rb +1 -1
- data/spec/models/api_response_security_intraday_prices_spec.rb +64 -0
- data/spec/models/api_response_security_stock_price_adjustments_spec.rb +1 -1
- data/spec/models/api_response_security_stock_prices_spec.rb +1 -1
- data/spec/models/api_response_sic_index_historical_data_spec.rb +1 -1
- data/spec/models/api_response_sic_indices_search_spec.rb +42 -0
- data/spec/models/api_response_sic_indices_spec.rb +1 -1
- data/spec/models/api_response_standardized_financials_spec.rb +1 -1
- data/spec/models/api_response_stock_exchange_securities_spec.rb +1 -1
- data/spec/models/api_response_stock_exchange_stock_price_adjustments_spec.rb +1 -1
- data/spec/models/api_response_stock_exchange_stock_prices_spec.rb +1 -1
- data/spec/models/api_response_stock_exchanges_spec.rb +1 -1
- data/spec/models/api_response_stock_market_index_historical_data_spec.rb +1 -1
- data/spec/models/api_response_stock_market_indices_search_spec.rb +42 -0
- data/spec/models/api_response_stock_market_indices_spec.rb +1 -1
- data/spec/models/company_filing_spec.rb +1 -1
- data/spec/models/company_news_spec.rb +1 -1
- data/spec/models/company_news_summary_spec.rb +1 -1
- data/spec/models/company_spec.rb +1 -1
- data/spec/models/company_summary_spec.rb +1 -1
- data/spec/models/data_tag_spec.rb +1 -1
- data/spec/models/data_tag_summary_spec.rb +1 -1
- data/spec/models/economic_index_spec.rb +1 -1
- data/spec/models/economic_index_summary_spec.rb +1 -1
- data/spec/models/filing_spec.rb +1 -1
- data/spec/models/filing_summary_spec.rb +1 -1
- data/spec/models/fundamental_spec.rb +1 -1
- data/spec/models/fundamental_summary_spec.rb +1 -1
- data/spec/models/historical_data_spec.rb +1 -1
- data/spec/models/intraday_stock_price_spec.rb +84 -0
- data/spec/models/municipality_financial_spec.rb +288 -0
- data/spec/models/municipality_spec.rb +150 -0
- data/spec/models/reported_financial_spec.rb +1 -1
- data/spec/models/reported_tag_spec.rb +1 -1
- data/spec/models/security_screen_clause_spec.rb +1 -1
- data/spec/models/security_screen_group_spec.rb +1 -1
- data/spec/models/security_screen_result_data_spec.rb +1 -1
- data/spec/models/security_screen_result_spec.rb +1 -1
- data/spec/models/security_spec.rb +1 -1
- data/spec/models/security_summary_spec.rb +1 -1
- data/spec/models/sic_index_spec.rb +1 -1
- data/spec/models/standardized_financial_spec.rb +1 -1
- data/spec/models/stock_exchange_spec.rb +1 -1
- data/spec/models/stock_market_index_spec.rb +1 -1
- data/spec/models/stock_market_index_summary_spec.rb +1 -1
- data/spec/models/stock_price_adjustment_spec.rb +7 -1
- data/spec/models/stock_price_adjustment_summary_spec.rb +1 -7
- data/spec/models/stock_price_spec.rb +1 -1
- data/spec/models/stock_price_summary_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +54 -3
- data/intrinio-sdk-1.1.0.gem +0 -0
@@ -0,0 +1,15 @@
|
|
1
|
+
# Intrinio::IntradayStockPrice
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**time** | **DateTime** | The timestamp that the `last_price` represents. | [optional]
|
7
|
+
**last_price** | **Float** | The price of the last trade. | [optional]
|
8
|
+
**ask_price** | **Float** | The price of the top ask order. | [optional]
|
9
|
+
**ask_size** | **Float** | The size of the top ask order. | [optional]
|
10
|
+
**bid_price** | **Float** | The price of the top bid order. | [optional]
|
11
|
+
**bid_size** | **Float** | The size of the top bid order. | [optional]
|
12
|
+
**volume** | **Float** | The number of shares exchanged during the trading day on the exchange. | [optional]
|
13
|
+
**source** | **String** | The source of the data. | [optional]
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# Intrinio::Municipality
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The Intrinio ID for Municipality | [optional]
|
7
|
+
**census_id** | **Float** | The ID for the census | [optional]
|
8
|
+
**government_name** | **String** | The government name of the Municipality | [optional]
|
9
|
+
**government_type** | **String** | The type of government of the Municipality | [optional]
|
10
|
+
**primary_contact_type** | **String** | The primary contact type of the Municipality | [optional]
|
11
|
+
**address1** | **String** | The first line of the address | [optional]
|
12
|
+
**address2** | **String** | The second line of the address (i.e. suite number) | [optional]
|
13
|
+
**city** | **String** | The city in which the Municipality is located in | [optional]
|
14
|
+
**state** | **String** | The state in which the Municipality is located in | [optional]
|
15
|
+
**zip** | **String** | The zip code in which the Municipality is located in | [optional]
|
16
|
+
**web_site** | **String** | The web site of the Municipality | [optional]
|
17
|
+
**population** | **Float** | The population of the Municipality | [optional]
|
18
|
+
**population_as_of_year** | **Float** | The year from which the population of the Municipality was measured | [optional]
|
19
|
+
**enrollment** | **Float** | The enrollment of the Municipality | [optional]
|
20
|
+
**enrollment_as_of_year** | **Float** | The year from which the enrollment of the Municipality was measured | [optional]
|
21
|
+
**area_name** | **String** | The name of the area of the Municipality | [optional]
|
22
|
+
**area_type** | **String** | The type of area of the Municipality | [optional]
|
23
|
+
**latitude** | **Float** | The latitude of the location of the Municipality | [optional]
|
24
|
+
**longitude** | **Float** | The longitude of the location of the Municipality | [optional]
|
25
|
+
|
26
|
+
|
@@ -0,0 +1,158 @@
|
|
1
|
+
# Intrinio::MunicipalityApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api-v2.intrinio.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**get_all_municipalities**](MunicipalityApi.md#get_all_municipalities) | **GET** /municipalities | All Municipalities
|
8
|
+
[**get_municipality_by_id**](MunicipalityApi.md#get_municipality_by_id) | **GET** /municipalities/{id} | Municipality by ID
|
9
|
+
[**get_municipality_financials**](MunicipalityApi.md#get_municipality_financials) | **GET** /municipalities/{id}/financials | Financials for a Municipality
|
10
|
+
|
11
|
+
|
12
|
+
# **get_all_municipalities**
|
13
|
+
> ApiResponseMunicipalities get_all_municipalities(opts)
|
14
|
+
|
15
|
+
All Municipalities
|
16
|
+
|
17
|
+
### Example
|
18
|
+
```ruby
|
19
|
+
# Load the gem
|
20
|
+
require 'intrinio-sdk'
|
21
|
+
|
22
|
+
# Setup authorization
|
23
|
+
Intrinio.configure do |config|
|
24
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
25
|
+
end
|
26
|
+
|
27
|
+
municipality_api = Intrinio::MunicipalityApi.new
|
28
|
+
|
29
|
+
opts = {
|
30
|
+
has_financials: true, # BOOLEAN | Return municipalities with financials
|
31
|
+
government_name: "government_name_example", # String | Return municipalities with a government name matching the given query
|
32
|
+
government_type: "government_type_example", # String | Return municipalities with the given government type
|
33
|
+
area_name: "area_name_example", # String | Return municipalities with an area name matching the given query
|
34
|
+
area_type: "area_type_example", # String | Return municipalities with the given area type
|
35
|
+
city: "city_example", # String | Return municipalities in the given city
|
36
|
+
state: "state_example", # String | Return municipalities in the given state
|
37
|
+
zipcode: 8.14, # Float | Return municipalities in the given zipcode
|
38
|
+
population_greater_than: 8.14, # Float | Return municipalities with a population greater than the given number
|
39
|
+
population_less_than: 8.14, # Float | Return municipalities with a population less than the given number
|
40
|
+
enrollment_greater_than: 8.14, # Float | Return municipalities with an enrollment greater than the given number
|
41
|
+
enrollment_less_than: 8.14, # Float | Return municipalities with an enrollment less than the given number
|
42
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
43
|
+
}
|
44
|
+
|
45
|
+
begin
|
46
|
+
result = municipality_api.get_all_municipalities(opts)
|
47
|
+
p result
|
48
|
+
rescue Intrinio::ApiError => e
|
49
|
+
puts "Exception when calling MunicipalityApi->get_all_municipalities: #{e}"
|
50
|
+
end
|
51
|
+
```
|
52
|
+
|
53
|
+
### Parameters
|
54
|
+
|
55
|
+
Name | Type | Description | Notes
|
56
|
+
------------- | ------------- | ------------- | -------------
|
57
|
+
**has_financials** | **BOOLEAN**| Return municipalities with financials | [optional]
|
58
|
+
**government_name** | **String**| Return municipalities with a government name matching the given query | [optional]
|
59
|
+
**government_type** | **String**| Return municipalities with the given government type | [optional]
|
60
|
+
**area_name** | **String**| Return municipalities with an area name matching the given query | [optional]
|
61
|
+
**area_type** | **String**| Return municipalities with the given area type | [optional]
|
62
|
+
**city** | **String**| Return municipalities in the given city | [optional]
|
63
|
+
**state** | **String**| Return municipalities in the given state | [optional]
|
64
|
+
**zipcode** | **Float**| Return municipalities in the given zipcode | [optional]
|
65
|
+
**population_greater_than** | **Float**| Return municipalities with a population greater than the given number | [optional]
|
66
|
+
**population_less_than** | **Float**| Return municipalities with a population less than the given number | [optional]
|
67
|
+
**enrollment_greater_than** | **Float**| Return municipalities with an enrollment greater than the given number | [optional]
|
68
|
+
**enrollment_less_than** | **Float**| Return municipalities with an enrollment less than the given number | [optional]
|
69
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
70
|
+
|
71
|
+
### Return type
|
72
|
+
|
73
|
+
[**ApiResponseMunicipalities**](ApiResponseMunicipalities.md)
|
74
|
+
|
75
|
+
# **get_municipality_by_id**
|
76
|
+
> Municipality get_municipality_by_id(id)
|
77
|
+
|
78
|
+
Municipality by ID
|
79
|
+
|
80
|
+
Returns the Municipality with the given ID
|
81
|
+
|
82
|
+
### Example
|
83
|
+
```ruby
|
84
|
+
# Load the gem
|
85
|
+
require 'intrinio-sdk'
|
86
|
+
|
87
|
+
# Setup authorization
|
88
|
+
Intrinio.configure do |config|
|
89
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
90
|
+
end
|
91
|
+
|
92
|
+
municipality_api = Intrinio::MunicipalityApi.new
|
93
|
+
|
94
|
+
id = "mun_Xn7x4z" # String | An Intrinio ID of a Municipality
|
95
|
+
|
96
|
+
|
97
|
+
begin
|
98
|
+
result = municipality_api.get_municipality_by_id(id)
|
99
|
+
p result
|
100
|
+
rescue Intrinio::ApiError => e
|
101
|
+
puts "Exception when calling MunicipalityApi->get_municipality_by_id: #{e}"
|
102
|
+
end
|
103
|
+
```
|
104
|
+
|
105
|
+
### Parameters
|
106
|
+
|
107
|
+
Name | Type | Description | Notes
|
108
|
+
------------- | ------------- | ------------- | -------------
|
109
|
+
**id** | **String**| An Intrinio ID of a Municipality |
|
110
|
+
|
111
|
+
### Return type
|
112
|
+
|
113
|
+
[**Municipality**](Municipality.md)
|
114
|
+
|
115
|
+
# **get_municipality_financials**
|
116
|
+
> ApiResponseMunicipalitiyFinancials get_municipality_financials(id, opts)
|
117
|
+
|
118
|
+
Financials for a Municipality
|
119
|
+
|
120
|
+
Returns financial statement data for the Municipality with the given ID
|
121
|
+
|
122
|
+
### Example
|
123
|
+
```ruby
|
124
|
+
# Load the gem
|
125
|
+
require 'intrinio-sdk'
|
126
|
+
|
127
|
+
# Setup authorization
|
128
|
+
Intrinio.configure do |config|
|
129
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
130
|
+
end
|
131
|
+
|
132
|
+
municipality_api = Intrinio::MunicipalityApi.new
|
133
|
+
|
134
|
+
id = "mun_Xn7x4z" # String | An Intrinio ID of a Municipality
|
135
|
+
|
136
|
+
opts = {
|
137
|
+
fiscal_year: 8.14 # Float | Return financials for the given fiscal year
|
138
|
+
}
|
139
|
+
|
140
|
+
begin
|
141
|
+
result = municipality_api.get_municipality_financials(id, opts)
|
142
|
+
p result
|
143
|
+
rescue Intrinio::ApiError => e
|
144
|
+
puts "Exception when calling MunicipalityApi->get_municipality_financials: #{e}"
|
145
|
+
end
|
146
|
+
```
|
147
|
+
|
148
|
+
### Parameters
|
149
|
+
|
150
|
+
Name | Type | Description | Notes
|
151
|
+
------------- | ------------- | ------------- | -------------
|
152
|
+
**id** | **String**| An Intrinio ID of a Municipality |
|
153
|
+
**fiscal_year** | **Float**| Return financials for the given fiscal year | [optional]
|
154
|
+
|
155
|
+
### Return type
|
156
|
+
|
157
|
+
[**ApiResponseMunicipalitiyFinancials**](ApiResponseMunicipalitiyFinancials.md)
|
158
|
+
|
@@ -0,0 +1,49 @@
|
|
1
|
+
# Intrinio::MunicipalityFinancial
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**fiscal_year** | **Float** | The fiscal year from which the financial data came from | [optional]
|
7
|
+
**current_assets** | **Float** | Government-wide holdings that can be liquidated on short notice | [optional]
|
8
|
+
**non_current_assets** | **Float** | Government-wide holdings not intended for near-term liquidation | [optional]
|
9
|
+
**deferred_outflows** | **Float** | Government-wide consumptions of net position applicable to a future year | [optional]
|
10
|
+
**total_assets** | **Float** | Government-wide holdings | [optional]
|
11
|
+
**total_assets_plus_deferred_outflows** | **Float** | Sum of government-wide total assets and deferred outflows of resources | [optional]
|
12
|
+
**current_liabilities** | **Float** | Government-wide liabilities that typically become due within one year | [optional]
|
13
|
+
**current_portion_of_long_term_debt** | **Float** | Government-wide portion of long term obligations, such as bond and loan debt coming due within the next year | [optional]
|
14
|
+
**net_pension_liability** | **Float** | Government-wide liability for employee pensions net of the fiduciary net position of pension plans in which the government has an interest | [optional]
|
15
|
+
**net_opeb_liability** | **Float** | Government-wide liability for other postemployment benefits (OPEB). These are benefits (such as death benefits, life insurance, disability, and long-term care) that are paid in the period after employment and that are provided separately from a pension plan, as well as healthcare benefits paid in the period after employment, regardless of the manner in which they are provided. OPEB does not include termination benefits or termination payments for sick leave. Liability is reported net of any OPEB assets the government may control. | [optional]
|
16
|
+
**all_other_long_term_debt** | **Float** | Government-wide liabilities not elsewhere classified | [optional]
|
17
|
+
**total_liabilities** | **Float** | The sum of the Municipality's all other long term debt, net open liability, net pension liability, and current portion of long term debt | [optional]
|
18
|
+
**deferred_inflows** | **Float** | Government-wide acquisitions of net position applicable to a future year | [optional]
|
19
|
+
**total_liabilities_plus_deferred_inflows** | **Float** | Sum of government-wide liabilities and deferred inflows of resources | [optional]
|
20
|
+
**total_net_position** | **Float** | Government-wide assets and deferred outflows less government-wide liabilities and deferred inflows | [optional]
|
21
|
+
**total_unrestricted_net_position** | **Float** | Net amount of government-wide assets, deferred outflows of resources, liabilities, and deferred inflows of resources that are not included in the determination of net investment in capital assets or the restricted components of net position | [optional]
|
22
|
+
**total_expenses** | **Float** | Decreases in net position that occurred during the past year, government-wide | [optional]
|
23
|
+
**charges_for_services** | **Float** | Charges for services is the term used for a broad category of program revenues that arise from charges to customers, applicants, or others who purchase, use, or directly benefit from the goods, services, or privileges provided, or are otherwise directly affected by the services. Revenues in this category include fees charged for specific services, such as water use or garbage collection; licenses and permits, such as dog licenses, liquor licenses, and building permits; operating special assessments, such as for street cleaning or special street lighting; and any other amounts charged to service recipients. Fines and forfeitures are also included in this category because they result from direct charges to those who are otherwise directly affected by a program or service, even though they receive no benefit. Payments from other governments for goods or services should be reported in this category. | [optional]
|
24
|
+
**operating_grants_and_contributions** | **Float** | Program-specific grants and contributions - includes revenues arising from mandatory and voluntary nonexchange transactions with other governments, organizations, or individuals that are restricted for use in a particular program. Some grants and contributions consist of capital assets or resources that are restricted for capital purposes—to purchase, construct, or renovate capital assets associated with a specific program. These should be reported separately from grants and contributions that may be used either for operating expenses or for capital expenditures of the program at the discretion of the reporting government. These categories of program revenue are specifically attributable to a program and reduce the net expense of that program to the reporting government. For example, a state may provide an operating grant to a county sheriff's department for a drug-awareness-and-enforcement program. | [optional]
|
25
|
+
**capital_grants_and_contributions** | **Float** | Program-specific grants and contributions - includes revenues arising from mandatory and voluntary nonexchange transactions with other governments, organizations, or individuals that are restricted for use in a particular program. Some grants and contributions consist of capital assets or resources that are restricted for capital purposes—to purchase, construct, or renovate capital assets associated with a specific program. These should be reported separately from grants and contributions that may be used either for operating expenses or for capital expenditures of the program at the discretion of the reporting government. These categories of program revenue are specifically attributable to a program and reduce the net expense of that program to the reporting government. For example, a state may provide a capital grant to finance construction of a new jail. | [optional]
|
26
|
+
**general_revenues** | **Float** | All revenues are general revenues unless they are required to be reported as program revenues. All taxes, even those that are levied for a specific purpose, are general revenues and should be reported by type of tax—for example, sales tax, property tax, franchise tax, income tax. All other nontax revenues (including interest, grants, and contributions) that do not meet the criteria to be reported as program revenues should also be reported as general revenues. General revenues should be reported after total net expense of the government's functions. | [optional]
|
27
|
+
**other_revenues** | **Float** | Government-wide revenues not elsewhere classified | [optional]
|
28
|
+
**total_revenues** | **Float** | Increases in net position that occurred during the past year, government-wide | [optional]
|
29
|
+
**change_in_net_assets** | **Float** | Difference between the government's net position at the end of the fiscal year and the government's net position at the beginning of the fiscal year | [optional]
|
30
|
+
**non_spendable_general_fund_balance** | **Float** | The portion of general fund balance classified as nonspendable. The nonspendable fund balance classification includes amounts that cannot be spent because they are either (a) not in spendable form or (b) legally or contractually required to be maintained intact. The “not in spendable form” criterion includes items that are not expected to be converted to cash, for example, inventories and prepaid amounts. It also includes the long-term amount of loans and notes receivable, as well as property acquired for resale. However, if the use of the proceeds from the collection of those receivables or from the sale of those properties is restricted, committed, or assigned, then they should be included in the appropriate fund balance classification (restricted, committed, or assigned), rather than nonspendable fund balance. The corpus (or principal) of a permanent fund is an example of an amount that is legally or contractually required to be maintained intact. | [optional]
|
31
|
+
**restricted_general_fund_balance** | **Float** | The portion of general fund balance classified as restricted. Fund balance should be reported as restricted when constraints placed on the use of resources are either (a) Externally imposed by creditors (such as through debt covenants), grantors, contributors, or laws or regulations of other governments or (b) Imposed by law through constitutional provisions or enabling legislation. | [optional]
|
32
|
+
**committed_general_fund_balance** | **Float** | The portion of general fund balance classified as committed. Amounts that can only be used for specific purposes pursuant to constraints imposed by formal action of the government’s highest level of decision-making authority should be reported as committed fund balance. Those committed amounts cannot be used for any other purpose unless the government removes or changes the specified use by taking the same type of action (for example, legislation, resolution, ordinance) it employed to previously commit those amounts. The authorization specifying the purposes for which amounts can be used should have the consent of both the legislative and executive branches of the government, if applicable. Committed fund balance also should incorporate contractual obligations to the extent that existing resources in the fund have been specifically committed for use in satisfying those contractual requirements. | [optional]
|
33
|
+
**unassigned_general_fund_balance** | **Float** | The portion of general fund balance classified as unassigned. Unassigned fund balance is the residual classification for the general fund. This classification represents fund balance that has not been assigned to other funds and that has not been restricted, committed, or assigned to specific purposes within the general fund. The general fund should be the only fund that reports a positive unassigned fund balance amount. In other governmental funds, if expenditures incurred for specific purposes exceeded the amounts restricted, committed, or assigned to those purposes, it may be necessary to report a negative unassigned fund balance. | [optional]
|
34
|
+
**assigned_general_fund_balance** | **Float** | The portion of general fund balance classified as assigned. Amounts that are constrained by the government’s intent to be used for specific purposes, but are neither restricted nor committed, should be reported as assigned fund balance, except for stabilization arrangements.. Intent should be expressed by (a) the governing body itself or (b) a body (a budget or finance committee, for example) or official to which the governing body has delegated the authority to assign amounts to be used for specific purposes. | [optional]
|
35
|
+
**total_general_fund_balance** | **Float** | General fund balance in all classifications. Fund balance is the difference between governmental fund assets and deferred outflows of resources, and liabilities and deferred inflows of resources. It is sometimes referred to as fund equity. The general fund is used to account for and report all financial resources not accounted for and reported in another governmental fund. | [optional]
|
36
|
+
**non_spendable_governmental_fund_balance** | **Float** | For all governmental funds, the aggregate of fund balances that are classified as nonspendable. The nonspendable fund balance classification includes amounts that cannot be spent because they are either (a) not in spendable form or (b) legally or contractually required to be maintained intact. The “not in spendable form” criterion includes items that are not expected to be converted to cash, for example, inventories and prepaid amounts. It also includes the long-term amount of loans and notes receivable, as well as property acquired for resale. However, if the use of the proceeds from the collection of those receivables or from the sale of those properties is restricted, committed, or assigned, then they should be included in the appropriate fund balance classification (restricted, committed, or assigned), rather than nonspendable fund balance. | [optional]
|
37
|
+
**restricted_governmental_fund_balance** | **Float** | For all governmental funds, the aggregate of fund balances that are classified as restricted. Fund balance should be reported as restricted when constraints placed on the use of resources are either (a) Externally imposed by creditors (such as through debt covenants), grantors, contributors, or laws or regulations of other governments; or (b) Imposed by law through constitutional provisions or enabling legislation. | [optional]
|
38
|
+
**committed_governmental_fund_balance** | **Float** | For all governmental funds, the aggregate of fund balances that are classified as committed. Amounts that can only be used for specific purposes pursuant to constraints imposed by formal action of the government’s highest level of decision-making authority should be reported as committed fund balance. Those committed amounts cannot be used for any other purpose unless the government removes or changes the specified use by taking the same type of action (for example, legislation, resolution, ordinance) it employed to previously commit those amounts. The authorization specifying the purposes for which amounts can be used should have the consent of both the legislative and executive branches of the government, if applicable. Committed fund balance also should incorporate contractual obligations to the extent that existing resources in the fund have been specifically committed for use in satisfying those contractual requirements. | [optional]
|
39
|
+
**unassigned_governmental_fund_balance** | **Float** | For all governmental funds, the aggregate of fund balances that are classified as unassigned. Unassigned fund balance is the residual classification for the general fund. This classification represents fund balance that has not been assigned to other funds and that has not been restricted, committed, or assigned to specific purposes within the general fund. The general fund should be the only fund that reports a positive unassigned fund balance amount. In other governmental funds, if expenditures incurred for specific purposes exceeded the amounts restricted, committed, or assigned to those purposes, it may be necessary to report a negative unassigned fund balance. | [optional]
|
40
|
+
**assigned_governmental_fund_balance** | **Float** | For all governmental funds, the aggregate of fund balances that are classified as assigned. Amounts that are constrained by the government’s intent to be used for specific purposes, but are neither restricted nor committed, should be reported as assigned fund balance, except for stabilization arrangements.. Intent should be expressed by (a) the governing body itself or (b) a body (a budget or finance committee, for example) or official to which the governing body has delegated the authority to assign amounts to be used for specific purposes. | [optional]
|
41
|
+
**total_governmental_fund_balance** | **Float** | For all governmental funds, the aggregate of all fund balances in any classification. Fund balance is the difference between governmental fund assets and deferred outflows of resources, and liabilities and deferred inflows of resources. It is sometimes referred to as fund equity. Governmental funds are used to account for general government activities that are financed primarily through taxes, intergovernmental revenues, and other nonexchange revenues. | [optional]
|
42
|
+
**general_fund_revenues** | **Float** | Increases in financial resources attributable to the general fund. The general fund is used to account for and report all financial resources not accounted for and reported in another governmental fund. | [optional]
|
43
|
+
**general_fund_expenditures** | **Float** | Decreases in financial resources attributable to the general fund. The general fund is used to account for and report all financial resources not accounted for and reported in another governmental fund. | [optional]
|
44
|
+
**general_fund_revenues_over_under_expenditure** | **Float** | Difference between general fund revenues and expenditures. If positive, this amount is called a surplus. If negative, it represents a deficit. The general fund is used to account for and report all financial resources not accounted for and reported in another governmental fund. | [optional]
|
45
|
+
**governmental_fund_revenues** | **Float** | Increases in financial resources attributable to any governmental fund. Governmental funds are used to account for general government activities that are financed primarily through taxes, intergovernmental revenues, and other nonexchange revenues. | [optional]
|
46
|
+
**governmental_fund_expenditures** | **Float** | Decreases in financial resources attributable to any governmental fund. Governmental funds are used to account for general government activities that are financed primarily through taxes, intergovernmental revenues, and other nonexchange revenues. | [optional]
|
47
|
+
**governmental_fund_revenues_over_under_expenditure** | **Float** | Difference between revenues and expenditures attributable to all governmental funds. If positive, this amount is called a surplus. If negative, it represents a deficit. Governmental funds are used to account for general government activities that are financed primarily through taxes, intergovernmental revenues, and other nonexchange revenues. | [optional]
|
48
|
+
|
49
|
+
|
data/docs/RealtimeStockPrice.md
CHANGED
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
|
|
15
15
|
**exchange_volume** | **Float** | The number of shares exchanged during the trading day on the exchange. | [optional]
|
16
16
|
**market_volume** | **Float** | The number of shares exchanged during the trading day for the whole market. | [optional]
|
17
17
|
**updated_on** | **DateTime** | The date and time when the data was last updated. | [optional]
|
18
|
-
**source** | **String** |
|
18
|
+
**source** | **String** | The source of the data. | [optional]
|
19
19
|
**security** | [**RealtimeStockPriceSecurity**](RealtimeStockPriceSecurity.md) | | [optional]
|
20
20
|
|
21
21
|
|
data/docs/SecurityApi.md
CHANGED
@@ -9,6 +9,7 @@ Method | HTTP request | Description
|
|
9
9
|
[**get_security_data_point_number**](SecurityApi.md#get_security_data_point_number) | **GET** /securities/{identifier}/data_point/{tag}/number | Data Point (Number) for Security
|
10
10
|
[**get_security_data_point_text**](SecurityApi.md#get_security_data_point_text) | **GET** /securities/{identifier}/data_point/{tag}/text | Data Point (Text) for Security
|
11
11
|
[**get_security_historical_data**](SecurityApi.md#get_security_historical_data) | **GET** /securities/{identifier}/historical_data/{tag} | Historical Data for Security
|
12
|
+
[**get_security_intraday_prices**](SecurityApi.md#get_security_intraday_prices) | **GET** /securities/{identifier}/prices/intraday | Intraday Stock Prices for Security
|
12
13
|
[**get_security_latest_dividend_record**](SecurityApi.md#get_security_latest_dividend_record) | **GET** /securities/{identifier}/dividends/latest | Lastest Dividend Record for Security
|
13
14
|
[**get_security_latest_earnings_record**](SecurityApi.md#get_security_latest_earnings_record) | **GET** /securities/{identifier}/earnings/latest | Lastest Earnings Record for Security
|
14
15
|
[**get_security_realtime_price**](SecurityApi.md#get_security_realtime_price) | **GET** /securities/{identifier}/prices/realtime | Realtime Stock Price for Security
|
@@ -36,6 +37,7 @@ end
|
|
36
37
|
security_api = Intrinio::SecurityApi.new
|
37
38
|
|
38
39
|
opts = {
|
40
|
+
page_size: 100, # Float | The number of results to return
|
39
41
|
next_page: nil # String | Gets the next page of data from a previous API call
|
40
42
|
}
|
41
43
|
|
@@ -51,6 +53,7 @@ end
|
|
51
53
|
|
52
54
|
Name | Type | Description | Notes
|
53
55
|
------------- | ------------- | ------------- | -------------
|
56
|
+
**page_size** | **Float**| The number of results to return | [optional] [default to 100]
|
54
57
|
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
55
58
|
|
56
59
|
### Return type
|
@@ -212,6 +215,7 @@ opts = {
|
|
212
215
|
start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
|
213
216
|
end_date: Date.parse("2019-01-01"), # Date | Get historical date on or before this date
|
214
217
|
sort_order: "desc", # String | Sort by date `asc` or `desc`
|
218
|
+
page_size: 100, # Float | The number of results to return
|
215
219
|
next_page: nil # String | Gets the next page of data from a previous API call
|
216
220
|
}
|
217
221
|
|
@@ -234,12 +238,65 @@ Name | Type | Description | Notes
|
|
234
238
|
**start_date** | **Date**| Get historical data on or after this date | [optional]
|
235
239
|
**end_date** | **Date**| Get historical date on or before this date | [optional]
|
236
240
|
**sort_order** | **String**| Sort by date `asc` or `desc` | [optional] [default to desc]
|
241
|
+
**page_size** | **Float**| The number of results to return | [optional] [default to 100]
|
237
242
|
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
238
243
|
|
239
244
|
### Return type
|
240
245
|
|
241
246
|
[**ApiResponseSecurityHistoricalData**](ApiResponseSecurityHistoricalData.md)
|
242
247
|
|
248
|
+
# **get_security_intraday_prices**
|
249
|
+
> ApiResponseSecurityIntradayPrices get_security_intraday_prices(identifier, opts)
|
250
|
+
|
251
|
+
Intraday Stock Prices for Security
|
252
|
+
|
253
|
+
Return intraday stock prices for the Security with the given `identifier`
|
254
|
+
|
255
|
+
### Example
|
256
|
+
```ruby
|
257
|
+
# Load the gem
|
258
|
+
require 'intrinio-sdk'
|
259
|
+
|
260
|
+
# Setup authorization
|
261
|
+
Intrinio.configure do |config|
|
262
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
263
|
+
end
|
264
|
+
|
265
|
+
security_api = Intrinio::SecurityApi.new
|
266
|
+
|
267
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
268
|
+
|
269
|
+
opts = {
|
270
|
+
source: nil, # String | Return intraday prices from the specified data source
|
271
|
+
start_date: Date.parse("2018-01-01"), # Date | Return intraday prices starting at the specified date
|
272
|
+
start_time: "4200", # String | Return intraday prices starting at the specified time on the `start_date` (timezone is UTC)
|
273
|
+
end_date: Date.parse("2018-01-01"), # Date | Return intraday prices stopping at the specified date
|
274
|
+
end_time: "4200" # String | Return intraday prices stopping at the specified time on the `end_date` (timezone is UTC)
|
275
|
+
}
|
276
|
+
|
277
|
+
begin
|
278
|
+
result = security_api.get_security_intraday_prices(identifier, opts)
|
279
|
+
p result
|
280
|
+
rescue Intrinio::ApiError => e
|
281
|
+
puts "Exception when calling SecurityApi->get_security_intraday_prices: #{e}"
|
282
|
+
end
|
283
|
+
```
|
284
|
+
|
285
|
+
### Parameters
|
286
|
+
|
287
|
+
Name | Type | Description | Notes
|
288
|
+
------------- | ------------- | ------------- | -------------
|
289
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
290
|
+
**source** | **String**| Return intraday prices from the specified data source | [optional]
|
291
|
+
**start_date** | **Date**| Return intraday prices starting at the specified date | [optional]
|
292
|
+
**start_time** | **String**| Return intraday prices starting at the specified time on the `start_date` (timezone is UTC) | [optional]
|
293
|
+
**end_date** | **Date**| Return intraday prices stopping at the specified date | [optional]
|
294
|
+
**end_time** | **String**| Return intraday prices stopping at the specified time on the `end_date` (timezone is UTC) | [optional]
|
295
|
+
|
296
|
+
### Return type
|
297
|
+
|
298
|
+
[**ApiResponseSecurityIntradayPrices**](ApiResponseSecurityIntradayPrices.md)
|
299
|
+
|
243
300
|
# **get_security_latest_dividend_record**
|
244
301
|
> DividendRecord get_security_latest_dividend_record(identifier)
|
245
302
|
|
@@ -388,6 +445,7 @@ identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP,
|
|
388
445
|
opts = {
|
389
446
|
start_date: Date.parse("2018-01-01"), # Date | Return price adjustments on or after the date
|
390
447
|
end_date: Date.parse("2019-01-01"), # Date | Return price adjustments on or before the date
|
448
|
+
page_size: 100, # Float | The number of results to return
|
391
449
|
next_page: nil # String | Gets the next page of data from a previous API call
|
392
450
|
}
|
393
451
|
|
@@ -406,6 +464,7 @@ Name | Type | Description | Notes
|
|
406
464
|
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
407
465
|
**start_date** | **Date**| Return price adjustments on or after the date | [optional]
|
408
466
|
**end_date** | **Date**| Return price adjustments on or before the date | [optional]
|
467
|
+
**page_size** | **Float**| The number of results to return | [optional] [default to 100]
|
409
468
|
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
410
469
|
|
411
470
|
### Return type
|
@@ -437,6 +496,7 @@ opts = {
|
|
437
496
|
start_date: Date.parse("2018-01-01"), # Date | Return prices on or after the date
|
438
497
|
end_date: Date.parse("2019-01-01"), # Date | Return prices on or before the date
|
439
498
|
frequency: "daily", # String | Return stock prices in the given frequency
|
499
|
+
page_size: 100, # Float | The number of results to return
|
440
500
|
next_page: nil # String | Gets the next page of data from a previous API call
|
441
501
|
}
|
442
502
|
|
@@ -456,6 +516,7 @@ Name | Type | Description | Notes
|
|
456
516
|
**start_date** | **Date**| Return prices on or after the date | [optional]
|
457
517
|
**end_date** | **Date**| Return prices on or before the date | [optional]
|
458
518
|
**frequency** | **String**| Return stock prices in the given frequency | [optional] [default to daily]
|
519
|
+
**page_size** | **Float**| The number of results to return | [optional] [default to 100]
|
459
520
|
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
460
521
|
|
461
522
|
### Return type
|
@@ -485,7 +546,8 @@ opts = {
|
|
485
546
|
logic: Intrinio::SecurityScreenGroup.new, # SecurityScreenGroup | The logic to screen with, consisting of operators, clauses, and nested groups.<br/> See <a href=\"/documentation/screener_v2\" target=\"_blank\">screener documentation</a> for details on how to construct conditions.
|
486
547
|
order_column: "order_column_example", # String | Results returned sorted by this column
|
487
548
|
order_direction: "asc", # String | Sort order to use with the order_column
|
488
|
-
primary_only: false # BOOLEAN | Return only primary securities
|
549
|
+
primary_only: false, # BOOLEAN | Return only primary securities
|
550
|
+
page_size: 100 # Float | The number of results to return
|
489
551
|
}
|
490
552
|
|
491
553
|
begin
|
@@ -504,13 +566,14 @@ Name | Type | Description | Notes
|
|
504
566
|
**order_column** | **String**| Results returned sorted by this column | [optional]
|
505
567
|
**order_direction** | **String**| Sort order to use with the order_column | [optional] [default to asc]
|
506
568
|
**primary_only** | **BOOLEAN**| Return only primary securities | [optional] [default to false]
|
569
|
+
**page_size** | **Float**| The number of results to return | [optional] [default to 100]
|
507
570
|
|
508
571
|
### Return type
|
509
572
|
|
510
573
|
[**Array<SecurityScreenResult>**](SecurityScreenResult.md)
|
511
574
|
|
512
575
|
# **search_securities**
|
513
|
-
>
|
576
|
+
> ApiResponseSecuritiesSearch search_securities(query, opts)
|
514
577
|
|
515
578
|
Search Securities
|
516
579
|
|
@@ -530,9 +593,12 @@ security_api = Intrinio::SecurityApi.new
|
|
530
593
|
|
531
594
|
query = "Apple" # String |
|
532
595
|
|
596
|
+
opts = {
|
597
|
+
page_size: 100 # Float | The number of results to return
|
598
|
+
}
|
533
599
|
|
534
600
|
begin
|
535
|
-
result = security_api.search_securities(query)
|
601
|
+
result = security_api.search_securities(query, opts)
|
536
602
|
p result
|
537
603
|
rescue Intrinio::ApiError => e
|
538
604
|
puts "Exception when calling SecurityApi->search_securities: #{e}"
|
@@ -544,8 +610,9 @@ end
|
|
544
610
|
Name | Type | Description | Notes
|
545
611
|
------------- | ------------- | ------------- | -------------
|
546
612
|
**query** | **String**| |
|
613
|
+
**page_size** | **Float**| The number of results to return | [optional] [default to 100]
|
547
614
|
|
548
615
|
### Return type
|
549
616
|
|
550
|
-
[**
|
617
|
+
[**ApiResponseSecuritiesSearch**](ApiResponseSecuritiesSearch.md)
|
551
618
|
|
data/docs/StockExchangeApi.md
CHANGED
@@ -4,7 +4,6 @@ All URIs are relative to *https://api-v2.intrinio.com*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**filter_stock_exchanges**](StockExchangeApi.md#filter_stock_exchanges) | **GET** /stock_exchanges/filter | Filter Stock Exchanges
|
8
7
|
[**get_all_stock_exchanges**](StockExchangeApi.md#get_all_stock_exchanges) | **GET** /stock_exchanges | All Stock Exchanges
|
9
8
|
[**get_stock_exchange_by_id**](StockExchangeApi.md#get_stock_exchange_by_id) | **GET** /stock_exchanges/{identifier} | Lookup Stock Exchange
|
10
9
|
[**get_stock_exchange_price_adjustments**](StockExchangeApi.md#get_stock_exchange_price_adjustments) | **GET** /stock_exchanges/{identifier}/prices/adjustments | Stock Price Adjustments by Exchange
|
@@ -13,12 +12,12 @@ Method | HTTP request | Description
|
|
13
12
|
[**get_stock_exchange_securities**](StockExchangeApi.md#get_stock_exchange_securities) | **GET** /stock_exchanges/{identifier}/securities | Securities by Exchange
|
14
13
|
|
15
14
|
|
16
|
-
# **
|
17
|
-
> ApiResponseStockExchanges
|
15
|
+
# **get_all_stock_exchanges**
|
16
|
+
> ApiResponseStockExchanges get_all_stock_exchanges(opts)
|
18
17
|
|
19
|
-
|
18
|
+
All Stock Exchanges
|
20
19
|
|
21
|
-
Returns Stock Exchanges matching
|
20
|
+
Returns all Stock Exchanges. Returns Stock Exchanges matching parameters when specified.
|
22
21
|
|
23
22
|
### Example
|
24
23
|
```ruby
|
@@ -35,14 +34,15 @@ stockExchange_api = Intrinio::StockExchangeApi.new
|
|
35
34
|
opts = {
|
36
35
|
city: "city_example", # String | Filter by city
|
37
36
|
country: "CHINA", # String | Filter by country
|
38
|
-
country_code: "country_code_example" # String | Filter by ISO country code
|
37
|
+
country_code: "country_code_example", # String | Filter by ISO country code
|
38
|
+
page_size: 100 # Float | The number of results to return
|
39
39
|
}
|
40
40
|
|
41
41
|
begin
|
42
|
-
result = stockExchange_api.
|
42
|
+
result = stockExchange_api.get_all_stock_exchanges(opts)
|
43
43
|
p result
|
44
44
|
rescue Intrinio::ApiError => e
|
45
|
-
puts "Exception when calling StockExchangeApi->
|
45
|
+
puts "Exception when calling StockExchangeApi->get_all_stock_exchanges: #{e}"
|
46
46
|
end
|
47
47
|
```
|
48
48
|
|
@@ -53,40 +53,7 @@ Name | Type | Description | Notes
|
|
53
53
|
**city** | **String**| Filter by city | [optional]
|
54
54
|
**country** | **String**| Filter by country | [optional]
|
55
55
|
**country_code** | **String**| Filter by ISO country code | [optional]
|
56
|
-
|
57
|
-
### Return type
|
58
|
-
|
59
|
-
[**ApiResponseStockExchanges**](ApiResponseStockExchanges.md)
|
60
|
-
|
61
|
-
# **get_all_stock_exchanges**
|
62
|
-
> ApiResponseStockExchanges get_all_stock_exchanges
|
63
|
-
|
64
|
-
All Stock Exchanges
|
65
|
-
|
66
|
-
Returns all Stock Exchanges
|
67
|
-
|
68
|
-
### Example
|
69
|
-
```ruby
|
70
|
-
# Load the gem
|
71
|
-
require 'intrinio-sdk'
|
72
|
-
|
73
|
-
# Setup authorization
|
74
|
-
Intrinio.configure do |config|
|
75
|
-
config.api_key['api_key'] = 'YOUR API KEY'
|
76
|
-
end
|
77
|
-
|
78
|
-
stockExchange_api = Intrinio::StockExchangeApi.new
|
79
|
-
|
80
|
-
begin
|
81
|
-
result = stockExchange_api.get_all_stock_exchanges
|
82
|
-
p result
|
83
|
-
rescue Intrinio::ApiError => e
|
84
|
-
puts "Exception when calling StockExchangeApi->get_all_stock_exchanges: #{e}"
|
85
|
-
end
|
86
|
-
```
|
87
|
-
|
88
|
-
### Parameters
|
89
|
-
This endpoint does not need any parameter.
|
56
|
+
**page_size** | **Float**| The number of results to return | [optional] [default to 100]
|
90
57
|
|
91
58
|
### Return type
|
92
59
|
|
@@ -155,6 +122,7 @@ identifier = "USCOMP" # String | A Stock Exchange identifier (MIC or Intrinio ID
|
|
155
122
|
|
156
123
|
opts = {
|
157
124
|
date: Date.parse("2018-08-14"), # Date | The date for which to return price adjustments
|
125
|
+
page_size: 100, # Float | The number of results to return
|
158
126
|
next_page: nil # String | Gets the next page of data from a previous API call
|
159
127
|
}
|
160
128
|
|
@@ -172,6 +140,7 @@ Name | Type | Description | Notes
|
|
172
140
|
------------- | ------------- | ------------- | -------------
|
173
141
|
**identifier** | **String**| A Stock Exchange identifier (MIC or Intrinio ID) |
|
174
142
|
**date** | **Date**| The date for which to return price adjustments | [optional]
|
143
|
+
**page_size** | **Float**| The number of results to return | [optional] [default to 100]
|
175
144
|
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
176
145
|
|
177
146
|
### Return type
|
@@ -201,6 +170,7 @@ identifier = "USCOMP" # String | A Stock Exchange identifier (MIC or Intrinio ID
|
|
201
170
|
|
202
171
|
opts = {
|
203
172
|
date: Date.parse("2018-08-14"), # Date | The date for which to return prices
|
173
|
+
page_size: 100, # Float | The number of results to return
|
204
174
|
next_page: nil # String | Gets the next page of data from a previous API call
|
205
175
|
}
|
206
176
|
|
@@ -218,6 +188,7 @@ Name | Type | Description | Notes
|
|
218
188
|
------------- | ------------- | ------------- | -------------
|
219
189
|
**identifier** | **String**| A Stock Exchange identifier (MIC or Intrinio ID) |
|
220
190
|
**date** | **Date**| The date for which to return prices | [optional]
|
191
|
+
**page_size** | **Float**| The number of results to return | [optional] [default to 100]
|
221
192
|
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
222
193
|
|
223
194
|
### Return type
|
@@ -247,6 +218,7 @@ identifier = "USCOMP" # String | A Stock Exchange identifier (MIC or Intrinio ID
|
|
247
218
|
|
248
219
|
opts = {
|
249
220
|
source: nil, # String | Return realtime prices from the specified data source
|
221
|
+
page_size: 100, # Float | The number of results to return
|
250
222
|
next_page: nil # String | Gets the next page of data from a previous API call
|
251
223
|
}
|
252
224
|
|
@@ -264,6 +236,7 @@ Name | Type | Description | Notes
|
|
264
236
|
------------- | ------------- | ------------- | -------------
|
265
237
|
**identifier** | **String**| A Stock Exchange identifier (MIC or Intrinio ID) |
|
266
238
|
**source** | **String**| Return realtime prices from the specified data source | [optional]
|
239
|
+
**page_size** | **Float**| The number of results to return | [optional] [default to 100]
|
267
240
|
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
268
241
|
|
269
242
|
### Return type
|
@@ -292,6 +265,7 @@ stockExchange_api = Intrinio::StockExchangeApi.new
|
|
292
265
|
identifier = "USCOMP" # String | A Stock Exchange identifier (MIC or Intrinio ID)
|
293
266
|
|
294
267
|
opts = {
|
268
|
+
page_size: 100, # Float | The number of results to return
|
295
269
|
next_page: nil # String | Gets the next page of data from a previous API call
|
296
270
|
}
|
297
271
|
|
@@ -308,6 +282,7 @@ end
|
|
308
282
|
Name | Type | Description | Notes
|
309
283
|
------------- | ------------- | ------------- | -------------
|
310
284
|
**identifier** | **String**| A Stock Exchange identifier (MIC or Intrinio ID) |
|
285
|
+
**page_size** | **Float**| The number of results to return | [optional] [default to 100]
|
311
286
|
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
312
287
|
|
313
288
|
### Return type
|