quandl v0.2.0 Quandl.V3.Api.Datasets

API calls for Quandl Time Series API

Link to this section Summary

Functions

Retrieves data from a specified time-series.

Retrieves metadata for a time-series.

Link to this section Functions

Link to this function

get_data(database_code, dataset_code, optional_params \\ [])

Retrieves data from a specified time-series.

Parameters

  • database_code (type: String.t) - database code, e.g. WIKI.
  • dataset_code (type: String.t) - dataset code, e.g. FB.
  • optional_params (type: keyword()) - Optional parameters.

    • limit (type: integer()) - limits the dataset.
    • column_index (type: integer())
    • start_date (type: String.t()) - e.g. "2014-01-01"
    • end_date (type: String.t()) - e.g. "2014-12-31"
    • order (type: String.t()) - "asc" or "desc" (default)
    • collapse (type: String.t()) - "none", "daily", "weekly", "monthly", "quarterly", "annual"
    • transform (type: String.t()) - "none", "diff", "rdiff", "rdiff_from", "cumul" or "normalize"

Returns

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

get_metadata(database_code, dataset_code)

Retrieves metadata for a time-series.

Parameters

  • database_code (type: String.t) - database code, e.g. WIKI.
  • dataset_code (type: String.t) - dataset code, e.g. FB.

Returns

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