Skip to content

Commit f0a6b8a

Browse files
No release notes for this build
1 parent a13ccb9 commit f0a6b8a

File tree

300 files changed

+1611
-333
lines changed

Some content is hidden

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

300 files changed

+1611
-333
lines changed

README.md

+8-3
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.34.0
12-
- Package version: 6.22.3
11+
- API version: 2.39.0
12+
- Package version: 6.23.0
1313

1414

1515
## Installation
@@ -148,7 +148,7 @@ Class | Method | HTTP request | Description
148148
*Intrinio::OptionsApi* | [**get_options_chain_eod**](docs/OptionsApi.md#get_options_chain_eod) | **GET** /options/chain/{symbol}/{expiration}/eod | Options Chain EOD
149149
*Intrinio::OptionsApi* | [**get_options_chain_realtime**](docs/OptionsApi.md#get_options_chain_realtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
150150
*Intrinio::OptionsApi* | [**get_options_expirations**](docs/OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
151-
*Intrinio::OptionsApi* | [**get_options_interval_by_contract**](docs/OptionsApi.md#get_options_interval_by_contract) | **GET** /options/interval/{identifier} | Options intervals by contract
151+
*Intrinio::OptionsApi* | [**get_options_interval_by_contract**](docs/OptionsApi.md#get_options_interval_by_contract) | **GET** /options/interval/{identifier} | Options Intervals By Contract
152152
*Intrinio::OptionsApi* | [**get_options_interval_movers**](docs/OptionsApi.md#get_options_interval_movers) | **GET** /options/interval/movers | Options Intervals Movers
153153
*Intrinio::OptionsApi* | [**get_options_interval_movers_change**](docs/OptionsApi.md#get_options_interval_movers_change) | **GET** /options/interval/movers/change | Options Intervals Movers By Change
154154
*Intrinio::OptionsApi* | [**get_options_interval_movers_volume**](docs/OptionsApi.md#get_options_interval_movers_volume) | **GET** /options/interval/movers/volume | Options Intervals Movers By Volume
@@ -173,6 +173,9 @@ Class | Method | HTTP request | Description
173173
*Intrinio::SecurityApi* | [**get_security_data_point_text**](docs/SecurityApi.md#get_security_data_point_text) | **GET** /securities/{identifier}/data_point/{tag}/text | Data Point (Text) for Security
174174
*Intrinio::SecurityApi* | [**get_security_historical_data**](docs/SecurityApi.md#get_security_historical_data) | **GET** /securities/{identifier}/historical_data/{tag} | Historical Data for Security
175175
*Intrinio::SecurityApi* | [**get_security_insider_ownership**](docs/SecurityApi.md#get_security_insider_ownership) | **GET** /securities/{identifier}/institutional_ownership | Institutional Ownership by Security
176+
*Intrinio::SecurityApi* | [**get_security_interval_movers**](docs/SecurityApi.md#get_security_interval_movers) | **GET** /securities/market_movers | Security Intervals Movers
177+
*Intrinio::SecurityApi* | [**get_security_interval_movers_change**](docs/SecurityApi.md#get_security_interval_movers_change) | **GET** /securities/market_movers/change | Security Intervals Movers By Change
178+
*Intrinio::SecurityApi* | [**get_security_interval_movers_volume**](docs/SecurityApi.md#get_security_interval_movers_volume) | **GET** /securities/market_movers/volume | Security Intervals Movers By Volume
176179
*Intrinio::SecurityApi* | [**get_security_interval_prices**](docs/SecurityApi.md#get_security_interval_prices) | **GET** /securities/{identifier}/prices/intervals | Interval Stock Prices for Security
177180
*Intrinio::SecurityApi* | [**get_security_intraday_prices**](docs/SecurityApi.md#get_security_intraday_prices) | **GET** /securities/{identifier}/prices/intraday | Intraday Stock Prices for Security
178181
*Intrinio::SecurityApi* | [**get_security_latest_dividend_record**](docs/SecurityApi.md#get_security_latest_dividend_record) | **GET** /securities/{identifier}/dividends/latest | Latest Dividend Record for Security
@@ -486,6 +489,8 @@ Class | Method | HTTP request | Description
486489
- [Intrinio::ReportedTag](docs/ReportedTag.md)
487490
- [Intrinio::SICIndex](docs/SICIndex.md)
488491
- [Intrinio::Security](docs/Security.md)
492+
- [Intrinio::SecurityIntervalMover](docs/SecurityIntervalMover.md)
493+
- [Intrinio::SecurityIntervalsMoversResult](docs/SecurityIntervalsMoversResult.md)
489494
- [Intrinio::SecurityScreenClause](docs/SecurityScreenClause.md)
490495
- [Intrinio::SecurityScreenGroup](docs/SecurityScreenGroup.md)
491496
- [Intrinio::SecurityScreenResult](docs/SecurityScreenResult.md)

docs/ApiResponseSecurityIntervalPrices.md

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

1313
Name | Type | Description
1414
------------ | ------------- | -------------
15-
**intervals** | [**Array<StockPriceInterval>**](StockPriceInterval.md) | Open, High, Low, Close, and Volume for a particular interval  
15+
**intervals** | [**Array<StockPriceInterval>**](StockPriceInterval.md) | Open, close, high, low, volume, average price, and change ratio for a particular interval  
1616
**security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier  
1717
**source** | String | The source of the data  
1818
**next_page** | String | The token required to request the next page of the data. If null, no further results are available.  

docs/OptionsApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Method | HTTP request | Description
1313
[**get_options_chain_eod**](OptionsApi.md#get_options_chain_eod) | **GET** /options/chain/{symbol}/{expiration}/eod | Options Chain EOD
1414
[**get_options_chain_realtime**](OptionsApi.md#get_options_chain_realtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
1515
[**get_options_expirations**](OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
16-
[**get_options_interval_by_contract**](OptionsApi.md#get_options_interval_by_contract) | **GET** /options/interval/{identifier} | Options intervals by contract
16+
[**get_options_interval_by_contract**](OptionsApi.md#get_options_interval_by_contract) | **GET** /options/interval/{identifier} | Options Intervals By Contract
1717
[**get_options_interval_movers**](OptionsApi.md#get_options_interval_movers) | **GET** /options/interval/movers | Options Intervals Movers
1818
[**get_options_interval_movers_change**](OptionsApi.md#get_options_interval_movers_change) | **GET** /options/interval/movers/change | Options Intervals Movers By Change
1919
[**get_options_interval_movers_volume**](OptionsApi.md#get_options_interval_movers_volume) | **GET** /options/interval/movers/volume | Options Intervals Movers By Volume
@@ -861,7 +861,7 @@ Name | Type | Description | Notes
861861

862862
> OptionIntervalsResult get_options_interval_by_contract(identifier, interval_size, opts)
863863
864-
#### Options intervals by contract
864+
#### Options Intervals By Contract
865865

866866

867867
Returns a list of interval data points for a contract.

docs/RealtimeStockPrice.md

+5
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ Name | Type | Description
2727
**market_volume** | Float | The number of shares exchanged during the trading day for the whole market.  
2828
**updated_on** | DateTime | The date and time when the data was last updated.  
2929
**source** | String | The source of the data.  
30+
**listing_venue** | String | The venue the price came from.  
31+
**sales_conditions** | String | The condition for the sale.  
32+
**quote_conditions** | String | The condition for the quote.  
33+
**market_center_code** | String | The market center character code.  
34+
**is_darkpool** | BOOLEAN | Whether or not the current trade is from a darkpool or not.  
3035
**security** | [**RealtimeStockPriceSecurity**](RealtimeStockPriceSecurity.md) |  
3136

3237
[//]: # (END_DEFINITION)

docs/SecurityApi.md

+256-7
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ Method | HTTP request | Description
1010
[**get_security_data_point_text**](SecurityApi.md#get_security_data_point_text) | **GET** /securities/{identifier}/data_point/{tag}/text | Data Point (Text) for Security
1111
[**get_security_historical_data**](SecurityApi.md#get_security_historical_data) | **GET** /securities/{identifier}/historical_data/{tag} | Historical Data for Security
1212
[**get_security_insider_ownership**](SecurityApi.md#get_security_insider_ownership) | **GET** /securities/{identifier}/institutional_ownership | Institutional Ownership by Security
13+
[**get_security_interval_movers**](SecurityApi.md#get_security_interval_movers) | **GET** /securities/market_movers | Security Intervals Movers
14+
[**get_security_interval_movers_change**](SecurityApi.md#get_security_interval_movers_change) | **GET** /securities/market_movers/change | Security Intervals Movers By Change
15+
[**get_security_interval_movers_volume**](SecurityApi.md#get_security_interval_movers_volume) | **GET** /securities/market_movers/volume | Security Intervals Movers By Volume
1316
[**get_security_interval_prices**](SecurityApi.md#get_security_interval_prices) | **GET** /securities/{identifier}/prices/intervals | Interval Stock Prices for Security
1417
[**get_security_intraday_prices**](SecurityApi.md#get_security_intraday_prices) | **GET** /securities/{identifier}/prices/intraday | Intraday Stock Prices for Security
1518
[**get_security_latest_dividend_record**](SecurityApi.md#get_security_latest_dividend_record) | **GET** /securities/{identifier}/dividends/latest | Latest Dividend Record for Security
@@ -582,6 +585,252 @@ Name | Type | Description | Notes
582585
[//]: # (END_OPERATION)
583586

584587

588+
[//]: # (START_OPERATION)
589+
590+
[//]: # (CLASS:Intrinio::SecurityApi)
591+
592+
[//]: # (METHOD:get_security_interval_movers)
593+
594+
[//]: # (RETURN_TYPE:Intrinio::SecurityIntervalsMoversResult)
595+
596+
[//]: # (RETURN_TYPE_KIND:object)
597+
598+
[//]: # (RETURN_TYPE_DOC:SecurityIntervalsMoversResult.md)
599+
600+
[//]: # (OPERATION:get_security_interval_movers_v2)
601+
602+
[//]: # (ENDPOINT:/securities/market_movers)
603+
604+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_interval_movers)
605+
606+
## **get_security_interval_movers**
607+
608+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_interval_movers_v2)
609+
610+
[//]: # (START_OVERVIEW)
611+
612+
> SecurityIntervalsMoversResult get_security_interval_movers(opts)
613+
614+
#### Security Intervals Movers
615+
616+
617+
Returns a list of intervals for the biggest movers over the last hour interval.
618+
619+
[//]: # (END_OVERVIEW)
620+
621+
### Example
622+
623+
[//]: # (START_CODE_EXAMPLE)
624+
625+
```ruby
626+
# Load the gem
627+
require 'intrinio-sdk'
628+
require 'pp'
629+
630+
# Setup authorization
631+
Intrinio.configure do |config|
632+
config.api_key['api_key'] = 'YOUR_API_KEY'
633+
config.allow_retries = true
634+
end
635+
636+
security_api = Intrinio::SecurityApi.new
637+
638+
opts = {
639+
source: nil,
640+
open_time: DateTime.parse(nil)
641+
}
642+
643+
result = security_api.get_security_interval_movers(opts)
644+
pp result
645+
```
646+
647+
[//]: # (END_CODE_EXAMPLE)
648+
649+
[//]: # (START_DEFINITION)
650+
651+
### Parameters
652+
653+
[//]: # (START_PARAMETERS)
654+
655+
656+
Name | Type | Description | Notes
657+
------------- | ------------- | ------------- | -------------
658+
**source** | String| Realtime or 15-minute delayed contracts. | [optional]  
659+
**open_time** | DateTime| The inclusive UTC date and time the interval opens at. | [optional]  
660+
661+
[//]: # (END_PARAMETERS)
662+
663+
### Return type
664+
665+
[**SecurityIntervalsMoversResult**](SecurityIntervalsMoversResult.md)
666+
667+
[//]: # (END_OPERATION)
668+
669+
670+
[//]: # (START_OPERATION)
671+
672+
[//]: # (CLASS:Intrinio::SecurityApi)
673+
674+
[//]: # (METHOD:get_security_interval_movers_change)
675+
676+
[//]: # (RETURN_TYPE:Intrinio::SecurityIntervalsMoversResult)
677+
678+
[//]: # (RETURN_TYPE_KIND:object)
679+
680+
[//]: # (RETURN_TYPE_DOC:SecurityIntervalsMoversResult.md)
681+
682+
[//]: # (OPERATION:get_security_interval_movers_change_v2)
683+
684+
[//]: # (ENDPOINT:/securities/market_movers/change)
685+
686+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_interval_movers_change)
687+
688+
## **get_security_interval_movers_change**
689+
690+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_interval_movers_change_v2)
691+
692+
[//]: # (START_OVERVIEW)
693+
694+
> SecurityIntervalsMoversResult get_security_interval_movers_change(opts)
695+
696+
#### Security Intervals Movers By Change
697+
698+
699+
Returns a list of intervals for the biggest movers by change over the last hour interval.
700+
701+
[//]: # (END_OVERVIEW)
702+
703+
### Example
704+
705+
[//]: # (START_CODE_EXAMPLE)
706+
707+
```ruby
708+
# Load the gem
709+
require 'intrinio-sdk'
710+
require 'pp'
711+
712+
# Setup authorization
713+
Intrinio.configure do |config|
714+
config.api_key['api_key'] = 'YOUR_API_KEY'
715+
config.allow_retries = true
716+
end
717+
718+
security_api = Intrinio::SecurityApi.new
719+
720+
opts = {
721+
source: nil,
722+
open_time: DateTime.parse(nil)
723+
}
724+
725+
result = security_api.get_security_interval_movers_change(opts)
726+
pp result
727+
```
728+
729+
[//]: # (END_CODE_EXAMPLE)
730+
731+
[//]: # (START_DEFINITION)
732+
733+
### Parameters
734+
735+
[//]: # (START_PARAMETERS)
736+
737+
738+
Name | Type | Description | Notes
739+
------------- | ------------- | ------------- | -------------
740+
**source** | String| Realtime or 15-minute delayed contracts. | [optional]  
741+
**open_time** | DateTime| The inclusive UTC date and time the interval opens at. | [optional]  
742+
743+
[//]: # (END_PARAMETERS)
744+
745+
### Return type
746+
747+
[**SecurityIntervalsMoversResult**](SecurityIntervalsMoversResult.md)
748+
749+
[//]: # (END_OPERATION)
750+
751+
752+
[//]: # (START_OPERATION)
753+
754+
[//]: # (CLASS:Intrinio::SecurityApi)
755+
756+
[//]: # (METHOD:get_security_interval_movers_volume)
757+
758+
[//]: # (RETURN_TYPE:Intrinio::SecurityIntervalsMoversResult)
759+
760+
[//]: # (RETURN_TYPE_KIND:object)
761+
762+
[//]: # (RETURN_TYPE_DOC:SecurityIntervalsMoversResult.md)
763+
764+
[//]: # (OPERATION:get_security_interval_movers_volume_v2)
765+
766+
[//]: # (ENDPOINT:/securities/market_movers/volume)
767+
768+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_interval_movers_volume)
769+
770+
## **get_security_interval_movers_volume**
771+
772+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_interval_movers_volume_v2)
773+
774+
[//]: # (START_OVERVIEW)
775+
776+
> SecurityIntervalsMoversResult get_security_interval_movers_volume(opts)
777+
778+
#### Security Intervals Movers By Volume
779+
780+
781+
Returns a list of intervals for the biggest movers by volume over the last hour interval.
782+
783+
[//]: # (END_OVERVIEW)
784+
785+
### Example
786+
787+
[//]: # (START_CODE_EXAMPLE)
788+
789+
```ruby
790+
# Load the gem
791+
require 'intrinio-sdk'
792+
require 'pp'
793+
794+
# Setup authorization
795+
Intrinio.configure do |config|
796+
config.api_key['api_key'] = 'YOUR_API_KEY'
797+
config.allow_retries = true
798+
end
799+
800+
security_api = Intrinio::SecurityApi.new
801+
802+
opts = {
803+
source: nil,
804+
open_time: DateTime.parse(nil)
805+
}
806+
807+
result = security_api.get_security_interval_movers_volume(opts)
808+
pp result
809+
```
810+
811+
[//]: # (END_CODE_EXAMPLE)
812+
813+
[//]: # (START_DEFINITION)
814+
815+
### Parameters
816+
817+
[//]: # (START_PARAMETERS)
818+
819+
820+
Name | Type | Description | Notes
821+
------------- | ------------- | ------------- | -------------
822+
**source** | String| Realtime or 15-minute delayed contracts. | [optional]  
823+
**open_time** | DateTime| The inclusive UTC date and time the interval opens at. | [optional]  
824+
825+
[//]: # (END_PARAMETERS)
826+
827+
### Return type
828+
829+
[**SecurityIntervalsMoversResult**](SecurityIntervalsMoversResult.md)
830+
831+
[//]: # (END_OPERATION)
832+
833+
585834
[//]: # (START_OPERATION)
586835

587836
[//]: # (CLASS:Intrinio::SecurityApi)
@@ -606,12 +855,12 @@ Name | Type | Description | Notes
606855

607856
[//]: # (START_OVERVIEW)
608857

609-
> ApiResponseSecurityIntervalPrices get_security_interval_prices(identifier, opts)
858+
> ApiResponseSecurityIntervalPrices get_security_interval_prices(identifier, interval_size, opts)
610859
611860
#### Interval Stock Prices for Security
612861

613862

614-
Return Open, High, Low, Close, and Volume for a particular interval for the Security with the given `identifier`
863+
Return open, close, high, low, volume, average price, and change ratio for a particular interval for the Security with the given `identifier`
615864

616865
[//]: # (END_OVERVIEW)
617866

@@ -632,6 +881,7 @@ end
632881

633882
security_api = Intrinio::SecurityApi.new
634883
identifier = "AAPL"
884+
interval_size = "15m"
635885

636886
opts = {
637887
source: nil,
@@ -640,12 +890,11 @@ opts = {
640890
end_date: Date.parse("2019-01-01"),
641891
end_time: nil,
642892
timezone: "UTC",
643-
interval_size: 1d,
644893
page_size: 100,
645894
next_page: nil
646895
}
647896

648-
result = security_api.get_security_interval_prices(identifier, opts)
897+
result = security_api.get_security_interval_prices(identifier, interval_size, opts)
649898
pp result
650899
```
651900

@@ -661,13 +910,13 @@ pp result
661910
Name | Type | Description | Notes
662911
------------- | ------------- | ------------- | -------------
663912
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |  
913+
**interval_size** | String| The interval for which to return stock prices | [default to 15m]  
664914
**source** | String| Return intervals from the specified data source | [optional]  
665915
**start_date** | Date| Return intervals starting at the specified date | [optional]  
666-
**start_time** | String| Return intervals starting at the specified time on the `start_date` (24-hour in 'hh:mm' format, UTC timezone) | [optional]  
916+
**start_time** | String| Return intervals starting at the specified time on the `start_date` (24-hour in 'hh:mm:ss' format) | [optional]  
667917
**end_date** | Date| Return intervals stopping at the specified date | [optional]  
668-
**end_time** | String| Return intervals stopping at the specified time on the `end_date` (24-hour in 'hh:mm' format, UTC timezone) | [optional]  
918+
**end_time** | String| Return intervals stopping at the specified time on the `end_date` (24-hour in 'hh:mm:ss' format) | [optional]  
669919
**timezone** | String| Returns trading times in this timezone | [optional] [default to UTC]  
670-
**interval_size** | String| The interval for which to return stock prices | [optional] [default to 1d]  
671920
**page_size** | Integer| The number of results to return | [optional] [default to 100]  
672921
**next_page** | String| Gets the next page of data from a previous API call | [optional]  
673922

0 commit comments

Comments
 (0)