This repository has been archived by the owner. It is now read-only.
[DEPRECATED] An open API server, data import tools, and sample apps to help small businesses search for opportunities to work with the U.S. government.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
api Deprecate and remove ES_SERVICE_NAME Nov 16, 2015
cf-cron Added cron app Jul 6, 2015
elasticsearch Add ES initialization as a Makefile command Sep 17, 2015
loaders Deprecate and remove ES_SERVICE_NAME Nov 16, 2015
sample-www Merge branch 'master' into docs-update Nov 14, 2014
tools removed yellow warning for es health script Jul 18, 2014
.about.yml Updated .about.yml to validate with required fields Oct 26, 2015
.env.sample Issue #126: Improve autoenv sample Jul 28, 2014
.gitignore Move non-sensitive config vars into source control Jun 29, 2015
.jshintrc Updates to get loader working on CF Aug 14, 2015
.nvmrc Rolling back to 0.12.7 Oct 8, 2015 Updating licensing text. Jul 30, 2014 Updating licensing text. Jul 30, 2014
Makefile Moved ENV var definitions into API test itself Oct 15, 2015 clarifying that the site is no longer active Nov 20, 2017
Vagrantfile Manifest runs all the way through Jun 26, 2014
apiary.apib Updated docs redirect in Apiary file Aug 11, 2015
crontab Adding cleanup to crontab Aug 25, 2014 This is a replacement for PR #131: tweaks and improvements to OSX set… Jul 28, 2014 This is a replacement for PR #131: tweaks and improvements to OSX set… Jul 28, 2014
logrotate.conf Adding working logrotate config Aug 1, 2014
manifest.yml Deprecate and remove ES_SERVICE_NAME Nov 16, 2015
requirements.txt Fixing requirements.txt for dodsbir Jul 23, 2014 Removing sudo from npm installs Aug 18, 2015


FBOpen is an open API server, data import tools, and sample apps to help small businesses search for opportunities to work with the U.S. government.

The project began as an attempt to make it easier to search the content of, the U.S. government's system of record for opportunities to do business with the government. We downloaded the (XML) data from FBO's weekly data dump of opportunity listings, and loaded it into a Elasticsearch search server. Then we used a primitive crawler to download listings' attachments and load them into Elasticsearch -- something Elasticsearch makes easy thanks to their [Mapper Attachments Type] ( plugin.

Underneath the Google-style query page (/sample-www), we built a simple REST API (really a thin layer over Elasticsearc's API) so you can build your own query tools.

Then someone realized we didn't have to limit this server to FBO data. There's a second sample data loader that can be used to load data nightly from, and the API allows you to post opportunities, too. Many more data loaders are on their way.

As of 2014-03-12, the project was live at However in early 2017, the service was phased out.

Quickstart (OSX-only) (experimental)

This gets you a minimum viable setup:

$ cd fbopen
$ FBOPEN_ROOT=~/your/root/to/fbopen ./

To clean out any new files created from that script, as well as uninstall Elasticsearch, you can run:

$ ./

How to get started (manually)

  • Clone this repo.
  • This repo has an external dependency on another git repo, which needs to be populated at first, so cd to the repo and run: git submodule update --init --recursive.
  • Then install Elasticsearch. FBOpen requires at least version 1.2.
  • Get the API server up and running. See the in /api.
  • Load data into the search index using the import tools in /loaders -- or roll your own, or use the API's POST /v0/opp to post opportunities one at a time (POST functionality is temporarily disabled).
  • To run a simple query web page, try the sample app in /sample-www.
    • A quick and easy way to access this page at localhost, provided you have Python installed, is to cd to the /sample-www directory and run: python -m SimpleHTTPServer. By default, you'll then be able to access the client at http://localhost:8000


  • You can add an FBOpen query to any HTML page by just copying and pasting a snippet of JavaScript with our FBOpen Widget Maker.
  • The BusinessUSA PIF team coded up a sample form specifically geared toward submitting or tweaking SBIR solicitations in FBOpen. The relevant code can be found here: Hyabusa is a test-bed Rails 4 app, and includes several other mini-applications, so look for the SbirSolicitationsController and related views.
  • One of the BusinessUSA PIF's also coded up a sample site to showcase how could function if FBOpen were the backend data source for the solicitation listings. That repo, as of this writing very much a work in progress, can be found here: This is a Python app built with the Flask microframework.


This project is brand new and very incomplete. No guarantees of data completeness or functionality are implied or should be assumed. There is lots to do!


FBopen is a joint project of 18F, the Presidential Innovation Fellowship, and the GSA Integrated Award Environment.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.