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 Feb 1, 2024
1 parent ba40af2 commit ea21bae
Show file tree
Hide file tree
Showing 608 changed files with 2,359 additions and 615 deletions.
7 changes: 5 additions & 2 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.48.1
- Package version: 6.26.5
- API version: 2.52.0
- Package version: 6.26.6


## Requirements.
Expand Down Expand Up @@ -103,6 +103,7 @@ Class | Method | HTTP request | Description
*CompanyApi* | [**get_all_company_news**](docs/CompanyApi.md#get_all_company_news) | **GET** /companies/news | All News
*CompanyApi* | [**get_company**](docs/CompanyApi.md#get_company) | **GET** /companies/{identifier} | Lookup Company
*CompanyApi* | [**get_company_answers**](docs/CompanyApi.md#get_company_answers) | **GET** /companies/{identifier}/answers | Company Answers
*CompanyApi* | [**get_company_daily_metrics**](docs/CompanyApi.md#get_company_daily_metrics) | **GET** /companies/{identifier}/daily_metrics | Company metrics by Company
*CompanyApi* | [**get_company_data_point_number**](docs/CompanyApi.md#get_company_data_point_number) | **GET** /companies/{identifier}/data_point/{tag}/number | Data Point (Number) for Company
*CompanyApi* | [**get_company_data_point_text**](docs/CompanyApi.md#get_company_data_point_text) | **GET** /companies/{identifier}/data_point/{tag}/text | Data Point (Text) for Company
*CompanyApi* | [**get_company_filings**](docs/CompanyApi.md#get_company_filings) | **GET** /companies/{identifier}/filings | All Filings by Company
Expand Down Expand Up @@ -324,6 +325,7 @@ Class | Method | HTTP request | Description
- [ApiResponseCompanies](docs/ApiResponseCompanies.md)
- [ApiResponseCompaniesSearch](docs/ApiResponseCompaniesSearch.md)
- [ApiResponseCompanyAnswers](docs/ApiResponseCompanyAnswers.md)
- [ApiResponseCompanyDailyMetrics](docs/ApiResponseCompanyDailyMetrics.md)
- [ApiResponseCompanyFilings](docs/ApiResponseCompanyFilings.md)
- [ApiResponseCompanyFundamentals](docs/ApiResponseCompanyFundamentals.md)
- [ApiResponseCompanyHistoricalData](docs/ApiResponseCompanyHistoricalData.md)
Expand Down Expand Up @@ -453,6 +455,7 @@ Class | Method | HTTP request | Description
- [ChaikinMoneyFlowTechnicalValue](docs/ChaikinMoneyFlowTechnicalValue.md)
- [CommodityChannelIndexTechnicalValue](docs/CommodityChannelIndexTechnicalValue.md)
- [Company](docs/Company.md)
- [CompanyDailyMetric](docs/CompanyDailyMetric.md)
- [CompanyFiling](docs/CompanyFiling.md)
- [CompanyInitialPublicOffering](docs/CompanyInitialPublicOffering.md)
- [CompanyNews](docs/CompanyNews.md)
Expand Down
28 changes: 28 additions & 0 deletions docs/ApiResponseCompanyDailyMetrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@


[//]: # (CLASS:ApiResponseCompanyDailyMetrics)

[//]: # (KIND:object)

### ApiResponseCompanyDailyMetrics

#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**daily_metrics** | [**list[CompanyDailyMetric]**](CompanyDailyMetric.md) |  
**company** | [**CompanySummary**](CompanySummary.md) |  
**next_page** | str | The token required to request the next page of the data. If null, no further results are available.  

[//]: # (END_DEFINITION)


[//]: # (CONTAINED_CLASS:CompanyDailyMetric)


[//]: # (CONTAINED_CLASS:CompanySummary)



82 changes: 82 additions & 0 deletions docs/CompanyApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Method | HTTP request | Description
[**get_all_company_news**](CompanyApi.md#get_all_company_news) | **GET** /companies/news | All News
[**get_company**](CompanyApi.md#get_company) | **GET** /companies/{identifier} | Lookup Company
[**get_company_answers**](CompanyApi.md#get_company_answers) | **GET** /companies/{identifier}/answers | Company Answers
[**get_company_daily_metrics**](CompanyApi.md#get_company_daily_metrics) | **GET** /companies/{identifier}/daily_metrics | Company metrics by Company
[**get_company_data_point_number**](CompanyApi.md#get_company_data_point_number) | **GET** /companies/{identifier}/data_point/{tag}/number | Data Point (Number) for Company
[**get_company_data_point_text**](CompanyApi.md#get_company_data_point_text) | **GET** /companies/{identifier}/data_point/{tag}/text | Data Point (Text) for Company
[**get_company_filings**](CompanyApi.md#get_company_filings) | **GET** /companies/{identifier}/filings | All Filings by Company
Expand Down Expand Up @@ -350,6 +351,87 @@ Name | Type | Description | Notes
[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

[//]: # (CLASS:CompanyApi)

[//]: # (METHOD:get_company_daily_metrics)

[//]: # (RETURN_TYPE:ApiResponseCompanyDailyMetrics)

[//]: # (RETURN_TYPE_KIND:object)

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

[//]: # (OPERATION:get_company_daily_metrics_v2)

[//]: # (ENDPOINT:/companies/{identifier}/daily_metrics)

[//]: # (DOCUMENT_LINK:CompanyApi.md#get_company_daily_metrics)

## **get_company_daily_metrics**

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

[//]: # (START_OVERVIEW)

> ApiResponseCompanyDailyMetrics get_company_daily_metrics(identifier, page_size=page_size, next_page=next_page, next_page2=next_page2)
#### Company metrics by Company


Returns the latest company metrics.

[//]: # (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)

identifier = 'AAPL'
page_size = 100
next_page = ''
next_page2 = ''

response = intrinio.CompanyApi().get_company_daily_metrics(identifier, page_size=page_size, next_page=next_page, next_page2=next_page2)
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
------------- | ------------- | ------------- | -------------
**identifier** | str| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |  
**page_size** | int| The number of results to return | [optional] [default to 100]  
**next_page** | str| Gets the next page of data from a previous API call | [optional]  
**next_page2** | str| Gets the next page of data from a previous API call | [optional]  
<br/>

[//]: # (END_PARAMETERS)

### Return type

[**ApiResponseCompanyDailyMetrics**](ApiResponseCompanyDailyMetrics.md)

[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

[//]: # (CLASS:CompanyApi)
Expand Down
35 changes: 35 additions & 0 deletions docs/CompanyDailyMetric.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@


[//]: # (CLASS:CompanyDailyMetric)

[//]: # (KIND:object)

### CompanyDailyMetric

#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**date** | datetime | The date of the metric &nbsp;
**enterprise_value** | float | The enterprise value. &nbsp;
**ev_to_ebit** | float | The enterprise value to earnings before interest and taxes ratio. &nbsp;
**ev_to_ebitda** | float | The enterprise value to earnings before interest, taxes, depreciation, and amoritization ratio. &nbsp;
**market_cap** | float | The market cap. &nbsp;
**price_to_book** | float | The price to book ratio. &nbsp;
**price_to_earnings** | float | The price to earnings ratio. &nbsp;
**price_to_revenue** | float | The price to revenue ratio. &nbsp;
**price_to_tangible_book** | float | The price to tangible book ratio. &nbsp;
**dividend_yield** | float | The dividend yield. &nbsp;
**earnings_yield** | float | The earnings yield. &nbsp;
**ev_to_invested_capital** | float | The enterprise value to invested capital ratio. &nbsp;
**ev_to_revenue** | float | The enterprise value to revenue ratio. &nbsp;
**ev_to_nopat** | float | The enterprise value to normalized operating profit after tax ratio. &nbsp;
**ev_to_ocf** | float | The enterprise value to operating cash flow ratio. &nbsp;
**ev_to_fcff** | float | The enterprise value to free cash flow to the firm ratio. &nbsp;

[//]: # (END_DEFINITION)



8 changes: 5 additions & 3 deletions docs/SecurityApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4480,7 +4480,7 @@ Name | Type | Description | Notes

[//]: # (START_OVERVIEW)

> SecurityTradesResult get_security_trades_by_symbol(identifier, 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)
> SecurityTradesResult get_security_trades_by_symbol(identifier, source, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, timezone=timezone, darkpool_only=darkpool_only, page_size=page_size, next_page=next_page)
#### Security Trades By Symbol

Expand Down Expand Up @@ -4508,10 +4508,11 @@ start_time = ''
end_date = ''
end_time = ''
timezone = 'UTC'
darkpool_only = False
page_size = 100
next_page = ''

response = intrinio.SecurityApi().get_security_trades_by_symbol(identifier, 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)
response = intrinio.SecurityApi().get_security_trades_by_symbol(identifier, source, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, timezone=timezone, darkpool_only=darkpool_only, 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 @@ -4528,12 +4529,13 @@ print(response)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | str| The ticker symbol for which trades are being requested. | &nbsp;
**source** | str| The specific source of the data being requested. | &nbsp;
**source** | str| The specific source of the data being requested. Specifying delayed sip will result in the system automatically determining which delayed sip source (cta_delayed, cta_b_delayed, utp_delayed) to use. | &nbsp;
**start_date** | date| The start date for the data being requested. | [optional] &nbsp;
**start_time** | str| The start time for the data being requested. | [optional] &nbsp;
**end_date** | date| The end date for the data being requested. | [optional] &nbsp;
**end_time** | str| The end time for the data being requested. | [optional] &nbsp;
**timezone** | str| The timezone the start and end date/times use. | [optional] [default to UTC] &nbsp;
**darkpool_only** | bool| Set to True to show only darkpool trades | [optional] [default to False] &nbsp;
**page_size** | int| The maximum number of results to return per page. | [optional] [default to 100] &nbsp;
**next_page** | str| Gets the next page of data from a previous API call | [optional] &nbsp;
<br/>
Expand Down
1 change: 1 addition & 0 deletions docs/SecurityTrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Name | Type | Description
**total_volume** | float | The total volume of the symbol for the day up to the timestamp point in time. &nbsp;
**market_center** | str | The market center for the trade. &nbsp;
**condition** | str | The condition of the trade. &nbsp;
**is_darkpool** | bool | If the trade was darkpool or not. &nbsp;

[//]: # (END_DEFINITION)

Expand Down
4 changes: 3 additions & 1 deletion intrinio_sdk/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
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. # noqa: E501
OpenAPI spec version: 2.48.1
OpenAPI spec version: 2.52.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down Expand Up @@ -46,6 +46,7 @@
from intrinio_sdk.models.api_response_companies import ApiResponseCompanies
from intrinio_sdk.models.api_response_companies_search import ApiResponseCompaniesSearch
from intrinio_sdk.models.api_response_company_answers import ApiResponseCompanyAnswers
from intrinio_sdk.models.api_response_company_daily_metrics import ApiResponseCompanyDailyMetrics
from intrinio_sdk.models.api_response_company_filings import ApiResponseCompanyFilings
from intrinio_sdk.models.api_response_company_fundamentals import ApiResponseCompanyFundamentals
from intrinio_sdk.models.api_response_company_historical_data import ApiResponseCompanyHistoricalData
Expand Down Expand Up @@ -175,6 +176,7 @@
from intrinio_sdk.models.chaikin_money_flow_technical_value import ChaikinMoneyFlowTechnicalValue
from intrinio_sdk.models.commodity_channel_index_technical_value import CommodityChannelIndexTechnicalValue
from intrinio_sdk.models.company import Company
from intrinio_sdk.models.company_daily_metric import CompanyDailyMetric
from intrinio_sdk.models.company_filing import CompanyFiling
from intrinio_sdk.models.company_initial_public_offering import CompanyInitialPublicOffering
from intrinio_sdk.models.company_news import CompanyNews
Expand Down
2 changes: 1 addition & 1 deletion intrinio_sdk/api/bulk_downloads_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
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. # noqa: E501
OpenAPI spec version: 2.48.1
OpenAPI spec version: 2.52.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down
111 changes: 110 additions & 1 deletion intrinio_sdk/api/company_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
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. # noqa: E501
OpenAPI spec version: 2.48.1
OpenAPI spec version: 2.52.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down Expand Up @@ -461,6 +461,115 @@ def get_company_answers_with_http_info(self, identifier, query, **kwargs): # no
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)

def get_company_daily_metrics(self, identifier, **kwargs): # noqa: E501
"""Company metrics by Company # noqa: E501
Returns the latest company metrics. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_company_daily_metrics(identifier, _async=True)
>>> result = thread.get()
:param async bool
:param str identifier: A Company identifier (Ticker, CIK, LEI, Intrinio ID) (required)
:param int page_size: The number of results to return
:param str next_page: Gets the next page of data from a previous API call
:param str next_page2: Gets the next page of data from a previous API call
:return: ApiResponseCompanyDailyMetrics
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async'):
return self.get_company_daily_metrics_with_http_info(identifier, **kwargs) # noqa: E501
else:
(data) = self.get_company_daily_metrics_with_http_info(identifier, **kwargs) # noqa: E501
return data

def get_company_daily_metrics_with_http_info(self, identifier, **kwargs): # noqa: E501
"""Company metrics by Company # noqa: E501
Returns the latest company metrics. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_company_daily_metrics_with_http_info(identifier, _async=True)
>>> result = thread.get()
:param async bool
:param str identifier: A Company identifier (Ticker, CIK, LEI, Intrinio ID) (required)
:param int page_size: The number of results to return
:param str next_page: Gets the next page of data from a previous API call
:param str next_page2: Gets the next page of data from a previous API call
:return: ApiResponseCompanyDailyMetrics
If the method is called asynchronously,
returns the request thread.
"""

all_params = ['identifier', 'page_size', 'next_page', 'next_page2'] # noqa: E501
all_params.append('async')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')

params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_company_daily_metrics" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'identifier' is set
if ('identifier' not in params or
params['identifier'] is None):
raise ValueError("Missing the required parameter `identifier` when calling `get_company_daily_metrics`") # noqa: E501

if 'page_size' in params and params['page_size'] > 10000: # noqa: E501
raise ValueError("Invalid value for parameter `page_size` when calling `get_company_daily_metrics`, must be a value less than or equal to `10000`") # noqa: E501
collection_formats = {}

path_params = {}
if 'identifier' in params:
path_params['identifier'] = params['identifier'] # noqa: E501

query_params = []
if 'page_size' in params:
query_params.append(('page_size', params['page_size'])) # noqa: E501
if 'next_page' in params:
query_params.append(('next_page', params['next_page'])) # noqa: E501
if 'next_page2' in params:
query_params.append(('next_page', params['next_page2'])) # noqa: E501

header_params = {}

form_params = []
local_var_files = {}

body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501

# Authentication setting
auth_settings = ['ApiKeyAuth'] # noqa: E501

return self.api_client.call_api(
'/companies/{identifier}/daily_metrics', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiResponseCompanyDailyMetrics', # noqa: E501
auth_settings=auth_settings,
_async=params.get('async'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)

def get_company_data_point_number(self, identifier, tag, **kwargs): # noqa: E501
"""Data Point (Number) for Company # noqa: E501
Expand Down
Loading

0 comments on commit ea21bae

Please sign in to comment.