Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jwarykowski/fredapi
A Ruby wrapper for the Federal Reserve Economic Data API (FRED)
https://github.com/jwarykowski/fredapi
Last synced: about 1 month ago
JSON representation
A Ruby wrapper for the Federal Reserve Economic Data API (FRED)
- Host: GitHub
- URL: https://github.com/jwarykowski/fredapi
- Owner: jwarykowski
- License: mit
- Archived: true
- Created: 2013-09-14T14:06:33.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2013-12-21T10:24:55.000Z (almost 11 years ago)
- Last Synced: 2024-09-17T18:31:31.564Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 238 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-fintech - fredapi - A Ruby wrapper for the Federal Reserve Economic Data API (FRED). (Libraries / Ruby)
README
[](https://bitdeli.com/free "Bitdeli Badge")
[](http://badge.fury.io/rb/fredapi)
[](https://travis-ci.org/jonathanchrisp/fredapi)
[](https://gemnasium.com/jonathanchrisp/fredapi)
[](https://codeclimate.com/github/jonathanchrisp/fredapi)
[](https://coveralls.io/r/jonathanchrisp/fredapi)
# fredapi
A Ruby wrapper for the [Federal Reserve Economic Data API](http://api.stlouisfed.org/docs/fred/overview.html) (FRED).
## Documentation
* Original documenation:
* Gem documentation:
## Getting Started
In order to be able to send API requests you'll first need to install the `fredapi` gem.
```ruby
gem install fredapi
```
You will need to register and request an API key in order to requests. To register please click [here](http://research.stlouisfed.org/useraccount/register/step1). Request an API key by following the instructions [here](http://api.stlouisfed.org/api_key.html).
Once you have completed the steps above, you can now create an instance of a `FREDAPI::Client` and set your API key as appropriate:
```ruby
require 'fredapi'
api = FREDAPI::Client.new 'api_key' => '123456789'
```
If you now look at your `FREDAPI` object instance it will be similar to the following:
```ruby
```
By the default the file_type is set to `json`. This can be easily be changed by simply updating the instance variable to be set to `xml`:
```ruby
api.file_type = 'xml'
```
Please note that when sending any FRED API request if you don't pass an `api_key` or `file_type` parameter the values on the `FREDAPI::Client` instance will be used as default.
## Example requests
Now that you have an `FREDAPI::Client` instance with your API key you can now make requests to the FRED API. For example to send a category get request do the following:
```ruby
api.category 'category_id' => 125
```
The response is returned within a `Hashie::Mash` instance.
```ruby
{"categories"=>[{"id"=>125, "name"=>"Trade Balance", "parent_id"=>13}]}
```
To find out more information about `Hashie` please visit the following link: . To see all documention on the various FREDAPI endpoint method calls please visit:
## Tests
There are a number of unit tests which are included as part of this project, please run:
```ruby
rspec spec
```
Please note that a number of tests still need to be added so I don't currently have complete coverage, subject to workload these will be slowly added over the next few months.
## Feedback
I would be more than happy to recieve feedback, please email me at: [email protected].