Skip to content

Commit c616660

Browse files
No Release notes for this build
1 parent 80aa4a0 commit c616660

File tree

609 files changed

+2220
-604
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

609 files changed

+2220
-604
lines changed

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a
88

99
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
1010

11-
- API version: 2.47.3
12-
- Package version: 6.26.1
11+
- API version: 2.47.7
12+
- Package version: 6.26.2
1313

1414

1515
## Installation
@@ -73,6 +73,7 @@ Class | Method | HTTP request | Description
7373
*Intrinio::CompanyApi* | [**get_company_historical_data**](docs/CompanyApi.md#get_company_historical_data) | **GET** /companies/{identifier}/historical_data/{tag} | Historical Data for Company
7474
*Intrinio::CompanyApi* | [**get_company_ipos**](docs/CompanyApi.md#get_company_ipos) | **GET** /companies/ipos | IPOs
7575
*Intrinio::CompanyApi* | [**get_company_news**](docs/CompanyApi.md#get_company_news) | **GET** /companies/{identifier}/news | All News by Company
76+
*Intrinio::CompanyApi* | [**get_company_public_float**](docs/CompanyApi.md#get_company_public_float) | **GET** /companies/{identifier}/public_float | Get Company's public float
7677
*Intrinio::CompanyApi* | [**get_company_securities**](docs/CompanyApi.md#get_company_securities) | **GET** /companies/{identifier}/securities | All Securities by Company
7778
*Intrinio::CompanyApi* | [**insider_transaction_filings_by_company**](docs/CompanyApi.md#insider_transaction_filings_by_company) | **GET** /companies/{identifier}/insider_transaction_filings | Insider Transaction Filings by Company
7879
*Intrinio::CompanyApi* | [**latest_insider_transaction_filing_by_company**](docs/CompanyApi.md#latest_insider_transaction_filing_by_company) | **GET** /companies/{identifier}/insider_transaction_filings/latest | Latest Insider Transaction Filing by Company
@@ -124,6 +125,7 @@ Class | Method | HTTP request | Description
124125
*Intrinio::IndexApi* | [**get_economic_index_data_point_number**](docs/IndexApi.md#get_economic_index_data_point_number) | **GET** /indices/economic/{identifier}/data_point/{tag}/number | Data Point (Number) for an Economic Index
125126
*Intrinio::IndexApi* | [**get_economic_index_data_point_text**](docs/IndexApi.md#get_economic_index_data_point_text) | **GET** /indices/economic/{identifier}/data_point/{tag}/text | Data Point (Text) for an Economic Index
126127
*Intrinio::IndexApi* | [**get_economic_index_historical_data**](docs/IndexApi.md#get_economic_index_historical_data) | **GET** /indices/economic/{identifier}/historical_data/{tag} | Historical Data for an Economic Index
128+
*Intrinio::IndexApi* | [**get_realtime_index_price_by_id**](docs/IndexApi.md#get_realtime_index_price_by_id) | **GET** /indices/{identifier}/realtime | Realtime Index Price
127129
*Intrinio::IndexApi* | [**get_sic_index_by_id**](docs/IndexApi.md#get_sic_index_by_id) | **GET** /indices/sic/{identifier} | Lookup SIC Index
128130
*Intrinio::IndexApi* | [**get_sic_index_data_point_number**](docs/IndexApi.md#get_sic_index_data_point_number) | **GET** /indices/sic/{identifier}/data_point/{tag}/number | Data Point (Number) for an SIC Index
129131
*Intrinio::IndexApi* | [**get_sic_index_data_point_text**](docs/IndexApi.md#get_sic_index_data_point_text) | **GET** /indices/sic/{identifier}/data_point/{tag}/text | Data Point (Text) for an SIC Index
@@ -288,6 +290,7 @@ Class | Method | HTTP request | Description
288290
- [Intrinio::ApiResponseCompanyHistoricalData](docs/ApiResponseCompanyHistoricalData.md)
289291
- [Intrinio::ApiResponseCompanyInsiderTransactionFilings](docs/ApiResponseCompanyInsiderTransactionFilings.md)
290292
- [Intrinio::ApiResponseCompanyNews](docs/ApiResponseCompanyNews.md)
293+
- [Intrinio::ApiResponseCompanyPublicFloatResult](docs/ApiResponseCompanyPublicFloatResult.md)
291294
- [Intrinio::ApiResponseCompanyRecognize](docs/ApiResponseCompanyRecognize.md)
292295
- [Intrinio::ApiResponseCompanySecurities](docs/ApiResponseCompanySecurities.md)
293296
- [Intrinio::ApiResponseCompanySharesOutstanding](docs/ApiResponseCompanySharesOutstanding.md)
@@ -415,6 +418,7 @@ Class | Method | HTTP request | Description
415418
- [Intrinio::CompanyInitialPublicOffering](docs/CompanyInitialPublicOffering.md)
416419
- [Intrinio::CompanyNews](docs/CompanyNews.md)
417420
- [Intrinio::CompanyNewsSummary](docs/CompanyNewsSummary.md)
421+
- [Intrinio::CompanyPublicFloat](docs/CompanyPublicFloat.md)
418422
- [Intrinio::CompanySharesOutstanding](docs/CompanySharesOutstanding.md)
419423
- [Intrinio::CompanySummary](docs/CompanySummary.md)
420424
- [Intrinio::DataTag](docs/DataTag.md)
@@ -487,6 +491,8 @@ Class | Method | HTTP request | Description
487491
- [Intrinio::OptionUnusualTrade](docs/OptionUnusualTrade.md)
488492
- [Intrinio::Owner](docs/Owner.md)
489493
- [Intrinio::OwnerSummary](docs/OwnerSummary.md)
494+
- [Intrinio::RealtimeIndexPrice](docs/RealtimeIndexPrice.md)
495+
- [Intrinio::RealtimeIndexPriceIndex](docs/RealtimeIndexPriceIndex.md)
490496
- [Intrinio::RealtimeStockPrice](docs/RealtimeStockPrice.md)
491497
- [Intrinio::RealtimeStockPriceSecurity](docs/RealtimeStockPriceSecurity.md)
492498
- [Intrinio::RelativeStrengthIndexTechnicalValue](docs/RelativeStrengthIndexTechnicalValue.md)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
2+
3+
[//]: # (CLASS:Intrinio::ApiResponseCompanyPublicFloatResult)
4+
5+
[//]: # (KIND:object)
6+
7+
### Intrinio::ApiResponseCompanyPublicFloatResult
8+
9+
#### Properties
10+
11+
[//]: # (START_DEFINITION)
12+
13+
Name | Type | Description
14+
------------ | ------------- | -------------
15+
**next_page** | String | The token required to request the next page of the data. If null, no further results are available.  
16+
**company** | [**CompanySummary**](CompanySummary.md) |  
17+
**public_floats** | [**Array<CompanyPublicFloat>**](CompanyPublicFloat.md) | Array of all the public floats in this page of the result.  
18+
19+
[//]: # (END_DEFINITION)
20+
21+
22+
[//]: # (CONTAINED_CLASS:Intrinio::CompanySummary)
23+
24+
25+
[//]: # (CONTAINED_CLASS:Intrinio::CompanyPublicFloat)
26+
27+
28+

docs/CompanyApi.md

+89
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Method | HTTP request | Description
1515
[**get_company_historical_data**](CompanyApi.md#get_company_historical_data) | **GET** /companies/{identifier}/historical_data/{tag} | Historical Data for Company
1616
[**get_company_ipos**](CompanyApi.md#get_company_ipos) | **GET** /companies/ipos | IPOs
1717
[**get_company_news**](CompanyApi.md#get_company_news) | **GET** /companies/{identifier}/news | All News by Company
18+
[**get_company_public_float**](CompanyApi.md#get_company_public_float) | **GET** /companies/{identifier}/public_float | Get Company's public float
1819
[**get_company_securities**](CompanyApi.md#get_company_securities) | **GET** /companies/{identifier}/securities | All Securities by Company
1920
[**insider_transaction_filings_by_company**](CompanyApi.md#insider_transaction_filings_by_company) | **GET** /companies/{identifier}/insider_transaction_filings | Insider Transaction Filings by Company
2021
[**latest_insider_transaction_filing_by_company**](CompanyApi.md#latest_insider_transaction_filing_by_company) | **GET** /companies/{identifier}/insider_transaction_filings/latest | Latest Insider Transaction Filing by Company
@@ -987,6 +988,94 @@ Name | Type | Description | Notes
987988
[//]: # (END_OPERATION)
988989

989990

991+
[//]: # (START_OPERATION)
992+
993+
[//]: # (CLASS:Intrinio::CompanyApi)
994+
995+
[//]: # (METHOD:get_company_public_float)
996+
997+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCompanyPublicFloatResult)
998+
999+
[//]: # (RETURN_TYPE_KIND:object)
1000+
1001+
[//]: # (RETURN_TYPE_DOC:ApiResponseCompanyPublicFloatResult.md)
1002+
1003+
[//]: # (OPERATION:get_company_public_float_v2)
1004+
1005+
[//]: # (ENDPOINT:/companies/{identifier}/public_float)
1006+
1007+
[//]: # (DOCUMENT_LINK:CompanyApi.md#get_company_public_float)
1008+
1009+
## **get_company_public_float**
1010+
1011+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_company_public_float_v2)
1012+
1013+
[//]: # (START_OVERVIEW)
1014+
1015+
> ApiResponseCompanyPublicFloatResult get_company_public_float(identifier, opts)
1016+
1017+
#### Get Company's public float
1018+
1019+
1020+
Returns a list of public float data tied to a given company identifier.
1021+
1022+
[//]: # (END_OVERVIEW)
1023+
1024+
### Example
1025+
1026+
[//]: # (START_CODE_EXAMPLE)
1027+
1028+
```ruby
1029+
# Load the gem
1030+
require 'intrinio-sdk'
1031+
require 'pp'
1032+
1033+
# Setup authorization
1034+
Intrinio.configure do |config|
1035+
config.api_key['api_key'] = 'YOUR_API_KEY'
1036+
config.allow_retries = true
1037+
end
1038+
1039+
company_api = Intrinio::CompanyApi.new
1040+
identifier = "AAPL"
1041+
1042+
opts = {
1043+
float_date_greater_than: nil,
1044+
float_date_less_than: nil,
1045+
next_page: nil,
1046+
next_page2: nil
1047+
}
1048+
1049+
result = company_api.get_company_public_float(identifier, opts)
1050+
pp result
1051+
```
1052+
1053+
[//]: # (END_CODE_EXAMPLE)
1054+
1055+
[//]: # (START_DEFINITION)
1056+
1057+
### Parameters
1058+
1059+
[//]: # (START_PARAMETERS)
1060+
1061+
1062+
Name | Type | Description | Notes
1063+
------------- | ------------- | ------------- | -------------
1064+
**identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |  
1065+
**float_date_greater_than** | Date| The lower-bound date for the data being requested. | [optional]  
1066+
**float_date_less_than** | Date| The upper-bound date for the data being requested. | [optional]  
1067+
**next_page** | String| Gets the next page of data from a previous API call | [optional]  
1068+
**next_page2** | String| Gets the next page of data from a previous API call | [optional]  
1069+
1070+
[//]: # (END_PARAMETERS)
1071+
1072+
### Return type
1073+
1074+
[**ApiResponseCompanyPublicFloatResult**](ApiResponseCompanyPublicFloatResult.md)
1075+
1076+
[//]: # (END_OPERATION)
1077+
1078+
9901079
[//]: # (START_OPERATION)
9911080

9921081
[//]: # (CLASS:Intrinio::CompanyApi)

docs/CompanyPublicFloat.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
3+
[//]: # (CLASS:Intrinio::CompanyPublicFloat)
4+
5+
[//]: # (KIND:object)
6+
7+
### Intrinio::CompanyPublicFloat
8+
9+
#### Properties
10+
11+
[//]: # (START_DEFINITION)
12+
13+
Name | Type | Description
14+
------------ | ------------- | -------------
15+
**date** | Date | The date of the public float.  
16+
**filing_date** | Date | The filing date of the public float.  
17+
**public_float_value** | Float | The dollar value for company float.  
18+
**public_float_shares** | Float | The public shares for the company.  
19+
20+
[//]: # (END_DEFINITION)
21+
22+
23+

docs/CompanySharesOutstanding.md

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Name | Type | Description
1414
------------ | ------------- | -------------
1515
**xbrl_axis** | String | The xbrl concept axis member reported to the SEC.  
1616
**xbrl_member** | String | Provides information about the class of stock as reported in XBRL  
17+
**end_date** | Date | End date of the filing period  
1718
**title_of_security** | String | The description of the security type  
1819
**trading_symbol** | String | The symbol under which the security is traded in the exchange  
1920
**security_exchange_name** | String | The name of the secuirty exchange  

docs/IndexApi.md

+77
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Method | HTTP request | Description
1111
[**get_economic_index_data_point_number**](IndexApi.md#get_economic_index_data_point_number) | **GET** /indices/economic/{identifier}/data_point/{tag}/number | Data Point (Number) for an Economic Index
1212
[**get_economic_index_data_point_text**](IndexApi.md#get_economic_index_data_point_text) | **GET** /indices/economic/{identifier}/data_point/{tag}/text | Data Point (Text) for an Economic Index
1313
[**get_economic_index_historical_data**](IndexApi.md#get_economic_index_historical_data) | **GET** /indices/economic/{identifier}/historical_data/{tag} | Historical Data for an Economic Index
14+
[**get_realtime_index_price_by_id**](IndexApi.md#get_realtime_index_price_by_id) | **GET** /indices/{identifier}/realtime | Realtime Index Price
1415
[**get_sic_index_by_id**](IndexApi.md#get_sic_index_by_id) | **GET** /indices/sic/{identifier} | Lookup SIC Index
1516
[**get_sic_index_data_point_number**](IndexApi.md#get_sic_index_data_point_number) | **GET** /indices/sic/{identifier}/data_point/{tag}/number | Data Point (Number) for an SIC Index
1617
[**get_sic_index_data_point_text**](IndexApi.md#get_sic_index_data_point_text) | **GET** /indices/sic/{identifier}/data_point/{tag}/text | Data Point (Text) for an SIC Index
@@ -598,6 +599,82 @@ Name | Type | Description | Notes
598599
[//]: # (END_OPERATION)
599600

600601

602+
[//]: # (START_OPERATION)
603+
604+
[//]: # (CLASS:Intrinio::IndexApi)
605+
606+
[//]: # (METHOD:get_realtime_index_price_by_id)
607+
608+
[//]: # (RETURN_TYPE:Intrinio::RealtimeIndexPrice)
609+
610+
[//]: # (RETURN_TYPE_KIND:object)
611+
612+
[//]: # (RETURN_TYPE_DOC:RealtimeIndexPrice.md)
613+
614+
[//]: # (OPERATION:get_realtime_index_price_by_id_v2)
615+
616+
[//]: # (ENDPOINT:/indices/{identifier}/realtime)
617+
618+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_realtime_index_price_by_id)
619+
620+
## **get_realtime_index_price_by_id**
621+
622+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_realtime_index_price_by_id_v2)
623+
624+
[//]: # (START_OVERVIEW)
625+
626+
> RealtimeIndexPrice get_realtime_index_price_by_id(identifier)
627+
628+
#### Realtime Index Price
629+
630+
631+
632+
[//]: # (END_OVERVIEW)
633+
634+
### Example
635+
636+
[//]: # (START_CODE_EXAMPLE)
637+
638+
```ruby
639+
# Load the gem
640+
require 'intrinio-sdk'
641+
require 'pp'
642+
643+
# Setup authorization
644+
Intrinio.configure do |config|
645+
config.api_key['api_key'] = 'YOUR_API_KEY'
646+
config.allow_retries = true
647+
end
648+
649+
index_api = Intrinio::IndexApi.new
650+
identifier = "SPX"
651+
652+
result = index_api.get_realtime_index_price_by_id(identifier)
653+
pp result
654+
```
655+
656+
[//]: # (END_CODE_EXAMPLE)
657+
658+
[//]: # (START_DEFINITION)
659+
660+
### Parameters
661+
662+
[//]: # (START_PARAMETERS)
663+
664+
665+
Name | Type | Description | Notes
666+
------------- | ------------- | ------------- | -------------
667+
**identifier** | String| The ticker symbol of the currently trading index |  
668+
669+
[//]: # (END_PARAMETERS)
670+
671+
### Return type
672+
673+
[**RealtimeIndexPrice**](RealtimeIndexPrice.md)
674+
675+
[//]: # (END_OPERATION)
676+
677+
601678
[//]: # (START_OPERATION)
602679

603680
[//]: # (CLASS:Intrinio::IndexApi)

docs/InsiderTransaction.md

+4
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,13 @@ Name | Type | Description
2121
**ticker** | String | The ticker symbol for the company’s common stock  
2222
**security_title** | String | The name of the derivative security transacted  
2323
**conversion_exercise_price** | Float | The conversion or exercise price of the derivative security transacted  
24+
**transaction_date** | Date | The date of the transaction  
25+
**deemed_execution_date** | Date | The date of the transaction had it not a directly identifiable date  
2426
**transaction_type_code** | String | A symbol representing the transaction type; P = Purchase | S = Sale | A = Award | M = Conversion to Common | C = Conversion | X = Exercise of Derivative More Transaction Codes  
2527
**acquisition_disposition_code** | String | A symbol representing whether or not the derivative securities are Acquired or Disposed; A = Acquisition | D = Disposition  
2628
**amount_of_shares** | Float | The number of derivative securities involved in the subject transaction  
29+
**exercise_date** | Date | The exercise date of the derivative securities  
30+
**expiration_date** | Date | The expiration date of the derivative securities  
2731
**underlying_security_title** | String | The name of the underlying non-derivative security related to this derivative transaction  
2832
**underlying_shares** | Float | The number of non-derivative shares involved in the subject transaction  
2933
**transaction_price** | Float | The price of the derivative securities  

docs/InsiderTransactionFiling.md

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313
Name | Type | Description
1414
------------ | ------------- | -------------
15+
**filing_date** | Date | The date of the filing with the SEC made by the owner  
1516
**filing_url** | String | The URL of the filing with the SEC  
1617
**issuer_ticker** | String | The ticker of the issuing company.  
1718
**issuer_cik** | String | The Central Index Key (CIK) of the issuing company.  

docs/InstitutionalHolding.md

+1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Name | Type | Description
1818
**security_type** | String | The type of the security  
1919
**title_of_class** | String | The class of stock held  
2020
**stock_exchange** | String | The stock exchange where the security is traded  
21+
**period_ended** | Date | The date of the latest 13-F filing on record with the SEC.  
2122
**filing_date** | Date | The date when the filing was submitted to the SEC by the company  
2223
**value** | Float | The market value in amount of dollars of the holding in the listed security  
2324
**amount** | Float | The number of shares held in the listed security  

docs/InstitutionalOwnership.md

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Name | Type | Description
1414
------------ | ------------- | -------------
1515
**owner_cik** | String | The Central Index Key issued by the SEC, which is the unique identifier all owner filings  
1616
**owner_name** | String | The name of the institutional owner  
17+
**period_ended** | Date | The date of the latest 13-F filing on record with the SEC.  
1718
**value** | Float | The market value in amount of dollars of the holding in the listed security  
1819
**amount** | Float | The number of shares held in the listed security  
1920
**sole_voting_authority** | Float | The number of shares where the insitutional holder has sole voting authority  

docs/RealtimeIndexPrice.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
2+
3+
[//]: # (CLASS:Intrinio::RealtimeIndexPrice)
4+
5+
[//]: # (KIND:object)
6+
7+
### Intrinio::RealtimeIndexPrice
8+
9+
#### Properties
10+
11+
[//]: # (START_DEFINITION)
12+
13+
Name | Type | Description
14+
------------ | ------------- | -------------
15+
**last_price** | Float | The last price  
16+
**last_time** | DateTime | The timestamp of the last price  
17+
**index** | [**RealtimeIndexPriceIndex**](RealtimeIndexPriceIndex.md) |  
18+
19+
[//]: # (END_DEFINITION)
20+
21+
22+
[//]: # (CONTAINED_CLASS:Intrinio::RealtimeIndexPriceIndex)
23+
24+
25+

docs/RealtimeIndexPriceIndex.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
3+
[//]: # (CLASS:Intrinio::RealtimeIndexPriceIndex)
4+
5+
[//]: # (KIND:object)
6+
7+
### Intrinio::RealtimeIndexPriceIndex
8+
9+
#### Properties
10+
11+
[//]: # (START_DEFINITION)
12+
13+
Name | Type | Description
14+
------------ | ------------- | -------------
15+
**symbol** | String | The current ticker of the index  
16+
17+
[//]: # (END_DEFINITION)
18+
19+
20+

0 commit comments

Comments
 (0)