Skip to content

Commit

Permalink
No release notes for this build
Browse files Browse the repository at this point in the history
  • Loading branch information
ssnyder-intrinio committed Mar 17, 2023
1 parent e0d624f commit c2c4464
Show file tree
Hide file tree
Showing 301 changed files with 2,484 additions and 343 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ To get an API key, [sign up here](https://intrinio.com/).

Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.

- API version: 2.34.0
- Package version: 6.22.3
- API version: 2.39.0
- Package version: 6.23.0


## Requirements.
Expand Down Expand Up @@ -185,7 +185,7 @@ Class | Method | HTTP request | Description
*OptionsApi* | [**get_options_chain_eod**](docs/OptionsApi.md#get_options_chain_eod) | **GET** /options/chain/{symbol}/{expiration}/eod | Options Chain EOD
*OptionsApi* | [**get_options_chain_realtime**](docs/OptionsApi.md#get_options_chain_realtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
*OptionsApi* | [**get_options_expirations**](docs/OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
*OptionsApi* | [**get_options_interval_by_contract**](docs/OptionsApi.md#get_options_interval_by_contract) | **GET** /options/interval/{identifier} | Options intervals by contract
*OptionsApi* | [**get_options_interval_by_contract**](docs/OptionsApi.md#get_options_interval_by_contract) | **GET** /options/interval/{identifier} | Options Intervals By Contract
*OptionsApi* | [**get_options_interval_movers**](docs/OptionsApi.md#get_options_interval_movers) | **GET** /options/interval/movers | Options Intervals Movers
*OptionsApi* | [**get_options_interval_movers_change**](docs/OptionsApi.md#get_options_interval_movers_change) | **GET** /options/interval/movers/change | Options Intervals Movers By Change
*OptionsApi* | [**get_options_interval_movers_volume**](docs/OptionsApi.md#get_options_interval_movers_volume) | **GET** /options/interval/movers/volume | Options Intervals Movers By Volume
Expand All @@ -210,6 +210,9 @@ Class | Method | HTTP request | Description
*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
*SecurityApi* | [**get_security_historical_data**](docs/SecurityApi.md#get_security_historical_data) | **GET** /securities/{identifier}/historical_data/{tag} | Historical Data for Security
*SecurityApi* | [**get_security_insider_ownership**](docs/SecurityApi.md#get_security_insider_ownership) | **GET** /securities/{identifier}/institutional_ownership | Institutional Ownership by Security
*SecurityApi* | [**get_security_interval_movers**](docs/SecurityApi.md#get_security_interval_movers) | **GET** /securities/market_movers | Security Intervals Movers
*SecurityApi* | [**get_security_interval_movers_change**](docs/SecurityApi.md#get_security_interval_movers_change) | **GET** /securities/market_movers/change | Security Intervals Movers By Change
*SecurityApi* | [**get_security_interval_movers_volume**](docs/SecurityApi.md#get_security_interval_movers_volume) | **GET** /securities/market_movers/volume | Security Intervals Movers By Volume
*SecurityApi* | [**get_security_interval_prices**](docs/SecurityApi.md#get_security_interval_prices) | **GET** /securities/{identifier}/prices/intervals | Interval Stock Prices for Security
*SecurityApi* | [**get_security_intraday_prices**](docs/SecurityApi.md#get_security_intraday_prices) | **GET** /securities/{identifier}/prices/intraday | Intraday Stock Prices for Security
*SecurityApi* | [**get_security_latest_dividend_record**](docs/SecurityApi.md#get_security_latest_dividend_record) | **GET** /securities/{identifier}/dividends/latest | Latest Dividend Record for Security
Expand Down Expand Up @@ -523,6 +526,8 @@ Class | Method | HTTP request | Description
- [ReportedTag](docs/ReportedTag.md)
- [SICIndex](docs/SICIndex.md)
- [Security](docs/Security.md)
- [SecurityIntervalMover](docs/SecurityIntervalMover.md)
- [SecurityIntervalsMoversResult](docs/SecurityIntervalsMoversResult.md)
- [SecurityScreenClause](docs/SecurityScreenClause.md)
- [SecurityScreenGroup](docs/SecurityScreenGroup.md)
- [SecurityScreenResult](docs/SecurityScreenResult.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/ApiResponseSecurityIntervalPrices.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

Name | Type | Description
------------ | ------------- | -------------
**intervals** | [**list[StockPriceInterval]**](StockPriceInterval.md) | Open, High, Low, Close, and Volume for a particular interval  
**intervals** | [**list[StockPriceInterval]**](StockPriceInterval.md) | Open, close, high, low, volume, average price, and change ratio for a particular interval  
**security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier  
**source** | str | The source of the data  
**next_page** | str | The token required to request the next page of the data. If null, no further results are available.  
Expand Down
4 changes: 2 additions & 2 deletions docs/OptionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Method | HTTP request | Description
[**get_options_chain_eod**](OptionsApi.md#get_options_chain_eod) | **GET** /options/chain/{symbol}/{expiration}/eod | Options Chain EOD
[**get_options_chain_realtime**](OptionsApi.md#get_options_chain_realtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
[**get_options_expirations**](OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
[**get_options_interval_by_contract**](OptionsApi.md#get_options_interval_by_contract) | **GET** /options/interval/{identifier} | Options intervals by contract
[**get_options_interval_by_contract**](OptionsApi.md#get_options_interval_by_contract) | **GET** /options/interval/{identifier} | Options Intervals By Contract
[**get_options_interval_movers**](OptionsApi.md#get_options_interval_movers) | **GET** /options/interval/movers | Options Intervals Movers
[**get_options_interval_movers_change**](OptionsApi.md#get_options_interval_movers_change) | **GET** /options/interval/movers/change | Options Intervals Movers By Change
[**get_options_interval_movers_volume**](OptionsApi.md#get_options_interval_movers_volume) | **GET** /options/interval/movers/volume | Options Intervals Movers By Volume
Expand Down Expand Up @@ -797,7 +797,7 @@ Name | Type | Description | Notes

> OptionIntervalsResult get_options_interval_by_contract(identifier, interval_size, source=source, page_size=page_size, end_time=end_time)
#### Options intervals by contract
#### Options Intervals By Contract


Returns a list of interval data points for a contract.
Expand Down
5 changes: 5 additions & 0 deletions docs/RealtimeStockPrice.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ Name | Type | Description
**market_volume** | float | The number of shares exchanged during the trading day for the whole market.  
**updated_on** | datetime | The date and time when the data was last updated.  
**source** | str | The source of the data.  
**listing_venue** | str | The venue the price came from.  
**sales_conditions** | str | The condition for the sale.  
**quote_conditions** | str | The condition for the quote.  
**market_center_code** | str | The market center character code.  
**is_darkpool** | bool | Whether or not the current trade is from a darkpool or not.  
**security** | [**RealtimeStockPriceSecurity**](RealtimeStockPriceSecurity.md) |  

[//]: # (END_DEFINITION)
Expand Down
248 changes: 241 additions & 7 deletions docs/SecurityApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Method | HTTP request | Description
[**get_security_data_point_text**](SecurityApi.md#get_security_data_point_text) | **GET** /securities/{identifier}/data_point/{tag}/text | Data Point (Text) for Security
[**get_security_historical_data**](SecurityApi.md#get_security_historical_data) | **GET** /securities/{identifier}/historical_data/{tag} | Historical Data for Security
[**get_security_insider_ownership**](SecurityApi.md#get_security_insider_ownership) | **GET** /securities/{identifier}/institutional_ownership | Institutional Ownership by Security
[**get_security_interval_movers**](SecurityApi.md#get_security_interval_movers) | **GET** /securities/market_movers | Security Intervals Movers
[**get_security_interval_movers_change**](SecurityApi.md#get_security_interval_movers_change) | **GET** /securities/market_movers/change | Security Intervals Movers By Change
[**get_security_interval_movers_volume**](SecurityApi.md#get_security_interval_movers_volume) | **GET** /securities/market_movers/volume | Security Intervals Movers By Volume
[**get_security_interval_prices**](SecurityApi.md#get_security_interval_prices) | **GET** /securities/{identifier}/prices/intervals | Interval Stock Prices for Security
[**get_security_intraday_prices**](SecurityApi.md#get_security_intraday_prices) | **GET** /securities/{identifier}/prices/intraday | Intraday Stock Prices for Security
[**get_security_latest_dividend_record**](SecurityApi.md#get_security_latest_dividend_record) | **GET** /securities/{identifier}/dividends/latest | Latest Dividend Record for Security
Expand Down Expand Up @@ -564,6 +567,237 @@ Name | Type | Description | Notes
[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

[//]: # (CLASS:SecurityApi)

[//]: # (METHOD:get_security_interval_movers)

[//]: # (RETURN_TYPE:SecurityIntervalsMoversResult)

[//]: # (RETURN_TYPE_KIND:object)

[//]: # (RETURN_TYPE_DOC:SecurityIntervalsMoversResult.md)

[//]: # (OPERATION:get_security_interval_movers_v2)

[//]: # (ENDPOINT:/securities/market_movers)

[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_interval_movers)

## **get_security_interval_movers**

[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/python/get_security_interval_movers_v2)

[//]: # (START_OVERVIEW)

> SecurityIntervalsMoversResult get_security_interval_movers(source=source, open_time=open_time)
#### Security Intervals Movers


Returns a list of intervals for the biggest movers over the last hour interval.

[//]: # (END_OVERVIEW)

### Example
[//]: # (START_CODE_EXAMPLE)

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

source = ''
open_time = ''

response = intrinio.SecurityApi().get_security_interval_movers(source=source, open_time=open_time)
print(response)

# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)
```
[//]: # (END_CODE_EXAMPLE)

[//]: # (START_DEFINITION)

### Parameters

[//]: # (START_PARAMETERS)


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**source** | str| Realtime or 15-minute delayed contracts. | [optional]  
**open_time** | datetime| The inclusive UTC date and time the interval opens at. | [optional]  
<br/>

[//]: # (END_PARAMETERS)

### Return type

[**SecurityIntervalsMoversResult**](SecurityIntervalsMoversResult.md)

[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

[//]: # (CLASS:SecurityApi)

[//]: # (METHOD:get_security_interval_movers_change)

[//]: # (RETURN_TYPE:SecurityIntervalsMoversResult)

[//]: # (RETURN_TYPE_KIND:object)

[//]: # (RETURN_TYPE_DOC:SecurityIntervalsMoversResult.md)

[//]: # (OPERATION:get_security_interval_movers_change_v2)

[//]: # (ENDPOINT:/securities/market_movers/change)

[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_interval_movers_change)

## **get_security_interval_movers_change**

[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/python/get_security_interval_movers_change_v2)

[//]: # (START_OVERVIEW)

> SecurityIntervalsMoversResult get_security_interval_movers_change(source=source, open_time=open_time)
#### Security Intervals Movers By Change


Returns a list of intervals for the biggest movers by change over the last hour interval.

[//]: # (END_OVERVIEW)

### Example
[//]: # (START_CODE_EXAMPLE)

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

source = ''
open_time = ''

response = intrinio.SecurityApi().get_security_interval_movers_change(source=source, open_time=open_time)
print(response)

# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)
```
[//]: # (END_CODE_EXAMPLE)

[//]: # (START_DEFINITION)

### Parameters

[//]: # (START_PARAMETERS)


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**source** | str| Realtime or 15-minute delayed contracts. | [optional] &nbsp;
**open_time** | datetime| The inclusive UTC date and time the interval opens at. | [optional] &nbsp;
<br/>

[//]: # (END_PARAMETERS)

### Return type

[**SecurityIntervalsMoversResult**](SecurityIntervalsMoversResult.md)

[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

[//]: # (CLASS:SecurityApi)

[//]: # (METHOD:get_security_interval_movers_volume)

[//]: # (RETURN_TYPE:SecurityIntervalsMoversResult)

[//]: # (RETURN_TYPE_KIND:object)

[//]: # (RETURN_TYPE_DOC:SecurityIntervalsMoversResult.md)

[//]: # (OPERATION:get_security_interval_movers_volume_v2)

[//]: # (ENDPOINT:/securities/market_movers/volume)

[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_interval_movers_volume)

## **get_security_interval_movers_volume**

[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/python/get_security_interval_movers_volume_v2)

[//]: # (START_OVERVIEW)

> SecurityIntervalsMoversResult get_security_interval_movers_volume(source=source, open_time=open_time)
#### Security Intervals Movers By Volume


Returns a list of intervals for the biggest movers by volume over the last hour interval.

[//]: # (END_OVERVIEW)

### Example
[//]: # (START_CODE_EXAMPLE)

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

source = ''
open_time = ''

response = intrinio.SecurityApi().get_security_interval_movers_volume(source=source, open_time=open_time)
print(response)

# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)
```
[//]: # (END_CODE_EXAMPLE)

[//]: # (START_DEFINITION)

### Parameters

[//]: # (START_PARAMETERS)


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**source** | str| Realtime or 15-minute delayed contracts. | [optional] &nbsp;
**open_time** | datetime| The inclusive UTC date and time the interval opens at. | [optional] &nbsp;
<br/>

[//]: # (END_PARAMETERS)

### Return type

[**SecurityIntervalsMoversResult**](SecurityIntervalsMoversResult.md)

[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

[//]: # (CLASS:SecurityApi)
Expand All @@ -588,12 +822,12 @@ Name | Type | Description | Notes

[//]: # (START_OVERVIEW)

> ApiResponseSecurityIntervalPrices get_security_interval_prices(identifier, source=source, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, timezone=timezone, interval_size=interval_size, page_size=page_size, next_page=next_page)
> ApiResponseSecurityIntervalPrices get_security_interval_prices(identifier, interval_size, source=source, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, timezone=timezone, page_size=page_size, next_page=next_page)
#### Interval Stock Prices for Security


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

[//]: # (END_OVERVIEW)

Expand All @@ -610,17 +844,17 @@ intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'AAPL'
interval_size = '15m'
source = ''
start_date = '2018-01-01'
start_time = ''
end_date = '2019-01-01'
end_time = ''
timezone = 'UTC'
interval_size = '1d'
page_size = 100
next_page = ''

response = intrinio.SecurityApi().get_security_interval_prices(identifier, source=source, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, timezone=timezone, interval_size=interval_size, page_size=page_size, next_page=next_page)
response = intrinio.SecurityApi().get_security_interval_prices(identifier, interval_size, source=source, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, timezone=timezone, page_size=page_size, next_page=next_page)
print(response)

# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)
Expand All @@ -637,13 +871,13 @@ print(response)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | str| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp;
**interval_size** | str| The interval for which to return stock prices | [default to 15m] &nbsp;
**source** | str| Return intervals from the specified data source | [optional] &nbsp;
**start_date** | date| Return intervals starting at the specified date | [optional] &nbsp;
**start_time** | str| Return intervals starting at the specified time on the &#x60;start_date&#x60; (24-hour in &#39;hh:mm&#39; format, UTC timezone) | [optional] &nbsp;
**start_time** | str| Return intervals starting at the specified time on the &#x60;start_date&#x60; (24-hour in &#39;hh:mm:ss&#39; format) | [optional] &nbsp;
**end_date** | date| Return intervals stopping at the specified date | [optional] &nbsp;
**end_time** | str| Return intervals stopping at the specified time on the &#x60;end_date&#x60; (24-hour in &#39;hh:mm&#39; format, UTC timezone) | [optional] &nbsp;
**end_time** | str| Return intervals stopping at the specified time on the &#x60;end_date&#x60; (24-hour in &#39;hh:mm:ss&#39; format) | [optional] &nbsp;
**timezone** | str| Returns trading times in this timezone | [optional] [default to UTC] &nbsp;
**interval_size** | str| The interval for which to return stock prices | [optional] [default to 1d] &nbsp;
**page_size** | int| The number of results to return | [optional] [default to 100] &nbsp;
**next_page** | str| Gets the next page of data from a previous API call | [optional] &nbsp;
<br/>
Expand Down
Loading

0 comments on commit c2c4464

Please sign in to comment.