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
Kenneth Miller committed Dec 27, 2018
1 parent 4adcb85 commit e41737e
Show file tree
Hide file tree
Showing 113 changed files with 5,221 additions and 384 deletions.
124 changes: 72 additions & 52 deletions README.md

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions docs/ApiResponseFilingNotes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# ApiResponseFilingNotes

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**filing_notes** | [**list[FilingNoteSummary]**](FilingNoteSummary.md) | | [optional]
**next_page** | **str** | The token required to request the next page of the data | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


10 changes: 10 additions & 0 deletions docs/ApiResponseFilingNotesSearch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# ApiResponseFilingNotesSearch

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**filing_notes** | [**list[FilingNoteSummary]**](FilingNoteSummary.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


11 changes: 11 additions & 0 deletions docs/ApiResponseStockExchangeRealtimeStockPrices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# ApiResponseStockExchangeRealtimeStockPrices

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**stock_prices** | [**list[RealtimeStockPrice]**](RealtimeStockPrice.md) | The realtime stock prices for all Securities traded on the Stock Exchange | [optional]
**stock_exchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


66 changes: 36 additions & 30 deletions docs/CompanyApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ All URIs are relative to *https://api-v2.intrinio.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**filter_companies**](CompanyApi.md#filter_companies) | **GET** /companies/filter | Filter Companies
[**filter_company_fundamentals**](CompanyApi.md#filter_company_fundamentals) | **GET** /companies/{identifier}/fundamentals/filter | Filter Fundamentals for a Company
[**get_all_companies**](CompanyApi.md#get_all_companies) | **GET** /companies | Get All Companies
[**get_all_company_news**](CompanyApi.md#get_all_company_news) | **GET** /companies/news | Get All Company News
[**get_company**](CompanyApi.md#get_company) | **GET** /companies/{identifier} | Get a Company by ID
[**get_company_data_point_number**](CompanyApi.md#get_company_data_point_number) | **GET** /companies/{identifier}/data_point/{tag}/number | Get Company Data Point (Number)
[**get_company_data_point_text**](CompanyApi.md#get_company_data_point_text) | **GET** /companies/{identifier}/data_point/{tag}/text | Get Company Data Point (Text)
[**get_company_filings**](CompanyApi.md#get_company_filings) | **GET** /companies/{identifier}/filings | Get Filings for a Company
[**get_company_fundamentals**](CompanyApi.md#get_company_fundamentals) | **GET** /companies/{identifier}/fundamentals | Get All Fundamentals for a Company
[**get_company_historical_data**](CompanyApi.md#get_company_historical_data) | **GET** /companies/{identifier}/historical_data/{tag} | Get Company Historical Data
[**get_company_news**](CompanyApi.md#get_company_news) | **GET** /companies/{identifier}/news | Get News for a Company
[**get_company_securities**](CompanyApi.md#get_company_securities) | **GET** /companies/{identifier}/securities | Get Securities by Company
[**lookup_company_fundamental**](CompanyApi.md#lookup_company_fundamental) | **GET** /companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup a Fundamental for a Company
[**filter_company_fundamentals**](CompanyApi.md#filter_company_fundamentals) | **GET** /companies/{identifier}/fundamentals/filter | Filter Fundamentals by Company
[**get_all_companies**](CompanyApi.md#get_all_companies) | **GET** /companies | All Companies
[**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_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
[**get_company_fundamentals**](CompanyApi.md#get_company_fundamentals) | **GET** /companies/{identifier}/fundamentals | All Fundamentals by Company
[**get_company_historical_data**](CompanyApi.md#get_company_historical_data) | **GET** /companies/{identifier}/historical_data/{tag} | Historical Data for Company
[**get_company_news**](CompanyApi.md#get_company_news) | **GET** /companies/{identifier}/news | All News by Company
[**get_company_securities**](CompanyApi.md#get_company_securities) | **GET** /companies/{identifier}/securities | All Securities by Company
[**lookup_company_fundamental**](CompanyApi.md#lookup_company_fundamental) | **GET** /companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental by Company
[**search_companies**](CompanyApi.md#search_companies) | **GET** /companies/search | Search Companies


Expand Down Expand Up @@ -75,7 +75,7 @@ Name | Type | Description | Notes
# **filter_company_fundamentals**
> ApiResponseCompanyFundamentals filter_company_fundamentals(identifier, filed_after=filed_after, filed_before=filed_before, reported_only=reported_only, fiscal_year=fiscal_year, statement_code=statement_code, type=type, start_date=start_date, end_date=end_date, next_page=next_page)
Filter Fundamentals for a Company
Filter Fundamentals by Company

Returns Fundamentals for the Company with the given `identifier` and matching the specified filters

Expand Down Expand Up @@ -133,7 +133,9 @@ Name | Type | Description | Notes
# **get_all_companies**
> ApiResponseCompanies get_all_companies(next_page=next_page)
Get All Companies
All Companies

Returns all Companies

### Example
```python
Expand Down Expand Up @@ -171,9 +173,9 @@ Name | Type | Description | Notes
# **get_all_company_news**
> ApiResponseNews get_all_company_news(next_page=next_page)
Get All Company News
All News

Returns all news for all companies
Returns all News for all Companies

### Example
```python
Expand Down Expand Up @@ -211,7 +213,9 @@ Name | Type | Description | Notes
# **get_company**
> Company get_company(identifier)
Get a Company by ID
Lookup Company

Returns the Company with the given `identifier`

### Example
```python
Expand Down Expand Up @@ -249,7 +253,7 @@ Name | Type | Description | Notes
# **get_company_data_point_number**
> float get_company_data_point_number(identifier, tag)
Get Company Data Point (Number)
Data Point (Number) for Company

Returns a numeric value for the given `tag` for the Company with the given `identifier`

Expand Down Expand Up @@ -291,7 +295,7 @@ Name | Type | Description | Notes
# **get_company_data_point_text**
> str get_company_data_point_text(identifier, tag)
Get Company Data Point (Text)
Data Point (Text) for Company

Returns a text value for the given `tag` for the Company with the given `identifier`

Expand Down Expand Up @@ -333,7 +337,7 @@ Name | Type | Description | Notes
# **get_company_filings**
> ApiResponseCompanyFilings get_company_filings(identifier, next_page=next_page)
Get Filings for a Company
All Filings by Company

Returns a complete list of SEC filings for the Company with the given `identifier`

Expand Down Expand Up @@ -375,7 +379,7 @@ Name | Type | Description | Notes
# **get_company_fundamentals**
> ApiResponseCompanyFundamentals get_company_fundamentals(identifier, next_page=next_page)
Get All Fundamentals for a Company
All Fundamentals by Company

Returns all Fundamentals for the Company with the given `identifier`

Expand Down Expand Up @@ -415,9 +419,9 @@ Name | Type | Description | Notes
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_company_historical_data**
> ApiResponseCompanyHistoricalData get_company_historical_data(identifier, tag, type=type, start_date=start_date, end_date=end_date, sort_order=sort_order, next_page=next_page)
> ApiResponseCompanyHistoricalData get_company_historical_data(identifier, tag, frequency=frequency, type=type, start_date=start_date, end_date=end_date, sort_order=sort_order, next_page=next_page)
Get Company Historical Data
Historical Data for Company

Returns historical values for the given `tag` and the Company with the given `identifier`

Expand All @@ -434,15 +438,16 @@ intrinio_sdk.ApiClient().configuration.api_key['api_key'] = 'YOUR_API_KEY'
company_api = intrinio_sdk.CompanyApi()

identifier = 'AAPL' # str | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
tag = 'marketcap' # str | Item
tag = 'marketcap' # str | An Intrinio data-tag
frequency = 'daily' # str | Return historical data in the given frequency (optional) (default to daily)
type = '' # str | Filter by type, when applicable (optional)
start_date = '2018-01-01' # date | Get historical data on or after this date (optional)
end_date = '2019-01-01' # date | Get historical data on or before this date (optional)
sort_order = 'desc' # str | Sort by date `asc` or `desc` (optional) (default to desc)
next_page = '' # str | Gets the next page of data from a previous API call (optional)

try:
api_response = company_api.get_company_historical_data(identifier, tag, type=type, start_date=start_date, end_date=end_date, sort_order=sort_order, next_page=next_page)
api_response = company_api.get_company_historical_data(identifier, tag, frequency=frequency, type=type, start_date=start_date, end_date=end_date, sort_order=sort_order, next_page=next_page)
pprint(api_response)
except ApiException as e:
print("Exception when calling CompanyApi->get_company_historical_data: %s\n" % e)
Expand All @@ -453,7 +458,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | **str**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |
**tag** | **str**| Item |
**tag** | **str**| An Intrinio data-tag |
**frequency** | **str**| Return historical data in the given frequency | [optional] [default to daily]
**type** | **str**| Filter by type, when applicable | [optional]
**start_date** | **date**| Get historical data on or after this date | [optional]
**end_date** | **date**| Get historical data on or before this date | [optional]
Expand All @@ -469,7 +475,7 @@ Name | Type | Description | Notes
# **get_company_news**
> ApiResponseCompanyNews get_company_news(identifier, next_page=next_page)
Get News for a Company
All News by Company

Returns news for the Company with the given `identifier`

Expand Down Expand Up @@ -511,9 +517,9 @@ Name | Type | Description | Notes
# **get_company_securities**
> ApiResponseCompanySecurities get_company_securities(identifier, next_page=next_page)
Get Securities by Company
All Securities by Company

Return Securities for the Company with `identifier`
Returns Securities for the Company with the given `identifier`

### Example
```python
Expand Down Expand Up @@ -553,7 +559,7 @@ Name | Type | Description | Notes
# **lookup_company_fundamental**
> Fundamental lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year)
Lookup a Fundamental for a Company
Lookup Fundamental by Company

Returns the Fundamental for the Company with the given `identifier` and with the given parameters

Expand Down
8 changes: 4 additions & 4 deletions docs/DataPointApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ All URIs are relative to *https://api-v2.intrinio.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_data_point_number**](DataPointApi.md#get_data_point_number) | **GET** /data_point/{identifier}/{tag}/number | Get a Data Point (Number)
[**get_data_point_text**](DataPointApi.md#get_data_point_text) | **GET** /data_point/{identifier}/{tag}/text | Get a Data Point (Text)
[**get_data_point_number**](DataPointApi.md#get_data_point_number) | **GET** /data_point/{identifier}/{tag}/number | Data Point (Number)
[**get_data_point_text**](DataPointApi.md#get_data_point_text) | **GET** /data_point/{identifier}/{tag}/text | Data Point (Text)


# **get_data_point_number**
> float get_data_point_number(identifier, tag)
Get a Data Point (Number)
Data Point (Number)

Returns a numeric value for the given `tag` and the entity with the given `identifier`

Expand Down Expand Up @@ -53,7 +53,7 @@ Name | Type | Description | Notes
# **get_data_point_text**
> str get_data_point_text(identifier, tag)
Get a Data Point (Text)
Data Point (Text)

Returns a text value for the given `tag` and the entity with the given `identifier`

Expand Down
10 changes: 5 additions & 5 deletions docs/DataTagApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ All URIs are relative to *https://api-v2.intrinio.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**filter_data_tags**](DataTagApi.md#filter_data_tags) | **GET** /data_tags/filter | Filter Data Tags
[**get_all_data_tags**](DataTagApi.md#get_all_data_tags) | **GET** /data_tags | Get All Data Tags
[**get_data_tag_by_id**](DataTagApi.md#get_data_tag_by_id) | **GET** /data_tags/{identifier} | Get a Data Tag by ID
[**get_all_data_tags**](DataTagApi.md#get_all_data_tags) | **GET** /data_tags | All Data Tags
[**get_data_tag_by_id**](DataTagApi.md#get_data_tag_by_id) | **GET** /data_tags/{identifier} | Lookup Data Tag
[**search_data_tags**](DataTagApi.md#search_data_tags) | **GET** /data_tags/search | Search Data Tags


Expand Down Expand Up @@ -63,7 +63,7 @@ Name | Type | Description | Notes
# **get_all_data_tags**
> ApiResponseDataTags get_all_data_tags(next_page=next_page)
Get All Data Tags
All Data Tags

Returns All Data Tags

Expand Down Expand Up @@ -103,9 +103,9 @@ Name | Type | Description | Notes
# **get_data_tag_by_id**
> DataTag get_data_tag_by_id(identifier)
Get a Data Tag by ID
Lookup Data Tag

Returns a Data Tag with the specified `identifier`
Returns the Data Tag with the given `identifier`

### Example
```python
Expand Down
19 changes: 19 additions & 0 deletions docs/DividendRecord.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# DividendRecord

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ex_dividend** | **float** | Amount of dividend in US dollars | [optional]
**currency** | **str** | The 3-digit currency code the dividend amount was reported in | [optional]
**announcement_date** | **date** | Date dividend was announced | [optional]
**record_date** | **date** | Date before which holders-of-record will receive the dividend | [optional]
**pay_date** | **date** | Date the divdiend was paid | [optional]
**frequency** | **str** | Identifies payment frequency of announced dividend | [optional]
**status** | **str** | Status of the dividend | [optional]
**forward_yield** | **float** | The forward dividend yield | [optional]
**forward_rate** | **float** | The forward dividend rate | [optional]
**security** | [**SecuritySummary**](SecuritySummary.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


32 changes: 32 additions & 0 deletions docs/EarningsRecord.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# EarningsRecord

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**quarter** | **str** | The letter “Q” followed by the quarter number the earnings information applies to | [optional]
**time_of_day** | **str** | Indicates the time of the announcement | [optional]
**broadcast_url** | **str** | Link for Conference Call recording | [optional]
**transcript_url** | **str** | Link to the earnings release transcript | [optional]
**transcript_quarter** | **str** | The letter “Q” followed by the quarter number the earnings transcript applies to | [optional]
**transcript_fiscal_year** | **str** | Fiscal year in YYYY format for the earnings transcript | [optional]
**conference_call_date** | **date** | Date of the conference call | [optional]
**conference_call_time** | **str** | Published time of the conference call | [optional]
**conference_call_phone_number** | **str** | Publicly available phone number for replay conference call | [optional]
**conference_call_passcode** | **str** | Passcode for replay conference call | [optional]
**last_confirmation_date** | **date** | Date of last earnings date update by a WSH analyst | [optional]
**board_of_directors_meeting_date** | **date** | Date of Board/Shareholder Meeting | [optional]
**board_of_directors_meeting_type** | **str** | The type of meeting - \"B\" indicates a Board of Directors meeting and \"S\" indicates a Shareholder meeting | [optional]
**company_website** | **str** | Website link for the company | [optional]
**q1_date** | **date** | Earnings Date for 1st quarter | [optional]
**q2_date** | **date** | Earnings Date for 2nd quarter | [optional]
**q3_date** | **date** | Earnings Date for 3rd quarter | [optional]
**q4_date** | **date** | Earnings Date for 4th quarter | [optional]
**type** | **str** | The nature of the next reported earnings date - \"V\" indicates a Verified date, \"T\" indicates that the date was gathered from the company, but is still considered Tentative, and \"I\" indicates that the date is forecased or Inferred | [optional]
**next_earnings_date** | **date** | Next earnings date | [optional]
**next_earnings_quarter** | **str** | The quarter of the next earnings release | [optional]
**next_earnings_fiscal_year** | **int** | The fiscal year associated with next earnings date and next earnings quarter | [optional]
**security** | [**SecuritySummary**](SecuritySummary.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading

0 comments on commit e41737e

Please sign in to comment.