Equibles.Stocks.Api.StocksApi

All URIs are relative to https://api.equibles.com

Method	HTTP request	Description
CallList	GET /stocks/list	List Stocks
Officers	GET /stocks/officers	Officers
Profile	GET /stocks/profile	Profile
Screener	POST /stocks/screener	Screener
Search	GET /stocks/search	Search
Splits	GET /stocks/splits	Splits

CallList

StockProfilesResponse CallList (string apiKey, int? page, int? pageSize)

List Stocks

Get a list of all the available stocks.

Example

using System;
using System.Diagnostics;
using Equibles.Stocks.Api;
using Equibles.Stocks.Client;
using Equibles.Stocks.Model;

namespace Example
{
    public class CallListExample
    {
        public void main()
        {
            // Configure API key authorization: Query String
            Configuration.Default.AddApiKey("apiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("apiKey", "Bearer");

            var apiInstance = new StocksApi();
            var apiKey = apiKey_example;  // string | 
            var page = 56;  // int? | The number of the page to request. (optional)  (default to 1)
            var pageSize = 56;  // int? | The number of elements in each page. Max value: 100. (optional)  (default to 100)

            try
            {
                // List Stocks
                StockProfilesResponse result = apiInstance.CallList(apiKey, page, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StocksApi.CallList: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
apiKey	string
page	int?	The number of the page to request.	[optional] [default to 1]
pageSize	int?	The number of elements in each page. Max value: 100.	[optional] [default to 100]

Return type

StockProfilesResponse

Authorization

[Query String](../README.md#Query String)

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Officers

OfficersResponse Officers (string apiKey, string fullTicker)

Officers

Get the officers of the company.

Example

using System;
using System.Diagnostics;
using Equibles.Stocks.Api;
using Equibles.Stocks.Client;
using Equibles.Stocks.Model;

namespace Example
{
    public class OfficersExample
    {
        public void main()
        {
            // Configure API key authorization: Query String
            Configuration.Default.AddApiKey("apiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("apiKey", "Bearer");

            var apiInstance = new StocksApi();
            var apiKey = apiKey_example;  // string | 
            var fullTicker = fullTicker_example;  // string | The fully qualified ticker of the stock. Example: AAPL.XNAS

            try
            {
                // Officers
                OfficersResponse result = apiInstance.Officers(apiKey, fullTicker);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StocksApi.Officers: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
apiKey	string
fullTicker	string	The fully qualified ticker of the stock. Example: AAPL.XNAS

Return type

OfficersResponse

Authorization

[Query String](../README.md#Query String)

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Profile

StockProfileResponse Profile (string apiKey, string fullTicker)

Profile

Returns the profile of a given stock.

Example

using System;
using System.Diagnostics;
using Equibles.Stocks.Api;
using Equibles.Stocks.Client;
using Equibles.Stocks.Model;

namespace Example
{
    public class ProfileExample
    {
        public void main()
        {
            // Configure API key authorization: Query String
            Configuration.Default.AddApiKey("apiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("apiKey", "Bearer");

            var apiInstance = new StocksApi();
            var apiKey = apiKey_example;  // string | 
            var fullTicker = fullTicker_example;  // string | The fully qualified ticker of the stock. Example: AAPL.XNAS

            try
            {
                // Profile
                StockProfileResponse result = apiInstance.Profile(apiKey, fullTicker);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StocksApi.Profile: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
apiKey	string
fullTicker	string	The fully qualified ticker of the stock. Example: AAPL.XNAS

Return type

StockProfileResponse

Authorization

[Query String](../README.md#Query String)

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Screener

StockProfilesResponse Screener (ScreenerRequest body, string apiKey, int? page, int? pageSize)

Screener

Get a list of the stocks constraint to several criteria. You only need to fill the fields that you want to use as filters.

Example

using System;
using System.Diagnostics;
using Equibles.Stocks.Api;
using Equibles.Stocks.Client;
using Equibles.Stocks.Model;

namespace Example
{
    public class ScreenerExample
    {
        public void main()
        {
            // Configure API key authorization: Query String
            Configuration.Default.AddApiKey("apiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("apiKey", "Bearer");

            var apiInstance = new StocksApi();
            var body = new ScreenerRequest(); // ScreenerRequest | The criteria used to filter the search results. You only need to fill the fields that you want to use on the search.
            var apiKey = apiKey_example;  // string | 
            var page = 56;  // int? | The number of the page to request. (optional)  (default to 1)
            var pageSize = 56;  // int? | The number of elements in each page. Max value: 100. (optional)  (default to 100)

            try
            {
                // Screener
                StockProfilesResponse result = apiInstance.Screener(body, apiKey, page, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StocksApi.Screener: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	ScreenerRequest	The criteria used to filter the search results. You only need to fill the fields that you want to use on the search.
apiKey	string
page	int?	The number of the page to request.	[optional] [default to 1]
pageSize	int?	The number of elements in each page. Max value: 100.	[optional] [default to 100]

Return type

StockProfilesResponse

Authorization

[Query String](../README.md#Query String)

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Search

StockProfilesResponse Search (string apiKey, string text, int? page, int? pageSize)

Search

Search among all the available stocks.

Example

using System;
using System.Diagnostics;
using Equibles.Stocks.Api;
using Equibles.Stocks.Client;
using Equibles.Stocks.Model;

namespace Example
{
    public class SearchExample
    {
        public void main()
        {
            // Configure API key authorization: Query String
            Configuration.Default.AddApiKey("apiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("apiKey", "Bearer");

            var apiInstance = new StocksApi();
            var apiKey = apiKey_example;  // string | 
            var text = text_example;  // string | The text to search for.
            var page = 56;  // int? | The number of the page to request. (optional)  (default to 1)
            var pageSize = 56;  // int? | The number of elements in each page. Max value: 100. (optional)  (default to 100)

            try
            {
                // Search
                StockProfilesResponse result = apiInstance.Search(apiKey, text, page, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StocksApi.Search: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
apiKey	string
text	string	The text to search for.
page	int?	The number of the page to request.	[optional] [default to 1]
pageSize	int?	The number of elements in each page. Max value: 100.	[optional] [default to 100]

Return type

StockProfilesResponse

Authorization

[Query String](../README.md#Query String)

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Splits

SplitsResponse Splits (string apiKey, string fullTicker, int? page, int? pageSize)

Splits

Get all the splits for a given stock.

Example

using System;
using System.Diagnostics;
using Equibles.Stocks.Api;
using Equibles.Stocks.Client;
using Equibles.Stocks.Model;

namespace Example
{
    public class SplitsExample
    {
        public void main()
        {
            // Configure API key authorization: Query String
            Configuration.Default.AddApiKey("apiKey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("apiKey", "Bearer");

            var apiInstance = new StocksApi();
            var apiKey = apiKey_example;  // string | 
            var fullTicker = fullTicker_example;  // string | The fully qualified ticker of the stock. Example: AAPL.XNAS
            var page = 56;  // int? | The number of the page to request. (optional)  (default to 1)
            var pageSize = 56;  // int? | The number of elements in each page. Max value: 1000. (optional)  (default to 1000)

            try
            {
                // Splits
                SplitsResponse result = apiInstance.Splits(apiKey, fullTicker, page, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StocksApi.Splits: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
apiKey	string
fullTicker	string	The fully qualified ticker of the stock. Example: AAPL.XNAS
page	int?	The number of the page to request.	[optional] [default to 1]
pageSize	int?	The number of elements in each page. Max value: 1000.	[optional] [default to 1000]

Return type

SplitsResponse

Authorization

[Query String](../README.md#Query String)

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

StocksApi.md

Latest commit

History

StocksApi.md

File metadata and controls

Equibles.Stocks.Api.StocksApi

CallList

Example

Parameters

Return type

Authorization

HTTP request headers

Officers

Example

Parameters

Return type

Authorization

HTTP request headers

Profile

Example

Parameters

Return type

Authorization

HTTP request headers

Screener

Example

Parameters

Return type

Authorization

HTTP request headers

Search

Example

Parameters

Return type

Authorization

HTTP request headers

Splits

Example

Parameters

Return type

Authorization

HTTP request headers