Equibles Stocks API for Java

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.equibles.stocks</groupId>
  <artifactId>equibles-stocks</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.equibles.stocks:equibles-stocks:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/equibles-stocks-1.0.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.equibles.stocks.*;
import com.equibles.stocks.auth.*;
import com.equibles.stocks.models.*;
import com.equibles.stocks.api.ExchangesApi;

import java.io.File;
import java.util.*;

public class ExchangesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Query String
        ApiKeyAuth Query String = (ApiKeyAuth) defaultClient.getAuthentication("Query String");
        Query String.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Query String.setApiKeyPrefix("Token");

        ExchangesApi apiInstance = new ExchangesApi();
        try {
            CurrenciesResponse result = apiInstance.currencies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExchangesApi#currencies");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ExchangesApi	currencies	GET /stocks/exchanges/currencies	Get the list of all the currencies supported by this API.
ExchangesApi	list	GET /stocks/exchanges/list	Get the list of all the exchanges supported by this API.
ExchangesApi	stocks	GET /stocks/exchanges/stocks	Get all the stocks for a given exchange.
FundamentalsApi	dividends	GET /stocks/fundamentals/dividends	Get the dividends for a given stock.
FundamentalsApi	financialReports	GET /stocks/fundamentals/financialreports	Get the financial statements for a given stock.
MetricsApi	priceToEarnings	GET /stocks/metrics/pricetoearnings	Get the price to earnings ratio over time for this stock.
NewsApi	list	GET /stocks/news/list	Get the latest news for this stock.
NewsApi	publishers	GET /stocks/news/publishers	Get all the available news publishers.
PerformanceApi	list	GET /stocks/performance/list	Lists the performance for a given stock.
PricesApi	endOfDay	GET /stocks/prices/endofday	Lists the end of day prices for a given stock.
SectorsApi	list	GET /stocks/sectors/list	Lists all the sectors.
SectorsApi	searchStocks	GET /stocks/sectors/searchstocks	Lists and the stock in a given sector/industry.
StocksApi	list	GET /stocks/list	Get a list of all the available stocks.
StocksApi	officers	GET /stocks/officers	Get the officers of the company.
StocksApi	profile	GET /stocks/profile	The profile of this stock.
StocksApi	screener	POST /stocks/screener	Get a list of stocks constraint to several criteria.
StocksApi	search	GET /stocks/search	Search among all the available stocks.
StocksApi	splits	GET /stocks/splits	Get all the splits for a given stock.
TransactionsApi	insiders	GET /stocks/transactions/insiders	Lists the insider transactions for a given stock.
TransactionsApi	institutional	GET /stocks/transactions/institutional	Lists the institutional transactions for a given stock.

Documentation for Models

• AssetType
• BalanceSheet
• CashFlowStatement
• CommonStock
• CommonStockResponse
• CommonStocksResponse
• CurrenciesResponse
• Currency
• Dividend
• DividendsResponse
• Exchange
• ExchangesResponse
• FinancialAssetsResponse
• FinancialReport
• FiscalPeriod
• FundamentalsResponse
• Image
• IncomeStatement
• Industry
• MetricNullablePointsResponse
• News
• NewsResponse
• NullablePoint
• Officer
• OfficersResponse
• Performance
• PerformanceResponse
• Price
• PricesResponse
• Publisher
• PublishersResponse
• Recommendation
• ResponseStatus
• ScreenerRequest
• Sector
• SectorsResponse
• SplitsResponse
• StockSplit
• Transaction
• TransactionType
• TransactionsResponse

Documentation for Authorization

Authentication schemes defined for the API:

Query String

• Type: API key
• API key parameter name: ApiKey
• Location: URL query string

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

Equibles
equibles@gmail.com