quandl

v0.4.5

quandl v0.4.5 Quandl.V3.Api.Datatables

API calls for Quandl Tables API

Link to this section Summary

Functions

get_data(datatable_code, optional_params \\ [])

Retrieves table data.

get_metadata(datatable_code)

Retrieves table metadata.

Link to this section Functions

Link to this function

get_data(datatable_code, optional_params \\ [])

get_data(String.t(), keyword()) ::
  {:ok, Quandl.V3.Model.DatatableDataContainer.t()} | {:error, Tesla.Env.t()}

Retrieves table data.

Parameters

  • datatable_code (type: String.t) - datatable code, e.g. ETFG/FUND

  • optional_params (type: keyword()) - row filter criteria

    • ticker (type: String.t()) - ticker filter condition, e.g. "SPY"
    • date (type: String.t()) - date filter condition
    • columns (type: String.t()) - lists which columns to return: e.g. "ticker", "date", "shares_outstanding"

Returns

  • {:ok, %Quandl.V3.Model.DatatableDataContainer{}} on success
  • {:error, info} on failure
Link to this function

get_metadata(datatable_code)

get_metadata(String.t()) ::
  {:ok, Quandl.V3.Model.DatatableMetadataContainer.t()}
  | {:error, Tesla.Env.t()}

Retrieves table metadata.

Parameters

  • datatable_code (type: String.t) - datatable code, e.g. AR/MWCS #

Returns

  • {:ok, %Quandl.V3.Model.DatatableMetadataContainer{}} on success
  • {:error, info} on failure