Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A Ruby wrapper for the FCC Content API

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 fixtures
Octocat-spinner-32 lib
Octocat-spinner-32 test
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 Gemfile
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 fcc-content-api.gemspec
README.md

Build Status

The FCC Content API allows you to programmatically access much of the content accessible on FCC.gov.

fcc-content-api is a lightweight Ruby wrapper for the Federal Communication Commission's Content API. The query interface resembles ActiveRecord. The response objects are simple Ruby Hashes and Arrays.

The FCC Content API is powered by the Drupal Content API Module.

Usage

First, familiarize yourself with the FCC Content API REST Documentation.

The FccContentApi::Content object is where you'll do most of the querying.

results = FccContentApi::Content.where(:search_string => "broadband").all
results.first # => {"count"=>"587", "pages"=>58, "itemsPerPage"=>10, "currentPage"=>0}
results[1] # => {"nid"=>"38802", "title"=>"PSHSB Seeks Comment on Broadband Waiver Transition Process", "created"=>"2012-04-06", "changed"=>"2012-04-09", "type"=>"edoc", "webUrl"=>"http://www.fcc.gov/document/pshsb-seeks-comment-broadband-waiver-transition-process", "uri"=>"http://www.fcc.gov/api/content/38802"}

Options for FccContentApi#where map 1-to-1 to the query options listed in the official FCC docs.

For example, if you want proceedings, related edocs and comments:

FccContentApi::Content.where(:edocs => "true").where(:type => "proceeding").where(:comments => "true").all

# or pass a single Hash:
FccContentApi::Content.where({:edocs => "true", :type => "proceeding" :comments => "true"}).all

If you know the id of the object you want, use FccContentApi::Content#find:

FccContentApi::Content.find(38660)

Installation

gem install fcc-content-api or:

# Gemfile
gem "fcc-content-api"

More Info

For more information, please visit the FCC's Developers page and the FCC's Github page.

Something went wrong with that request. Please try again.