tsp_scraper

Scrapes fund price history from the TSP.gov website.

Installation

gem install tsp_scraper

Usage

The scrape method accepts Date objects as parameters and returns TSP price data as an array of hashes:

require 'tsp_scraper'
TSPScraper::Client.scrape() # Get trailing one month's prices
TSPScraper::Client.scrape(start_date, end_date) # Get January prices

The returned array of hashes has the format:

[
  {
    :date => DATE1,
    :funds => {
      "FUND NAME 1" => #<BigDecimal>,
      "FUND NAME 2" => #<BigDecimal>,
      "FUND NAME 3" => #<BigDecimal>
    }
  },
  {
    :date => DATE2,
    :funds => {
      "FUND NAME 1" => #<BigDecimal>,
      "FUND NAME 2" => #<BigDecimal>,
      "FUND NAME 3" => #<BigDecimal>
    }
  },
  {
    :date => DATE3,
    :funds => {
      "FUND NAME 1" => #<BigDecimal>,
      "FUND NAME 2" => #<BigDecimal>,
      "FUND NAME 3" => #<BigDecimal>
    }
  }
]

You can get the raw CSV data as returned by the TSP website by using TSPScraper::Client.scrape_raw(), which accepts the same parameters as the scrape method.

HTTParty Options

The scrape and scrape_raw methods also accept an options hash for the HTTP request. The options hash should contain HTTParty options.

TSPScraper::Client.scrape(start_date, end_date, verify: false) # Don't verify SSL certificate