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
alexread730 committed Apr 14, 2021
1 parent b5fac21 commit 3359e99
Show file tree
Hide file tree
Showing 17 changed files with 970 additions and 88 deletions.
9 changes: 6 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://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.19.0
- Package version: 5.9.1
- API version: 2.20.0
- Package version: 5.10.0


<a name="frameworks-supported"></a>
Expand Down Expand Up @@ -192,7 +192,9 @@ Class | Method | HTTP request | Description
*MunicipalityApi* | [**GetAllMunicipalities**](docs/MunicipalityApi.md#getallmunicipalities) | **GET** /municipalities | All Municipalities
*MunicipalityApi* | [**GetMunicipalityById**](docs/MunicipalityApi.md#getmunicipalitybyid) | **GET** /municipalities/{id} | Municipality by ID
*MunicipalityApi* | [**GetMunicipalityFinancials**](docs/MunicipalityApi.md#getmunicipalityfinancials) | **GET** /municipalities/{id}/financials | Financials for a Municipality
*OptionsApi* | [**GetOptionExpirationsRealtime**](docs/OptionsApi.md#getoptionexpirationsrealtime) | **GET** /options/expirations/{symbol}/realtime | Option Expirations Realtime
*OptionsApi* | [**GetOptions**](docs/OptionsApi.md#getoptions) | **GET** /options/{symbol} | Options
*OptionsApi* | [**GetOptionsBySymbolRealtime**](docs/OptionsApi.md#getoptionsbysymbolrealtime) | **GET** /options/{symbol}/realtime | Options by Symbol Realtime
*OptionsApi* | [**GetOptionsChain**](docs/OptionsApi.md#getoptionschain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain
*OptionsApi* | [**GetOptionsChainRealtime**](docs/OptionsApi.md#getoptionschainrealtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
*OptionsApi* | [**GetOptionsExpirations**](docs/OptionsApi.md#getoptionsexpirations) | **GET** /options/expirations/{symbol} | Options Expirations
Expand Down Expand Up @@ -248,7 +250,7 @@ Class | Method | HTTP request | Description
*SecurityApi* | [**GetSecurityRealtimePrice**](docs/SecurityApi.md#getsecurityrealtimeprice) | **GET** /securities/{identifier}/prices/realtime | Realtime Stock Price for Security
*SecurityApi* | [**GetSecurityStockPriceAdjustments**](docs/SecurityApi.md#getsecuritystockpriceadjustments) | **GET** /securities/{identifier}/prices/adjustments | Stock Price Adjustments by Security
*SecurityApi* | [**GetSecurityStockPrices**](docs/SecurityApi.md#getsecuritystockprices) | **GET** /securities/{identifier}/prices | Stock Prices by Security
*SecurityApi* | [**GetSecurityZacksAnalystRatings**](docs/SecurityApi.md#getsecurityzacksanalystratings) | **GET** /securities/{identifier}/zacks/analyst_ratings | Zacks Analyst Ratings
*SecurityApi* | [**GetSecurityZacksAnalystRatings**](docs/SecurityApi.md#getsecurityzacksanalystratings) | **GET** /securities/{identifier}/zacks/analyst_ratings | Zacks Analyst Ratings for Security
*SecurityApi* | [**GetSecurityZacksAnalystRatingsSnapshot**](docs/SecurityApi.md#getsecurityzacksanalystratingssnapshot) | **GET** /securities/{identifier}/zacks/analyst_ratings/snapshot | Zacks Analyst Ratings Snapshot
*SecurityApi* | [**GetSecurityZacksEpsSurprises**](docs/SecurityApi.md#getsecurityzacksepssurprises) | **GET** /securities/{identifier}/zacks/eps_surprises | Zacks EPS Surprises for Security
*SecurityApi* | [**GetSecurityZacksSalesSurprises**](docs/SecurityApi.md#getsecurityzackssalessurprises) | **GET** /securities/{identifier}/zacks/sales_surprises | Zacks Sales Surprises for Security
Expand Down Expand Up @@ -343,6 +345,7 @@ Class | Method | HTTP request | Description
- [Model.ApiResponseOptionsChainRealtime](docs/ApiResponseOptionsChainRealtime.md)
- [Model.ApiResponseOptionsExpirations](docs/ApiResponseOptionsExpirations.md)
- [Model.ApiResponseOptionsPriceRealtime](docs/ApiResponseOptionsPriceRealtime.md)
- [Model.ApiResponseOptionsRealtime](docs/ApiResponseOptionsRealtime.md)
- [Model.ApiResponseOptionsStatsRealtime](docs/ApiResponseOptionsStatsRealtime.md)
- [Model.ApiResponseOwnerInsiderTransactionFilings](docs/ApiResponseOwnerInsiderTransactionFilings.md)
- [Model.ApiResponseOwnerInstitutionalHoldings](docs/ApiResponseOwnerInstitutionalHoldings.md)
Expand Down
19 changes: 19 additions & 0 deletions docs/ApiResponseOptionsRealtime.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[//]: # (CLASS:Intrinio.SDK.Model.ApiResponseOptionsRealtime)

[//]: # (KIND:object)

### Intrinio.SDK.Model.ApiResponseOptionsRealtime
#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**Options** | [**List&lt;OptionRealtime&gt;**](OptionRealtime.md) | A list of options contracts with the given symbol &nbsp;

[//]: # (END_DEFINITION)


[//]: # (CONTAINED_CLASS:Intrinio.SDK.Model.OptionRealtime)


12 changes: 2 additions & 10 deletions docs/CompanyApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -1203,7 +1203,7 @@ Name | Type | Description | Notes

[//]: # (START_OVERVIEW)

> InsiderTransactionFiling LatestInsiderTransactionFilingByCompany (string identifier, DateTime? startDate = null, DateTime? endDate = null, string ownershipType = null, int? pageSize = null, string nextPage = null)
> InsiderTransactionFiling LatestInsiderTransactionFilingByCompany (string identifier, string nextPage = null)
#### Latest Insider Transaction Filing by Company

Expand Down Expand Up @@ -1237,13 +1237,9 @@ namespace Example
var companyApi = new CompanyApi();

string identifier = "AAPL";
DateTime? startDate = DateTime.Parse("2018-01-01");
DateTime? endDate = DateTime.Parse("2019-01-01");
string ownershipType = "D";
int? pageSize = 100;
string nextPage = null;

InsiderTransactionFiling result = companyApi.LatestInsiderTransactionFilingByCompany(identifier, startDate, endDate, ownershipType, pageSize, nextPage);
InsiderTransactionFiling result = companyApi.LatestInsiderTransactionFilingByCompany(identifier, nextPage);
Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
}
}
Expand All @@ -1260,10 +1256,6 @@ namespace Example
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | string| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | &nbsp;
**startDate** | DateTime?| Return Company&#39;s insider transaction filings on or after this date | [optional] &nbsp;
**endDate** | DateTime?| Return Company&#39;s insider transaction filings on or before this date | [optional] &nbsp;
**ownershipType** | string| The type of ownership to return transaction filings for. &#39;D&#39; is for direct transactions. &#39;I&#39; is for indirect transactions. Omit for both types. | [optional] &nbsp;
**pageSize** | int?| The number of results to return | [optional] [default to 100] &nbsp;
**nextPage** | string| Gets the next page of data from a previous API call | [optional] &nbsp;
<br/>

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**GetOptionExpirationsRealtime**](OptionsApi.md#getoptionexpirationsrealtime) | **GET** /options/expirations/{symbol}/realtime | Option Expirations Realtime
[**GetOptions**](OptionsApi.md#getoptions) | **GET** /options/{symbol} | Options
[**GetOptionsBySymbolRealtime**](OptionsApi.md#getoptionsbysymbolrealtime) | **GET** /options/{symbol}/realtime | Options by Symbol Realtime
[**GetOptionsChain**](OptionsApi.md#getoptionschain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain
[**GetOptionsChainRealtime**](OptionsApi.md#getoptionschainrealtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
[**GetOptionsExpirations**](OptionsApi.md#getoptionsexpirations) | **GET** /options/expirations/{symbol} | Options Expirations
Expand All @@ -14,6 +16,100 @@ Method | HTTP request | Description



[//]: # (START_OPERATION)

[//]: # (CLASS:Intrinio.SDK.Api.OptionsApi)

[//]: # (METHOD:GetOptionExpirationsRealtime)

[//]: # (RETURN_TYPE:Intrinio.SDK.Model.ApiResponseOptionsExpirations)

[//]: # (RETURN_TYPE_KIND:object)

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

[//]: # (OPERATION:GetOptionExpirationsRealtime_v2)

[//]: # (ENDPOINT:/options/expirations/{symbol}/realtime)

[//]: # (DOCUMENT_LINK:OptionsApi.md#getoptionexpirationsrealtime)

<a name="getoptionexpirationsrealtime"></a>
## **GetOptionExpirationsRealtime**

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

[//]: # (START_OVERVIEW)

> ApiResponseOptionsExpirations GetOptionExpirationsRealtime (string symbol, string after = null, string before = null, string source = null)
#### Option Expirations Realtime

Returns all realtime option contract expiration dates for a given symbol.

[//]: # (END_OVERVIEW)

### Example

[//]: # (START_CODE_EXAMPLE)

```csharp
using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
public class GetOptionExpirationsRealtimeExample
{
public static void Main()
{
Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
Configuration.Default.AllowRetries = true;

var optionsApi = new OptionsApi();

string symbol = "MSFT";
string after = "2022-01-01";
string before = "2023-04-01";
string source = null;

ApiResponseOptionsExpirations result = optionsApi.GetOptionExpirationsRealtime(symbol, after, before, source);
Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
}
}
}
```

[//]: # (END_CODE_EXAMPLE)

### Parameters

[//]: # (START_PARAMETERS)


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**symbol** | string| The option symbol, corresponding to the underlying security. | &nbsp;
**after** | string| Return option contract expiration dates after this date. | [optional] &nbsp;
**before** | string| Return option contract expiration dates before this date. | [optional] &nbsp;
**source** | string| Realtime or 15-minute delayed contracts. | [optional] &nbsp;
<br/>

[//]: # (END_PARAMETERS)

### Return type

[**ApiResponseOptionsExpirations**](ApiResponseOptionsExpirations.md)

[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

[//]: # (CLASS:Intrinio.SDK.Api.OptionsApi)
Expand Down Expand Up @@ -120,6 +216,110 @@ Name | Type | Description | Notes
[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

[//]: # (CLASS:Intrinio.SDK.Api.OptionsApi)

[//]: # (METHOD:GetOptionsBySymbolRealtime)

[//]: # (RETURN_TYPE:Intrinio.SDK.Model.ApiResponseOptionsRealtime)

[//]: # (RETURN_TYPE_KIND:object)

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

[//]: # (OPERATION:GetOptionsBySymbolRealtime_v2)

[//]: # (ENDPOINT:/options/{symbol}/realtime)

[//]: # (DOCUMENT_LINK:OptionsApi.md#getoptionsbysymbolrealtime)

<a name="getoptionsbysymbolrealtime"></a>
## **GetOptionsBySymbolRealtime**

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

[//]: # (START_OVERVIEW)

> ApiResponseOptionsRealtime GetOptionsBySymbolRealtime (string symbol, string type = null, decimal? strike = null, decimal? strikeGreaterThan = null, decimal? strikeLessThan = null, string expiration = null, string expirationAfter = null, string expirationBefore = null, string source = null)
#### Options by Symbol Realtime

Returns the master list of realtime option contracts for a given symbol.

[//]: # (END_OVERVIEW)

### Example

[//]: # (START_CODE_EXAMPLE)

```csharp
using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
public class GetOptionsBySymbolRealtimeExample
{
public static void Main()
{
Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
Configuration.Default.AllowRetries = true;

var optionsApi = new OptionsApi();

string symbol = "AAPL";
string type = "put";
decimal? strike = 170;
decimal? strikeGreaterThan = 150;
decimal? strikeLessThan = 190;
string expiration = "2022-04-16";
string expirationAfter = "2022-01-01";
string expirationBefore = "2023-12-31";
string source = null;

ApiResponseOptionsRealtime result = optionsApi.GetOptionsBySymbolRealtime(symbol, type, strike, strikeGreaterThan, strikeLessThan, expiration, expirationAfter, expirationBefore, source);
Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
}
}
}
```

[//]: # (END_CODE_EXAMPLE)

### Parameters

[//]: # (START_PARAMETERS)


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**symbol** | string| The option symbol, corresponding to the underlying security. | &nbsp;
**type** | string| The option contract type. | [optional] &nbsp;
**strike** | decimal?| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional] &nbsp;
**strikeGreaterThan** | decimal?| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional] &nbsp;
**strikeLessThan** | decimal?| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional] &nbsp;
**expiration** | string| The expiration date of the option contract. This will return options contracts with expiration dates on this date. | [optional] &nbsp;
**expirationAfter** | string| The expiration date of the option contract. This will return options contracts with expiration dates after this date. | [optional] &nbsp;
**expirationBefore** | string| The expiration date of the option contract. This will return options contracts with expiration dates before this date. | [optional] &nbsp;
**source** | string| Realtime or 15-minute delayed contracts. | [optional] &nbsp;
<br/>

[//]: # (END_PARAMETERS)

### Return type

[**ApiResponseOptionsRealtime**](ApiResponseOptionsRealtime.md)

[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

[//]: # (CLASS:Intrinio.SDK.Api.OptionsApi)
Expand Down
4 changes: 2 additions & 2 deletions docs/SecurityApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Method | HTTP request | Description
[**GetSecurityRealtimePrice**](SecurityApi.md#getsecurityrealtimeprice) | **GET** /securities/{identifier}/prices/realtime | Realtime Stock Price for Security
[**GetSecurityStockPriceAdjustments**](SecurityApi.md#getsecuritystockpriceadjustments) | **GET** /securities/{identifier}/prices/adjustments | Stock Price Adjustments by Security
[**GetSecurityStockPrices**](SecurityApi.md#getsecuritystockprices) | **GET** /securities/{identifier}/prices | Stock Prices by Security
[**GetSecurityZacksAnalystRatings**](SecurityApi.md#getsecurityzacksanalystratings) | **GET** /securities/{identifier}/zacks/analyst_ratings | Zacks Analyst Ratings
[**GetSecurityZacksAnalystRatings**](SecurityApi.md#getsecurityzacksanalystratings) | **GET** /securities/{identifier}/zacks/analyst_ratings | Zacks Analyst Ratings for Security
[**GetSecurityZacksAnalystRatingsSnapshot**](SecurityApi.md#getsecurityzacksanalystratingssnapshot) | **GET** /securities/{identifier}/zacks/analyst_ratings/snapshot | Zacks Analyst Ratings Snapshot
[**GetSecurityZacksEpsSurprises**](SecurityApi.md#getsecurityzacksepssurprises) | **GET** /securities/{identifier}/zacks/eps_surprises | Zacks EPS Surprises for Security
[**GetSecurityZacksSalesSurprises**](SecurityApi.md#getsecurityzackssalessurprises) | **GET** /securities/{identifier}/zacks/sales_surprises | Zacks Sales Surprises for Security
Expand Down Expand Up @@ -4422,7 +4422,7 @@ Name | Type | Description | Notes

> ApiResponseSecurityZacksAnalystRatings GetSecurityZacksAnalystRatings (string identifier, string startDate = null, string endDate = null, decimal? meanGreater = null, decimal? meanLess = null, int? strongBuysGreater = null, int? strongBuysLess = null, int? buysGreater = null, int? buysLess = null, int? holdsGreater = null, int? holdsLess = null, int? sellsGreater = null, int? sellsLess = null, int? strongSellsGreater = null, int? strongSellsLess = null, int? totalGreater = null, int? totalLess = null, int? pageSize = null)
#### Zacks Analyst Ratings
#### Zacks Analyst Ratings for Security

Returns buy, sell, and hold recommendations from analysts at brokerages for the Security with the given `identifier`. Zack’s storied research team aggregates and validates the ratings from professional analysts.

Expand Down
6 changes: 1 addition & 5 deletions src/Intrinio.SDK.Test/Api/CompanyApiTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -254,12 +254,8 @@ public void LatestInsiderTransactionFilingByCompanyTest()
{
// TODO uncomment below to test the method and replace null with proper value
//string identifier = null;
//DateTime? startDate = null;
//DateTime? endDate = null;
//string ownershipType = null;
//int? pageSize = null;
//string nextPage = null;
//var response = instance.LatestInsiderTransactionFilingByCompany(identifier, startDate, endDate, ownershipType, pageSize, nextPage);
//var response = instance.LatestInsiderTransactionFilingByCompany(identifier, nextPage);
//Assert.IsInstanceOf<InsiderTransactionFiling> (response, "response is InsiderTransactionFiling");
}

Expand Down
35 changes: 35 additions & 0 deletions src/Intrinio.SDK.Test/Api/OptionsApiTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,21 @@ public void InstanceTest()
}


/// <summary>
/// Test GetOptionExpirationsRealtime
/// </summary>
[Test]
public void GetOptionExpirationsRealtimeTest()
{
// TODO uncomment below to test the method and replace null with proper value
//string symbol = null;
//string after = null;
//string before = null;
//string source = null;
//var response = instance.GetOptionExpirationsRealtime(symbol, after, before, source);
//Assert.IsInstanceOf<ApiResponseOptionsExpirations> (response, "response is ApiResponseOptionsExpirations");
}

/// <summary>
/// Test GetOptions
/// </summary>
Expand All @@ -73,6 +88,26 @@ public void GetOptionsTest()
//Assert.IsInstanceOf<ApiResponseOptions> (response, "response is ApiResponseOptions");
}

/// <summary>
/// Test GetOptionsBySymbolRealtime
/// </summary>
[Test]
public void GetOptionsBySymbolRealtimeTest()
{
// TODO uncomment below to test the method and replace null with proper value
//string symbol = null;
//string type = null;
//decimal? strike = null;
//decimal? strikeGreaterThan = null;
//decimal? strikeLessThan = null;
//string expiration = null;
//string expirationAfter = null;
//string expirationBefore = null;
//string source = null;
//var response = instance.GetOptionsBySymbolRealtime(symbol, type, strike, strikeGreaterThan, strikeLessThan, expiration, expirationAfter, expirationBefore, source);
//Assert.IsInstanceOf<ApiResponseOptionsRealtime> (response, "response is ApiResponseOptionsRealtime");
}

/// <summary>
/// Test GetOptionsChain
/// </summary>
Expand Down
Loading

0 comments on commit 3359e99

Please sign in to comment.