com.jimmoores.quandl

Class QuandlSession

java.lang.Object

com.jimmoores.quandl.QuandlSession

public final class QuandlSession
extends Object

Quandl session class. Create an instance with either

   QuandlSession.of(SessionOptions.withAuthToken(AUTH_TOKEN));
 

to use your API authorization token string, or use the API without a token, which may have lower rate/volume limits.

   QuandlSession.of();
 

Then call one of the methods to fetch data! You can either invoke withDefaultRetentionPolicy() on the session or withFrequency() on the DataSetRequest to hint the CacheManager whether it should load over the network or retrieve data from the cache

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_TOKEN_PARAM_NAME the parameter name for the authorization token (aka Quandl API key).

Method Summary

Modifier and Type	Method and Description
static QuandlSession	create() Create a Quandl session without an authorization token (authToken).
static QuandlSession	create(SessionOptions sessionOptions) Create a Quandl session with detailed SessionOptions.
static QuandlSession	create(String authToken) Create a Quandl session to use a specific authorization token (authToken) with all requests.
protected javax.ws.rs.client.Client	getClient() Allow the client to be overridden by a test subclass.
TabularResult	getDataSet(DataSetRequest request) Get a tabular data set from Quandl.
TabularResult	getDataSets(MultiDataSetRequest request) Deprecated. this call is provided for compatibility purposes and is deprecated, please use the single request mechanism
MetaDataResult	getMetaData(MetaDataRequest request) Get meta data from Quandl about a particular quandlCode.
MetaDataResult	getMetaData(MultiMetaDataRequest request) Get meta data from Quandl about a range of quandlCodes returned as a single MetaDataResult.
Map<String,HeaderDefinition>	getMultipleHeaderDefinition(MultiMetaDataRequest request) Deprecated. this now uses single calls to simulate multisets to support legacy code
SearchResult	search(SearchRequest request) Get search results from Quandl.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AUTH_TOKEN_PARAM_NAME

public static final String AUTH_TOKEN_PARAM_NAME

the parameter name for the authorization token (aka Quandl API key).

See Also:

Constant Field Values

Method Detail

create

public static QuandlSession create(String authToken)

Create a Quandl session to use a specific authorization token (authToken) with all requests. Using a token means you can make more requests. Note that this method does not check the quandl.auth.token property. Creating this object does not make any actual API requests, the token is used in subsequent requests.

Parameters:

authToken - a Quandl API authorization token

Returns:

an instance of the Quandl session with an embedded authorization token

create

public static QuandlSession create()

Create a Quandl session without an authorization token (authToken). An attempt will be made to read the java property quandl.auth.token and use that if available. Any resulting SecurityException is logged at debug level, otherwise it is ignored and no auth token is used. Using a token means you can make more requests. Note creating this object does not make any actual API requests, the token is used in subsequent requests.

Returns:

an instance of the Quandl session, not null.

create

public static QuandlSession create(SessionOptions sessionOptions)

Create a Quandl session with detailed SessionOptions. No attempt will be made to read the java property quandl.auth.token even if available. Note creating this object does not make any actual API requests, the token is used in subsequent requests.

Parameters:

sessionOptions - a user created SessionOptions instance, not null

Returns:

an instance of the Quandl session, not null

getClient

protected javax.ws.rs.client.Client getClient()

Allow the client to be overridden by a test subclass.

Returns:

a Jersey Client

getDataSet

public TabularResult getDataSet(DataSetRequest request)

Get a tabular data set from Quandl.

Parameters:

request - the request object containing details of what is required

Returns:

a TabularResult set

getMetaData

public MetaDataResult getMetaData(MetaDataRequest request)

Get meta data from Quandl about a particular quandlCode.

Parameters:

request - the request object containing details of what is required

Returns:

a MetaDataResult

getDataSets

public TabularResult getDataSets(MultiDataSetRequest request)

Deprecated. this call is provided for compatibility purposes and is deprecated, please use the single request mechanism

Get a multiple data sets from quandl and return as single tabular result.

Parameters:

request - the multi data set request object containing details of what is required

Returns:

a single TabularResult set containing all requested results

getMetaData

public MetaDataResult getMetaData(MultiMetaDataRequest request)

Get meta data from Quandl about a range of quandlCodes returned as a single MetaDataResult.

Parameters:

request - the request object containing details of what is required

Returns:

a TabularResult set

getMultipleHeaderDefinition

public Map<String,HeaderDefinition> getMultipleHeaderDefinition(MultiMetaDataRequest request)

Deprecated. this now uses single calls to simulate multisets to support legacy code

Get header definitions from Quandl about a range of quandlCodes returned as a Map of Quandl code to HeaderDefinition. The keys of the map will retain the order of the request and are backed by an unmodifiable LinkedHashMap. Throws a QuandlRuntimeException if it can't find a parsable quandl code or Date column in the result.

Parameters:

request - the request object containing details of what is required, not null

Returns:

an unmodifiable Map of Quandl codes to MetaDataResult for each code, keys ordered according to request, not null

search

public SearchResult search(SearchRequest request)

Get search results from Quandl.

Parameters:

request - the search query parameter, not null

Returns:

the search result, not null