Tiingoclient
A java REST client for the tiingo.com daily api
Install / Use
/learn @feikede/TiingoclientREADME
tiingoclient
Goal of this project is to provide a java client for the tiingo api with low dependencies and usable as maven and gradle import. Implement API for stocks descriptions, for single EOD quotes, for historical EOD quotes aka timeseries.
Requirements
Building the API client library requires Maven to be installed.
Installation
To install the API client library to your local Maven repository, simply execute:
mvn install
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn deploy
Refer to the official documentation for more information.
Maven users
TODO: Deploy project to maven central - it's not done until now Add this dependency to your project's POM:
<dependency>
<groupId>de.feike.tiingoclient1</groupId>
<artifactId>tiingoclient</artifactId>
<version>1.0.0</version>
<scope>compile</scope>
</dependency>
Gradle users
Add this dependency to your project's build file:
compile "de.feike.tiingoclient1:tiingoclient:1.0.0"
Others
At first generate the JAR by executing:
mvn package
Then manually install the following JARs:
- target/tiingoclient-1.0.0.jar
- target/lib/*.jar
Getting Started
Please follow the installation instruction and execute the following Java code:
import java.util.List;
import org.joda.time.LocalDate;
import org.junit.Test;
import de.feike.tiingoclient.ApiException;
import de.feike.tiingoclient.model.Price;
/**
* API tests for QoutesApi
*/
public class QoutesApiTest extends TestBase {
private final QoutesApi api = new QoutesApi();
@Test
public void dailySymbolPricesGetTest() throws ApiException {
LocalDate startDate = new LocalDate(2017, 5, 1);
LocalDate endDate = new LocalDate(2017, 5, 24);
List<Price> response = api.dailySymbolPricesGet("intc", "Token secret", startDate, endDate);
System.out.println(response.get(0).toString());
}
}
Documentation for API Endpoints
All URIs are relative to https://api.tiingo.com/tiingo
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- QoutesApi | dailySymbolPricesGet | GET /daily/{symbol}/prices | quote data for a fund or stock StocksApi | dailySymbolGet | GET /daily/{symbol} | To request meta data for a stock
Documentation for Models
Documentation for Authorization
All endpoints do require token authorization, see tiingo.com.
Recommendation
It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.
Author
Rainer Feike, 2017
